[ { "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.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\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.", "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": [ "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": "T000002R000003", "___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 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.\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 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.", "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": "T000002R000011", "___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": "T000002R000014", "___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": "T000002R000019", "___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": "T000002R000028", "___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 aligns them based on the grid configuration given to this action.\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 then aligns them based on the grid configuration given to this action.", "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": "T000002R000047", "___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": "T000002R000080", "___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": "T000002R000084", "___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": "T000002R000088", "___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": "T000002R000093", "___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": "T000002R000096", "___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": "T000002R000151", "___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 * 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\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": "T000002R000165", "___s": true }, { "comment": "/**\r\n * Positions an array of Game Objects on evenly spaced points of a 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 *\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": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Positions an array of Game Objects on evenly spaced points of a 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" } ], "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": "T000002R000179", "___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 positional offset.\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 positional offset.", "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": "T000002R000191", "___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, to increase or decrease the packing of the Game Objects on the lines.\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, to increase or decrease the packing of the Game Objects on the lines.", "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": "T000002R000200", "___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": "T000002R000227", "___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": "T000002R000232", "___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": "T000002R000245", "___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": "T000002R000259", "___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": "T000002R000264", "___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": "T000002R000269", "___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": "T000002R000274", "___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": "T000002R000279", "___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": "T000002R000284", "___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": "T000002R000289", "___s": true }, { "comment": "/**\r\n * Rotates an array of Game Objects around a point by the given angle and distance.\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 an array of Game Objects around a point by the given angle and distance.", "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": "T000002R000297", "___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": "T000002R000304", "___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": "T000002R000308", "___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` property is applied incrementally, multiplied by 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` property is applied incrementally, multiplied by 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": "T000002R000313", "___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 each item in the array.\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 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": "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 each item in the array.\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 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.SetAlpha", "scope": "static", "___id": "T000002R000317", "___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": "T000002R000321", "___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.\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 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": "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.\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 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.SetDepth", "scope": "static", "___id": "T000002R000325", "___s": true }, { "comment": "/**\r\n * Passes all provided Game Objects to the Input Manager to enable them for input with identical areas and callbacks.\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} [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 *\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": "Passes all provided Game Objects to the Input Manager to enable them for input with identical areas and callbacks.", "see": [ "{@link Phaser.GameObjects.GameObject#setInteractive}" ], "kind": "function", "name": "SetHitArea", "since": "3.0.0", "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": "callback" } ], "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": "T000002R000328", "___s": true }, { "comment": "/**\n * Takes an array of Game Objects, or any objects that have the public properties `originX` and `originY`\n * and then sets them to the given values.\n *\n * The optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\n *\n * To use this with a Group: `SetOrigin(group.getChildren(), originX, originY, stepX, stepY)`\n *\n * @function Phaser.Actions.SetOrigin\n * @since 3.0.0\n *\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\n *\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\n * @param {number} originX - The amount to set the `originX` property to.\n * @param {number} [originY] - The amount to set the `originY` property to. If `undefined` or `null` it uses the `originX` value.\n * @param {number} [stepX=0] - This is added to the `originX` amount, multiplied by the iteration counter.\n * @param {number} [stepY=0] - This is added to the `originY` amount, multiplied by the iteration counter.\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\n *\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\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`\nand then sets them to the given values.\n\nThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetOrigin(group.getChildren(), originX, originY, stepX, stepY)`", "kind": "function", "name": "SetOrigin", "since": "3.0.0", "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": "T000002R000333", "___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.\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": "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.", "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.SetRotation", "scope": "static", "___id": "T000002R000338", "___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": "T000002R000342", "___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 each item in the array.\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 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": "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 each item in the array.\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 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.SetScaleX", "scope": "static", "___id": "T000002R000347", "___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 each item in the array.\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 each item in the array.\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": "T000002R000351", "___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": "T000002R000355", "___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": "T000002R000360", "___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": "T000002R000364", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public method setTint() and then updates it to the given value(s). You can specify tint color per corner or provide only one color value for `topLeft` parameter, in which case whole item will be tinted with that color.\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 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 {(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 it to the given value(s). You can specify tint color per corner or provide only one color value for `topLeft` parameter, in which case whole item will be tinted with that color.", "kind": "function", "name": "SetTint", "since": "3.0.0", "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 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": [ "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": "T000002R000367", "___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 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 {(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 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": [ "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": "T000002R000372", "___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 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": "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 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.SetX", "scope": "static", "___id": "T000002R000376", "___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": "T000002R000380", "___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": "T000002R000385", "___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 = first to last and 1 = last to first.\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 = first to last and 1 = last to first.", "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": "T000002R000389", "___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": "T000002R000420", "___s": true }, { "comment": "/**\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 smoothstep function is zero at both edges. This is convenient for creating a sequence of transitions using smoothstep to interpolate each segment as an alternative to using more sophisticated or expensive interpolation techniques.\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] - Should the values 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": "SmootherStep.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Smootherstep 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 smoothstep function is zero at both edges. This is convenient for creating a sequence of transitions using smoothstep to interpolate each segment as an alternative to using more sophisticated or expensive interpolation techniques.", "kind": "function", "name": "SmootherStep", "since": "3.0.0", "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": "Should the values 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.SmootherStep", "scope": "static", "___id": "T000002R000424", "___s": true }, { "comment": "/**\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 minimum interpolation value.\r\n * @param {number} max - The maximum interpolation value.\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": "Smoothstep 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 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": "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": "T000002R000435", "___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 (`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 (`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": "T000002R000445", "___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": "T000002R000457", "___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": "T000002R000462", "___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": "T000002R000463", "___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": "T000002R000464", "___s": true }, { "comment": "/**\r\n * Iterates through the given array and makes sure that each objects x and y\r\n * properties are wrapped to keep them contained within the given Rectangles\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 objects x and y\rproperties are wrapped to keep them contained within the given Rectangles\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": "T000002R000466", "___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 animations 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 animations 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": "T000002R000481", "___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": "T000002R000484", "___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": "T000002R000486", "___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": "T000002R000488", "___s": true }, { "comment": "/**\r\n * Extract all the frame data into the frames array.\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": "Extract all the frame data into the frames array.", "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": "T000002R000490", "___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": "T000002R000492", "___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": "T000002R000494", "___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": "T000002R000496", "___s": true }, { "comment": "/**\r\n * Skip frames if the time lags, or always advanced 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 advanced 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": "T000002R000498", "___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": "T000002R000500", "___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": "T000002R000502", "___s": true }, { "comment": "/**\r\n * The delay in ms before the 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 the 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": "T000002R000504", "___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": "T000002R000506", "___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": "T000002R000508", "___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": "T000002R000510", "___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": "T000002R000512", "___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": "T000002R000514", "___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": "T000002R000516", "___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": "T000002R000518", "___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": "T000002R000520", "___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": "T000002R000529", "___s": true }, { "comment": "/**\r\n * Add frame/s into the animation.\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": "Add frame/s into the animation.", "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": "T000002R000531", "___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": "T000002R000539", "___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": "T000002R000541", "___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": "T000002R000545", "___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": "T000002R000547", "___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": "T000002R000579", "___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": "T000002R000583", "___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": "T000002R000586", "___s": true }, { "comment": "/**\r\n * Returns the animation last frame.\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 animation last frame.", "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": "T000002R000596", "___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": "T000002R000598", "___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": "T000002R000604", "___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": "T000002R000607", "___s": true }, { "comment": "/**\r\n * Called internally during playback. Forces the animation to repeat, providing 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, providing 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": "T000002R000609", "___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": "T000002R000614", "___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": "T000002R000631", "___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": "T000002R000654", "___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": "T000002R000657", "___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": "T000002R000660", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single frame in an Animation sequence.\r\n *\r\n * An AnimationFrame consists of a reference to the Texture it uses for rendering, references to other\r\n * frames in the animation, and index data. It also has the ability to modify the animation timing.\r\n *\r\n * AnimationFrames are generated automatically by the Animation class.\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 in an Animation sequence.\r\rAn AnimationFrame consists of a reference to the Texture it uses for rendering, references to other\rframes in the animation, and index data. It also has the ability to modify the animation timing.\r\rAnimationFrames are generated automatically by the Animation class.", "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": "T000002R000667", "___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": 37, "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": "T000002R000671", "___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": 46, "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": "T000002R000673", "___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": 55, "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": "T000002R000675", "___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": 64, "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": "T000002R000677", "___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": 73, "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": "T000002R000679", "___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": 84, "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": "T000002R000681", "___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": 95, "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": "T000002R000683", "___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": 106, "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": "T000002R000685", "___s": true }, { "comment": "/**\r\n * Additional time (in ms) that this frame should appear for during playback.\r\n * The value is added onto the msPerFrame set by 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": 117, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Additional time (in ms) that this frame should appear for during playback.\rThe value is added onto the msPerFrame set by 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": "T000002R000687", "___s": true }, { "comment": "/**\r\n * What % through the animation does this frame come?\r\n * This value is generated 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": 128, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "What % through the animation does this frame come?\rThis value is generated 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": "T000002R000689", "___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": 140, "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": "T000002R000691", "___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": 150, "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": "T000002R000693", "___s": true }, { "comment": "/**\r\n * Destroys this object by removing references to external resources and callbacks.\r\n *\r\n * @method Phaser.Animations.AnimationFrame#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationFrame.js", "lineno": 168, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Destroys this object by removing references to external resources and callbacks.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationFrame", "longname": "Phaser.Animations.AnimationFrame#destroy", "scope": "instance", "___id": "T000002R000699", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Animation Manager.\r\n *\r\n * Animations are managed by the global Animation Manager. This is a singleton class that is\r\n * responsible for creating and delivering animations and their corresponding data to all Game Objects.\r\n * Unlike plugins it is owned by the Game instance, not the Scene.\r\n *\r\n * Sprites and other Game Objects get the data they need from the AnimationManager.\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.\r\rAnimations are managed by the global Animation Manager. This is a singleton class that is\rresponsible for creating and delivering animations and their corresponding data to all Game Objects.\rUnlike plugins it is owned by the Game instance, not the Scene.\r\rSprites and other Game Objects get the data they need from the AnimationManager.", "kind": "class", "name": "AnimationManager", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Animations", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "A reference to the Phaser.Game instance.", "name": "game" } ], "scope": "static", "longname": "Phaser.Animations.AnimationManager", "___id": "T000002R000714", "___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": 47, "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": "T000002R000718", "___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": 57, "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": "T000002R000720", "___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": 67, "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": "T000002R000722", "___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": 79, "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": "T000002R000724", "___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": 91, "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": "T000002R000726", "___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": 102, "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": "T000002R000728", "___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": 112, "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": "T000002R000730", "___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": 124, "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": "T000002R000732", "___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": 138, "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": "T000002R000735", "___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": 191, "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": "T000002R000744", "___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": 241, "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": "T000002R000750", "___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": 276, "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": "T000002R000756", "___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": 306, "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": "T000002R000759", "___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": 323, "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": "T000002R000761", "___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": 500, "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": "T000002R000794", "___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": 548, "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": "T000002R000800", "___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": 597, "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": "T000002R000807", "___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": 697, "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": "T000002R000827", "___s": true }, { "comment": "/**\r\n * Get an Animation.\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": 801, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Get an Animation.", "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": "T000002R000843", "___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": "T000002R000845", "___s": true }, { "comment": "/**\r\n * Pause all animations.\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": "Pause all animations.", "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": "T000002R000855", "___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": 877, "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": "T000002R000858", "___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": 903, "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": "T000002R000862", "___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": 969, "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": "T000002R000870", "___s": true }, { "comment": "/**\r\n * Resume all paused animations.\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": 999, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Resume all paused animations.", "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": "T000002R000873", "___s": true }, { "comment": "/**\r\n * Returns the Animation data as JavaScript object based on the given key.\r\n * Or, if not 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": 1020, "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 not 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": "T000002R000876", "___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": 1053, "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": "T000002R000881", "___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": "T000002R000892", "___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": "T000002R000895", "___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": "T000002R000897", "___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": "T000002R000899", "___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": "T000002R000901", "___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": "T000002R000903", "___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": "T000002R000905", "___s": true }, { "comment": "/**\r\n * The current Animation loaded into this Animation component.\r\n *\r\n * Will by `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 by `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": "T000002R000907", "___s": true }, { "comment": "/**\r\n * The current AnimationFrame being displayed by this Animation component.\r\n *\r\n * Will by `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 by `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": "T000002R000909", "___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 by `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 by `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": "T000002R000911", "___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": "T000002R000913", "___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": "T000002R000915", "___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": "T000002R000917", "___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": "T000002R000919", "___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": "T000002R000921", "___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": "T000002R000923", "___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": "T000002R000925", "___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": "T000002R000927", "___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": "T000002R000929", "___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": "T000002R000931", "___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": "T000002R000933", "___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": "T000002R000935", "___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": "T000002R000937", "___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": "T000002R000939", "___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": "T000002R000941", "___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": "T000002R000943", "___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": "T000002R000945", "___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": "T000002R000947", "___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": "T000002R000949", "___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": "T000002R000951", "___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": "T000002R000953", "___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": "T000002R000963", "___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": "T000002R000972", "___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": "T000002R000974", "___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": "T000002R000976", "___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": "T000002R001001", "___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": "T000002R001006", "___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": "T000002R001010", "___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": "T000002R001018", "___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": "T000002R001027", "___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": "T000002R001038", "___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": "T000002R001046", "___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": "T000002R001078", "___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": "T000002R001082", "___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": "T000002R001087", "___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": "T000002R001090", "___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": "T000002R001093", "___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": "T000002R001096", "___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": "T000002R001109", "___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": "T000002R001115", "___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": "T000002R001122", "___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": "T000002R001126", "___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": "T000002R001132", "___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": "T000002R001136", "___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": "T000002R001138", "___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": "T000002R001145", "___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": "T000002R001152", "___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": "T000002R001154", "___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": "T000002R001156", "___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": "T000002R001158", "___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": "T000002R001160", "___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": "T000002R001167", "___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": "T000002R001169", "___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 * If you're working with a texture atlas, see the `generateFrameNames` method instead.\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.\rIf you're working with a texture atlas, see the `generateFrameNames` method instead.\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": "T000002R001171", "___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": 1933, "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": "T000002R001173", "___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": 1962, "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": "T000002R001176", "___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": 1988, "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": "T000002R001184", "___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": "T000002R001188", "___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": "T000002R001190", "___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": "T000002R001192", "___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": "T000002R001194", "___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": "T000002R001196", "___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": "T000002R001198", "___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 stopeed 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 stopeed 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": "T000002R001200", "___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": "T000002R001202", "___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": "T000002R001204", "___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": "T000002R001217", "___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": "T000002R001219", "___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": "T000002R001221", "___s": true }, { "comment": "/**\n * @namespace Phaser.Animations\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": "T000002R001223", "___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": "T000002R001230", "___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": "T000002R001231", "___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": "T000002R001232", "___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": "T000002R001233", "___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": "T000002R001234", "___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": "T000002R001235", "___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": "T000002R001236", "___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": "T000002R001237", "___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": "T000002R001238", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The BaseCache is a base Cache class that can be used for storing references to any kind of data.\r\n *\r\n * Data can be added, retrieved and removed based on the given keys.\r\n *\r\n * Keys are string-based.\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": "The BaseCache is a base Cache class that can be used for storing references to any kind of data.\r\rData can be added, retrieved and removed based on the given keys.\r\rKeys are string-based.", "kind": "class", "name": "BaseCache", "memberof": "Phaser.Cache", "since": "3.0.0", "scope": "static", "longname": "Phaser.Cache.BaseCache", "___id": "T000002R001243", "___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": "T000002R001246", "___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": "T000002R001248", "___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": "T000002R001250", "___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": "T000002R001252", "___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": "T000002R001254", "___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": "T000002R001256", "___s": true }, { "comment": "/**\r\n * Removes and 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 and 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": "T000002R001258", "___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[]} Array containing all the keys.\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": "Array containing all the keys." } ], "memberof": "Phaser.Cache.BaseCache", "longname": "Phaser.Cache.BaseCache#getKeys", "scope": "instance", "___id": "T000002R001261", "___s": true }, { "comment": "/**\r\n * Destroys this cache and all items within it.\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.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Cache.BaseCache", "longname": "Phaser.Cache.BaseCache#destroy", "scope": "instance", "___id": "T000002R001263", "___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 * it has loaded. The manager itself doesn't store any files, but instead owns multiple BaseCache\r\n * instances, one per type of file. You can also add your own custom caches.\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\rit has loaded. The manager itself doesn't store any files, but instead owns multiple BaseCache\rinstances, one per type of file. You can also add your own custom caches.", "kind": "class", "name": "CacheManager", "memberof": "Phaser.Cache", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "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": "T000002R001271", "___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": 32, "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": "T000002R001274", "___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": 42, "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": "T000002R001276", "___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": 51, "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": "T000002R001278", "___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": 61, "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": "T000002R001280", "___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": 70, "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": "T000002R001282", "___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": 79, "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": "T000002R001284", "___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": 88, "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": "T000002R001286", "___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": 97, "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": "T000002R001288", "___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": 106, "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": "T000002R001290", "___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": 115, "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": "T000002R001292", "___s": true }, { "comment": "/**\r\n * A Cache storing all WaveFront OBJ files, typically added via the Loader.\r\n *\r\n * @name Phaser.Cache.CacheManager#obj\r\n * @type {Phaser.Cache.BaseCache}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 124, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "A Cache storing all WaveFront OBJ files, typically added via the Loader.", "name": "obj", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "since": "3.0.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#obj", "scope": "instance", "kind": "member", "___id": "T000002R001294", "___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": 133, "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": "T000002R001296", "___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": 143, "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": "T000002R001298", "___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": 152, "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": "T000002R001300", "___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": 165, "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": "T000002R001302", "___s": true }, { "comment": "/**\r\n * Removes all entries from all BaseCaches and destroys all custom caches.\r\n *\r\n * @method Phaser.Cache.CacheManager#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 187, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "Removes all entries from all BaseCaches and destroys all custom caches.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#destroy", "scope": "instance", "___id": "T000002R001305", "___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": "T000002R001314", "___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": "T000002R001316", "___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": "T000002R001320", "___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": "T000002R001322", "___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.Alpha\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": 17, "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.Alpha", "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": "T000002R001336", "___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": 79, "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": "T000002R001345", "___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": 88, "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": "T000002R001347", "___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": 97, "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": "T000002R001349", "___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": 106, "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": "T000002R001351", "___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": 115, "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": "T000002R001353", "___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": 126, "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": "T000002R001355", "___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": 136, "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": "T000002R001357", "___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": 146, "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": "T000002R001359", "___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": 158, "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": "T000002R001360", "___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": 170, "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": "T000002R001362", "___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 the `postRenderCamera` method of the renderer.\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": 183, "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 the `postRenderCamera` method of the renderer.", "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": "T000002R001364", "___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": 358, "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": "T000002R001388", "___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": 368, "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": "T000002R001390", "___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": 377, "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.Alpha#alpha", "___id": "T000002R001392", "___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": 388, "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": "T000002R001393", "___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": 410, "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": "T000002R001397", "___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": 425, "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": "T000002R001399", "___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": 442, "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": "T000002R001401", "___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.BitmapMask|Phaser.Display.Masks.GeometryMask)}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 470, "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.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "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": "T000002R001405", "___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": 494, "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": "T000002R001409", "___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": 510, "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": "T000002R001411", "___s": true }, { "comment": "/**\r\n * Adds the given Game Object to this cameras 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": 522, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Adds the given Game Object to this cameras 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": "T000002R001413", "___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": 538, "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.Alpha#setAlpha", "___id": "T000002R001415", "___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": 550, "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": "T000002R001416", "___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": 579, "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": "T000002R001422", "___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": 612, "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": "T000002R001431", "___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": 639, "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": "T000002R001437", "___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": 666, "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": "T000002R001443", "___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": 685, "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": "T000002R001445", "___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": 710, "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": "T000002R001452", "___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": 726, "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": "T000002R001456", "___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": 807, "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": "T000002R001488", "___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|Phaser.GameObjects.Layer|Phaser.GameObjects.Layer[])} 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": 874, "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", "Phaser.GameObjects.Layer", "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" } ] }, { "type": "NameExpression", "name": "Phaser.GameObjects.Group" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Layer" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Layer", "type": "NameExpression" } ] } ] } }, "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": "T000002R001518", "___s": true }, { "comment": "/**\r\n * Internal preRender step.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#preRender\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 915, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Internal preRender step.", "kind": "function", "name": "preRender", "access": "protected", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#preRender", "scope": "instance", "___id": "T000002R001525", "___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": 979, "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": "T000002R001549", "___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": 1011, "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": "T000002R001557", "___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": 1048, "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": "T000002R001565", "___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 cameras angle of rotation, given in degrees.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1067, "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 cameras 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": "T000002R001569", "___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": 1088, "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": "T000002R001573", "___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": 1114, "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": "T000002R001578", "___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": 1166, "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": "T000002R001585", "___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": 1191, "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": "T000002R001589", "___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": 1211, "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": "T000002R001593", "___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": 1234, "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": "T000002R001598", "___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": 1255, "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": "T000002R001602", "___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": 1274, "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": "T000002R001605", "___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": 1308, "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": "T000002R001614", "___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": 1333, "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": "T000002R001619", "___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 * @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": 1358, "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.", "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": "T000002R001624", "___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": 1389, "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": "T000002R001630", "___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 can be either a GeometryMask or a BitmapMask.\r\n *\r\n * Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 1430, "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 can be either a GeometryMask or a BitmapMask.\r\rBitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "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": "T000002R001638", "___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": 1461, "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": "T000002R001643", "___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": 1485, "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": "T000002R001647", "___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": 1498, "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": "T000002R001648", "___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": 1535, "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": "T000002R001667", "___s": true }, { "comment": "/**\r\n * Set if this Camera is being used as a Scene Camera, or a Texture\r\n * Camera.\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": 1550, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Set if this Camera is being used as a Scene Camera, or a Texture\rCamera.", "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": "T000002R001669", "___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": 1599, "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": "T000002R001678", "___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": 1638, "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": "T000002R001687", "___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": 1662, "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": "T000002R001692", "___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": 1686, "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": "T000002R001697", "___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": 1711, "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": "T000002R001702", "___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": 1736, "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": "T000002R001707", "___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": 1769, "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": "T000002R001713", "___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": 1802, "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": "T000002R001719", "___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": 1835, "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": "T000002R001726", "___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": 1866, "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": "T000002R001732", "___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": 1927, "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": "T000002R001744", "___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": 1944, "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": "T000002R001747", "___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": 1961, "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": "T000002R001750", "___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": 1984, "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": "T000002R001753", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Camera.\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 * A Camera also has built-in special effects including Fade, Flash and Camera Shake.\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 * @extends Phaser.GameObjects.Components.PostPipeline\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.\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\rA Camera also has built-in special effects including Fade, Flash and Camera Shake.", "kind": "class", "name": "Camera", "memberof": "Phaser.Cameras.Scene2D", "since": "3.0.0", "augments": [ "Phaser.Cameras.Scene2D.BaseCamera", "Phaser.GameObjects.Components.PostPipeline" ], "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": "T000002R001767", "___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": 70, "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": "T000002R001772", "___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": 80, "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": "T000002R001774", "___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": 90, "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": "T000002R001776", "___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": 100, "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": "T000002R001778", "___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": 110, "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": "T000002R001780", "___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": 120, "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": "T000002R001782", "___s": true }, { "comment": "/**\r\n * The Camera Zoom effect handler.\r\n * To zoom this camera see the `Camera.zoom` 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": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The Camera Zoom effect handler.\rTo zoom this camera see the `Camera.zoom` 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": "T000002R001784", "___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 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 * @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": 140, "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 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.", "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": "T000002R001786", "___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": 158, "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": "T000002R001788", "___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": 169, "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": "T000002R001790", "___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": 206, "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": "T000002R001794", "___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": 268, "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": "T000002R001806", "___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": 291, "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": "T000002R001808", "___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": 315, "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": "T000002R001810", "___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": 339, "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": "T000002R001812", "___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": 363, "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": "T000002R001814", "___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": 387, "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": "T000002R001816", "___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": 409, "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": "T000002R001818", "___s": true }, { "comment": "/**\r\n * This effect will rotate the Camera so that the viewport finishes at the given angle in radians,\r\n * 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} radians - The destination angle in radians to rotate the Camera viewport to. If the angle is positive then the rotation is clockwise else anticlockwise\r\n * @param {boolean} [shortestPath=false] - If shortest path is set to true the camera will rotate in the quickest direction clockwise or anti-clockwise.\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 rotation. 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 {CameraRotateCallback} [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 rotation angle in radians.\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": 435, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "This effect will rotate the Camera so that the viewport finishes at the given angle in radians,\rover 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 viewport to. If the angle is positive then the rotation is clockwise else anticlockwise", "name": "radians" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If shortest path is set to true the camera will rotate in the quickest direction clockwise or anti-clockwise.", "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 for the rotation. 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": [ "CameraRotateCallback" ], "parsedType": { "type": "NameExpression", "name": "CameraRotateCallback" } }, "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 rotation angle in radians.", "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": "T000002R001820", "___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 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": 459, "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 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#zoomTo", "scope": "instance", "___id": "T000002R001822", "___s": true }, { "comment": "/**\r\n * Internal preRender step.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#preRender\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Camera.js", "lineno": 483, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Internal preRender step.", "kind": "function", "name": "preRender", "access": "protected", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#preRender", "scope": "instance", "overrides": "Phaser.Cameras.Scene2D.BaseCamera#preRender", "___id": "T000002R001824", "___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 amount added to the horizontal linear interpolation of the follow target.\r\n * @param {number} [y=1] - The amount added to the vertical linear interpolation of the follow target.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "Camera.js", "lineno": 615, "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 amount added to the horizontal linear interpolation of the follow target.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount added to the vertical linear interpolation of the follow target.", "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": "T000002R001868", "___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": 643, "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": "T000002R001872", "___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": 665, "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": "T000002R001876", "___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": 730, "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": "T000002R001895", "___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": 745, "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": "T000002R001898", "___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": 765, "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": "T000002R001900", "___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": 788, "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": "T000002R001902", "___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": "T000002R001914", "___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": "T000002R001917", "___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": "T000002R001919", "___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": "T000002R001921", "___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": "T000002R001923", "___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": "T000002R001925", "___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": "T000002R001927", "___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": "T000002R001939", "___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": "T000002R001950", "___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 the `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 the `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": "T000002R001966", "___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": "T000002R001973", "___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": "T000002R001998", "___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": "T000002R002002", "___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": "T000002R002010", "___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": "T000002R002020", "___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": "T000002R002027", "___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": "T000002R002029", "___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": "T000002R002034", "___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": "T000002R002037", "___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": "T000002R002041", "___s": true }, { "comment": "/**\n * @classdesc\n * A Camera Fade effect.\n *\n * This effect will fade the camera viewport to the given color, over the duration specified.\n *\n * Only the camera viewport is faded. None of the objects it is displaying are impacted, i.e. their colors do\n * not change.\n *\n * The effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\n * which is invoked each frame for the duration of the effect, if required.\n *\n * @class Fade\n * @memberof Phaser.Cameras.Scene2D.Effects\n * @constructor\n * @since 3.5.0\n *\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera this effect is acting upon.\n */", "meta": { "filename": "Fade.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "classdesc": "A Camera Fade effect.\n\nThis effect will fade the camera viewport to the given color, over the duration specified.\n\nOnly the camera viewport is faded. None of the objects it is displaying are impacted, i.e. their colors do\nnot change.\n\nThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\nwhich is invoked each frame for the duration of the effect, if required.", "kind": "class", "name": "Fade", "memberof": "Phaser.Cameras.Scene2D.Effects", "since": "3.5.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "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": "T000002R002058", "___s": true }, { "comment": "/**\n * The Camera this effect belongs to.\n *\n * @name Phaser.Cameras.Scene2D.Effects.Fade#camera\n * @type {Phaser.Cameras.Scene2D.Camera}\n * @readonly\n * @since 3.5.0\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": "T000002R002061", "___s": true }, { "comment": "/**\n * Is this effect actively running?\n *\n * @name Phaser.Cameras.Scene2D.Effects.Fade#isRunning\n * @type {boolean}\n * @readonly\n * @default false\n * @since 3.5.0\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": "T000002R002063", "___s": true }, { "comment": "/**\n * Has this effect finished running?\n *\n * This is different from `isRunning` because it remains set to `true` when the effect is over,\n * until the effect is either reset or started again.\n *\n * @name Phaser.Cameras.Scene2D.Effects.Fade#isComplete\n * @type {boolean}\n * @readonly\n * @default false\n * @since 3.5.0\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?\n\nThis is different from `isRunning` because it remains set to `true` when the effect is over,\nuntil the effect is either reset or started again.", "name": "isComplete", "type": { "names": [ "boolean" ], "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": "T000002R002065", "___s": true }, { "comment": "/**\n * The direction of the fade.\n * `true` = fade out (transparent to color), `false` = fade in (color to transparent)\n *\n * @name Phaser.Cameras.Scene2D.Effects.Fade#direction\n * @type {boolean}\n * @readonly\n * @since 3.5.0\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.\n`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": "T000002R002067", "___s": true }, { "comment": "/**\n * The duration of the effect, in milliseconds.\n *\n * @name Phaser.Cameras.Scene2D.Effects.Fade#duration\n * @type {number}\n * @readonly\n * @default 0\n * @since 3.5.0\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": "T000002R002069", "___s": true }, { "comment": "/**\n * If this effect is running this holds the current percentage of the progress, a value between 0 and 1.\n *\n * @name Phaser.Cameras.Scene2D.Effects.Fade#progress\n * @type {number}\n * @since 3.5.0\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": "T000002R002079", "___s": true }, { "comment": "/**\n * Fades the Camera to or from the given color over the duration specified.\n *\n * @method Phaser.Cameras.Scene2D.Effects.Fade#start\n * @fires Phaser.Cameras.Scene2D.Events#FADE_IN_START\n * @fires Phaser.Cameras.Scene2D.Events#FADE_OUT_START\n * @since 3.5.0\n *\n * @param {boolean} [direction=true] - The direction of the fade. `true` = fade out (transparent to color), `false` = fade in (color to transparent)\n * @param {number} [duration=1000] - The duration of the effect in milliseconds.\n * @param {number} [red=0] - The amount to fade the red channel towards. A value between 0 and 255.\n * @param {number} [green=0] - The amount to fade the green channel towards. A value between 0 and 255.\n * @param {number} [blue=0] - The amount to fade the blue channel towards. A value between 0 and 255.\n * @param {boolean} [force=false] - Force the effect to start immediately, even if already running.\n * @param {Phaser.Types.Cameras.Scene2D.CameraFadeCallback} [callback] - This callback will be invoked every frame for the duration of the effect.\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.\n * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.\n *\n * @return {Phaser.Cameras.Scene2D.Camera} The Camera on which the effect was started.\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.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.", "name": "callback" }, { "type": { "names": [ "any" ], "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": "T000002R002087", "___s": true }, { "comment": "/**\n * The main update loop for this effect. Called automatically by the Camera.\n *\n * @method Phaser.Cameras.Scene2D.Effects.Fade#update\n * @since 3.5.0\n *\n * @param {number} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\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": "T000002R002110", "___s": true }, { "comment": "/**\n * Called internally by the Canvas Renderer.\n *\n * @method Phaser.Cameras.Scene2D.Effects.Fade#postRenderCanvas\n * @since 3.5.0\n *\n * @param {CanvasRenderingContext2D} ctx - The Canvas context to render to.\n *\n * @return {boolean} `true` if the effect drew to the renderer, otherwise `false`.\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": "T000002R002116", "___s": true }, { "comment": "/**\n * Called internally by the WebGL Renderer.\n *\n * @method Phaser.Cameras.Scene2D.Effects.Fade#postRenderWebGL\n * @since 3.5.0\n *\n * @param {Phaser.Renderer.WebGL.Pipelines.MultiPipeline} pipeline - The WebGL Pipeline to render to. Must provide the `drawFillRect` method.\n * @param {function} getTintFunction - A function that will return the gl safe tint colors.\n *\n * @return {boolean} `true` if the effect drew to the renderer, otherwise `false`.\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", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.MultiPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline" } }, "description": "The WebGL Pipeline to render to. Must provide the `drawFillRect` method.", "name": "pipeline" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "A function that will return the gl safe tint colors.", "name": "getTintFunction" } ], "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#postRenderWebGL", "scope": "instance", "___id": "T000002R002120", "___s": true }, { "comment": "/**\n * Called internally when the effect completes.\n *\n * @method Phaser.Cameras.Scene2D.Effects.Fade#effectComplete\n * @fires Phaser.Cameras.Scene2D.Events#FADE_IN_COMPLETE\n * @fires Phaser.Cameras.Scene2D.Events#FADE_OUT_COMPLETE\n * @since 3.5.0\n */", "meta": { "filename": "Fade.js", "lineno": 330, "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": "T000002R002126", "___s": true }, { "comment": "/**\n * Resets this camera effect.\n * If it was previously running, it stops instantly without calling its onComplete callback or emitting an event.\n *\n * @method Phaser.Cameras.Scene2D.Effects.Fade#reset\n * @since 3.5.0\n */", "meta": { "filename": "Fade.js", "lineno": 351, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Resets this camera effect.\nIf it was previously running, it stops instantly without calling its onComplete callback or emitting an event.", "kind": "function", "name": "reset", "since": "3.5.0", "memberof": "Phaser.Cameras.Scene2D.Effects.Fade", "longname": "Phaser.Cameras.Scene2D.Effects.Fade#reset", "scope": "instance", "___id": "T000002R002133", "___s": true }, { "comment": "/**\n * Destroys this effect, releasing it from the Camera.\n *\n * @method Phaser.Cameras.Scene2D.Effects.Fade#destroy\n * @since 3.5.0\n */", "meta": { "filename": "Fade.js", "lineno": 367, "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": "T000002R002139", "___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": "T000002R002146", "___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": "T000002R002149", "___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": "T000002R002151", "___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": "T000002R002153", "___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": "T000002R002161", "___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": "T000002R002163", "___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": "T000002R002173", "___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": "T000002R002192", "___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": "T000002R002197", "___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 * @param {Phaser.Renderer.WebGL.Pipelines.MultiPipeline} pipeline - The WebGL Pipeline to render to. Must provide the `drawFillRect` method.\r\n * @param {function} getTintFunction - A function that will return the gl safe tint colors.\r\n *\r\n * @return {boolean} `true` if the effect drew 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", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.MultiPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline" } }, "description": "The WebGL Pipeline to render to. Must provide the `drawFillRect` method.", "name": "pipeline" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "A function that will return the gl safe tint colors.", "name": "getTintFunction" } ], "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#postRenderWebGL", "scope": "instance", "___id": "T000002R002201", "___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": 308, "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": "T000002R002207", "___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": 326, "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": "T000002R002213", "___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": 341, "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": "T000002R002218", "___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": "T000002R002222", "___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": "T000002R002235", "___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": "T000002R002238", "___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": "T000002R002240", "___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": "T000002R002242", "___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": "T000002R002244", "___s": true }, { "comment": "/**\r\n * The constantly updated value based on zoom.\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 constantly updated value based on zoom.", "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": "T000002R002246", "___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": 89, "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": "T000002R002248", "___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": 98, "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": "T000002R002250", "___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": 107, "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": "T000002R002252", "___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": 148, "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": "T000002R002260", "___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": 217, "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": "T000002R002276", "___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": 270, "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": "T000002R002285", "___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": 287, "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": "T000002R002290", "___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": 302, "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": "T000002R002295", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Camera Rotate effect.\r\n *\r\n * This effect will rotate the Camera so that the 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 rotates. 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": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "classdesc": "A Camera Rotate effect.\r\rThis effect will rotate the Camera so that the 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 rotates. 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": "T000002R002305", "___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": 44, "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": "T000002R002308", "___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": 54, "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": "T000002R002310", "___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": 65, "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": "T000002R002312", "___s": true }, { "comment": "/**\r\n * The starting angle to rotate the camera from.\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": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The starting angle to rotate the camera from.", "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": "T000002R002314", "___s": true }, { "comment": "/**\r\n * The constantly updated value based on the force.\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": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The constantly updated value based on the force.", "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": "T000002R002316", "___s": true }, { "comment": "/**\r\n * The destination angle in radians to rotate the camera to.\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": 94, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The destination angle in radians to rotate the camera to.", "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": "T000002R002318", "___s": true }, { "comment": "/**\r\n * The ease function to use during the Rotate.\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": 103, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The ease function to use during the Rotate.", "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": "T000002R002320", "___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.RotateTo#progress\r\n * @type {number}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 112, "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.23.0", "memberof": "Phaser.Cameras.Scene2D.Effects.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#progress", "scope": "instance", "kind": "member", "___id": "T000002R002322", "___s": true }, { "comment": "/**\r\n * @callback CameraRotateCallback\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} angle - The Camera's new angle in radians.\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "kind": "typedef", "name": "CameraRotateCallback", "type": { "names": [ "function" ] }, "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 angle in radians.", "name": "angle" } ], "longname": "CameraRotateCallback", "scope": "global", "___id": "T000002R002326", "___s": true }, { "comment": "/**\r\n * The direction of the rotation.\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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The direction of the rotation.", "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": "T000002R002331", "___s": true }, { "comment": "/**\r\n * The shortest direction to the target rotation.\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": 169, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The shortest direction to the target rotation.", "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": "T000002R002333", "___s": true }, { "comment": "/**\r\n * This effect will scroll the Camera so that the center of its viewport finishes at the given angle,\r\n * 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} radians - The destination angle in radians to rotate the Camera viewport to. If the angle is positive then the rotation is clockwise else anticlockwise\r\n * @param {boolean} [shortestPath=false] - If shortest path is set to true the camera will rotate in the quickest direction clockwise or anti-clockwise.\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 Rotate. 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 {CameraRotateCallback} [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": "RotateTo.js", "lineno": 179, "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 angle,\rover 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 viewport to. If the angle is positive then the rotation is clockwise else anticlockwise", "name": "radians" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If shortest path is set to true the camera will rotate in the quickest direction clockwise or anti-clockwise.", "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 for the Rotate. 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": [ "CameraRotateCallback" ], "parsedType": { "type": "NameExpression", "name": "CameraRotateCallback" } }, "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.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#start", "scope": "instance", "___id": "T000002R002335", "___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": 299, "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": "T000002R002369", "___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": 379, "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": "T000002R002390", "___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": 395, "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": "T000002R002395", "___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": 410, "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": "T000002R002400", "___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": "T000002R002410", "___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": "T000002R002413", "___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": "T000002R002415", "___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": "T000002R002417", "___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": "T000002R002419", "___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": "T000002R002421", "___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": "T000002R002433", "___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": "T000002R002448", "___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": "T000002R002450", "___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": "T000002R002462", "___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": "T000002R002469", "___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": "T000002R002476", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Camera Zoom effect.\r\n *\r\n * This effect will zoom the Camera to the given scale, over the duration and with the ease specified.\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 will zoom the Camera to the given scale, over the duration and with the ease specified.\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": "T000002R002485", "___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": 34, "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": "T000002R002488", "___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": 44, "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": "T000002R002490", "___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": 55, "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": "T000002R002492", "___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": 66, "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": "T000002R002494", "___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": 75, "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": "T000002R002496", "___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": 84, "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": "T000002R002498", "___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": 93, "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": "T000002R002500", "___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": 134, "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": "T000002R002508", "___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": 198, "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": "T000002R002526", "___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": 240, "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": "T000002R002532", "___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": 257, "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": "T000002R002537", "___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": 272, "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": "T000002R002542", "___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": "T000002R002546", "___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": "T000002R002548", "___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": "T000002R002550", "___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": "T000002R002552", "___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": "T000002R002554", "___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": "T000002R002556", "___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": "T000002R002558", "___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": "T000002R002560", "___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": "T000002R002562", "___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": "T000002R002582", "___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": "T000002R002584", "___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 only dispatched if the Camera is rendering to a texture.\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 only dispatched if the Camera is rendering to a texture.\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": "T000002R002586", "___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": "T000002R002588", "___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": "T000002R002590", "___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": "T000002R002592", "___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": "T000002R002594", "___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": "T000002R002596", "___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": "T000002R002598", "___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": "T000002R002600", "___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": "T000002R002602", "___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": "T000002R002609", "___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": "T000002R002610", "___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": "T000002R002611", "___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": "T000002R002612", "___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": "T000002R002613", "___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": "T000002R002614", "___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": "T000002R002615", "___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 st status of 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 st status of 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": "T000002R002616", "___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": "T000002R002617", "___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 the defined keys.\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 the defined keys.\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": "T000002R002620", "___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": 42, "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": "T000002R002623", "___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": 52, "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": "T000002R002625", "___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": 62, "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": "T000002R002627", "___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": 72, "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": "T000002R002629", "___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": 82, "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": "T000002R002631", "___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": 92, "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": "T000002R002633", "___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": 102, "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": "T000002R002635", "___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.FixedKeyControl#zoomSpeed\r\n * @type {number}\r\n * @default 0.01\r\n * @since 3.0.0\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 112, "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.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#zoomSpeed", "scope": "instance", "kind": "member", "___id": "T000002R002637", "___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": 122, "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": "T000002R002639", "___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": 132, "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": "T000002R002641", "___s": true }, { "comment": "/**\r\n * The horizontal speed the camera will move.\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": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The horizontal speed the camera will move.", "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": "T000002R002643", "___s": true }, { "comment": "/**\r\n * The vertical speed the camera will move.\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": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The vertical speed the camera will move.", "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": "T000002R002645", "___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": 186, "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": "T000002R002654", "___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": 196, "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": "T000002R002656", "___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": 211, "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": "T000002R002659", "___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": 226, "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": "T000002R002662", "___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": 243, "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": "T000002R002665", "___s": true }, { "comment": "/**\r\n * Destroys this Key Control.\r\n *\r\n * @method Phaser.Cameras.Controls.FixedKeyControl#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 304, "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.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#destroy", "scope": "instance", "___id": "T000002R002677", "___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": "T000002R002687", "___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": "T000002R002693", "___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": "T000002R002696", "___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": "T000002R002698", "___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": "T000002R002700", "___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": "T000002R002702", "___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": "T000002R002704", "___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": "T000002R002706", "___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": "T000002R002708", "___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": "T000002R002710", "___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": "T000002R002712", "___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": "T000002R002714", "___s": true }, { "comment": "/**\r\n * The horizontal acceleration the camera will move.\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 the camera will move.", "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": "T000002R002716", "___s": true }, { "comment": "/**\r\n * The vertical acceleration the camera will move.\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 the camera will move.", "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": "T000002R002718", "___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": "T000002R002725", "___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": "T000002R002727", "___s": true }, { "comment": "/**\r\n * The maximum horizontal speed the camera will move.\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 will move.", "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": "T000002R002734", "___s": true }, { "comment": "/**\r\n * The maximum vertical speed the camera will move.\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 will move.", "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": "T000002R002736", "___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": "T000002R002749", "___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": "T000002R002751", "___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": "T000002R002754", "___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": "T000002R002757", "___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": "T000002R002760", "___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": "T000002R002788", "___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": "T000002R002798", "___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": "T000002R002799", "___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": "T000002R002800", "___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": "T000002R002801", "___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": "T000002R002802", "___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": "T000002R002807", "___s": true }, { "comment": "/**\r\n * This setting will auto-detect if the browser is capable of suppporting 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": 29, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "This setting will auto-detect if the browser is capable of suppporting 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": "T000002R002811", "___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": 40, "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": "T000002R002813", "___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": 51, "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": "T000002R002815", "___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": 63, "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": "T000002R002817", "___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": 75, "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": "T000002R002819", "___s": true }, { "comment": "/**\r\n * Direction constant.\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": 86, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "Direction constant.", "name": "NONE", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.NONE", "scope": "static", "___id": "T000002R002821", "___s": true }, { "comment": "/**\r\n * Direction constant.\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": 96, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "Direction constant.", "name": "UP", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.UP", "scope": "static", "___id": "T000002R002823", "___s": true }, { "comment": "/**\r\n * Direction constant.\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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "Direction constant.", "name": "DOWN", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.DOWN", "scope": "static", "___id": "T000002R002825", "___s": true }, { "comment": "/**\r\n * Direction constant.\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": 116, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "Direction constant.", "name": "LEFT", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.LEFT", "scope": "static", "___id": "T000002R002827", "___s": true }, { "comment": "/**\r\n * Direction constant.\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": 126, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "Direction constant.", "name": "RIGHT", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.RIGHT", "scope": "static", "___id": "T000002R002829", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The active game configuration settings, parsed from a {@link Phaser.Types.Core.GameConfig} object.\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": 19, "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.", "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": "T000002R002843", "___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": 54, "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": "T000002R002850", "___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": 59, "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": "T000002R002852", "___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": 64, "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": "T000002R002854", "___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": 69, "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": "T000002R002856", "___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": 74, "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": "T000002R002858", "___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": 79, "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": "T000002R002860", "___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": 84, "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": "T000002R002862", "___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": 89, "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": "T000002R002864", "___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": 94, "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": "T000002R002866", "___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": 99, "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": "T000002R002868", "___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": 104, "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": "T000002R002870", "___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": 109, "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": "T000002R002872", "___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": 114, "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": "T000002R002874", "___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": 119, "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": "T000002R002876", "___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": 124, "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": "T000002R002878", "___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": 129, "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": "T000002R002880", "___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": 134, "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": "T000002R002882", "___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": 139, "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": "T000002R002884", "___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": 144, "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": "T000002R002886", "___s": true }, { "comment": "/**\r\n * @const {?object} Phaser.Core.Config#sceneConfig - The default Scene configuration object.\r\n */", "meta": { "filename": "Config.js", "lineno": 149, "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": "T000002R002888", "___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": 154, "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": "T000002R002890", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#gameTitle - The title of the game.\r\n */", "meta": { "filename": "Config.js", "lineno": 161, "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": "T000002R002893", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#gameURL - The URL of the game.\r\n */", "meta": { "filename": "Config.js", "lineno": 166, "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": "T000002R002895", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#gameVersion - The version of the game.\r\n */", "meta": { "filename": "Config.js", "lineno": 171, "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": "T000002R002897", "___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": 176, "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": "T000002R002899", "___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": 181, "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": "T000002R002901", "___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": 195, "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": "T000002R002905", "___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": 200, "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": "T000002R002907", "___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": 207, "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": "T000002R002909", "___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": 212, "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": "T000002R002911", "___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": 217, "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": "T000002R002913", "___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": 222, "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": "T000002R002915", "___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": 227, "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": "T000002R002917", "___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": 232, "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": "T000002R002919", "___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": 237, "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": "T000002R002921", "___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": 242, "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": "T000002R002923", "___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": 247, "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": "T000002R002925", "___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": 252, "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": "T000002R002927", "___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": 257, "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": "T000002R002929", "___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": 262, "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": "T000002R002931", "___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": 267, "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": "T000002R002933", "___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": 272, "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": "T000002R002935", "___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": 277, "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": "T000002R002937", "___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": 282, "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": "T000002R002939", "___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": 287, "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": "T000002R002941", "___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": 292, "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": "T000002R002943", "___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": 297, "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": "T000002R002945", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#hideBanner - Don't write the banner line to the console.log.\r\n */", "meta": { "filename": "Config.js", "lineno": 304, "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.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#hideBanner", "scope": "instance", "___id": "T000002R002947", "___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": 309, "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": "T000002R002949", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#bannerTextColor - The color of the banner text.\r\n */", "meta": { "filename": "Config.js", "lineno": 314, "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": "T000002R002951", "___s": true }, { "comment": "/**\r\n * @const {string[]} Phaser.Core.Config#bannerBackgroundColor - The background colors of the banner.\r\n */", "meta": { "filename": "Config.js", "lineno": 319, "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": "T000002R002953", "___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": 329, "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": "T000002R002956", "___s": true }, { "comment": "/**\r\n * @const {Phaser.Types.Core.PipelineConfig} Phaser.Core.Config#pipeline - An object mapping WebGL names to WebGLPipeline classes. These should be class constructors, not instances.\r\n */", "meta": { "filename": "Config.js", "lineno": 338, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "pipeline", "type": { "names": [ "Phaser.Types.Core.PipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.PipelineConfig" } }, "description": "An object mapping WebGL names to WebGLPipeline classes. These should be class constructors, not instances.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#pipeline", "scope": "instance", "___id": "T000002R002959", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#autoMobilePipeline - Automatically enable the Mobile Pipeline if iOS or Android detected?\r\n */", "meta": { "filename": "Config.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "autoMobilePipeline", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Automatically enable the Mobile Pipeline if iOS or Android detected?", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#autoMobilePipeline", "scope": "instance", "___id": "T000002R002961", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#defaultPipeline - The WebGL Pipeline that Game Objects will use by default. Set to 'MultiPipeline' as standard. See also 'autoMobilePipeline'.\r\n */", "meta": { "filename": "Config.js", "lineno": 348, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "defaultPipeline", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The WebGL Pipeline that Game Objects will use by default. Set to 'MultiPipeline' as standard. See also 'autoMobilePipeline'.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#defaultPipeline", "scope": "instance", "___id": "T000002R002963", "___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": 353, "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": "T000002R002965", "___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": 358, "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": "T000002R002967", "___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": 363, "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": "T000002R002969", "___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": 368, "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": "T000002R002971", "___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": 373, "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": "T000002R002973", "___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 linear filter mode).\r\n */", "meta": { "filename": "Config.js", "lineno": 378, "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 linear filter mode).", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#pixelArt", "scope": "instance", "___id": "T000002R002975", "___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": 390, "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": "T000002R002980", "___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": 395, "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": "T000002R002982", "___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": 400, "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": "T000002R002984", "___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": 405, "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": "T000002R002986", "___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": 410, "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": "T000002R002988", "___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": 415, "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": "T000002R002990", "___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": 420, "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": "T000002R002992", "___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": 425, "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": "T000002R002994", "___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": 430, "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": "T000002R002996", "___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": 437, "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": "T000002R002999", "___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": 448, "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": "T000002R003003", "___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": 453, "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": "T000002R003005", "___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": 458, "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": "T000002R003007", "___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', 'impact' or 'matter'.\r\n */", "meta": { "filename": "Config.js", "lineno": 463, "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', 'impact' or 'matter'.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#defaultPhysicsSystem", "scope": "instance", "___id": "T000002R003009", "___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": 468, "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": "T000002R003011", "___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": 473, "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": "T000002R003013", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#loaderMaxParallelDownloads - Maximum parallel downloads allowed for resources (Default to 32).\r\n */", "meta": { "filename": "Config.js", "lineno": 478, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "loaderMaxParallelDownloads", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Maximum parallel downloads allowed for resources (Default to 32).", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#loaderMaxParallelDownloads", "scope": "instance", "___id": "T000002R003015", "___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": 483, "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": "T000002R003017", "___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": 488, "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": "T000002R003019", "___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": 493, "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": "T000002R003021", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#loaderUser - Optional username for all XHR requests.\r\n */", "meta": { "filename": "Config.js", "lineno": 498, "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": "T000002R003023", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#loaderPassword - Optional password for all XHR requests.\r\n */", "meta": { "filename": "Config.js", "lineno": 503, "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": "T000002R003025", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#loaderTimeout - Optional XHR timeout value, in ms.\r\n */", "meta": { "filename": "Config.js", "lineno": 508, "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": "T000002R003027", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#loaderWithCredentials - Optional XHR withCredentials value.\r\n */", "meta": { "filename": "Config.js", "lineno": 513, "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": "T000002R003029", "___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": 518, "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": "T000002R003031", "___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": 526, "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": "T000002R003033", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#glowFXQuality - The quality of the Glow FX (defaults to 0.1)\r\n */", "meta": { "filename": "Config.js", "lineno": 531, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "glowFXQuality", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The quality of the Glow FX (defaults to 0.1)", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#glowFXQuality", "scope": "instance", "___id": "T000002R003035", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#glowFXDistance - The distance of the Glow FX (defaults to 10)\r\n */", "meta": { "filename": "Config.js", "lineno": 536, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "glowFXDistance", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance of the Glow FX (defaults to 10)", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#glowFXDistance", "scope": "instance", "___id": "T000002R003037", "___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": 559, "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": "T000002R003039", "___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": 564, "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": "T000002R003041", "___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": 595, "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": "T000002R003050", "___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": 603, "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": "T000002R003053", "___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": 608, "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": "T000002R003055", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#whiteImage - A base64 encoded PNG that will be used as the default texture when a texture is assigned that is white or not loaded.\r\n */", "meta": { "filename": "Config.js", "lineno": 613, "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 that will be used as the default texture when a texture is assigned that is white or not loaded.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#whiteImage", "scope": "instance", "___id": "T000002R003057", "___s": true }, { "comment": "/**\r\n * Called automatically by Phaser.Game and responsible for creating the renderer it will use.\r\n *\r\n * Relies upon two webpack global flags to be defined: `WEBGL_RENDERER` and `CANVAS_RENDERER` during build time, but not at run-time.\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\rRelies upon two webpack global flags to be defined: `WEBGL_RENDERER` and `CANVAS_RENDERER` during build time, but not at run-time.", "kind": "function", "name": "CreateRenderer", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "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": "T000002R003066", "___s": true }, { "comment": "/**\r\n * Called automatically by Phaser.Game and responsible for creating the console.log debug header.\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 and responsible for creating the console.log debug header.\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": "T000002R003094", "___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": "T000002R003121", "___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": "T000002R003123", "___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": "T000002R003125", "___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": "T000002R003127", "___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": "T000002R003129", "___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": "T000002R003131", "___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": "T000002R003133", "___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": "T000002R003150", "___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": "T000002R003152", "___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": "T000002R003154", "___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": "T000002R003156", "___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": "T000002R003158", "___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": "T000002R003160", "___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 */", "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", "memberof": "Phaser.Core.Events", "longname": "Phaser.Core.Events#event:RESUME", "scope": "instance", "___id": "T000002R003162", "___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": "T000002R003164", "___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": "T000002R003166", "___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} [GameConfig] - The configuration object for your Phaser Game instance.\r\n */", "meta": { "filename": "Game.js", "lineno": 41, "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": "GameConfig" } ], "scope": "static", "longname": "Phaser.Game", "___id": "T000002R003193", "___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": 68, "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": "T000002R003196", "___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": 80, "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": "T000002R003198", "___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": 89, "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": "T000002R003200", "___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": 103, "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": "T000002R003202", "___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": 114, "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": "T000002R003204", "___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": 127, "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": "T000002R003206", "___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": 137, "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": "T000002R003208", "___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": 147, "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": "T000002R003210", "___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": 156, "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": "T000002R003212", "___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": 167, "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": "T000002R003214", "___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": 178, "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": "T000002R003216", "___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": 189, "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": "T000002R003218", "___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": 200, "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": "T000002R003220", "___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": 211, "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": "T000002R003222", "___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": 222, "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": "T000002R003224", "___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": 234, "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": "T000002R003226", "___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": 245, "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": "T000002R003228", "___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": 263, "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": "T000002R003231", "___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": 275, "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": "T000002R003233", "___s": true }, { "comment": "/**\r\n * An instance of the Facebook Instant Games Plugin.\r\n *\r\n * This will only be available if the plugin has been built into Phaser,\r\n * or you're using the special Facebook Instant Games custom build.\r\n *\r\n * @name Phaser.Game#facebook\r\n * @type {Phaser.FacebookInstantGamesPlugin}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Game.js", "lineno": 289, "columnno": 12, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "An instance of the Facebook Instant Games Plugin.\r\rThis will only be available if the plugin has been built into Phaser,\ror you're using the special Facebook Instant Games custom build.", "name": "facebook", "type": { "names": [ "Phaser.FacebookInstantGamesPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FacebookInstantGamesPlugin" } }, "since": "3.13.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#facebook", "scope": "instance", "kind": "member", "___id": "T000002R003235", "___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": 333, "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": "T000002R003243", "___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": 344, "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": "T000002R003245", "___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": 359, "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": "T000002R003247", "___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": 421, "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": "T000002R003253", "___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": 455, "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": "T000002R003257", "___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.Game#PRE_RENDER\r\n * @fires Phaser.Game#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": 525, "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.Game#event:PRE_RENDER", "Phaser.Game#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": "T000002R003261", "___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": 581, "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": "T000002R003265", "___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": 597, "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": "T000002R003267", "___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": 620, "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": "T000002R003271", "___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": 636, "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": "T000002R003273", "___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": 657, "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": "T000002R003277", "___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": 672, "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": "T000002R003280", "___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": 687, "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": "T000002R003283", "___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": 702, "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": "T000002R003285", "___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 games 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": 715, "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 games 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": "T000002R003287", "___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": "T000002R003297", "___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\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" } }, "name": "config" } ], "scope": "static", "longname": "Phaser.Core.TimeStep", "___id": "T000002R003309", "___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": "T000002R003312", "___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": "T000002R003314", "___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": "T000002R003316", "___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": "T000002R003318", "___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": "T000002R003320", "___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": "T000002R003322", "___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 * @name Phaser.Core.TimeStep#fpsLimit\r\n * @type {number}\r\n * @default 0\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.", "name": "fpsLimit", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#fpsLimit", "scope": "instance", "kind": "member", "___id": "T000002R003324", "___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 * @since 3.60.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 140, "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", "since": "3.60.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#hasFpsLimit", "scope": "instance", "kind": "member", "___id": "T000002R003326", "___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": 188, "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": "T000002R003334", "___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": 199, "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": "T000002R003336", "___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": 212, "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": "T000002R003338", "___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": 223, "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": "T000002R003340", "___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": 233, "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": "T000002R003342", "___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": 245, "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": "T000002R003344", "___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": 258, "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": "T000002R003346", "___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": 270, "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": "T000002R003348", "___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": 282, "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": "T000002R003350", "___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": 294, "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": "T000002R003352", "___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": 329, "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": "T000002R003358", "___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": 339, "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": "T000002R003360", "___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": 349, "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": "T000002R003362", "___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": 358, "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": "T000002R003364", "___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": 370, "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": "T000002R003366", "___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": 383, "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": "T000002R003368", "___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": 396, "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": "T000002R003370", "___s": true }, { "comment": "/**\r\n * Apply smoothing to the delta value used within Phasers 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": 410, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Apply smoothing to the delta value used within Phasers 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": "T000002R003372", "___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": 427, "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": "T000002R003374", "___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": 438, "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": "T000002R003377", "___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": 451, "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": "T000002R003380", "___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": 462, "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": "T000002R003383", "___s": true }, { "comment": "/**\r\n * Resets the time, lastTime, fps averages and delta history.\r\n * Called automatically when a browser sleeps them resumes.\r\n *\r\n * @method Phaser.Core.TimeStep#resetDelta\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 475, "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 them resumes.", "kind": "function", "name": "resetDelta", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#resetDelta", "scope": "instance", "___id": "T000002R003386", "___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": 504, "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": "T000002R003398", "___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": 539, "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": "T000002R003407", "___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, so rafin'g at 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": 603, "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, so rafin'g at 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": "T000002R003421", "___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": 638, "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": "T000002R003426", "___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": 689, "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": "T000002R003436", "___s": true }, { "comment": "/**\r\n * Manually 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": 735, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Manually calls `TimeStep.step`.", "kind": "function", "name": "tick", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#tick", "scope": "instance", "___id": "T000002R003445", "___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": 755, "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": "T000002R003448", "___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": 771, "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": "T000002R003451", "___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": 808, "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": "T000002R003461", "___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": 821, "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": "T000002R003463", "___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": 834, "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": "T000002R003465", "___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": 852, "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": "T000002R003469", "___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": "T000002R003475", "___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": "T000002R003476", "___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": "T000002R003477", "___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": "T000002R003478", "___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": "T000002R003479", "___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'. Never set this higher than RAF can handle.\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'. Never set this higher than RAF can handle.", "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": "T000002R003480", "___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)} [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 {Phaser.Types.Core.PipelineConfig} [pipeline] - A WebGL Pipeline configuration object. Can also be part of the `RenderConfig`.\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} [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} [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} [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=4096] - 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} [autoMobilePipeline=true] - Automatically enable the Mobile Pipeline if iOS or Android detected?\r\n * @property {string} [defaultPipeline='MultiPipeline'] - The WebGL Pipeline that Game Objects will use by default. Set to 'MultiPipeline' as standard.\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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLElement" }, { "type": "NameExpression", "name": "string" } ] } }, "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": [ "Phaser.Types.Core.PipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.PipelineConfig" } }, "optional": true, "description": "A WebGL Pipeline configuration object. Can also be part of the `RenderConfig`.", "name": "pipeline" }, { "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": "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": "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": "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": 4096, "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": true, "description": "Automatically enable the Mobile Pipeline if iOS or Android detected?", "name": "autoMobilePipeline" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'MultiPipeline'", "description": "The WebGL Pipeline that Game Objects will use by default. Set to 'MultiPipeline' as standard.", "name": "defaultPipeline" }, { "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": "T000002R003481", "___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": "T000002R003482", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.ImagesConfig\r\n * @since 3.0.0\r\n *\r\n * @property {string} [default] - A base64 encoded image file to use as the 'default' texture.\r\n * @property {string} [missing] - A base64 encoded image file to use as the 'missing' texture.\r\n * @property {string} [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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "A base64 encoded image file to use as the 'default' texture.", "name": "default" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "A base64 encoded image file to use as the 'missing' texture.", "name": "missing" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "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": "T000002R003483", "___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": "T000002R003484", "___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": "T000002R003485", "___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": "T000002R003486", "___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 */", "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" } ], "memberof": "Phaser.Types.Core", "longname": "Phaser.Types.Core.LoaderConfig", "scope": "static", "___id": "T000002R003487", "___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": "T000002R003488", "___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": "T000002R003489", "___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": "T000002R003490", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.PipelineConfig\r\n * @since 3.50.0\r\n *\r\n * @property {string} name - The name of the pipeline. Must be unique within the Pipeline Manager.\r\n * @property {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline class. This should be a constructable object, **not** an instance of a class.\r\n * @property {number} [frameInc=32] - Sets the `PipelineManager.frameInc` value to control the dimension increase in the Render Targets.\r\n */", "meta": { "filename": "PipelineConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "PipelineConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the pipeline. Must be unique within the Pipeline Manager.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "description": "The pipeline class. This should be a constructable object, **not** an instance of a class.", "name": "pipeline" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "Sets the `PipelineManager.frameInc` value to control the dimension increase in the Render Targets.", "name": "frameInc" } ], "memberof": "Phaser.Types.Core", "longname": "Phaser.Types.Core.PipelineConfig", "scope": "static", "___id": "T000002R003491", "___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": "T000002R003492", "___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": "T000002R003493", "___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} [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} [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} [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=4096] - 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 {Phaser.Types.Core.PipelineConfig} [pipeline] - The WebGL Pipeline configuration object.\r\n * @property {boolean} [autoMobilePipeline=true] - Automatically enable the Mobile Pipeline if iOS or Android detected?\r\n * @property {string} [defaultPipeline='MultiPipeline'] - The WebGL Pipeline that Game Objects will use by default. Set to 'MultiPipeline' as standard.\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": "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": "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": "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": 4096, "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": [ "Phaser.Types.Core.PipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.PipelineConfig" } }, "optional": true, "description": "The WebGL Pipeline configuration object.", "name": "pipeline" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Automatically enable the Mobile Pipeline if iOS or Android detected?", "name": "autoMobilePipeline" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'MultiPipeline'", "description": "The WebGL Pipeline that Game Objects will use by default. Set to 'MultiPipeline' as standard.", "name": "defaultPipeline" } ], "memberof": "Phaser.Types.Core", "longname": "Phaser.Types.Core.RenderConfig", "scope": "static", "___id": "T000002R003494", "___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 {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": [ "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": "T000002R003495", "___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": "T000002R003496", "___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": "T000002R003497", "___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": "T000002R003498", "___s": true }, { "comment": "/**\r\n * The Visibility Handler is responsible for listening out for document level visibility change events.\r\n * This includes `visibilitychange` if the browser supports it, and blur and focus events. It then uses\r\n * the provided Event Emitter and fires the related events.\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 out for document level visibility change events.\rThis includes `visibilitychange` if the browser supports it, and blur and focus events. It then uses\rthe provided Event Emitter and fires the related events.", "kind": "function", "name": "VisibilityHandler", "fires": [ "Phaser.Core.Events#event:BLUR", "Phaser.Core.Events#event:FOCUS", "Phaser.Core.Events#event:HIDDEN", "Phaser.Core.Events#event:VISIBLE" ], "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "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": "T000002R003500", "___s": true }, { "comment": "/**\r\n * Generates a texture based on the given Create configuration object.\r\n *\r\n * The texture is drawn using a fixed-size indexed palette of 16 colors, where the hex value in the\r\n * data cells map to a single color. For example, if the texture config looked like this:\r\n *\r\n * ```javascript\r\n * var star = [\r\n * '.....828.....',\r\n * '....72227....',\r\n * '....82228....',\r\n * '...7222227...',\r\n * '2222222222222',\r\n * '8222222222228',\r\n * '.72222222227.',\r\n * '..787777787..',\r\n * '..877777778..',\r\n * '.78778887787.',\r\n * '.27887.78872.',\r\n * '.787.....787.'\r\n * ];\r\n *\r\n * this.textures.generate('star', { data: star, pixelWidth: 4 });\r\n * ```\r\n *\r\n * Then it would generate a texture that is 52 x 48 pixels in size, because each cell of the data array\r\n * represents 1 pixel multiplied by the `pixelWidth` value. The cell values, such as `8`, maps to color\r\n * number 8 in the palette. If a cell contains a period character `.` then it is transparent.\r\n *\r\n * The default palette is Arne16, but you can specify your own using the `palette` property.\r\n *\r\n * @function Phaser.Create.GenerateTexture\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Create.GenerateTextureConfig} config - The Generate Texture Configuration object.\r\n *\r\n * @return {HTMLCanvasElement} An HTMLCanvasElement which contains the generated texture drawn to it.\r\n */", "meta": { "filename": "GenerateTexture.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\create", "code": {} }, "description": "Generates a texture based on the given Create configuration object.\r\rThe texture is drawn using a fixed-size indexed palette of 16 colors, where the hex value in the\rdata cells map to a single color. For example, if the texture config looked like this:\r\r```javascript\rvar star = [\r '.....828.....',\r '....72227....',\r '....82228....',\r '...7222227...',\r '2222222222222',\r '8222222222228',\r '.72222222227.',\r '..787777787..',\r '..877777778..',\r '.78778887787.',\r '.27887.78872.',\r '.787.....787.'\r];\r\rthis.textures.generate('star', { data: star, pixelWidth: 4 });\r```\r\rThen it would generate a texture that is 52 x 48 pixels in size, because each cell of the data array\rrepresents 1 pixel multiplied by the `pixelWidth` value. The cell values, such as `8`, maps to color\rnumber 8 in the palette. If a cell contains a period character `.` then it is transparent.\r\rThe default palette is Arne16, but you can specify your own using the `palette` property.", "kind": "function", "name": "GenerateTexture", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Create.GenerateTextureConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Create.GenerateTextureConfig" } }, "description": "The Generate Texture Configuration object.", "name": "config" } ], "returns": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "An HTMLCanvasElement which contains the generated texture drawn to it." } ], "memberof": "Phaser.Create", "longname": "Phaser.Create.GenerateTexture", "scope": "static", "___id": "T000002R003515", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Create\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\create", "code": {} }, "kind": "namespace", "name": "Create", "memberof": "Phaser", "longname": "Phaser.Create", "scope": "static", "___id": "T000002R003541", "___s": true }, { "comment": "/**\r\n * A 16 color palette by [Arne](http://androidarts.com/palette/16pal.htm)\r\n *\r\n * @name Phaser.Create.Palettes.ARNE16\r\n * @since 3.0.0\r\n *\r\n * @type {Phaser.Types.Create.Palette}\r\n */", "meta": { "filename": "Arne16.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\create\\palettes", "code": {} }, "description": "A 16 color palette by [Arne](http://androidarts.com/palette/16pal.htm)", "name": "ARNE16", "since": "3.0.0", "type": { "names": [ "Phaser.Types.Create.Palette" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Create.Palette" } }, "memberof": "Phaser.Create.Palettes", "longname": "Phaser.Create.Palettes.ARNE16", "scope": "static", "kind": "member", "___id": "T000002R003545", "___s": true }, { "comment": "/**\r\n * A 16 color palette inspired by the Commodore 64.\r\n *\r\n * @name Phaser.Create.Palettes.C64\r\n * @since 3.0.0\r\n *\r\n * @type {Phaser.Types.Create.Palette}\r\n */", "meta": { "filename": "C64.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\create\\palettes", "code": {} }, "description": "A 16 color palette inspired by the Commodore 64.", "name": "C64", "since": "3.0.0", "type": { "names": [ "Phaser.Types.Create.Palette" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Create.Palette" } }, "memberof": "Phaser.Create.Palettes", "longname": "Phaser.Create.Palettes.C64", "scope": "static", "kind": "member", "___id": "T000002R003563", "___s": true }, { "comment": "/**\r\n * A 16 color CGA inspired palette by [Arne](http://androidarts.com/palette/16pal.htm)\r\n *\r\n * @name Phaser.Create.Palettes.CGA\r\n * @since 3.0.0\r\n *\r\n * @type {Phaser.Types.Create.Palette}\r\n */", "meta": { "filename": "CGA.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\create\\palettes", "code": {} }, "description": "A 16 color CGA inspired palette by [Arne](http://androidarts.com/palette/16pal.htm)", "name": "CGA", "since": "3.0.0", "type": { "names": [ "Phaser.Types.Create.Palette" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Create.Palette" } }, "memberof": "Phaser.Create.Palettes", "longname": "Phaser.Create.Palettes.CGA", "scope": "static", "kind": "member", "___id": "T000002R003581", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Create.Palettes\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\create\\palettes", "code": {} }, "kind": "namespace", "name": "Palettes", "memberof": "Phaser.Create", "longname": "Phaser.Create.Palettes", "scope": "static", "___id": "T000002R003599", "___s": true }, { "comment": "/**\r\n * A 16 color JMP palette by [Arne](http://androidarts.com/palette/16pal.htm)\r\n *\r\n * @name Phaser.Create.Palettes.JMP\r\n * @since 3.0.0\r\n *\r\n * @type {Phaser.Types.Create.Palette}\r\n */", "meta": { "filename": "JMP.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\create\\palettes", "code": {} }, "description": "A 16 color JMP palette by [Arne](http://androidarts.com/palette/16pal.htm)", "name": "JMP", "since": "3.0.0", "type": { "names": [ "Phaser.Types.Create.Palette" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Create.Palette" } }, "memberof": "Phaser.Create.Palettes", "longname": "Phaser.Create.Palettes.JMP", "scope": "static", "kind": "member", "___id": "T000002R003606", "___s": true }, { "comment": "/**\r\n * A 16 color palette inspired by Japanese computers like the MSX.\r\n *\r\n * @name Phaser.Create.Palettes.MSX\r\n * @since 3.0.0\r\n *\r\n * @type {Phaser.Types.Create.Palette}\r\n */", "meta": { "filename": "MSX.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\create\\palettes", "code": {} }, "description": "A 16 color palette inspired by Japanese computers like the MSX.", "name": "MSX", "since": "3.0.0", "type": { "names": [ "Phaser.Types.Create.Palette" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Create.Palette" } }, "memberof": "Phaser.Create.Palettes", "longname": "Phaser.Create.Palettes.MSX", "scope": "static", "kind": "member", "___id": "T000002R003624", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Create.GenerateTextureCallback\r\n * @since 3.0.0\r\n *\r\n * @param {HTMLCanvasElement} canvas - The HTML Canvas element to operate on.\r\n * @param {CanvasRenderingContext2D} context - The context of the HTML Canvas element.\r\n */", "meta": { "filename": "GenerateTextureConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\create\\typedefs", "code": {} }, "kind": "typedef", "name": "GenerateTextureCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "params": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The HTML Canvas element to operate on.", "name": "canvas" }, { "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "description": "The context of the HTML Canvas element.", "name": "context" } ], "memberof": "Phaser.Types.Create", "longname": "Phaser.Types.Create.GenerateTextureCallback", "scope": "static", "___id": "T000002R003642", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Create.GenerateTextureConfig\r\n * @since 3.0.0\r\n *\r\n * @property {array} [data=[]] - An array of data, where each row is a string of single values 0-9A-F, or the period character.\r\n * @property {HTMLCanvasElement} [canvas=null] - The HTML Canvas to draw the texture to.\r\n * @property {Phaser.Types.Create.Palette} [palette=Arne16] - The indexed palette that the data cell values map to.\r\n * @property {number} [pixelWidth=1] - The width of each 'pixel' in the generated texture.\r\n * @property {number} [pixelHeight=1] - The height of each 'pixel' in the generated texture.\r\n * @property {boolean} [resizeCanvas=true] - Should the canvas be resized before the texture is drawn?\r\n * @property {boolean} [clearCanvas=true] - Should the canvas be cleared before the texture is drawn?\r\n * @property {Phaser.Types.Create.GenerateTextureCallback} [preRender] - A callback to send the canvas to prior to the texture being drawn.\r\n * @property {Phaser.Types.Create.GenerateTextureCallback} [postRender] - A callback to send the canvas to after the texture has been drawn.\r\n */", "meta": { "filename": "GenerateTextureConfig.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\create\\typedefs", "code": {} }, "kind": "typedef", "name": "GenerateTextureConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "defaultvalue": "[]", "description": "An array of data, where each row is a string of single values 0-9A-F, or the period character.", "name": "data" }, { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "optional": true, "defaultvalue": null, "description": "The HTML Canvas to draw the texture to.", "name": "canvas" }, { "type": { "names": [ "Phaser.Types.Create.Palette" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Create.Palette" } }, "optional": true, "defaultvalue": "Arne16", "description": "The indexed palette that the data cell values map to.", "name": "palette" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The width of each 'pixel' in the generated texture.", "name": "pixelWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The height of each 'pixel' in the generated texture.", "name": "pixelHeight" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the canvas be resized before the texture is drawn?", "name": "resizeCanvas" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the canvas be cleared before the texture is drawn?", "name": "clearCanvas" }, { "type": { "names": [ "Phaser.Types.Create.GenerateTextureCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Create.GenerateTextureCallback" } }, "optional": true, "description": "A callback to send the canvas to prior to the texture being drawn.", "name": "preRender" }, { "type": { "names": [ "Phaser.Types.Create.GenerateTextureCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Create.GenerateTextureCallback" } }, "optional": true, "description": "A callback to send the canvas to after the texture has been drawn.", "name": "postRender" } ], "memberof": "Phaser.Types.Create", "longname": "Phaser.Types.Create.GenerateTextureConfig", "scope": "static", "___id": "T000002R003643", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Create\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\create\\typedefs", "code": {} }, "kind": "namespace", "name": "Create", "memberof": "Phaser.Types", "longname": "Phaser.Types.Create", "scope": "static", "___id": "T000002R003644", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Create.Palette\r\n * @since 3.0.0\r\n *\r\n * @property {string} 0 - Color value 1.\r\n * @property {string} 1 - Color value 2.\r\n * @property {string} 2 - Color value 3.\r\n * @property {string} 3 - Color value 4.\r\n * @property {string} 4 - Color value 5.\r\n * @property {string} 5 - Color value 6.\r\n * @property {string} 6 - Color value 7.\r\n * @property {string} 7 - Color value 8.\r\n * @property {string} 8 - Color value 9.\r\n * @property {string} 9 - Color value 10.\r\n * @property {string} A - Color value 11.\r\n * @property {string} B - Color value 12.\r\n * @property {string} C - Color value 13.\r\n * @property {string} D - Color value 14.\r\n * @property {string} E - Color value 15.\r\n * @property {string} F - Color value 16.\r\n */", "meta": { "filename": "Palette.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\create\\typedefs", "code": {} }, "kind": "typedef", "name": "Palette", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Color value 1.", "name": "0" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Color value 2.", "name": "1" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Color value 3.", "name": "2" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Color value 4.", "name": "3" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Color value 5.", "name": "4" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Color value 6.", "name": "5" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Color value 7.", "name": "6" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Color value 8.", "name": "7" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Color value 9.", "name": "8" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Color value 10.", "name": "9" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Color value 11.", "name": "A" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Color value 12.", "name": "B" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Color value 13.", "name": "C" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Color value 14.", "name": "D" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Color value 15.", "name": "E" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Color value 16.", "name": "F" } ], "memberof": "Phaser.Types.Create", "longname": "Phaser.Types.Create.Palette", "scope": "static", "___id": "T000002R003645", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A higher-order Bézier curve constructed of four points.\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 higher-order Bézier curve constructed of four points.", "kind": "class", "name": "CubicBezier", "augments": [ "Phaser.Curves.Curve" ], "memberof": "Phaser.Curves", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Array." ], "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": "T000002R003650", "___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": 47, "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": "T000002R003658", "___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": 56, "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": "T000002R003660", "___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": 65, "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": "T000002R003662", "___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": 74, "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": "T000002R003664", "___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": 84, "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": "T000002R003666", "___s": true }, { "comment": "/**\r\n * Returns the resolution of this curve.\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": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Returns the resolution of this curve.", "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": "T000002R003669", "___s": true }, { "comment": "/**\r\n * Get point at relative position in curve according to length.\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": 118, "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.CubicBezier", "longname": "Phaser.Curves.CubicBezier#getPoint", "scope": "instance", "___id": "T000002R003671", "___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": 143, "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": "T000002R003678", "___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": 176, "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": "T000002R003683", "___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": 199, "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": "T000002R003687", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Base Curve class, which all other curve types extend.\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\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": "T000002R003699", "___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": 31, "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": "T000002R003702", "___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": 40, "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": "T000002R003704", "___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": 50, "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": "T000002R003706", "___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": 60, "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": "T000002R003708", "___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": 70, "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": "T000002R003710", "___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": 80, "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": "T000002R003712", "___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": 111, "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": "T000002R003718", "___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": 135, "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": "T000002R003721", "___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.Geom.Point[]} An Array of Point objects.\r\n */", "meta": { "filename": "Curve.js", "lineno": 169, "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.Geom.Point", "type": "NameExpression" } ] } }, "description": "An Array of Point objects." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getDistancePoints", "scope": "instance", "___id": "T000002R003728", "___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 curves end point.\r\n */", "meta": { "filename": "Curve.js", "lineno": 189, "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 curves end point." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getEndPoint", "scope": "instance", "___id": "T000002R003732", "___s": true }, { "comment": "/**\r\n * Get total curve arc length\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": 206, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get total curve arc length", "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": "T000002R003735", "___s": true }, { "comment": "/**\r\n * Get a list of cumulative segment lengths.\r\n *\r\n * These lengths are\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": 222, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get a list of cumulative segment lengths.\r\rThese lengths are\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": "T000002R003738", "___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": 278, "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": "T000002R003750", "___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 {(array|Phaser.Math.Vector2[])} [out] - An optional array to store the points in.\r\n *\r\n * @return {(array|Phaser.Math.Vector2[])} An array of Points from the curve.\r\n */", "meta": { "filename": "Curve.js", "lineno": 300, "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } ] } }, "description": "An array of Points from the curve." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getPoints", "scope": "instance", "___id": "T000002R003753", "___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": 349, "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": "T000002R003759", "___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 {(array|Phaser.Math.Vector2[])} [out] - An optional array to store the points in.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of points.\r\n */", "meta": { "filename": "Curve.js", "lineno": 370, "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "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 points." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getSpacedPoints", "scope": "instance", "___id": "T000002R003762", "___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": 411, "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": "T000002R003769", "___s": true }, { "comment": "/**\r\n * Get a unit vector tangent at a relative position on the curve.\r\n * In case any sub curve does not implement its tangent derivation,\r\n * 2 points a small delta apart will be used to find its gradient\r\n * which seems to give a reasonable approximation\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": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get a unit vector tangent at a relative position on the curve.\rIn case any sub curve does not implement its tangent derivation,\r2 points a small delta apart will be used to find its gradient\rwhich seems to give a reasonable approximation", "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": "T000002R003772", "___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": 472, "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": "T000002R003780", "___s": true }, { "comment": "/**\r\n * Given a distance in pixels, get a t to find p.\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 distance.\r\n */", "meta": { "filename": "Curve.js", "lineno": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Given a distance in pixels, get a t to find p.", "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 distance." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getTFromDistance", "scope": "instance", "___id": "T000002R003783", "___s": true }, { "comment": "/**\r\n * Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equidistant.\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": 513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equidistant.", "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": "T000002R003785", "___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": 594, "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": "T000002R003806", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * An Elliptical Curve derived from the Base Curve class.\r\n * \r\n * See https://en.wikipedia.org/wiki/Elliptic_curve 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 Elliptical Curve derived from the Base Curve class.\r\rSee https://en.wikipedia.org/wiki/Elliptic_curve for more details.", "kind": "class", "name": "Ellipse", "augments": [ "Phaser.Curves.Curve" ], "memberof": "Phaser.Curves", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "Phaser.Types.Curves.EllipseCurveConfig" ], "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": "T000002R003816", "___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": 71, "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": "T000002R003834", "___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": 143, "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": "T000002R003848", "___s": true }, { "comment": "/**\r\n * Get the resolution of the curve.\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": 162, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get the resolution of the curve.", "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": "T000002R003851", "___s": true }, { "comment": "/**\r\n * Get point at relative position in curve according to length.\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": 177, "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.Ellipse", "longname": "Phaser.Curves.Ellipse#getPoint", "scope": "instance", "___id": "T000002R003853", "___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": 253, "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": "T000002R003874", "___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": 270, "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": "T000002R003877", "___s": true }, { "comment": "/**\r\n * Sets the width of this curve.\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": 287, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Sets the width of this curve.", "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": "T000002R003880", "___s": true }, { "comment": "/**\r\n * Sets the height of this curve.\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": 304, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Sets the height of this curve.", "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": "T000002R003883", "___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 radians.\r\n *\r\n * @return {this} This curve object.\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 321, "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 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#setStartAngle", "scope": "instance", "___id": "T000002R003886", "___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 radians.\r\n *\r\n * @return {this} This curve object.\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 338, "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 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#setEndAngle", "scope": "instance", "___id": "T000002R003889", "___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": 355, "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": "T000002R003892", "___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": 372, "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": "T000002R003895", "___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": 389, "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": "T000002R003898", "___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": 410, "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": "T000002R003903", "___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": 431, "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": "T000002R003908", "___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": 452, "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": "T000002R003913", "___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": 473, "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": "T000002R003918", "___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": 494, "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": "T000002R003923", "___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": 515, "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": "T000002R003928", "___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": 536, "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": "T000002R003933", "___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": 557, "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": "T000002R003938", "___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": 578, "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": "T000002R003943", "___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": 603, "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": "T000002R003954", "___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": "T000002R003957", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A LineCurve is a \"curve\" comprising exactly two points (a line segment).\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 \"curve\" comprising exactly two points (a line segment).", "kind": "class", "name": "Line", "augments": [ "Phaser.Curves.Curve" ], "memberof": "Phaser.Curves", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Array." ], "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": "T000002R003972", "___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": 45, "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": "T000002R003978", "___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": 54, "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": "T000002R003980", "___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": 65, "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": "T000002R003982", "___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": 76, "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": "T000002R003984", "___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": 95, "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": "T000002R003987", "___s": true }, { "comment": "/**\r\n * Gets the resolution of the line.\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": 114, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Gets the resolution of the line.", "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": "T000002R003990", "___s": true }, { "comment": "/**\r\n * Get point at relative position in curve according to length.\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": 131, "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.Line", "longname": "Phaser.Curves.Line#getPoint", "scope": "instance", "___id": "T000002R003993", "___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": 160, "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": "T000002R003996", "___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": 178, "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": "T000002R003998", "___s": true }, { "comment": "/**\r\n * Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equidistant.\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": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equidistant.", "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": "T000002R004001", "___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": 236, "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": "T000002R004009", "___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": 259, "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": "T000002R004011", "___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": 280, "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": "T000002R004015", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A MoveTo Curve is a very simple curve consisting of only a single point.\r\n * Its intended use is to move the ending point in a Path.\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 very simple curve consisting of only a single point.\rIts intended use is to move the ending point in a Path.", "kind": "class", "name": "MoveTo", "memberof": "Phaser.Curves", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "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": "T000002R004023", "___s": true }, { "comment": "/**\r\n * Denotes that this Curve does not influence the bounds, points, and drawing of its parent Path. Must be `false` or some methods in the parent Path will throw errors.\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": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Denotes that this Curve does not influence the bounds, points, and drawing of its parent Path. Must be `false` or some methods in the parent Path will throw errors.", "name": "active", "type": { "names": [ "boolean" ], "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": "T000002R004026", "___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": 39, "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": "T000002R004028", "___s": true }, { "comment": "/**\r\n * Get point at relative position in curve according to length.\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": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "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.MoveTo", "longname": "Phaser.Curves.MoveTo#getPoint", "scope": "instance", "___id": "T000002R004030", "___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": 69, "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": "T000002R004033", "___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": 87, "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": "T000002R004035", "___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": 100, "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": "T000002R004037", "___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": 113, "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": "T000002R004039", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Path combines multiple Curves into one continuous compound curve.\r\n * It does not matter how many Curves are in the Path or what type they are.\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.\rIt does not matter how many Curves are in the Path or what type they are.\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": "T000002R004055", "___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": 46, "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": "T000002R004060", "___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": 57, "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": "T000002R004062", "___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": 67, "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": "T000002R004064", "___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": 79, "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": "T000002R004066", "___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": 89, "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": "T000002R004068", "___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": 130, "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": "T000002R004074", "___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": 149, "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": "T000002R004076", "___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": 168, "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": "T000002R004079", "___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": 195, "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": "T000002R004083", "___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": 236, "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": "T000002R004095", "___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": 270, "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": "T000002R004104", "___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": 300, "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": "T000002R004108", "___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": 332, "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": "T000002R004115", "___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": 386, "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": "T000002R004122", "___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": 435, "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": "T000002R004139", "___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": 472, "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": "T000002R004146", "___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": 501, "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": "T000002R004151", "___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": 531, "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": "T000002R004154", "___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": 557, "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": "T000002R004157", "___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=12] - The number of divisions per resolution per curve.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of Vector2 objects that containing the points along the Path.\r\n */", "meta": { "filename": "Path.js", "lineno": 600, "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, "defaultvalue": 12, "description": "The number of divisions per resolution per curve.", "name": "divisions" } ], "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 that containing the points along the Path." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#getPoints", "scope": "instance", "___id": "T000002R004167", "___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": 654, "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": "T000002R004179", "___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": 675, "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": "T000002R004182", "___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": 706, "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": "T000002R004187", "___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": 725, "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": "T000002R004190", "___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)} x - The X coordinate of the line's end point, or a `Vector2` 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": 765, "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Math.Vector2" } ] } }, "description": "The X coordinate of the line's end point, or a `Vector2` containing the entire end point.", "name": "x" }, { "type": { "names": [ "number" ], "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": "T000002R004200", "___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": 792, "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": "T000002R004203", "___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)} x - The X coordinate of the position to move the path's end point to, or a `Vector2` 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": 809, "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Math.Vector2" } ] } }, "description": "The X coordinate of the position to move the path's end point to, or a `Vector2` containing the entire new end point.", "name": "x" }, { "type": { "names": [ "number" ], "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": "T000002R004205", "___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": 834, "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": "T000002R004207", "___s": true }, { "comment": "/**\r\n * cacheLengths must be recalculated.\r\n *\r\n * @method Phaser.Curves.Path#updateArcLengths\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Path.js", "lineno": 860, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "cacheLengths must be recalculated.", "kind": "function", "name": "updateArcLengths", "since": "3.0.0", "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#updateArcLengths", "scope": "instance", "___id": "T000002R004216", "___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": 873, "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": "T000002R004219", "___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": 888, "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": "T000002R004224", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A quadratic Bézier curve constructed from two control 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 - Control Point 2.\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 two control 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": "Control Point 2.", "name": "p2" } ], "scope": "static", "longname": "Phaser.Curves.QuadraticBezier", "___id": "T000002R004230", "___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": 43, "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": "T000002R004237", "___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": 52, "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": "T000002R004239", "___s": true }, { "comment": "/**\r\n * The second control point.\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": 61, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The second control point.", "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": "T000002R004241", "___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": 71, "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": "T000002R004243", "___s": true }, { "comment": "/**\r\n * Get the resolution of the curve.\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": 90, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get the resolution of the curve.", "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": "T000002R004246", "___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": 105, "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": "T000002R004248", "___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": 132, "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": "T000002R004254", "___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": 168, "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": "T000002R004259", "___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": 190, "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": "T000002R004263", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Create a smooth 2d spline curve from a series of points.\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": "Create a smooth 2d spline curve from a series of points.", "kind": "class", "name": "Spline", "augments": [ "Phaser.Curves.Curve" ], "memberof": "Phaser.Curves", "since": "3.0.0", "params": [ { "type": { "names": [ "Array.", "Array.", "Array.>" ], "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": "T000002R004274", "___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": 38, "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": "T000002R004279", "___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 that configure the curve.\r\n *\r\n * @return {this} This curve object.\r\n */", "meta": { "filename": "SplineCurve.js", "lineno": 51, "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 that configure the curve.", "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": "T000002R004281", "___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 this curve\r\n * @param {number} y - The y coordinate of this curve\r\n *\r\n * @return {Phaser.Math.Vector2} The new Vector2 added to the curve\r\n */", "meta": { "filename": "SplineCurve.js", "lineno": 91, "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 this curve", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of this curve", "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": "T000002R004291", "___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": 111, "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": "T000002R004294", "___s": true }, { "comment": "/**\r\n * Get the resolution of the curve.\r\n *\r\n * @method Phaser.Curves.Spline#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": "SplineCurve.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get the resolution of the curve.", "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.Spline", "longname": "Phaser.Curves.Spline#getResolution", "scope": "instance", "___id": "T000002R004297", "___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": 145, "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": "T000002R004299", "___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": 178, "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": "T000002R004310", "___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": 204, "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": "T000002R004316", "___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 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 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": "T000002R004319", "___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": "T000002R004320", "___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 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 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": "T000002R004321", "___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 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 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 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 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": "T000002R004322", "___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 of the curve.\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 of the curve.", "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": "T000002R004323", "___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": "T000002R004326", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Data Manager Component features a means to store pieces of data specific to a Game Object, System or Plugin.\r\n * You can then search, query it, and retrieve the data. The parent must either extend EventEmitter,\r\n * or have a property called `events` that is an instance of it.\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 Component features a means to store pieces of data specific to a Game Object, System or Plugin.\rYou can then search, query it, and retrieve the data. The parent must either extend EventEmitter,\ror have a property called `events` that is an instance of it.", "kind": "class", "name": "DataManager", "memberof": "Phaser.Data", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "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": "T000002R004327", "___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": 39, "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": "T000002R004330", "___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": 48, "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": "T000002R004332", "___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": 62, "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": "T000002R004335", "___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 `setdata` 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": 72, "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 `setdata` 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": "T000002R004337", "___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": 116, "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": "T000002R004341", "___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": 167, "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": "T000002R004346", "___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": 190, "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": "T000002R004351", "___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": 215, "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": "T000002R004356", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key. If the key doesn't already exist in the Data Manager then it is increased from 0.\r\n *\r\n * When the value is first set, a `setdata` event is emitted.\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": 285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Increase a value for the given key. If the key doesn't already exist in the Data Manager then it is increased from 0.\r\rWhen the value is first set, a `setdata` event is emitted.", "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": "T000002R004359", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key. If the key doesn't already exist in the Data Manager then it is toggled from false.\r\n *\r\n * When the value is first set, a `setdata` event is emitted.\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": 325, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Toggle a boolean value for the given key. If the key doesn't already exist in the Data Manager then it is toggled from false.\r\rWhen the value is first set, a `setdata` event is emitted.", "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": "T000002R004364", "___s": true }, { "comment": "/**\r\n * Passes all data entries to the given callback.\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": 419, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Passes all data entries to the given callback.", "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": "T000002R004380", "___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": 451, "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": "T000002R004387", "___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": 484, "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": "T000002R004391", "___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": 553, "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": "T000002R004397", "___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": 581, "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": "T000002R004401", "___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": 599, "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": "T000002R004403", "___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": 617, "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": "T000002R004406", "___s": true }, { "comment": "/**\r\n * Destroy this data manager.\r\n *\r\n * @method Phaser.Data.DataManager#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DataManager.js", "lineno": 638, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Destroy this data manager.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#destroy", "scope": "instance", "___id": "T000002R004410", "___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": 655, "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": "T000002R004413", "___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": 677, "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": "T000002R004418", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Data Component features a means to store pieces of data specific to a Game Object, System or Plugin.\r\n * You can then search, query it, and retrieve the data. The parent must either extend EventEmitter,\r\n * or have a property called `events` that is an instance of it.\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 Component features a means to store pieces of data specific to a Game Object, System or Plugin.\rYou can then search, query it, and retrieve the data. The parent must either extend EventEmitter,\ror have a property called `events` that is an instance of it.", "kind": "class", "name": "DataManagerPlugin", "augments": [ "Phaser.Data.DataManager" ], "memberof": "Phaser.Data", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "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": "T000002R004428", "___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": 36, "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": "T000002R004432", "___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": 45, "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": "T000002R004434", "___s": true }, { "comment": "/**\r\n * The Scene that owns this plugin is being destroyed.\r\n * We need to shutdown and then kill off all external references.\r\n *\r\n * @method Phaser.Data.DataManagerPlugin#destroy\r\n * @since 3.5.0\r\n */", "meta": { "filename": "DataManagerPlugin.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "The Scene that owns this plugin is being destroyed.\rWe need to shutdown and then kill off all external references.", "kind": "function", "name": "destroy", "since": "3.5.0", "memberof": "Phaser.Data.DataManagerPlugin", "longname": "Phaser.Data.DataManagerPlugin#destroy", "scope": "instance", "overrides": "Phaser.Data.DataManager#destroy", "___id": "T000002R004443", "___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": "T000002R004448", "___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": "T000002R004450", "___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": "T000002R004452", "___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": "T000002R004454", "___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": "T000002R004461", "___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": "T000002R004463", "___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": "T000002R004465", "___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 can play m4a files.\r\n * @property {boolean} aac - Can this device can play aac files.\r\n * @property {boolean} flac - Can this device can 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 can play m4a files.", "name": "m4a" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device can play aac files.", "name": "aac" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device can 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": "T000002R004471", "___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+)\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+)", "name": "trident" }, { "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": "T000002R004505", "___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 inversed 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 inversed 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": "T000002R004548", "___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 - Is canvas available?\r\n * @property {?boolean} canvasBitBltShift - True if canvas supports a 'copy' bitblt onto itself when the source and destination regions overlap.\r\n * @property {boolean} file - Is file available?\r\n * @property {boolean} fileSystem - Is fileSystem available?\r\n * @property {boolean} getUserMedia - Does the device support the getUserMedia API?\r\n * @property {boolean} littleEndian - Is the device big or little endian? (only detected if the browser supports TypedArrays)\r\n * @property {boolean} localStorage - Is localStorage available?\r\n * @property {boolean} pointerLock - Is Pointer Lock available?\r\n * @property {boolean} stableSort - Is Array.sort stable?\r\n * @property {boolean} support32bit - Does the device context support 32bit pixel manipulation using array buffer views?\r\n * @property {boolean} vibration - Does the device support the Vibration API?\r\n * @property {boolean} webGL - Is webGL available?\r\n * @property {boolean} worker - Is worker available?\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": "Is canvas available?", "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.", "name": "canvasBitBltShift" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is file available?", "name": "file" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is fileSystem available?", "name": "fileSystem" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Does the device support the getUserMedia API?", "name": "getUserMedia" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is the device big or little endian? (only detected if the browser supports TypedArrays)", "name": "littleEndian" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is localStorage available?", "name": "localStorage" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is Pointer Lock available?", "name": "pointerLock" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is Array.sort stable?", "name": "stableSort" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Does the device context support 32bit pixel manipulation using array buffer views?", "name": "support32bit" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Does the device support the Vibration API?", "name": "vibration" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is webGL available?", "name": "webGL" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is worker available?", "name": "worker" } ], "memberof": "Phaser.Device", "longname": "Phaser.Device.Features", "scope": "static", "___id": "T000002R004582", "___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 {string} cancel - If the browser supports the Full Screen API this holds the call you need to use to cancel it.\r\n * @property {string} request - If the browser supports the Full Screen API this holds the call you need to use to activate it.\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": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "If the browser supports the Full Screen API this holds the call you need to use to cancel it.", "name": "cancel" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "If the browser supports the Full Screen API this holds the call you need to use to activate it.", "name": "request" } ], "memberof": "Phaser.Device", "longname": "Phaser.Device.Fullscreen", "scope": "static", "___id": "T000002R004634", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Device\r\n * @since 3.0.0\r\n */", "meta": { "filename": "index.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\device", "code": {} }, "kind": "namespace", "name": "Device", "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.Device", "scope": "static", "___id": "T000002R004654", "___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": "T000002R004655", "___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} wheelType - The newest type of Wheel/Scroll event supported: 'wheel', 'mousewheel', 'DOMMouseScroll'\r\n * @property {boolean} gamepads - Is navigator.getGamepads available?\r\n * @property {boolean} mspointer - Is mspointer available?\r\n * @property {boolean} touch - Is touch available?\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 newest type of Wheel/Scroll event supported: 'wheel', 'mousewheel', 'DOMMouseScroll'", "name": "wheelType" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is navigator.getGamepads available?", "name": "gamepads" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is mspointer available?", "name": "mspointer" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is touch available?", "name": "touch" } ], "memberof": "Phaser.Device", "longname": "Phaser.Device.Input", "scope": "static", "___id": "T000002R004666", "___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 - PixelRatio 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": "PixelRatio of the host device?", "name": "pixelRatio" } ], "memberof": "Phaser.Device", "longname": "Phaser.Device.OS", "scope": "static", "___id": "T000002R004680", "___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 * In Phaser 3.20 the properties were renamed to drop the 'Video' suffix.\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} 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 {function} getVideoURL - Returns the first video URL that can be played by this browser.\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.\r\rIn Phaser 3.20 the properties were renamed to drop the 'Video' suffix.", "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 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": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "Returns the first video URL that can be played by this browser.", "name": "getVideoURL" } ], "memberof": "Phaser.Device", "longname": "Phaser.Device.Video", "scope": "static", "___id": "T000002R004735", "___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": "T000002R004770", "___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": "T000002R004772", "___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": "T000002R004774", "___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": "T000002R004776", "___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": "T000002R004778", "___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": "T000002R004780", "___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": "T000002R004782", "___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": "T000002R004784", "___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": "T000002R004786", "___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": "T000002R004788", "___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": "T000002R004790", "___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": "T000002R004792", "___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": "T000002R004794", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned in the bottom center of the other.\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 given Game Object and aligns it so that it is positioned in the bottom center of the other.", "kind": "function", "name": "BottomCenter", "since": "3.0.0", "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": "T000002R004801", "___s": true }, { "comment": "/**\r\n * Takes 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 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": "T000002R004810", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned in the bottom right of the other.\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 given Game Object and aligns it so that it is positioned in the bottom right of the other.", "kind": "function", "name": "BottomRight", "since": "3.0.0", "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": "T000002R004819", "___s": true }, { "comment": "/**\r\n * Takes 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 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": "T000002R004827", "___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": "T000002R004832", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned in the left center of the other.\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 given Game Object and aligns it so that it is positioned in the left center of the other.", "kind": "function", "name": "LeftCenter", "since": "3.0.0", "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": "T000002R004848", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned relative to the other.\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 given Game Object and aligns it so that it is positioned relative to the other.\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": "T000002R004868", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned in the right center of the other.\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 given Game Object and aligns it so that it is positioned in the right center of the other.", "kind": "function", "name": "RightCenter", "since": "3.0.0", "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": "T000002R004875", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned in the top center of the other.\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 given Game Object and aligns it so that it is positioned in the top center of the other.", "kind": "function", "name": "TopCenter", "since": "3.0.0", "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": "T000002R004884", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned in the top left of the other.\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 given Game Object and aligns it so that it is positioned in the top left of the other.", "kind": "function", "name": "TopLeft", "since": "3.0.0", "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": "T000002R004893", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned in the top right of the other.\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 given Game Object and aligns it so that it is positioned in the top right of the other.", "kind": "function", "name": "TopRight", "since": "3.0.0", "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": "T000002R004902", "___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": "T000002R004909", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned next to the bottom center position of the other.\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 given Game Object and aligns it so that it is positioned next to the bottom center position of the other.", "kind": "function", "name": "BottomCenter", "since": "3.0.0", "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": "T000002R004919", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned next to the bottom left position of the other.\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 given Game Object and aligns it so that it is positioned next to the bottom left position of the other.", "kind": "function", "name": "BottomLeft", "since": "3.0.0", "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": "T000002R004928", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned next to the bottom right position of the other.\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 given Game Object and aligns it so that it is positioned next to the bottom right position of the other.", "kind": "function", "name": "BottomRight", "since": "3.0.0", "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": "T000002R004937", "___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": "T000002R004942", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned next to the left bottom position of the other.\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 given Game Object and aligns it so that it is positioned next to the left bottom position of the other.", "kind": "function", "name": "LeftBottom", "since": "3.0.0", "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": "T000002R004961", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned next to the left center position of the other.\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 given Game Object and aligns it so that it is positioned next to the left center position of the other.", "kind": "function", "name": "LeftCenter", "since": "3.0.0", "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": "T000002R004970", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned next to the left top position of the other.\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 given Game Object and aligns it so that it is positioned next to the left top position of the other.", "kind": "function", "name": "LeftTop", "since": "3.0.0", "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": "T000002R004979", "___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.\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": 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.", "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.QuickSet", "scope": "static", "___id": "T000002R004998", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned next to the right bottom position of the other.\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 given Game Object and aligns it so that it is positioned next to the right bottom position of the other.", "kind": "function", "name": "RightBottom", "since": "3.0.0", "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": "T000002R005005", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned next to the right center position of the other.\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 given Game Object and aligns it so that it is positioned next to the right center position of the other.", "kind": "function", "name": "RightCenter", "since": "3.0.0", "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": "T000002R005014", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned next to the right top position of the other.\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 given Game Object and aligns it so that it is positioned next to the right top position of the other.", "kind": "function", "name": "RightTop", "since": "3.0.0", "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": "T000002R005023", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned next to the top center position of the other.\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 given Game Object and aligns it so that it is positioned next to the top center position of the other.", "kind": "function", "name": "TopCenter", "since": "3.0.0", "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": "T000002R005032", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned next to the top left position of the other.\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 given Game Object and aligns it so that it is positioned next to the top left position of the other.", "kind": "function", "name": "TopLeft", "since": "3.0.0", "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": "T000002R005041", "___s": true }, { "comment": "/**\r\n * Takes given Game Object and aligns it so that it is positioned next to the top right position of the other.\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 given Game Object and aligns it so that it is positioned next to the top right position of the other.", "kind": "function", "name": "TopRight", "since": "3.0.0", "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": "T000002R005050", "___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": "T000002R005057", "___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": "T000002R005060", "___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": "T000002R005068", "___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": "T000002R005078", "___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": "T000002R005081", "___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": "T000002R005084", "___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": "T000002R005087", "___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 `width * 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 `width * 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": "T000002R005090", "___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": "T000002R005093", "___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": "T000002R005096", "___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": "T000002R005099", "___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": "T000002R005117", "___s": true }, { "comment": "/**\r\n * Positions the Game Object so that the center top 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 center top 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": "T000002R005121", "___s": true }, { "comment": "/**\r\n * Positions the Game Object so that the center top 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 center top 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": "T000002R005126", "___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": "T000002R005131", "___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.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 left 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": "T000002R005135", "___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": "T000002R005139", "___s": true }, { "comment": "/**\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": {} }, "kind": "namespace", "name": "CanvasInterpolation", "since": "3.0.0", "memberof": "Phaser.Display.Canvas", "longname": "Phaser.Display.Canvas.CanvasInterpolation", "scope": "static", "___id": "T000002R005143", "___s": true }, { "comment": "/**\r\n * Sets the CSS image-rendering property on the given canvas to be 'crisp' (aka 'optimize contrast' on webkit).\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": 13, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "Sets the CSS image-rendering property on the given canvas to be 'crisp' (aka 'optimize contrast' on webkit).", "kind": "function", "name": "setCrisp", "since": "3.0.0", "params": [ { "type": { "names": [ "HTMLCanvasElement" ], "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": "T000002R005145", "___s": true }, { "comment": "/**\r\n * Sets the CSS image-rendering property on the given canvas to be 'bicubic' (aka 'auto').\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": 37, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "Sets the CSS image-rendering property on the given canvas to be 'bicubic' (aka 'auto').", "kind": "function", "name": "setBicubic", "since": "3.0.0", "params": [ { "type": { "names": [ "HTMLCanvasElement" ], "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": "T000002R005150", "___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 some of the Phaser pipelines / 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 some of the Phaser pipelines / 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": "T000002R005159", "___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": "T000002R005161", "___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.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 created canvas.\r\n */", "meta": { "filename": "CanvasPool.js", "lineno": 91, "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": "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 created canvas." } ], "memberof": "Phaser.Display.Canvas.CanvasPool", "longname": "Phaser.Display.Canvas.CanvasPool.create2D", "scope": "static", "___id": "T000002R005180", "___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.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": 108, "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": "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": "T000002R005182", "___s": true }, { "comment": "/**\r\n * Gets the first free canvas index 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": 125, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "Gets the first free canvas index 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": "T000002R005184", "___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": 157, "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": "T000002R005189", "___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": 182, "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": "T000002R005195", "___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": 205, "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": "T000002R005198", "___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": 218, "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": "T000002R005200", "___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": 229, "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": "T000002R005203", "___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": "T000002R005217", "___s": true }, { "comment": "/**\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": {} }, "kind": "namespace", "name": "Smoothing", "since": "3.0.0", "memberof": "Phaser.Display.Canvas", "longname": "Phaser.Display.Canvas.Smoothing", "scope": "static", "___id": "T000002R005225", "___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": 16, "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": "T000002R005227", "___s": true }, { "comment": "/**\r\n * Sets the Image Smoothing property on the given context. Set to false to disable image smoothing.\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": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "Sets the Image Smoothing property on the given context. Set to false to disable image smoothing.\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": "T000002R005232", "___s": true }, { "comment": "/**\r\n * Sets the Image Smoothing property on the given context. Set to false to disable image smoothing.\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": 72, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "Sets the Image Smoothing property on the given context. Set to false to disable image smoothing.\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": "T000002R005236", "___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": 101, "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": "T000002R005240", "___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": "T000002R005247", "___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 touch callout value to set on the canvas. Set to `none` to disable 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 touch callout value to set on the canvas. Set to `none` to disable 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": "T000002R005254", "___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": "T000002R005267", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Color class holds a single color value and allows for easy modification and reading of it.\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": "The Color class holds a single color value and allows for easy modification and reading of it.", "kind": "class", "name": "Color", "memberof": "Phaser.Display", "since": "3.0.0", "params": [ { "type": { "names": [ "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": "T000002R005268", "___s": true }, { "comment": "/**\r\n * An array containing the calculated color values for WebGL use.\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": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "An array containing the calculated color values for WebGL use.", "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": "T000002R005291", "___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": 177, "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": "T000002R005299", "___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": 199, "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": "T000002R005307", "___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": 230, "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": "T000002R005317", "___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": 259, "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": "T000002R005326", "___s": true }, { "comment": "/**\r\n * Sets the color based on the hue, saturation and lightness values 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": 287, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Sets the color based on the hue, saturation and lightness values given.", "kind": "function", "name": "setFromHSV", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "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": "T000002R005334", "___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": 359, "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": "T000002R005351", "___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": 372, "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": "T000002R005353", "___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": 387, "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": "T000002R005355", "___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": 410, "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": "T000002R005362", "___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": 431, "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": "T000002R005367", "___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": 449, "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": "T000002R005370", "___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": 467, "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": "T000002R005373", "___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": 484, "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": "T000002R005376", "___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": 501, "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": "T000002R005379", "___s": true }, { "comment": "/**\r\n * The color of this Color component, 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": 524, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The color of this Color component, 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": "T000002R005387", "___s": true }, { "comment": "/**\r\n * The color of this Color component, 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": 541, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The color of this Color component, 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": "T000002R005390", "___s": true }, { "comment": "/**\r\n * The color of this Color component as a string which can be used in CSS color values.\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": 558, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The color of this Color component as a string which can be used in CSS color values.", "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": "T000002R005393", "___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": 575, "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": "T000002R005396", "___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": 600, "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": "T000002R005402", "___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": 625, "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": "T000002R005408", "___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": 650, "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": "T000002R005414", "___s": true }, { "comment": "/**\r\n * The red color value, normalized to 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": 675, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The red color value, normalized to 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": "T000002R005420", "___s": true }, { "comment": "/**\r\n * The green color value, normalized to 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": 702, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The green color value, normalized to 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": "T000002R005427", "___s": true }, { "comment": "/**\r\n * The blue color value, normalized to 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": 729, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The blue color value, normalized to 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": "T000002R005434", "___s": true }, { "comment": "/**\r\n * The alpha color value, normalized to 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": 756, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The alpha color value, normalized to 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": "T000002R005441", "___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": 783, "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": "T000002R005448", "___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": 807, "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": "T000002R005453", "___s": true }, { "comment": "/**\r\n * The lightness color value. A number between 0 and 1.\r\n * This controls how dark the color is. Where 1 is as bright as possible 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": 831, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The lightness color value. A number between 0 and 1.\rThis controls how dark the color is. Where 1 is as bright as possible 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": "T000002R005458", "___s": true }, { "comment": "/**\r\n * Return an array of Colors in a Color Spectrum.\r\n *\r\n * The spectrum colors flow in the order: red, yellow, green, blue.\r\n *\r\n * By default this function will return an array with 1024 elements in.\r\n *\r\n * However, you can reduce this to a smaller quantity if needed, by specitying the `limit` parameter.\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": "Return an array of Colors in a Color Spectrum.\r\rThe spectrum colors flow in the order: red, yellow, green, blue.\r\rBy default this function will return an array with 1024 elements in.\r\rHowever, you can reduce this to a smaller quantity if needed, by specitying the `limit` parameter.", "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": "T000002R005465", "___s": true }, { "comment": "/**\r\n * Converts the given color value into an Object containing r,g,b and a properties.\r\n *\r\n * @function Phaser.Display.Color.ColorToRGBA\r\n * @since 3.0.0\r\n *\r\n * @param {number} color - A color value, optionally including the alpha value.\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.", "kind": "function", "name": "ColorToRGBA", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A color value, optionally including the alpha value.", "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": "T000002R005504", "___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": "T000002R005513", "___s": true }, { "comment": "/**\r\n * Given 3 separate color values this will return an integer representation of it.\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 combined color value.\r\n */", "meta": { "filename": "GetColor.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Given 3 separate color values this will return an integer representation of it.", "kind": "function", "name": "GetColor", "since": "3.0.0", "params": [ { "type": { "names": [ "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 combined color value." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.GetColor", "scope": "static", "___id": "T000002R005517", "___s": true }, { "comment": "/**\r\n * Given an alpha and 3 color values this will return an integer representation of it.\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 combined color value.\r\n */", "meta": { "filename": "GetColor32.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Given an alpha and 3 color values this will return an integer representation of it.", "kind": "function", "name": "GetColor32", "since": "3.0.0", "params": [ { "type": { "names": [ "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 combined color value." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.GetColor32", "scope": "static", "___id": "T000002R005520", "___s": true }, { "comment": "/**\r\n * Converts a hex string into a Phaser Color object.\r\n * \r\n * The hex string can 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 *\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 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" } ], "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": "T000002R005524", "___s": true }, { "comment": "/**\r\n * Converts HSL (hue, saturation and lightness) values to a Phaser Color object.\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 *\r\n * @return {Phaser.Display.Color} A Color object created from the results of the h, s and l values.\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.", "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" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "A Color object created from the results of the h, s and l values." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.HSLToColor", "scope": "static", "___id": "T000002R005535", "___s": true }, { "comment": "/**\r\n * Generates an HSV color wheel which is an array of 360 Color objects, for each step of the wheel.\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 containing 360 ColorObject elements, where each element contains a Color object corresponding to the color at that point in 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 which is an array of 360 Color objects, for each step of the wheel.", "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 containing 360 ColorObject elements, where each element contains a Color object corresponding to the color at that point in the HSV color wheel." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.HSVColorWheel", "scope": "static", "___id": "T000002R005548", "___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 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 * @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 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" }, { "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": "T000002R005559", "___s": true }, { "comment": "/**\r\n * Converts a hue to an RGB color.\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\r\n * @param {number} q\r\n * @param {number} t\r\n *\r\n * @return {number} The combined color value.\r\n */", "meta": { "filename": "HueToComponent.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Converts a hue to an RGB color.\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" } }, "name": "p" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "name": "q" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "name": "t" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The combined color value." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.HueToComponent", "scope": "static", "___id": "T000002R005575", "___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 color value to convert into a Color object.\r\n *\r\n * @return {Phaser.Display.Color} A Color object.\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 color value to convert into a Color object.", "name": "input" } ], "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.IntegerToColor", "scope": "static", "___id": "T000002R005603", "___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 * Alpha will only be set if it exists in the given color (0xAARRGGBB)\r\n *\r\n * @function Phaser.Display.Color.IntegerToRGB\r\n * @since 3.0.0\r\n *\r\n * @param {number} input - The color value to convert into a Color object.\r\n *\r\n * @return {Phaser.Types.Display.ColorObject} An object with the red, green and blue values set in the 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\rAlpha will only be set if it exists in the given color (0xAARRGGBB)", "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": "input" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Display.ColorObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Display.ColorObject" } }, "description": "An object with the red, green and blue values set in the r, g and b properties." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.IntegerToRGB", "scope": "static", "___id": "T000002R005607", "___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": 9, "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": "T000002R005619", "___s": true }, { "comment": "/**\r\n * Interpolates between the two given color ranges 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 - Blue value.\r\n * @param {number} b1 - Green value.\r\n * @param {number} r2 - Red value.\r\n * @param {number} g2 - Blue value.\r\n * @param {number} b2 - Green 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": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Interpolates between the two given color ranges over the length supplied.", "kind": "function", "name": "RGBWithRGB", "memberof": "Phaser.Display.Color.Interpolate", "scope": "static", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Red value.", "name": "r1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Blue value.", "name": "g1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Green 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": "Blue value.", "name": "g2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Green 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": "T000002R005620", "___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 *\r\n * @return {Phaser.Types.Display.ColorObject} An object containing the interpolated color values.\r\n */", "meta": { "filename": "Interpolate.js", "lineno": 48, "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" } ], "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": "T000002R005628", "___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} color1 - The first Color object.\r\n * @param {number} r - Red value.\r\n * @param {number} g - Blue value.\r\n * @param {number} b - Green 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": 71, "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 first Color object.", "name": "color1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Red value.", "name": "r" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Blue value.", "name": "g" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Green 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": "T000002R005632", "___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 *\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" } ], "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": "T000002R005641", "___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": "T000002R005646", "___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 *\r\n * @return {Phaser.Display.Color} A Color object.\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" } ], "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.RGBStringToColor", "scope": "static", "___id": "T000002R005652", "___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": "T000002R005661", "___s": true }, { "comment": "/**\r\n * Converts the color values into an HTML compatible color string, prefixed with either `#` or `0x`.\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 string-based representation of the color values.\r\n */", "meta": { "filename": "RGBToString.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Converts the color values into an HTML compatible color string, prefixed with either `#` or `0x`.", "kind": "function", "name": "RGBToString", "since": "3.0.0", "params": [ { "type": { "names": [ "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 string-based representation of the color values." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.RGBToString", "scope": "static", "___id": "T000002R005688", "___s": true }, { "comment": "/**\r\n * Converts the given source color value into an instance of a Color class.\r\n * The value can be either a string, prefixed with `rgb` or a hex string, a number or an Object.\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 *\r\n * @return {Phaser.Display.Color} A Color object.\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 either a string, prefixed with `rgb` or a hex string, a number or an Object.", "kind": "function", "name": "ValueToColor", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "number", "Phaser.Types.Display.InputColorObject" ], "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" } ], "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.ValueToColor", "scope": "static", "___id": "T000002R005697", "___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 * Use the method `getData` to return a Float32Array containing the current color values.\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\rUse the method `getData` to return a Float32Array containing the current color values.", "kind": "class", "name": "ColorMatrix", "memberof": "Phaser.Display", "since": "3.50.0", "scope": "static", "longname": "Phaser.Display.ColorMatrix", "___id": "T000002R005703", "___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": 40, "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": "T000002R005708", "___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": 75, "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": "T000002R005714", "___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": 94, "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": "T000002R005717", "___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": 121, "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": "T000002R005726", "___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": 150, "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": "T000002R005734", "___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": 176, "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": "T000002R005739", "___s": true }, { "comment": "/**\r\n * Desaturates this ColorMatrix (removes color from it).\r\n *\r\n * @method Phaser.Display.ColorMatrix#saturation\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": 203, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Desaturates this ColorMatrix (removes color from it).", "kind": "function", "name": "saturation", "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#saturation", "scope": "instance", "___id": "T000002R005745", "___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": 220, "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": "T000002R005748", "___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": 252, "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": "T000002R005758", "___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": 271, "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": "T000002R005762", "___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": 288, "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": "T000002R005765", "___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": 315, "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": "T000002R005771", "___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": 332, "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": "T000002R005774", "___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": 349, "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": "T000002R005777", "___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": 366, "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": "T000002R005780", "___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": 390, "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": "T000002R005784", "___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": 407, "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": "T000002R005787", "___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": 424, "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": "T000002R005790", "___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": 441, "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": "T000002R005793", "___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": 458, "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": "T000002R005796", "___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": 475, "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": "T000002R005799", "___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": 492, "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": "T000002R005802", "___s": true }, { "comment": "/**\r\n * Multiplies the two given matrices.\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": 509, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Multiplies the two given matrices.", "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": "T000002R005805", "___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": 575, "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": "T000002R005811", "___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": 585, "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": "T000002R005813", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for desatured 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": 595, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for desatured 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": "T000002R005815", "___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": 605, "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": "T000002R005817", "___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": 615, "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": "T000002R005819", "___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": 625, "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": "T000002R005821", "___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": 635, "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": "T000002R005823", "___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": 645, "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": "T000002R005825", "___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": 655, "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": "T000002R005827", "___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": 665, "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": "T000002R005829", "___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": 675, "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": "T000002R005831", "___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": "T000002R005834", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Bitmap Mask combines the alpha (opacity) of a masked pixel with the alpha of another pixel.\r\n * Unlike the Geometry Mask, which is a clipping path, a Bitmap Mask behaves like an alpha mask,\r\n * not a clipping path. It is only available when using the WebGL Renderer.\r\n *\r\n * A Bitmap Mask can use any Game Object or Dynamic Texture to determine the alpha of each pixel of the masked Game Object(s).\r\n * For any given point of a masked Game Object's texture, the pixel's alpha will be multiplied by the alpha\r\n * of the pixel at the same position in the Bitmap Mask's Game Object. The color of the pixel from the\r\n * Bitmap Mask doesn't matter.\r\n *\r\n * For example, if a pure blue pixel with an alpha of 0.95 is masked with a pure red pixel with an\r\n * alpha of 0.5, the resulting pixel will be pure blue with an alpha of 0.475. Naturally, this means\r\n * that a pixel in the mask with an alpha of 0 will hide the corresponding pixel in all masked Game Objects.\r\n * A pixel with an alpha of 1 in the masked Game Object will receive the same alpha as the\r\n * corresponding pixel in the mask.\r\n *\r\n * Note: You cannot combine Bitmap Masks and Blend Modes on the same Game Object. You can, however,\r\n * combine Geometry Masks and Blend Modes together.\r\n *\r\n * The Bitmap Mask's location matches the location of its Game Object, not the location of the\r\n * masked objects. Moving or transforming the underlying Game Object will change the mask\r\n * (and affect the visibility of any masked objects), whereas moving or transforming a masked object\r\n * will not affect the mask.\r\n *\r\n * The Bitmap Mask will not render its Game Object by itself. If the Game Object is not in a\r\n * Scene's display list, it will only be used for the mask and its full texture will not be directly\r\n * visible. Adding the underlying Game Object to a Scene will not cause any problems - it will\r\n * render as a normal Game Object and will also serve as a mask.\r\n *\r\n * @class BitmapMask\r\n * @memberof Phaser.Display.Masks\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this mask is being added.\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n */", "meta": { "filename": "BitmapMask.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "classdesc": "A Bitmap Mask combines the alpha (opacity) of a masked pixel with the alpha of another pixel.\rUnlike the Geometry Mask, which is a clipping path, a Bitmap Mask behaves like an alpha mask,\rnot a clipping path. It is only available when using the WebGL Renderer.\r\rA Bitmap Mask can use any Game Object or Dynamic Texture to determine the alpha of each pixel of the masked Game Object(s).\rFor any given point of a masked Game Object's texture, the pixel's alpha will be multiplied by the alpha\rof the pixel at the same position in the Bitmap Mask's Game Object. The color of the pixel from the\rBitmap Mask doesn't matter.\r\rFor example, if a pure blue pixel with an alpha of 0.95 is masked with a pure red pixel with an\ralpha of 0.5, the resulting pixel will be pure blue with an alpha of 0.475. Naturally, this means\rthat a pixel in the mask with an alpha of 0 will hide the corresponding pixel in all masked Game Objects.\rA pixel with an alpha of 1 in the masked Game Object will receive the same alpha as the\rcorresponding pixel in the mask.\r\rNote: You cannot combine Bitmap Masks and Blend Modes on the same Game Object. You can, however,\rcombine Geometry Masks and Blend Modes together.\r\rThe Bitmap Mask's location matches the location of its Game Object, not the location of the\rmasked objects. Moving or transforming the underlying Game Object will change the mask\r(and affect the visibility of any masked objects), whereas moving or transforming a masked object\rwill not affect the mask.\r\rThe Bitmap Mask will not render its Game Object by itself. If the Game Object is not in a\rScene's display list, it will only be used for the mask and its full texture will not be directly\rvisible. Adding the underlying Game Object to a Scene will not cause any problems - it will\rrender as a normal Game Object and will also serve as a mask.", "kind": "class", "name": "BitmapMask", "memberof": "Phaser.Display.Masks", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this mask is being added.", "name": "scene" }, { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "scope": "static", "longname": "Phaser.Display.Masks.BitmapMask", "___id": "T000002R005846", "___s": true }, { "comment": "/**\r\n * The Game Object that is used as the mask. Must use a texture, such as a Sprite.\r\n *\r\n * @name Phaser.Display.Masks.BitmapMask#bitmapMask\r\n * @type {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BitmapMask.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "The Game Object that is used as the mask. Must use a texture, such as a Sprite.", "name": "bitmapMask", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "since": "3.0.0", "memberof": "Phaser.Display.Masks.BitmapMask", "longname": "Phaser.Display.Masks.BitmapMask#bitmapMask", "scope": "instance", "kind": "member", "___id": "T000002R005855", "___s": true }, { "comment": "/**\r\n * Whether to invert the masks alpha.\r\n *\r\n * If `true`, the alpha of the masking pixel will be inverted before it's multiplied with the masked pixel.\r\n *\r\n * Essentially, this means that a masked area will be visible only if the corresponding area in the mask is invisible.\r\n *\r\n * @name Phaser.Display.Masks.BitmapMask#invertAlpha\r\n * @type {boolean}\r\n * @since 3.1.2\r\n */", "meta": { "filename": "BitmapMask.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "Whether to invert the masks alpha.\r\rIf `true`, the alpha of the masking pixel will be inverted before it's multiplied with the masked pixel.\r\rEssentially, this means that a masked area will be visible only if the corresponding area in the mask is invisible.", "name": "invertAlpha", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.1.2", "memberof": "Phaser.Display.Masks.BitmapMask", "longname": "Phaser.Display.Masks.BitmapMask#invertAlpha", "scope": "instance", "kind": "member", "___id": "T000002R005857", "___s": true }, { "comment": "/**\r\n * Is this mask a stencil mask? This is false by default and should not be changed.\r\n *\r\n * @name Phaser.Display.Masks.BitmapMask#isStencil\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.17.0\r\n */", "meta": { "filename": "BitmapMask.js", "lineno": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "Is this mask a stencil mask? This is false by default and should not be changed.", "name": "isStencil", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.17.0", "memberof": "Phaser.Display.Masks.BitmapMask", "longname": "Phaser.Display.Masks.BitmapMask#isStencil", "scope": "instance", "kind": "member", "___id": "T000002R005859", "___s": true }, { "comment": "/**\r\n * Sets a new Game Object or Dynamic Texture for this Bitmap Mask to use.\r\n *\r\n * If a Game Object it must have a texture, such as a Sprite.\r\n *\r\n * You can update the source of the mask as often as you like.\r\n *\r\n * @method Phaser.Display.Masks.BitmapMask#setBitmap\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} maskObject - The Game Object or Dynamic Texture that will be used as the mask. If a Game Object, it must have a texture, such as a Sprite.\r\n */", "meta": { "filename": "BitmapMask.js", "lineno": 96, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "Sets a new Game Object or Dynamic Texture for this Bitmap Mask to use.\r\rIf a Game Object it must have a texture, such as a Sprite.\r\rYou can update the source of the mask as often as you like.", "kind": "function", "name": "setBitmap", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "description": "The Game Object or Dynamic Texture that will be used as the mask. If a Game Object, it must have a texture, such as a Sprite.", "name": "maskObject" } ], "memberof": "Phaser.Display.Masks.BitmapMask", "longname": "Phaser.Display.Masks.BitmapMask#setBitmap", "scope": "instance", "___id": "T000002R005861", "___s": true }, { "comment": "/**\r\n * Prepares the WebGL Renderer to render a Game Object with this mask applied.\r\n *\r\n * This renders the masking Game Object to the mask framebuffer and switches to the main framebuffer so that the masked Game Object will be rendered to it instead of being rendered directly to the frame.\r\n *\r\n * @method Phaser.Display.Masks.BitmapMask#preRenderWebGL\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - The WebGL Renderer to prepare.\r\n * @param {Phaser.GameObjects.GameObject} maskedObject - The masked Game Object which will be drawn.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to render to.\r\n */", "meta": { "filename": "BitmapMask.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "Prepares the WebGL Renderer to render a Game Object with this mask applied.\r\rThis renders the masking Game Object to the mask framebuffer and switches to the main framebuffer so that the masked Game Object will be rendered to it instead of being rendered directly to the frame.", "kind": "function", "name": "preRenderWebGL", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Renderer.Canvas.CanvasRenderer", "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.Canvas.CanvasRenderer" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } ] } }, "description": "The WebGL Renderer to prepare.", "name": "renderer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The masked Game Object which will be drawn.", "name": "maskedObject" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to render to.", "name": "camera" } ], "memberof": "Phaser.Display.Masks.BitmapMask", "longname": "Phaser.Display.Masks.BitmapMask#preRenderWebGL", "scope": "instance", "___id": "T000002R005864", "___s": true }, { "comment": "/**\r\n * Finalizes rendering of a masked Game Object.\r\n *\r\n * This resets the previously bound framebuffer and switches the WebGL Renderer to the Bitmap Mask Pipeline, which uses a special fragment shader to apply the masking effect.\r\n *\r\n * @method Phaser.Display.Masks.BitmapMask#postRenderWebGL\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - The WebGL Renderer to clean up.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to render to.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [renderTarget] - Optional WebGL RenderTarget.\r\n */", "meta": { "filename": "BitmapMask.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "Finalizes rendering of a masked Game Object.\r\rThis resets the previously bound framebuffer and switches the WebGL Renderer to the Bitmap Mask Pipeline, which uses a special fragment shader to apply the masking effect.", "kind": "function", "name": "postRenderWebGL", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Renderer.Canvas.CanvasRenderer", "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.Canvas.CanvasRenderer" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } ] } }, "description": "The WebGL Renderer to clean up.", "name": "renderer" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to render to.", "name": "camera" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "Optional WebGL RenderTarget.", "name": "renderTarget" } ], "memberof": "Phaser.Display.Masks.BitmapMask", "longname": "Phaser.Display.Masks.BitmapMask#postRenderWebGL", "scope": "instance", "___id": "T000002R005866", "___s": true }, { "comment": "/**\r\n * This is a NOOP method. Bitmap Masks are not supported by the Canvas Renderer.\r\n *\r\n * @method Phaser.Display.Masks.BitmapMask#preRenderCanvas\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - The Canvas Renderer which would be rendered to.\r\n * @param {Phaser.GameObjects.GameObject} mask - The masked Game Object which would be rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to render to.\r\n */", "meta": { "filename": "BitmapMask.js", "lineno": 147, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "This is a NOOP method. Bitmap Masks are not supported by the Canvas Renderer.", "kind": "function", "name": "preRenderCanvas", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Renderer.Canvas.CanvasRenderer", "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.Canvas.CanvasRenderer" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } ] } }, "description": "The Canvas Renderer which would be rendered to.", "name": "renderer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The masked Game Object which would be rendered.", "name": "mask" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to render to.", "name": "camera" } ], "memberof": "Phaser.Display.Masks.BitmapMask", "longname": "Phaser.Display.Masks.BitmapMask#preRenderCanvas", "scope": "instance", "___id": "T000002R005868", "___s": true }, { "comment": "/**\r\n * This is a NOOP method. Bitmap Masks are not supported by the Canvas Renderer.\r\n *\r\n * @method Phaser.Display.Masks.BitmapMask#postRenderCanvas\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - The Canvas Renderer which would be rendered to.\r\n */", "meta": { "filename": "BitmapMask.js", "lineno": 162, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "This is a NOOP method. Bitmap Masks are not supported by the Canvas Renderer.", "kind": "function", "name": "postRenderCanvas", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Renderer.Canvas.CanvasRenderer", "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.Canvas.CanvasRenderer" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } ] } }, "description": "The Canvas Renderer which would be rendered to.", "name": "renderer" } ], "memberof": "Phaser.Display.Masks.BitmapMask", "longname": "Phaser.Display.Masks.BitmapMask#postRenderCanvas", "scope": "instance", "___id": "T000002R005870", "___s": true }, { "comment": "/**\r\n * Destroys this BitmapMask 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.BitmapMask#destroy\r\n * @since 3.7.0\r\n */", "meta": { "filename": "BitmapMask.js", "lineno": 175, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "Destroys this BitmapMask 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.BitmapMask", "longname": "Phaser.Display.Masks.BitmapMask#destroy", "scope": "instance", "___id": "T000002R005872", "___s": true }, { "comment": "/**\r\n * A Bitmap Mask combines the alpha (opacity) of a masked pixel with the alpha of another pixel.\r\n * Unlike the Geometry Mask, which is a clipping path, a Bitmap Mask behaves like an alpha mask,\r\n * not a clipping path. It is only available when using the WebGL Renderer.\r\n *\r\n * A Bitmap Mask can use any Game Object, or Dynamic Texture, to determine the alpha of each pixel of the masked Game Object(s).\r\n * For any given point of a masked Game Object's texture, the pixel's alpha will be multiplied by the alpha\r\n * of the pixel at the same position in the Bitmap Mask's Game Object. The color of the pixel from the\r\n * Bitmap Mask doesn't matter.\r\n *\r\n * For example, if a pure blue pixel with an alpha of 0.95 is masked with a pure red pixel with an\r\n * alpha of 0.5, the resulting pixel will be pure blue with an alpha of 0.475. Naturally, this means\r\n * that a pixel in the mask with an alpha of 0 will hide the corresponding pixel in all masked Game Objects\r\n * A pixel with an alpha of 1 in the masked Game Object will receive the same alpha as the\r\n * corresponding pixel in the mask.\r\n *\r\n * Note: You cannot combine Bitmap Masks and Blend Modes on the same Game Object. You can, however,\r\n * combine Geometry Masks and Blend Modes together.\r\n *\r\n * The Bitmap Mask's location matches the location of its Game Object, not the location of the\r\n * masked objects. Moving or transforming the underlying Game Object will change the mask\r\n * (and affect the visibility of any masked objects), whereas moving or transforming a masked object\r\n * will not affect the mask.\r\n *\r\n * The Bitmap Mask will not render its Game Object by itself. If the Game Object is not in a\r\n * Scene's display list, it will only be used for the mask and its full texture will not be directly\r\n * visible. Adding the underlying Game Object to a Scene will not cause any problems - it will\r\n * render as a normal Game Object and will also serve as a mask.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#bitmapMask\r\n * @since 3.60.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} The Bitmap Mask that was created.\r\n */", "meta": { "filename": "BitmapMask.js", "lineno": 191, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "A Bitmap Mask combines the alpha (opacity) of a masked pixel with the alpha of another pixel.\rUnlike the Geometry Mask, which is a clipping path, a Bitmap Mask behaves like an alpha mask,\rnot a clipping path. It is only available when using the WebGL Renderer.\r\rA Bitmap Mask can use any Game Object, or Dynamic Texture, to determine the alpha of each pixel of the masked Game Object(s).\rFor any given point of a masked Game Object's texture, the pixel's alpha will be multiplied by the alpha\rof the pixel at the same position in the Bitmap Mask's Game Object. The color of the pixel from the\rBitmap Mask doesn't matter.\r\rFor example, if a pure blue pixel with an alpha of 0.95 is masked with a pure red pixel with an\ralpha of 0.5, the resulting pixel will be pure blue with an alpha of 0.475. Naturally, this means\rthat a pixel in the mask with an alpha of 0 will hide the corresponding pixel in all masked Game Objects\r A pixel with an alpha of 1 in the masked Game Object will receive the same alpha as the\rcorresponding pixel in the mask.\r\rNote: You cannot combine Bitmap Masks and Blend Modes on the same Game Object. You can, however,\rcombine Geometry Masks and Blend Modes together.\r\rThe Bitmap Mask's location matches the location of its Game Object, not the location of the\rmasked objects. Moving or transforming the underlying Game Object will change the mask\r(and affect the visibility of any masked objects), whereas moving or transforming a masked object\rwill not affect the mask.\r\rThe Bitmap Mask will not render its Game Object by itself. If the Game Object is not in a\rScene's display list, it will only be used for the mask and its full texture will not be directly\rvisible. Adding the underlying Game Object to a Scene will not cause any problems - it will\rrender as a normal Game Object and will also serve as a mask.", "kind": "function", "name": "bitmapMask", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "The Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#bitmapMask", "scope": "instance", "___id": "T000002R005875", "___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 * @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.", "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": "T000002R005878", "___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": 41, "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": "T000002R005881", "___s": true }, { "comment": "/**\r\n * Similar to the BitmapMasks invertAlpha setting this to true will then hide all pixels\r\n * drawn to the Geometry Mask.\r\n *\r\n * This is a WebGL only feature.\r\n *\r\n * @name Phaser.Display.Masks.GeometryMask#invertAlpha\r\n * @type {boolean}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "GeometryMask.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "Similar to the BitmapMasks invertAlpha setting this to true will then hide all pixels\rdrawn to the Geometry Mask.\r\rThis is a WebGL only feature.", "name": "invertAlpha", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.16.0", "memberof": "Phaser.Display.Masks.GeometryMask", "longname": "Phaser.Display.Masks.GeometryMask#invertAlpha", "scope": "instance", "kind": "member", "___id": "T000002R005883", "___s": true }, { "comment": "/**\r\n * Is this mask a stencil mask?\r\n *\r\n * @name Phaser.Display.Masks.GeometryMask#isStencil\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.17.0\r\n */", "meta": { "filename": "GeometryMask.js", "lineno": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "Is this mask a stencil mask?", "name": "isStencil", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.17.0", "memberof": "Phaser.Display.Masks.GeometryMask", "longname": "Phaser.Display.Masks.GeometryMask#isStencil", "scope": "instance", "kind": "member", "___id": "T000002R005885", "___s": true }, { "comment": "/**\r\n * The current stencil level. This can change dynamically at runtime\r\n * and is set in the applyStencil method.\r\n *\r\n * @name Phaser.Display.Masks.GeometryMask#level\r\n * @type {boolean}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "GeometryMask.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "The current stencil level. This can change dynamically at runtime\rand is set in the applyStencil method.", "name": "level", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.17.0", "memberof": "Phaser.Display.Masks.GeometryMask", "longname": "Phaser.Display.Masks.GeometryMask#level", "scope": "instance", "kind": "member", "___id": "T000002R005887", "___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": 83, "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": "T000002R005889", "___s": true }, { "comment": "/**\r\n * Sets the `invertAlpha` property of this Geometry Mask.\r\n *\r\n * Inverting the alpha essentially flips the way the mask works.\r\n *\r\n * This is a WebGL only feature.\r\n *\r\n * @method Phaser.Display.Masks.GeometryMask#setInvertAlpha\r\n * @since 3.17.0\r\n *\r\n * @param {boolean} [value=true] - Invert the alpha of this mask?\r\n *\r\n * @return {this} This Geometry Mask\r\n */", "meta": { "filename": "GeometryMask.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "Sets the `invertAlpha` property of this Geometry Mask.\r\rInverting the alpha essentially flips the way the mask works.\r\rThis is a WebGL only feature.", "kind": "function", "name": "setInvertAlpha", "since": "3.17.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Invert the alpha of this mask?", "name": "value" } ], "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#setInvertAlpha", "scope": "instance", "___id": "T000002R005892", "___s": true }, { "comment": "/**\r\n * Renders the Geometry Mask's underlying Graphics object to the OpenGL stencil buffer and enables the stencil test, which clips rendered pixels according to the mask.\r\n *\r\n * @method Phaser.Display.Masks.GeometryMask#preRenderWebGL\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - The WebGL Renderer instance to draw to.\r\n * @param {Phaser.GameObjects.GameObject} child - 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": 123, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "Renders the Geometry Mask's underlying Graphics object to the OpenGL stencil buffer and enables the stencil test, which clips rendered pixels according to the mask.", "kind": "function", "name": "preRenderWebGL", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "description": "The WebGL Renderer instance to draw to.", "name": "renderer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered.", "name": "child" }, { "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#preRenderWebGL", "scope": "instance", "___id": "T000002R005896", "___s": true }, { "comment": "/**\r\n * Applies the current stencil mask to the renderer.\r\n *\r\n * @method Phaser.Display.Masks.GeometryMask#applyStencil\r\n * @since 3.17.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - The WebGL Renderer instance to draw to.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera the Game Object is being rendered through.\r\n * @param {boolean} inc - Is this an INCR stencil or a DECR stencil?\r\n */", "meta": { "filename": "GeometryMask.js", "lineno": 160, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "Applies the current stencil mask to the renderer.", "kind": "function", "name": "applyStencil", "since": "3.17.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "description": "The WebGL Renderer instance to draw to.", "name": "renderer" }, { "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" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this an INCR stencil or a DECR stencil?", "name": "inc" } ], "memberof": "Phaser.Display.Masks.GeometryMask", "longname": "Phaser.Display.Masks.GeometryMask#applyStencil", "scope": "instance", "___id": "T000002R005903", "___s": true }, { "comment": "/**\r\n * Flushes all rendered pixels and disables the stencil test of a WebGL context, thus disabling the mask for it.\r\n *\r\n * @method Phaser.Display.Masks.GeometryMask#postRenderWebGL\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - The WebGL Renderer instance to draw flush.\r\n */", "meta": { "filename": "GeometryMask.js", "lineno": 213, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "Flushes all rendered pixels and disables the stencil test of a WebGL context, thus disabling the mask for it.", "kind": "function", "name": "postRenderWebGL", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "description": "The WebGL Renderer instance to draw flush.", "name": "renderer" } ], "memberof": "Phaser.Display.Masks.GeometryMask", "longname": "Phaser.Display.Masks.GeometryMask#postRenderWebGL", "scope": "instance", "___id": "T000002R005910", "___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": 259, "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": "T000002R005919", "___s": true }, { "comment": "/**\r\n * Restore 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": 280, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "Restore the canvas context's previous clipping path, thus turning off the mask for it.", "kind": "function", "name": "postRenderCanvas", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Renderer.Canvas.CanvasRenderer" ], "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": "T000002R005922", "___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": 293, "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": "T000002R005924", "___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": "T000002R005928", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The RGB class holds a single color value and allows for easy modification and reading of it,\r\n * with optional on-change callback notification and a dirty flag.\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 and allows for easy modification and reading of it,\rwith optional on-change callback notification and a dirty flag.", "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": "T000002R005934", "___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 is sent the new color values as the parameters.\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": 40, "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 is sent the new color values as the parameters.", "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": "T000002R005939", "___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": 51, "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": "T000002R005941", "___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": 63, "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": "T000002R005943", "___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": 89, "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": "T000002R005949", "___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": 109, "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": "T000002R005952", "___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": 126, "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": "T000002R005956", "___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": 151, "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": "T000002R005961", "___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": 176, "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": "T000002R005966", "___s": true }, { "comment": "/**\r\n * Nulls any external references this object contains.\r\n *\r\n * @method Phaser.Display.RGB#destroy\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RGB.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Nulls any external references this object contains.", "kind": "function", "name": "destroy", "since": "3.50.0", "memberof": "Phaser.Display.RGB", "longname": "Phaser.Display.RGB#destroy", "scope": "instance", "___id": "T000002R005971", "___s": true }, { "comment": "/**\n * @classdesc\n * A BaseShader is a small resource class that contains the data required for a WebGL Shader to be created.\n *\n * It contains the raw source code to the fragment and vertex shader, as well as an object that defines\n * the uniforms the shader requires, if any.\n *\n * BaseShaders are stored in the Shader Cache, available in a Scene via `this.cache.shaders` and are referenced\n * by a unique key-based string. Retrieve them via `this.cache.shaders.get(key)`.\n *\n * BaseShaders are created automatically by the GLSL File Loader when loading an external shader resource.\n * They can also be created at runtime, allowing you to use dynamically generated shader source code.\n *\n * Default fragment and vertex source is used if not provided in the constructor, setting-up a basic shader,\n * suitable for debug rendering.\n *\n * @class BaseShader\n * @memberof Phaser.Display\n * @constructor\n * @since 3.17.0\n *\n * @param {string} key - The key of this shader. Must be unique within the shader cache.\n * @param {string} [fragmentSrc] - The fragment source for the shader.\n * @param {string} [vertexSrc] - The vertex source for the shader.\n * @param {any} [uniforms] - Optional object defining the uniforms the shader uses.\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 the data required for a WebGL Shader to be created.\n\nIt contains the raw source code to the fragment and vertex shader, as well as an object that defines\nthe uniforms the shader requires, if any.\n\nBaseShaders are stored in the Shader Cache, available in a Scene via `this.cache.shaders` and are referenced\nby a unique key-based string. Retrieve them via `this.cache.shaders.get(key)`.\n\nBaseShaders are created automatically by the GLSL File Loader when loading an external shader resource.\nThey can also be created at runtime, allowing you to use dynamically generated shader source code.\n\nDefault fragment and vertex source is used if not provided in the constructor, setting-up a basic shader,\nsuitable for debug rendering.", "kind": "class", "name": "BaseShader", "memberof": "Phaser.Display", "since": "3.17.0", "params": [ { "type": { "names": [ "string" ], "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" } }, "optional": true, "description": "The fragment source for the shader.", "name": "fragmentSrc" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The vertex source for the shader.", "name": "vertexSrc" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Optional object defining the uniforms the shader uses.", "name": "uniforms" } ], "scope": "static", "longname": "Phaser.Display.BaseShader", "___id": "T000002R005976", "___s": true }, { "comment": "/**\n * The key of this shader, unique within the shader cache of this Phaser game instance.\n *\n * @name Phaser.Display.BaseShader#key\n * @type {string}\n * @since 3.17.0\n */", "meta": { "filename": "BaseShader.js", "lineno": 81, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display\\shader", "code": {} }, "description": "The key of this shader, unique 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": "T000002R005982", "___s": true }, { "comment": "/**\n * The source code, as a string, of the fragment shader being used.\n *\n * @name Phaser.Display.BaseShader#fragmentSrc\n * @type {string}\n * @since 3.17.0\n */", "meta": { "filename": "BaseShader.js", "lineno": 90, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display\\shader", "code": {} }, "description": "The source code, as a string, of the fragment shader being used.", "name": "fragmentSrc", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.17.0", "memberof": "Phaser.Display.BaseShader", "longname": "Phaser.Display.BaseShader#fragmentSrc", "scope": "instance", "kind": "member", "___id": "T000002R005984", "___s": true }, { "comment": "/**\n * The source code, as a string, of the vertex shader being used.\n *\n * @name Phaser.Display.BaseShader#vertexSrc\n * @type {string}\n * @since 3.17.0\n */", "meta": { "filename": "BaseShader.js", "lineno": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display\\shader", "code": {} }, "description": "The source code, as a string, of the vertex shader being used.", "name": "vertexSrc", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.17.0", "memberof": "Phaser.Display.BaseShader", "longname": "Phaser.Display.BaseShader#vertexSrc", "scope": "instance", "kind": "member", "___id": "T000002R005986", "___s": true }, { "comment": "/**\n * The default uniforms for this shader.\n *\n * @name Phaser.Display.BaseShader#uniforms\n * @type {?any}\n * @since 3.17.0\n */", "meta": { "filename": "BaseShader.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display\\shader", "code": {} }, "description": "The default uniforms for this shader.", "name": "uniforms", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "nullable": true } }, "nullable": true, "since": "3.17.0", "memberof": "Phaser.Display.BaseShader", "longname": "Phaser.Display.BaseShader#uniforms", "scope": "instance", "kind": "member", "___id": "T000002R005988", "___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": "T000002R005991", "___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": "T000002R005992", "___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": "T000002R005993", "___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": "T000002R005994", "___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, providing it was able to access it.\r\n * If no parent was given it falls back to using `document.body`.\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 added to the DOM.\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, providing it was able to access it.\rIf no parent was given it falls back to using `document.body`.", "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 added to the DOM." } ], "memberof": "Phaser.DOM", "longname": "Phaser.DOM.AddToDOM", "scope": "static", "___id": "T000002R005995", "___s": true }, { "comment": "/**\r\n * @callback ContentLoadedCallback\r\n */", "meta": { "filename": "DOMContentLoaded.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "kind": "typedef", "name": "ContentLoadedCallback", "type": { "names": [ "function" ] }, "longname": "ContentLoadedCallback", "scope": "global", "___id": "T000002R006010", "___s": true }, { "comment": "/**\r\n * Inspects the readyState of the document. If the document is already complete then it invokes the given callback.\r\n * If not complete it sets up several event listeners such as `deviceready`, and once those fire, it invokes 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": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "Inspects the readyState of the document. If the document is already complete then it invokes the given callback.\rIf not complete it sets up several event listeners such as `deviceready`, and once those fire, it invokes 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": "T000002R006011", "___s": true }, { "comment": "/**\r\n * Attempts to determine the document inner height across iOS and standard devices.\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 value.\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.\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 value." } ], "memberof": "Phaser.DOM", "longname": "Phaser.DOM.GetInnerHeight", "scope": "static", "___id": "T000002R006015", "___s": true }, { "comment": "/**\r\n * Attempts to determine the screen orientation using the Orientation API.\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} The orientation.\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 the Orientation API.", "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": "The orientation." } ], "memberof": "Phaser.DOM", "longname": "Phaser.DOM.GetScreenOrientation", "scope": "static", "___id": "T000002R006027", "___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.\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.", "name": "element" } ], "memberof": "Phaser.DOM", "longname": "Phaser.DOM.GetTarget", "scope": "static", "___id": "T000002R006032", "___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": "T000002R006039", "___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 {?(DOMParser|ActiveXObject)} 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": [ "DOMParser", "ActiveXObject" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "DOMParser" }, { "type": "NameExpression", "name": "ActiveXObject" } ], "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": "T000002R006050", "___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": "T000002R006058", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Abstracts away the use of RAF or setTimeOut for the core game update loop.\r\n *\r\n * This is invoked 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 RAF or setTimeOut for the core game update loop.\r\rThis is invoked automatically by the Phaser.Game instance.", "kind": "class", "name": "RequestAnimationFrame", "memberof": "Phaser.DOM", "since": "3.0.0", "scope": "static", "longname": "Phaser.DOM.RequestAnimationFrame", "___id": "T000002R006063", "___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": 27, "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": "T000002R006066", "___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": 37, "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": "T000002R006068", "___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": 46, "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": "T000002R006070", "___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": 56, "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": "T000002R006072", "___s": true }, { "comment": "/**\r\n * The delay rate in ms for 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": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "The delay rate in ms for 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": "T000002R006074", "___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": 78, "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": "T000002R006077", "___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": 99, "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": "T000002R006080", "___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 setTimeout delay rate in ms.\r\n */", "meta": { "filename": "RequestAnimationFrame.js", "lineno": 120, "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 setTimeout delay rate in ms.", "name": "delay" } ], "memberof": "Phaser.DOM.RequestAnimationFrame", "longname": "Phaser.DOM.RequestAnimationFrame#start", "scope": "instance", "___id": "T000002R006083", "___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": 148, "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": "T000002R006090", "___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": 168, "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": "T000002R006093", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * EventEmitter is a Scene Systems plugin compatible version of eventemitter3.\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 version of eventemitter3.", "kind": "class", "name": "EventEmitter", "memberof": "Phaser.Events", "since": "3.0.0", "scope": "static", "longname": "Phaser.Events.EventEmitter", "___id": "T000002R006100", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "description": "Removes all listeners.", "kind": "function", "name": "shutdown", "since": "3.0.0", "memberof": "Phaser.Events.EventEmitter", "longname": "Phaser.Events.EventEmitter#shutdown", "scope": "instance", "___id": "T000002R006104", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "description": "Removes all listeners.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Events.EventEmitter", "longname": "Phaser.Events.EventEmitter#destroy", "scope": "instance", "___id": "T000002R006106", "___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": 55, "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": "T000002R006108", "___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": 64, "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": "T000002R006109", "___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": 75, "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": "T000002R006110", "___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": 86, "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": "T000002R006111", "___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": 98, "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": "T000002R006112", "___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": 111, "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": "T000002R006113", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "description": "Add a one-time listener for a given event.", "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": "T000002R006114", "___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": 137, "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": "T000002R006115", "___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": 151, "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": "T000002R006116", "___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": 165, "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": "T000002R006117", "___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": "T000002R006119", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Barrel FX Controller.\r\n *\r\n * This FX controller manages the barrel distortion effect for a Game Object.\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 * A Barrel effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.preFX.addBarrel();\r\n * sprite.postFX.addBarrel();\r\n * ```\r\n *\r\n * @class Barrel\r\n * @extends Phaser.FX.Controller\r\n * @memberof Phaser.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A reference to the Game Object that has this fx.\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": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "classdesc": "The Barrel FX Controller.\r\rThis FX controller manages the barrel distortion effect for a Game Object.\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.\r\rA Barrel effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.preFX.addBarrel();\rsprite.postFX.addBarrel();\r```", "kind": "class", "name": "Barrel", "augments": [ "Phaser.FX.Controller" ], "memberof": "Phaser.FX", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A reference to the Game Object that has this fx.", "name": "gameObject" }, { "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.FX.Barrel", "___id": "T000002R006125", "___s": true }, { "comment": "/**\r\n * The amount of distortion applied to the barrel effect.\r\n *\r\n * Typically keep this within the range 1 (no distortion) to +- 1.\r\n *\r\n * @name Phaser.FX.Barrel#amount\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Barrel.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The amount of distortion applied to the barrel effect.\r\rTypically keep this within the range 1 (no distortion) to +- 1.", "name": "amount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Barrel", "longname": "Phaser.FX.Barrel#amount", "scope": "instance", "kind": "member", "___id": "T000002R006130", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Bloom FX Controller.\r\n *\r\n * This FX controller manages the bloom effect for a Game Object.\r\n *\r\n * Bloom is an effect used to reproduce an imaging artifact of real-world cameras.\r\n * The effect produces fringes of light extending from the borders of bright areas in an image,\r\n * contributing to the illusion of an extremely bright light overwhelming the\r\n * camera or eye capturing the scene.\r\n *\r\n * A Bloom effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.preFX.addBloom();\r\n * sprite.postFX.addBloom();\r\n * ```\r\n *\r\n * @class Bloom\r\n * @extends Phaser.FX.Controller\r\n * @memberof Phaser.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A reference to the Game Object that has this fx.\r\n * @param {number} [color=0xffffff] - The color of the Bloom, as a hex value.\r\n * @param {number} [offsetX=1] - The horizontal offset of the bloom effect.\r\n * @param {number} [offsetY=1] - The vertical offset of the bloom effect.\r\n * @param {number} [blurStrength=1] - The strength of the blur process of the bloom effect.\r\n * @param {number} [strength=1] - The strength of the blend process of the bloom effect.\r\n * @param {number} [steps=4] - The number of steps to run the Bloom effect for. This value should always be an integer.\r\n */", "meta": { "filename": "Bloom.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "classdesc": "The Bloom FX Controller.\r\rThis FX controller manages the bloom effect for a Game Object.\r\rBloom is an effect used to reproduce an imaging artifact of real-world cameras.\rThe effect produces fringes of light extending from the borders of bright areas in an image,\rcontributing to the illusion of an extremely bright light overwhelming the\rcamera or eye capturing the scene.\r\rA Bloom effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.preFX.addBloom();\rsprite.postFX.addBloom();\r```", "kind": "class", "name": "Bloom", "augments": [ "Phaser.FX.Controller" ], "memberof": "Phaser.FX", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A reference to the Game Object that has this fx.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color of the Bloom, as a hex value.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The horizontal offset of the bloom effect.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The vertical offset of the bloom effect.", "name": "offsetY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blur process of the bloom effect.", "name": "blurStrength" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend process of the bloom effect.", "name": "strength" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 4, "description": "The number of steps to run the Bloom effect for. This value should always be an integer.", "name": "steps" } ], "scope": "static", "longname": "Phaser.FX.Bloom", "___id": "T000002R006136", "___s": true }, { "comment": "/**\r\n * The number of steps to run the Bloom effect for.\r\n *\r\n * This value should always be an integer.\r\n *\r\n * It defaults to 4. The higher the value, the smoother the Bloom,\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.FX.Bloom#steps\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Bloom.js", "lineno": 61, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The number of steps to run the Bloom effect for.\r\rThis value should always be an integer.\r\rIt defaults to 4. The higher the value, the smoother the Bloom,\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" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bloom", "longname": "Phaser.FX.Bloom#steps", "scope": "instance", "kind": "member", "___id": "T000002R006145", "___s": true }, { "comment": "/**\r\n * The horizontal offset of the bloom effect.\r\n *\r\n * @name Phaser.FX.Bloom#offsetX\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Bloom.js", "lineno": 78, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The horizontal offset of the bloom effect.", "name": "offsetX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bloom", "longname": "Phaser.FX.Bloom#offsetX", "scope": "instance", "kind": "member", "___id": "T000002R006147", "___s": true }, { "comment": "/**\r\n * The vertical offset of the bloom effect.\r\n *\r\n * @name Phaser.FX.Bloom#offsetY\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Bloom.js", "lineno": 87, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The vertical offset of the bloom effect.", "name": "offsetY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bloom", "longname": "Phaser.FX.Bloom#offsetY", "scope": "instance", "kind": "member", "___id": "T000002R006149", "___s": true }, { "comment": "/**\r\n * The strength of the blur process of the bloom effect.\r\n *\r\n * @name Phaser.FX.Bloom#blurStrength\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Bloom.js", "lineno": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The strength of the blur process of the bloom effect.", "name": "blurStrength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bloom", "longname": "Phaser.FX.Bloom#blurStrength", "scope": "instance", "kind": "member", "___id": "T000002R006151", "___s": true }, { "comment": "/**\r\n * The strength of the blend process of the bloom effect.\r\n *\r\n * @name Phaser.FX.Bloom#strength\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Bloom.js", "lineno": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The strength of the blend process of the bloom effect.", "name": "strength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bloom", "longname": "Phaser.FX.Bloom#strength", "scope": "instance", "kind": "member", "___id": "T000002R006153", "___s": true }, { "comment": "/**\r\n * The internal gl color array.\r\n *\r\n * @name Phaser.FX.Bloom#glcolor\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Bloom.js", "lineno": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "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": "3.60.0", "memberof": "Phaser.FX.Bloom", "longname": "Phaser.FX.Bloom#glcolor", "scope": "instance", "kind": "member", "___id": "T000002R006155", "___s": true }, { "comment": "/**\r\n * The color of the bloom as a number value.\r\n *\r\n * @name Phaser.FX.Bloom#color\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Bloom.js", "lineno": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The color of the bloom as a number value.", "name": "color", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bloom", "longname": "Phaser.FX.Bloom#color", "scope": "instance", "kind": "member", "___id": "T000002R006158", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Blur FX Controller.\r\n *\r\n * This FX controller manages the blur effect for a Game Object.\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 * A Blur effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.preFX.addBlur();\r\n * sprite.postFX.addBlur();\r\n * ```\r\n *\r\n * @class Blur\r\n * @extends Phaser.FX.Controller\r\n * @memberof Phaser.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A reference to the Game Object that has this fx.\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": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "classdesc": "The Blur FX Controller.\r\rThis FX controller manages the blur effect for a Game Object.\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\rA Blur effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.preFX.addBlur();\rsprite.postFX.addBlur();\r```", "kind": "class", "name": "Blur", "augments": [ "Phaser.FX.Controller" ], "memberof": "Phaser.FX", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A reference to the Game Object that has this fx.", "name": "gameObject" }, { "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.FX.Blur", "___id": "T000002R006171", "___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 shader is 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.FX.Blur#quality\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Blur.js", "lineno": 61, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "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 shader is 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" } }, "since": "3.60.0", "memberof": "Phaser.FX.Blur", "longname": "Phaser.FX.Blur#quality", "scope": "instance", "kind": "member", "___id": "T000002R006180", "___s": true }, { "comment": "/**\r\n * The horizontal offset of the blur effect.\r\n *\r\n * @name Phaser.FX.Blur#x\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Blur.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The horizontal offset of the blur effect.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Blur", "longname": "Phaser.FX.Blur#x", "scope": "instance", "kind": "member", "___id": "T000002R006182", "___s": true }, { "comment": "/**\r\n * The vertical offset of the blur effect.\r\n *\r\n * @name Phaser.FX.Blur#y\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Blur.js", "lineno": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The vertical offset of the blur effect.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Blur", "longname": "Phaser.FX.Blur#y", "scope": "instance", "kind": "member", "___id": "T000002R006184", "___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 * It defaults to 4. 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.FX.Blur#steps\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Blur.js", "lineno": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The number of steps to run the Blur effect for.\r\rThis value should always be an integer.\r\rIt defaults to 4. The 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" } }, "since": "3.60.0", "memberof": "Phaser.FX.Blur", "longname": "Phaser.FX.Blur#steps", "scope": "instance", "kind": "member", "___id": "T000002R006186", "___s": true }, { "comment": "/**\r\n * The strength of the blur effect.\r\n *\r\n * @name Phaser.FX.Blur#strength\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Blur.js", "lineno": 119, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The strength of the blur effect.", "name": "strength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Blur", "longname": "Phaser.FX.Blur#strength", "scope": "instance", "kind": "member", "___id": "T000002R006188", "___s": true }, { "comment": "/**\r\n * The internal gl color array.\r\n *\r\n * @name Phaser.FX.Blur#glcolor\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Blur.js", "lineno": 128, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "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": "3.60.0", "memberof": "Phaser.FX.Blur", "longname": "Phaser.FX.Blur#glcolor", "scope": "instance", "kind": "member", "___id": "T000002R006190", "___s": true }, { "comment": "/**\r\n * The color of the blur as a number value.\r\n *\r\n * @name Phaser.FX.Blur#color\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Blur.js", "lineno": 143, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The color of the blur as a number value.", "name": "color", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Blur", "longname": "Phaser.FX.Blur#color", "scope": "instance", "kind": "member", "___id": "T000002R006193", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Bokeh FX Controller.\r\n *\r\n * This FX controller manages the bokeh effect for a Game Object.\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 * A Bokeh effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.preFX.addBokeh();\r\n * sprite.postFX.addBokeh();\r\n * ```\r\n *\r\n * @class Bokeh\r\n * @extends Phaser.FX.Controller\r\n * @memberof Phaser.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A reference to the Game Object that has this fx.\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 Tile 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": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "classdesc": "The Bokeh FX Controller.\r\rThis FX controller manages the bokeh effect for a Game Object.\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\rA Bokeh effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.preFX.addBokeh();\rsprite.postFX.addBokeh();\r```", "kind": "class", "name": "Bokeh", "augments": [ "Phaser.FX.Controller" ], "memberof": "Phaser.FX", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A reference to the Game Object that has this fx.", "name": "gameObject" }, { "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 Tile 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.FX.Bokeh", "___id": "T000002R006206", "___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.FX.Bokeh#radius\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Bokeh.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "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" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bokeh", "longname": "Phaser.FX.Bokeh#radius", "scope": "instance", "kind": "member", "___id": "T000002R006217", "___s": true }, { "comment": "/**\r\n * The amount, or strength, of the bokeh effect. Defaults to 1.\r\n *\r\n * @name Phaser.FX.Bokeh#amount\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Bokeh.js", "lineno": 81, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The amount, or strength, of the bokeh effect. Defaults to 1.", "name": "amount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bokeh", "longname": "Phaser.FX.Bokeh#amount", "scope": "instance", "kind": "member", "___id": "T000002R006219", "___s": true }, { "comment": "/**\r\n * The color contrast, or brightness, of the bokeh effect. Defaults to 0.2.\r\n *\r\n * @name Phaser.FX.Bokeh#contrast\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Bokeh.js", "lineno": 90, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The color contrast, or brightness, of the bokeh effect. Defaults to 0.2.", "name": "contrast", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bokeh", "longname": "Phaser.FX.Bokeh#contrast", "scope": "instance", "kind": "member", "___id": "T000002R006221", "___s": true }, { "comment": "/**\r\n * Is this a Tilt Shift effect or a standard bokeh effect?\r\n *\r\n * @name Phaser.FX.Bokeh#isTiltShift\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Bokeh.js", "lineno": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "Is this a Tilt Shift effect or a standard bokeh effect?", "name": "isTiltShift", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bokeh", "longname": "Phaser.FX.Bokeh#isTiltShift", "scope": "instance", "kind": "member", "___id": "T000002R006223", "___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.FX.Bokeh#strength\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Bokeh.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "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" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bokeh", "longname": "Phaser.FX.Bokeh#strength", "scope": "instance", "kind": "member", "___id": "T000002R006225", "___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.FX.Bokeh#blurX\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Bokeh.js", "lineno": 119, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "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" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bokeh", "longname": "Phaser.FX.Bokeh#blurX", "scope": "instance", "kind": "member", "___id": "T000002R006227", "___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.FX.Bokeh#blurY\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Bokeh.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "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" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bokeh", "longname": "Phaser.FX.Bokeh#blurY", "scope": "instance", "kind": "member", "___id": "T000002R006229", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Circle FX Controller.\r\n *\r\n * This FX controller manages the circle effect for a Game Object.\r\n *\r\n * This effect will draw a circle around the texture of the Game Object, effectively masking off\r\n * any area outside of the circle without the need for an actual mask. You can control the thickness\r\n * of the circle, the color of the circle and the color of the background, should the texture be\r\n * transparent. You can also control the feathering applied to the circle, allowing for a harsh or soft edge.\r\n *\r\n * Please note that adding this effect to a Game Object will not change the input area or physics body of\r\n * the Game Object, should it have one.\r\n *\r\n * A Circle effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.preFX.addCircle();\r\n * sprite.postFX.addCircle();\r\n * ```\r\n *\r\n * @class Circle\r\n * @extends Phaser.FX.Controller\r\n * @memberof Phaser.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A reference to the Game Object that has this fx.\r\n * @param {number} [thickness=8] - The width of the circle around the texture, in pixels.\r\n * @param {number} [color=0xfeedb6] - The color of the circular ring, given as a number value.\r\n * @param {number} [backgroundColor=0xff0000] - The color of the background, behind the texture, given as a number value.\r\n * @param {number} [scale=1] - The scale of the circle. The default scale is 1, which is a circle the full size of the underlying texture.\r\n * @param {number} [feather=0.005] - The amount of feathering to apply to the circle from the ring.\r\n */", "meta": { "filename": "Circle.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "classdesc": "The Circle FX Controller.\r\rThis FX controller manages the circle effect for a Game Object.\r\rThis effect will draw a circle around the texture of the Game Object, effectively masking off\rany area outside of the circle without the need for an actual mask. You can control the thickness\rof the circle, the color of the circle and the color of the background, should the texture be\rtransparent. You can also control the feathering applied to the circle, allowing for a harsh or soft edge.\r\rPlease note that adding this effect to a Game Object will not change the input area or physics body of\rthe Game Object, should it have one.\r\rA Circle effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.preFX.addCircle();\rsprite.postFX.addCircle();\r```", "kind": "class", "name": "Circle", "augments": [ "Phaser.FX.Controller" ], "memberof": "Phaser.FX", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A reference to the Game Object that has this fx.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 8, "description": "The width of the circle around the texture, in pixels.", "name": "thickness" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xfeedb6", "description": "The color of the circular ring, given as a number value.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xff0000", "description": "The color of the background, behind the texture, given as a number value.", "name": "backgroundColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The scale of the circle. The default scale is 1, which is a circle the full size of the underlying texture.", "name": "scale" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.005, "description": "The amount of feathering to apply to the circle from the ring.", "name": "feather" } ], "scope": "static", "longname": "Phaser.FX.Circle", "___id": "T000002R006235", "___s": true }, { "comment": "/**\r\n * The scale of the circle. The default scale is 1, which is a circle\r\n * the full size of the underlying texture. Reduce this value to create\r\n * a smaller circle, or increase it to create a circle that extends off\r\n * the edges of the texture.\r\n *\r\n * @name Phaser.FX.Circle#scale\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 61, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The scale of the circle. The default scale is 1, which is a circle\rthe full size of the underlying texture. Reduce this value to create\ra smaller circle, or increase it to create a circle that extends off\rthe edges of the texture.", "name": "scale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Circle", "longname": "Phaser.FX.Circle#scale", "scope": "instance", "kind": "member", "___id": "T000002R006242", "___s": true }, { "comment": "/**\r\n * The amount of feathering to apply to the circle from the ring,\r\n * extending into the middle of the circle. The default is 0.005,\r\n * which is a very low amount of feathering just making sure the ring\r\n * has a smooth edge. Increase this amount to a value such as 0.5\r\n * or 0.025 for larger amounts of feathering.\r\n *\r\n * @name Phaser.FX.Circle#feather\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The amount of feathering to apply to the circle from the ring,\rextending into the middle of the circle. The default is 0.005,\rwhich is a very low amount of feathering just making sure the ring\rhas a smooth edge. Increase this amount to a value such as 0.5\ror 0.025 for larger amounts of feathering.", "name": "feather", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Circle", "longname": "Phaser.FX.Circle#feather", "scope": "instance", "kind": "member", "___id": "T000002R006244", "___s": true }, { "comment": "/**\r\n * The width of the circle around the texture, in pixels. This value\r\n * doesn't factor in the feather, which can extend the thickness\r\n * internally depending on its value.\r\n *\r\n * @name Phaser.FX.Circle#thickness\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The width of the circle around the texture, in pixels. This value\rdoesn't factor in the feather, which can extend the thickness\rinternally depending on its value.", "name": "thickness", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Circle", "longname": "Phaser.FX.Circle#thickness", "scope": "instance", "kind": "member", "___id": "T000002R006246", "___s": true }, { "comment": "/**\r\n * The internal gl color array for the ring color.\r\n *\r\n * @name Phaser.FX.Circle#glcolor\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The internal gl color array for the ring color.", "name": "glcolor", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.FX.Circle", "longname": "Phaser.FX.Circle#glcolor", "scope": "instance", "kind": "member", "___id": "T000002R006248", "___s": true }, { "comment": "/**\r\n * The internal gl color array for the background color.\r\n *\r\n * @name Phaser.FX.Circle#glcolor2\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 106, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The internal gl color array for the background color.", "name": "glcolor2", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.FX.Circle", "longname": "Phaser.FX.Circle#glcolor2", "scope": "instance", "kind": "member", "___id": "T000002R006250", "___s": true }, { "comment": "/**\r\n * The color of the circular ring, given as a number value.\r\n *\r\n * @name Phaser.FX.Circle#color\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 126, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The color of the circular ring, given as a number value.", "name": "color", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Circle", "longname": "Phaser.FX.Circle#color", "scope": "instance", "kind": "member", "___id": "T000002R006254", "___s": true }, { "comment": "/**\r\n * The color of the background, behind the texture, given as a number value.\r\n *\r\n * @name Phaser.FX.Circle#backgroundColor\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 153, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The color of the background, behind the texture, given as a number value.", "name": "backgroundColor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Circle", "longname": "Phaser.FX.Circle#backgroundColor", "scope": "instance", "kind": "member", "___id": "T000002R006263", "___s": true }, { "comment": "/**\r\n * The alpha of the background, behind the texture, given as a number value.\r\n *\r\n * @name Phaser.FX.Circle#backgroundAlpha\r\n * @type {number}\r\n * @since 3.61.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 180, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The alpha of the background, behind the texture, given as a number value.", "name": "backgroundAlpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.61.0", "memberof": "Phaser.FX.Circle", "longname": "Phaser.FX.Circle#backgroundAlpha", "scope": "instance", "kind": "member", "___id": "T000002R006272", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The ColorMatrix FX Controller.\r\n *\r\n * This FX controller manages the color matrix effect for a Game Object.\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 Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.preFX.addColorMatrix();\r\n * sprite.postFX.addColorMatrix();\r\n * ```\r\n *\r\n * @class ColorMatrix\r\n * @extends Phaser.Display.ColorMatrix\r\n * @memberof Phaser.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A reference to the Game Object that has this fx.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "classdesc": "The ColorMatrix FX Controller.\r\rThis FX controller manages the color matrix effect for a Game Object.\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 Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.preFX.addColorMatrix();\rsprite.postFX.addColorMatrix();\r```", "kind": "class", "name": "ColorMatrix", "augments": [ "Phaser.Display.ColorMatrix" ], "memberof": "Phaser.FX", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A reference to the Game Object that has this fx.", "name": "gameObject" } ], "scope": "static", "longname": "Phaser.FX.ColorMatrix", "___id": "T000002R006281", "___s": true }, { "comment": "/**\r\n * The FX_CONST type of this effect.\r\n *\r\n * @name Phaser.FX.ColorMatrix#type\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The FX_CONST type of this effect.", "name": "type", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.ColorMatrix", "longname": "Phaser.FX.ColorMatrix#type", "scope": "instance", "kind": "member", "___id": "T000002R006285", "___s": true }, { "comment": "/**\r\n * A reference to the Game Object that owns this effect.\r\n *\r\n * @name Phaser.FX.ColorMatrix#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "A reference to the Game Object that owns this effect.", "name": "gameObject", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.60.0", "memberof": "Phaser.FX.ColorMatrix", "longname": "Phaser.FX.ColorMatrix#gameObject", "scope": "instance", "kind": "member", "___id": "T000002R006287", "___s": true }, { "comment": "/**\r\n * Toggle this boolean to enable or disable this effect,\r\n * without removing and adding it from the Game Object.\r\n *\r\n * @name Phaser.FX.ColorMatrix#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "Toggle this boolean to enable or disable this effect,\rwithout removing and adding it from the Game Object.", "name": "active", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.ColorMatrix", "longname": "Phaser.FX.ColorMatrix#active", "scope": "instance", "kind": "member", "___id": "T000002R006289", "___s": true }, { "comment": "/**\r\n * The Glow FX.\r\n *\r\n * @name Phaser.FX.GLOW\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 9, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The Glow FX.", "name": "GLOW", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.FX", "longname": "Phaser.FX.GLOW", "scope": "static", "___id": "T000002R006297", "___s": true }, { "comment": "/**\r\n * The Shadow FX.\r\n *\r\n * @name Phaser.FX.SHADOW\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The Shadow FX.", "name": "SHADOW", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.FX", "longname": "Phaser.FX.SHADOW", "scope": "static", "___id": "T000002R006299", "___s": true }, { "comment": "/**\r\n * The Pixelate FX.\r\n *\r\n * @name Phaser.FX.PIXELATE\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 29, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The Pixelate FX.", "name": "PIXELATE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.FX", "longname": "Phaser.FX.PIXELATE", "scope": "static", "___id": "T000002R006301", "___s": true }, { "comment": "/**\r\n * The Vignette FX.\r\n *\r\n * @name Phaser.FX.VIGNETTE\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 39, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The Vignette FX.", "name": "VIGNETTE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.FX", "longname": "Phaser.FX.VIGNETTE", "scope": "static", "___id": "T000002R006303", "___s": true }, { "comment": "/**\r\n * The Shine FX.\r\n *\r\n * @name Phaser.FX.SHINE\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The Shine FX.", "name": "SHINE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.FX", "longname": "Phaser.FX.SHINE", "scope": "static", "___id": "T000002R006305", "___s": true }, { "comment": "/**\r\n * The Blur FX.\r\n *\r\n * @name Phaser.FX.BLUR\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 59, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The Blur FX.", "name": "BLUR", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.FX", "longname": "Phaser.FX.BLUR", "scope": "static", "___id": "T000002R006307", "___s": true }, { "comment": "/**\r\n * The Gradient FX.\r\n *\r\n * @name Phaser.FX.GRADIENT\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 69, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The Gradient FX.", "name": "GRADIENT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.FX", "longname": "Phaser.FX.GRADIENT", "scope": "static", "___id": "T000002R006309", "___s": true }, { "comment": "/**\r\n * The Bloom FX.\r\n *\r\n * @name Phaser.FX.BLOOM\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The Bloom FX.", "name": "BLOOM", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.FX", "longname": "Phaser.FX.BLOOM", "scope": "static", "___id": "T000002R006311", "___s": true }, { "comment": "/**\r\n * The Color Matrix FX.\r\n *\r\n * @name Phaser.FX.COLOR_MATRIX\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 89, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The Color Matrix FX.", "name": "COLOR_MATRIX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.FX", "longname": "Phaser.FX.COLOR_MATRIX", "scope": "static", "___id": "T000002R006313", "___s": true }, { "comment": "/**\r\n * The Circle FX.\r\n *\r\n * @name Phaser.FX.CIRCLE\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 99, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The Circle FX.", "name": "CIRCLE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.FX", "longname": "Phaser.FX.CIRCLE", "scope": "static", "___id": "T000002R006315", "___s": true }, { "comment": "/**\r\n * The Barrel FX.\r\n *\r\n * @name Phaser.FX.BARREL\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 109, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The Barrel FX.", "name": "BARREL", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.FX", "longname": "Phaser.FX.BARREL", "scope": "static", "___id": "T000002R006317", "___s": true }, { "comment": "/**\r\n * The Displacement FX.\r\n *\r\n * @name Phaser.FX.DISPLACEMENT\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 119, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The Displacement FX.", "name": "DISPLACEMENT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.FX", "longname": "Phaser.FX.DISPLACEMENT", "scope": "static", "___id": "T000002R006319", "___s": true }, { "comment": "/**\r\n * The Wipe FX.\r\n *\r\n * @name Phaser.FX.WIPE\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The Wipe FX.", "name": "WIPE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.FX", "longname": "Phaser.FX.WIPE", "scope": "static", "___id": "T000002R006321", "___s": true }, { "comment": "/**\r\n * The Bokeh and Tilt Shift FX.\r\n *\r\n * @name Phaser.FX.BOKEH\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The Bokeh and Tilt Shift FX.", "name": "BOKEH", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.FX", "longname": "Phaser.FX.BOKEH", "scope": "static", "___id": "T000002R006323", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * FX Controller is the base class that all built-in FX use.\r\n *\r\n * You should not normally create an instance of this class directly, but instead use one of the built-in FX that extend it.\r\n *\r\n * @class Controller\r\n * @memberof Phaser.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {number} type - The FX Type constant.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A reference to the Game Object that has this fx.\r\n */", "meta": { "filename": "Controller.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "classdesc": "FX Controller is the base class that all built-in FX use.\r\rYou should not normally create an instance of this class directly, but instead use one of the built-in FX that extend it.", "kind": "class", "name": "Controller", "memberof": "Phaser.FX", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The FX Type constant.", "name": "type" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A reference to the Game Object that has this fx.", "name": "gameObject" } ], "scope": "static", "longname": "Phaser.FX.Controller", "___id": "T000002R006327", "___s": true }, { "comment": "/**\r\n * The FX_CONST type of this effect.\r\n *\r\n * @name Phaser.FX.Controller#type\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The FX_CONST type of this effect.", "name": "type", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Controller", "longname": "Phaser.FX.Controller#type", "scope": "instance", "kind": "member", "___id": "T000002R006330", "___s": true }, { "comment": "/**\r\n * A reference to the Game Object that owns this effect.\r\n *\r\n * @name Phaser.FX.Controller#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "A reference to the Game Object that owns this effect.", "name": "gameObject", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.60.0", "memberof": "Phaser.FX.Controller", "longname": "Phaser.FX.Controller#gameObject", "scope": "instance", "kind": "member", "___id": "T000002R006332", "___s": true }, { "comment": "/**\r\n * Toggle this boolean to enable or disable this effect,\r\n * without removing and adding it from the Game Object.\r\n *\r\n * Only works for Pre FX.\r\n *\r\n * Post FX are always active.\r\n *\r\n * @name Phaser.FX.Controller#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "Toggle this boolean to enable or disable this effect,\rwithout removing and adding it from the Game Object.\r\rOnly works for Pre FX.\r\rPost FX are always active.", "name": "active", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Controller", "longname": "Phaser.FX.Controller#active", "scope": "instance", "kind": "member", "___id": "T000002R006334", "___s": true }, { "comment": "/**\r\n * Sets the active state of this FX Controller.\r\n *\r\n * A disabled FX Controller will not be updated.\r\n *\r\n * @method Phaser.FX.Controller#setActive\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} value - `true` to enable this FX Controller, or `false` to disable it.\r\n *\r\n * @return {this} This FX Controller instance.\r\n */", "meta": { "filename": "Controller.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "Sets the active state of this FX Controller.\r\rA disabled FX Controller will not be updated.", "kind": "function", "name": "setActive", "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable this FX Controller, or `false` to disable it.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Controller instance." } ], "memberof": "Phaser.FX.Controller", "longname": "Phaser.FX.Controller#setActive", "scope": "instance", "___id": "T000002R006336", "___s": true }, { "comment": "/**\r\n * Destroys this FX Controller.\r\n *\r\n * @method Phaser.FX.Controller#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "Destroys this FX Controller.", "kind": "function", "name": "destroy", "since": "3.60.0", "memberof": "Phaser.FX.Controller", "longname": "Phaser.FX.Controller#destroy", "scope": "instance", "___id": "T000002R006339", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Displacement FX Controller.\r\n *\r\n * This FX controller manages the displacement effect for a Game Object.\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 * A Displacement effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.preFX.addDisplacement();\r\n * sprite.postFX.addDisplacement();\r\n * ```\r\n *\r\n * @class Displacement\r\n * @extends Phaser.FX.Controller\r\n * @memberof Phaser.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A reference to the Game Object that has this fx.\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": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "classdesc": "The Displacement FX Controller.\r\rThis FX controller manages the displacement effect for a Game Object.\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\rA Displacement effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.preFX.addDisplacement();\rsprite.postFX.addDisplacement();\r```", "kind": "class", "name": "Displacement", "augments": [ "Phaser.FX.Controller" ], "memberof": "Phaser.FX", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A reference to the Game Object that has this fx.", "name": "gameObject" }, { "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.FX.Displacement", "___id": "T000002R006347", "___s": true }, { "comment": "/**\r\n * The amount of horizontal displacement to apply.\r\n *\r\n * @name Phaser.FX.Displacement#x\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Displacement.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The amount of horizontal displacement to apply.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Displacement", "longname": "Phaser.FX.Displacement#x", "scope": "instance", "kind": "member", "___id": "T000002R006354", "___s": true }, { "comment": "/**\r\n * The amount of vertical displacement to apply.\r\n *\r\n * @name Phaser.FX.Displacement#y\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Displacement.js", "lineno": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The amount of vertical displacement to apply.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Displacement", "longname": "Phaser.FX.Displacement#y", "scope": "instance", "kind": "member", "___id": "T000002R006356", "___s": true }, { "comment": "/**\r\n * The underlying WebGLTexture used for displacement.\r\n *\r\n * @name Phaser.FX.Displacement#glTexture\r\n * @type {WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Displacement.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The underlying WebGLTexture used for displacement.", "name": "glTexture", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "since": "3.60.0", "memberof": "Phaser.FX.Displacement", "longname": "Phaser.FX.Displacement#glTexture", "scope": "instance", "kind": "member", "___id": "T000002R006358", "___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.GameObjects.Components.FX#setTexture\r\n * @since 3.60.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 *\r\n * @return {this} This FX Controller.\r\n */", "meta": { "filename": "Displacement.js", "lineno": 87, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "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": "3.60.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 FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#setTexture", "scope": "instance", "___id": "T000002R006360", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Glow FX Controller.\r\n *\r\n * This FX controller manages the glow effect for a Game Object.\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 Game Object. The color and strength of the glow can be modified.\r\n *\r\n * A Glow effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.preFX.addGlow();\r\n * sprite.postFX.addGlow();\r\n * ```\r\n *\r\n * @class Glow\r\n * @extends Phaser.FX.Controller\r\n * @memberof Phaser.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A reference to the Game Object that has this fx.\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 the Sprite.\r\n * @param {number} [innerStrength=0] - The strength of the glow inward from the edge of the Sprite.\r\n * @param {boolean} [knockout=false] - If `true` only the glow is drawn, not the texture itself.\r\n */", "meta": { "filename": "Glow.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "classdesc": "The Glow FX Controller.\r\rThis FX controller manages the glow effect for a Game Object.\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 Game Object. The color and strength of the glow can be modified.\r\rA Glow effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.preFX.addGlow();\rsprite.postFX.addGlow();\r```", "kind": "class", "name": "Glow", "augments": [ "Phaser.FX.Controller" ], "memberof": "Phaser.FX", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A reference to the Game Object that has this fx.", "name": "gameObject" }, { "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 the Sprite.", "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 the Sprite.", "name": "innerStrength" }, { "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" } ], "scope": "static", "longname": "Phaser.FX.Glow", "___id": "T000002R006368", "___s": true }, { "comment": "/**\r\n * The strength of the glow outward from the edge of the Sprite.\r\n *\r\n * @name Phaser.FX.Glow#outerStrength\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Glow.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The strength of the glow outward from the edge of the Sprite.", "name": "outerStrength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Glow", "longname": "Phaser.FX.Glow#outerStrength", "scope": "instance", "kind": "member", "___id": "T000002R006375", "___s": true }, { "comment": "/**\r\n * The strength of the glow inward from the edge of the Sprite.\r\n *\r\n * @name Phaser.FX.Glow#innerStrength\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Glow.js", "lineno": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The strength of the glow inward from the edge of the Sprite.", "name": "innerStrength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Glow", "longname": "Phaser.FX.Glow#innerStrength", "scope": "instance", "kind": "member", "___id": "T000002R006377", "___s": true }, { "comment": "/**\r\n * If `true` only the glow is drawn, not the texture itself.\r\n *\r\n * @name Phaser.FX.Glow#knockout\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Glow.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "If `true` only the glow is drawn, not the texture itself.", "name": "knockout", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Glow", "longname": "Phaser.FX.Glow#knockout", "scope": "instance", "kind": "member", "___id": "T000002R006379", "___s": true }, { "comment": "/**\r\n * A 4 element array of gl color values.\r\n *\r\n * @name Phaser.FX.Glow#glcolor\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Glow.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "A 4 element array of gl color values.", "name": "glcolor", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.FX.Glow", "longname": "Phaser.FX.Glow#glcolor", "scope": "instance", "kind": "member", "___id": "T000002R006381", "___s": true }, { "comment": "/**\r\n * The color of the glow as a number value.\r\n *\r\n * @name Phaser.FX.Glow#color\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Glow.js", "lineno": 99, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The color of the glow as a number value.", "name": "color", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Glow", "longname": "Phaser.FX.Glow#color", "scope": "instance", "kind": "member", "___id": "T000002R006384", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Gradient FX Controller.\r\n *\r\n * This FX controller manages the gradient effect for a Game Object.\r\n *\r\n * The gradient overlay effect is a visual technique where a smooth color transition is applied over Game Objects,\r\n * such as sprites or UI components. This effect is used to enhance visual appeal, emphasize depth, or create\r\n * stylistic and atmospheric variations. It can also be utilized to convey information, such as representing\r\n * progress or health status through color changes.\r\n *\r\n * A Gradient effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.preFX.addGradient();\r\n * sprite.postFX.addGradient();\r\n * ```\r\n *\r\n * @class Gradient\r\n * @extends Phaser.FX.Controller\r\n * @memberof Phaser.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A reference to the Game Object that has this fx.\r\n * @param {number} [color1=0xff0000] - The first gradient color, given as a number value.\r\n * @param {number} [color2=0x00ff00] - The second gradient color, given as a number value.\r\n * @param {number} [alpha=0.2] - The alpha value of the gradient effect.\r\n * @param {number} [fromX=0] - The horizontal position the gradient will start from. This value is normalized, between 0 and 1, and is not in pixels.\r\n * @param {number} [fromY=0] - The vertical position the gradient will start from. This value is normalized, between 0 and 1, and is not in pixels.\r\n * @param {number} [toX=0] - The horizontal position the gradient will end at. This value is normalized, between 0 and 1, and is not in pixels.\r\n * @param {number} [toY=1] - The vertical position the gradient will end at. This value is normalized, between 0 and 1, and is not in pixels.\r\n * @param {number} [size=0] - How many 'chunks' the gradient is divided in to, as spread over the entire height of the texture. Leave this at zero for a smooth gradient, or set higher for a more retro chunky effect.\r\n */", "meta": { "filename": "Gradient.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "classdesc": "The Gradient FX Controller.\r\rThis FX controller manages the gradient effect for a Game Object.\r\rThe gradient overlay effect is a visual technique where a smooth color transition is applied over Game Objects,\rsuch as sprites or UI components. This effect is used to enhance visual appeal, emphasize depth, or create\rstylistic and atmospheric variations. It can also be utilized to convey information, such as representing\rprogress or health status through color changes.\r\rA Gradient effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.preFX.addGradient();\rsprite.postFX.addGradient();\r```", "kind": "class", "name": "Gradient", "augments": [ "Phaser.FX.Controller" ], "memberof": "Phaser.FX", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A reference to the Game Object that has this fx.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xff0000", "description": "The first gradient color, given as a number value.", "name": "color1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x00ff00", "description": "The second gradient color, given as a number value.", "name": "color2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.2, "description": "The alpha value of the gradient effect.", "name": "alpha" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position the gradient will start from. This value is normalized, between 0 and 1, and is not in pixels.", "name": "fromX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position the gradient will start from. This value is normalized, between 0 and 1, and is not in pixels.", "name": "fromY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position the gradient will end at. This value is normalized, between 0 and 1, and is not in pixels.", "name": "toX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The vertical position the gradient will end at. This value is normalized, between 0 and 1, and is not in pixels.", "name": "toY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "How many 'chunks' the gradient is divided in to, as spread over the entire height of the texture. Leave this at zero for a smooth gradient, or set higher for a more retro chunky effect.", "name": "size" } ], "scope": "static", "longname": "Phaser.FX.Gradient", "___id": "T000002R006397", "___s": true }, { "comment": "/**\r\n * The alpha value of the gradient effect.\r\n *\r\n * @name Phaser.FX.Gradient#alpha\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 64, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The alpha value of the gradient effect.", "name": "alpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Gradient", "longname": "Phaser.FX.Gradient#alpha", "scope": "instance", "kind": "member", "___id": "T000002R006407", "___s": true }, { "comment": "/**\r\n * Sets how many 'chunks' the gradient is divided in to, as spread over the\r\n * entire height of the texture. Leave this at zero for a smooth gradient,\r\n * or set to a higher number to split the gradient into that many sections, giving\r\n * a more banded 'retro' effect.\r\n *\r\n * @name Phaser.FX.Gradient#size\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "Sets how many 'chunks' the gradient is divided in to, as spread over the\rentire height of the texture. Leave this at zero for a smooth gradient,\ror set to a higher number to split the gradient into that many sections, giving\ra more banded 'retro' effect.", "name": "size", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Gradient", "longname": "Phaser.FX.Gradient#size", "scope": "instance", "kind": "member", "___id": "T000002R006409", "___s": true }, { "comment": "/**\r\n * The horizontal position the gradient will start from. This value is normalized, between 0 and 1 and is not in pixels.\r\n *\r\n * @name Phaser.FX.Gradient#fromX\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The horizontal position the gradient will start from. This value is normalized, between 0 and 1 and is not in pixels.", "name": "fromX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Gradient", "longname": "Phaser.FX.Gradient#fromX", "scope": "instance", "kind": "member", "___id": "T000002R006411", "___s": true }, { "comment": "/**\r\n * The vertical position the gradient will start from. This value is normalized, between 0 and 1 and is not in pixels.\r\n *\r\n * @name Phaser.FX.Gradient#fromY\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 94, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The vertical position the gradient will start from. This value is normalized, between 0 and 1 and is not in pixels.", "name": "fromY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Gradient", "longname": "Phaser.FX.Gradient#fromY", "scope": "instance", "kind": "member", "___id": "T000002R006413", "___s": true }, { "comment": "/**\r\n * The horizontal position the gradient will end. This value is normalized, between 0 and 1 and is not in pixels.\r\n *\r\n * @name Phaser.FX.Gradient#toX\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 103, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The horizontal position the gradient will end. This value is normalized, between 0 and 1 and is not in pixels.", "name": "toX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Gradient", "longname": "Phaser.FX.Gradient#toX", "scope": "instance", "kind": "member", "___id": "T000002R006415", "___s": true }, { "comment": "/**\r\n * The vertical position the gradient will end. This value is normalized, between 0 and 1 and is not in pixels.\r\n *\r\n * @name Phaser.FX.Gradient#toY\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The vertical position the gradient will end. This value is normalized, between 0 and 1 and is not in pixels.", "name": "toY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Gradient", "longname": "Phaser.FX.Gradient#toY", "scope": "instance", "kind": "member", "___id": "T000002R006417", "___s": true }, { "comment": "/**\r\n * The internal gl color array for the starting color.\r\n *\r\n * @name Phaser.FX.Gradient#glcolor1\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 121, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The internal gl color array for the starting color.", "name": "glcolor1", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.FX.Gradient", "longname": "Phaser.FX.Gradient#glcolor1", "scope": "instance", "kind": "member", "___id": "T000002R006419", "___s": true }, { "comment": "/**\r\n * The internal gl color array for the ending color.\r\n *\r\n * @name Phaser.FX.Gradient#glcolor2\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The internal gl color array for the ending color.", "name": "glcolor2", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.FX.Gradient", "longname": "Phaser.FX.Gradient#glcolor2", "scope": "instance", "kind": "member", "___id": "T000002R006421", "___s": true }, { "comment": "/**\r\n * The first gradient color, given as a number value.\r\n *\r\n * @name Phaser.FX.Gradient#color1\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 150, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The first gradient color, given as a number value.", "name": "color1", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Gradient", "longname": "Phaser.FX.Gradient#color1", "scope": "instance", "kind": "member", "___id": "T000002R006425", "___s": true }, { "comment": "/**\r\n * The second gradient color, given as a number value.\r\n *\r\n * @name Phaser.FX.Gradient#color2\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 177, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The second gradient color, given as a number value.", "name": "color2", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Gradient", "longname": "Phaser.FX.Gradient#color2", "scope": "instance", "kind": "member", "___id": "T000002R006434", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.FX\r\n */", "meta": { "filename": "index.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "kind": "namespace", "name": "FX", "memberof": "Phaser", "longname": "Phaser.FX", "scope": "static", "___id": "T000002R006446", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Pixelate FX Controller.\r\n *\r\n * This FX controller manages the pixelate effect for a Game Object.\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 * A Pixelate effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.preFX.addPixelate();\r\n * sprite.postFX.addPixelate();\r\n * ```\r\n *\r\n * @class Pixelate\r\n * @extends Phaser.FX.Controller\r\n * @memberof Phaser.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A reference to the Game Object that has this fx.\r\n * @param {number} [amount=1] - The amount of pixelation to apply.\r\n */", "meta": { "filename": "Pixelate.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "classdesc": "The Pixelate FX Controller.\r\rThis FX controller manages the pixelate effect for a Game Object.\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.\r\rA Pixelate effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.preFX.addPixelate();\rsprite.postFX.addPixelate();\r```", "kind": "class", "name": "Pixelate", "augments": [ "Phaser.FX.Controller" ], "memberof": "Phaser.FX", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A reference to the Game Object that has this fx.", "name": "gameObject" }, { "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.FX.Pixelate", "___id": "T000002R006468", "___s": true }, { "comment": "/**\r\n * The amount of pixelation to apply.\r\n *\r\n * @name Phaser.FX.Pixelate#amount\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Pixelate.js", "lineno": 52, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The amount of pixelation to apply.", "name": "amount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Pixelate", "longname": "Phaser.FX.Pixelate#amount", "scope": "instance", "kind": "member", "___id": "T000002R006473", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Shadow FX Controller.\r\n *\r\n * This FX controller manages the shadow effect for a Game Object.\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 * A Shadow effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.preFX.addShadow();\r\n * sprite.postFX.addShadow();\r\n * ```\r\n *\r\n * @class Shadow\r\n * @extends Phaser.FX.Controller\r\n * @memberof Phaser.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A reference to the Game Object that has this fx.\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 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.\r\n * @param {number} [samples=6] - The number of samples that the shadow effect will run for. An integer between 1 and 12.\r\n * @param {number} [intensity=1] - The intensity of the shadow effect.\r\n */", "meta": { "filename": "Shadow.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "classdesc": "The Shadow FX Controller.\r\rThis FX controller manages the shadow effect for a Game Object.\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\rA Shadow effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.preFX.addShadow();\rsprite.postFX.addShadow();\r```", "kind": "class", "name": "Shadow", "augments": [ "Phaser.FX.Controller" ], "memberof": "Phaser.FX", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A reference to the Game Object that has this fx.", "name": "gameObject" }, { "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 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.", "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. An integer between 1 and 12.", "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.FX.Shadow", "___id": "T000002R006479", "___s": true }, { "comment": "/**\r\n * The horizontal offset of the shadow effect.\r\n *\r\n * @name Phaser.FX.Shadow#x\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Shadow.js", "lineno": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The horizontal offset of the shadow effect.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Shadow", "longname": "Phaser.FX.Shadow#x", "scope": "instance", "kind": "member", "___id": "T000002R006489", "___s": true }, { "comment": "/**\r\n * The vertical offset of the shadow effect.\r\n *\r\n * @name Phaser.FX.Shadow#y\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Shadow.js", "lineno": 71, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The vertical offset of the shadow effect.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Shadow", "longname": "Phaser.FX.Shadow#y", "scope": "instance", "kind": "member", "___id": "T000002R006491", "___s": true }, { "comment": "/**\r\n * The amount of decay for the shadow effect.\r\n *\r\n * @name Phaser.FX.Shadow#decay\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Shadow.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The amount of decay for the shadow effect.", "name": "decay", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Shadow", "longname": "Phaser.FX.Shadow#decay", "scope": "instance", "kind": "member", "___id": "T000002R006493", "___s": true }, { "comment": "/**\r\n * The power of the shadow effect.\r\n *\r\n * @name Phaser.FX.Shadow#power\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Shadow.js", "lineno": 89, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The power of the shadow effect.", "name": "power", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Shadow", "longname": "Phaser.FX.Shadow#power", "scope": "instance", "kind": "member", "___id": "T000002R006495", "___s": true }, { "comment": "/**\r\n * The internal gl color array.\r\n *\r\n * @name Phaser.FX.Shadow#glcolor\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Shadow.js", "lineno": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "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": "3.60.0", "memberof": "Phaser.FX.Shadow", "longname": "Phaser.FX.Shadow#glcolor", "scope": "instance", "kind": "member", "___id": "T000002R006497", "___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.FX.Shadow#samples\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Shadow.js", "lineno": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "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": "3.60.0", "memberof": "Phaser.FX.Shadow", "longname": "Phaser.FX.Shadow#samples", "scope": "instance", "kind": "member", "___id": "T000002R006499", "___s": true }, { "comment": "/**\r\n * The intensity of the shadow effect.\r\n *\r\n * @name Phaser.FX.Shadow#intensity\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Shadow.js", "lineno": 118, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The intensity of the shadow effect.", "name": "intensity", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Shadow", "longname": "Phaser.FX.Shadow#intensity", "scope": "instance", "kind": "member", "___id": "T000002R006501", "___s": true }, { "comment": "/**\r\n * The color of the shadow.\r\n *\r\n * @name Phaser.FX.Shadow#color\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Shadow.js", "lineno": 133, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The color of the shadow.", "name": "color", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Shadow", "longname": "Phaser.FX.Shadow#color", "scope": "instance", "kind": "member", "___id": "T000002R006504", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Shine FX Controller.\r\n *\r\n * This FX controller manages the shift effect for a Game Object.\r\n *\r\n * The shine effect is a visual technique that simulates the appearance of reflective\r\n * or glossy surfaces by passing a light beam across a Game Object. This effect is used to\r\n * enhance visual appeal, emphasize certain features, and create a sense of depth or\r\n * material properties.\r\n *\r\n * A Shine effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.preFX.addShine();\r\n * sprite.postFX.addShine();\r\n * ```\r\n *\r\n * @class Shine\r\n * @extends Phaser.FX.Controller\r\n * @memberof Phaser.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A reference to the Game Object that has this fx.\r\n * @param {number} [speed=0.5] - The speed of the Shine effect.\r\n * @param {number} [lineWidth=0.5] - The line width of the Shine effect.\r\n * @param {number} [gradient=3] - The gradient of the Shine effect.\r\n * @param {boolean} [reveal=false] - Does this Shine effect reveal or get added to its target?\r\n */", "meta": { "filename": "Shine.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "classdesc": "The Shine FX Controller.\r\rThis FX controller manages the shift effect for a Game Object.\r\rThe shine effect is a visual technique that simulates the appearance of reflective\ror glossy surfaces by passing a light beam across a Game Object. This effect is used to\renhance visual appeal, emphasize certain features, and create a sense of depth or\rmaterial properties.\r\rA Shine effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.preFX.addShine();\rsprite.postFX.addShine();\r```", "kind": "class", "name": "Shine", "augments": [ "Phaser.FX.Controller" ], "memberof": "Phaser.FX", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A reference to the Game Object that has this fx.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The speed of the Shine effect.", "name": "speed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The line width of the Shine effect.", "name": "lineWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 3, "description": "The gradient of the Shine effect.", "name": "gradient" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Shine effect reveal or get added to its target?", "name": "reveal" } ], "scope": "static", "longname": "Phaser.FX.Shine", "___id": "T000002R006517", "___s": true }, { "comment": "/**\r\n * The speed of the Shine effect.\r\n *\r\n * @name Phaser.FX.Shine#speed\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Shine.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The speed of the Shine effect.", "name": "speed", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Shine", "longname": "Phaser.FX.Shine#speed", "scope": "instance", "kind": "member", "___id": "T000002R006525", "___s": true }, { "comment": "/**\r\n * The line width of the Shine effect.\r\n *\r\n * @name Phaser.FX.Shine#lineWidth\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Shine.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The line width of the Shine effect.", "name": "lineWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Shine", "longname": "Phaser.FX.Shine#lineWidth", "scope": "instance", "kind": "member", "___id": "T000002R006527", "___s": true }, { "comment": "/**\r\n * The gradient of the Shine effect.\r\n *\r\n * @name Phaser.FX.Shine#gradient\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Shine.js", "lineno": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The gradient of the Shine effect.", "name": "gradient", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Shine", "longname": "Phaser.FX.Shine#gradient", "scope": "instance", "kind": "member", "___id": "T000002R006529", "___s": true }, { "comment": "/**\r\n * Does this Shine effect reveal or get added to its target?\r\n *\r\n * @name Phaser.FX.Shine#reveal\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Shine.js", "lineno": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "Does this Shine effect reveal or get added to its target?", "name": "reveal", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Shine", "longname": "Phaser.FX.Shine#reveal", "scope": "instance", "kind": "member", "___id": "T000002R006531", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Vignette FX Controller.\r\n *\r\n * This FX controller manages the vignette effect for a Game Object.\r\n *\r\n * The vignette effect is a visual technique where the edges of the screen, or a Game Object, gradually darken or blur,\r\n * creating a frame-like appearance. This effect is used to draw the player's focus towards the central action or subject,\r\n * enhance immersion, and provide a cinematic or artistic quality to the game's visuals.\r\n *\r\n * A Vignette effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.preFX.addVignette();\r\n * sprite.postFX.addVignette();\r\n * ```\r\n *\r\n * @class Vignette\r\n * @extends Phaser.FX.Controller\r\n * @memberof Phaser.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A reference to the Game Object that has this fx.\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 */", "meta": { "filename": "Vignette.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "classdesc": "The Vignette FX Controller.\r\rThis FX controller manages the vignette effect for a Game Object.\r\rThe vignette effect is a visual technique where the edges of the screen, or a Game Object, gradually darken or blur,\rcreating a frame-like appearance. This effect is used to draw the player's focus towards the central action or subject,\renhance immersion, and provide a cinematic or artistic quality to the game's visuals.\r\rA Vignette effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.preFX.addVignette();\rsprite.postFX.addVignette();\r```", "kind": "class", "name": "Vignette", "augments": [ "Phaser.FX.Controller" ], "memberof": "Phaser.FX", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A reference to the Game Object that has this fx.", "name": "gameObject" }, { "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" } ], "scope": "static", "longname": "Phaser.FX.Vignette", "___id": "T000002R006537", "___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.FX.Vignette#x\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Vignette.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "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": "3.60.0", "memberof": "Phaser.FX.Vignette", "longname": "Phaser.FX.Vignette#x", "scope": "instance", "kind": "member", "___id": "T000002R006545", "___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.FX.Vignette#y\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Vignette.js", "lineno": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "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": "3.60.0", "memberof": "Phaser.FX.Vignette", "longname": "Phaser.FX.Vignette#y", "scope": "instance", "kind": "member", "___id": "T000002R006547", "___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.FX.Vignette#radius\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Vignette.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "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": "3.60.0", "memberof": "Phaser.FX.Vignette", "longname": "Phaser.FX.Vignette#radius", "scope": "instance", "kind": "member", "___id": "T000002R006549", "___s": true }, { "comment": "/**\r\n * The strength of the vignette effect.\r\n *\r\n * @name Phaser.FX.Vignette#strength\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Vignette.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The strength of the vignette effect.", "name": "strength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Vignette", "longname": "Phaser.FX.Vignette#strength", "scope": "instance", "kind": "member", "___id": "T000002R006551", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Wipe FX Controller.\r\n *\r\n * This FX controller manages the wipe effect for a Game Object.\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 1, axis 0\r\n *\r\n * It is up to you to set the `progress` value yourself, i.e. via a Tween, in order to transition the effect.\r\n *\r\n * A Wipe effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.preFX.addWipe();\r\n * sprite.postFX.addWipe();\r\n * sprite.preFX.addReveal();\r\n * sprite.postFX.addReveal();\r\n * ```\r\n *\r\n * @class Wipe\r\n * @extends Phaser.FX.Controller\r\n * @memberof Phaser.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A reference to the Game Object that has this fx.\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 or 1. Set in conjunction with the axis property.\r\n * @param {number} [axis=0] - The axis of the wipe effect. Either 0 or 1. Set in conjunction with the direction property.\r\n * @param {boolean} [reveal=false] - Is this a reveal (true) or a fade (false) effect?\r\n */", "meta": { "filename": "Wipe.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "classdesc": "The Wipe FX Controller.\r\rThis FX controller manages the wipe effect for a Game Object.\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 1, axis 0\r\rIt is up to you to set the `progress` value yourself, i.e. via a Tween, in order to transition the effect.\r\rA Wipe effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.preFX.addWipe();\rsprite.postFX.addWipe();\rsprite.preFX.addReveal();\rsprite.postFX.addReveal();\r```", "kind": "class", "name": "Wipe", "augments": [ "Phaser.FX.Controller" ], "memberof": "Phaser.FX", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A reference to the Game Object that has this fx.", "name": "gameObject" }, { "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 or 1. 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 or 1. Set in conjunction with the direction property.", "name": "axis" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is this a reveal (true) or a fade (false) effect?", "name": "reveal" } ], "scope": "static", "longname": "Phaser.FX.Wipe", "___id": "T000002R006557", "___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 (i.e. via a Tween)\r\n *\r\n * @name Phaser.FX.Wipe#progress\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Wipe.js", "lineno": 69, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "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 (i.e. via a Tween)", "name": "progress", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Wipe", "longname": "Phaser.FX.Wipe#progress", "scope": "instance", "kind": "member", "___id": "T000002R006565", "___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.FX.Wipe#wipeWidth\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Wipe.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "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": "3.60.0", "memberof": "Phaser.FX.Wipe", "longname": "Phaser.FX.Wipe#wipeWidth", "scope": "instance", "kind": "member", "___id": "T000002R006567", "___s": true }, { "comment": "/**\r\n * The direction of the wipe effect. Either 0 or 1. Set in conjunction with the axis property.\r\n *\r\n * @name Phaser.FX.Wipe#direction\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Wipe.js", "lineno": 89, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The direction of the wipe effect. Either 0 or 1. Set in conjunction with the axis property.", "name": "direction", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Wipe", "longname": "Phaser.FX.Wipe#direction", "scope": "instance", "kind": "member", "___id": "T000002R006569", "___s": true }, { "comment": "/**\r\n * The axis of the wipe effect. Either 0 or 1. Set in conjunction with the direction property.\r\n *\r\n * @name Phaser.FX.Wipe#axis\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Wipe.js", "lineno": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "The axis of the wipe effect. Either 0 or 1. Set in conjunction with the direction property.", "name": "axis", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Wipe", "longname": "Phaser.FX.Wipe#axis", "scope": "instance", "kind": "member", "___id": "T000002R006571", "___s": true }, { "comment": "/**\r\n * Is this a reveal (true) or a fade (false) effect?\r\n *\r\n * @name Phaser.FX.Wipe#reveal\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Wipe.js", "lineno": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "description": "Is this a reveal (true) or a fade (false) effect?", "name": "reveal", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Wipe", "longname": "Phaser.FX.Wipe#reveal", "scope": "instance", "kind": "member", "___id": "T000002R006573", "___s": true }, { "comment": "/**\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": "Text 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": "T000002R006592", "___s": true }, { "comment": "/**\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": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "Text 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": "T000002R006594", "___s": true }, { "comment": "/**\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": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "Text 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": "T000002R006596", "___s": true }, { "comment": "/**\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": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "Text 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": "T000002R006598", "___s": true }, { "comment": "/**\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": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "Text 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": "T000002R006600", "___s": true }, { "comment": "/**\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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "Text 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": "T000002R006602", "___s": true }, { "comment": "/**\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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "Text 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": "T000002R006604", "___s": true }, { "comment": "/**\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": 72, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "Text 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": "T000002R006606", "___s": true }, { "comment": "/**\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": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "Text 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": "T000002R006608", "___s": true }, { "comment": "/**\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": 90, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "Text 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": "T000002R006610", "___s": true }, { "comment": "/**\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": 99, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "Text 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": "T000002R006612", "___s": true }, { "comment": "/**\n * @classdesc\n * BitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\n *\n * During rendering for each letter of the text is rendered to the display, proportionally spaced out and aligned to\n * match the font structure.\n *\n * Dynamic Bitmap Text objects are different from Static Bitmap Text in that they invoke a callback for each\n * letter being rendered during the render pass. This callback allows you to manipulate the properties of\n * each letter being rendered, such as its position, scale or tint, allowing you to create interesting effects\n * like jiggling text, which can't be done with Static text. This means that Dynamic Text takes more processing\n * time, so only use them if you require the callback ability they have.\n *\n * BitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability\n * to use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\n * processing the font texture in an image editor, applying fills and any other effects required.\n *\n * To create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\n *\n * To create a BitmapText data files you need a 3rd party app such as:\n *\n * BMFont (Windows, free): {@link http://www.angelcode.com/products/bmfont/|http://www.angelcode.com/products/bmfont/}\n * Glyph Designer (OS X, commercial): {@link http://www.71squared.com/en/glyphdesigner|http://www.71squared.com/en/glyphdesigner}\n * Snow BMF (Web-based, free): {@link https://snowb.org//|https://snowb.org/}\n * Littera (Flash-based, free): {@link http://kvazars.com/littera/|http://kvazars.com/littera/}\n *\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\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}\n *\n * @class DynamicBitmapText\n * @extends Phaser.GameObjects.BitmapText\n * @memberof Phaser.GameObjects\n * @constructor\n * @since 3.0.0\n *\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. It can only belong to one Scene at any given time.\n * @param {number} x - The x coordinate of this Game Object in world space.\n * @param {number} y - The y coordinate of this Game Object in world space.\n * @param {string} font - The key of the font to use from the Bitmap Font cache.\n * @param {(string|string[])} [text] - The string, or array of strings, to be set as the content of this Bitmap Text.\n * @param {number} [size] - The font size of this Bitmap Text.\n * @param {number} [align=0] - The alignment of the text in a multi-line BitmapText object.\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.\n\nDuring rendering for each letter of the text is rendered to the display, proportionally spaced out and aligned to\nmatch the font structure.\n\nDynamic Bitmap Text objects are different from Static Bitmap Text in that they invoke a callback for each\nletter being rendered during the render pass. This callback allows you to manipulate the properties of\neach letter being rendered, such as its position, scale or tint, allowing you to create interesting effects\nlike jiggling text, which can't be done with Static text. This means that Dynamic Text takes more processing\ntime, so only use them if you require the callback ability they have.\n\nBitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability\nto use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\nprocessing the font texture in an image editor, applying fills and any other effects required.\n\nTo create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\n\nTo create a BitmapText data files you need a 3rd party app such as:\n\nBMFont (Windows, free): {@link http://www.angelcode.com/products/bmfont/|http://www.angelcode.com/products/bmfont/}\nGlyph Designer (OS X, commercial): {@link http://www.71squared.com/en/glyphdesigner|http://www.71squared.com/en/glyphdesigner}\nSnow BMF (Web-based, free): {@link https://snowb.org//|https://snowb.org/}\nLittera (Flash-based, free): {@link http://kvazars.com/littera/|http://kvazars.com/littera/}\n\nFor most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\nconverting a valid XML file through the popular X2JS library. An online tool for conversion can be found here: {@link http://codebeautify.org/xmltojson|http://codebeautify.org/xmltojson}", "kind": "class", "name": "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": "T000002R006618", "___s": true }, { "comment": "/**\n * The horizontal scroll position of the Bitmap Text.\n *\n * @name Phaser.GameObjects.DynamicBitmapText#scrollX\n * @type {number}\n * @default 0\n * @since 3.0.0\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": "T000002R006624", "___s": true }, { "comment": "/**\n * The vertical scroll position of the Bitmap Text.\n *\n * @name Phaser.GameObjects.DynamicBitmapText#scrollY\n * @type {number}\n * @default 0\n * @since 3.0.0\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": "T000002R006626", "___s": true }, { "comment": "/**\n * The crop width of the Bitmap Text.\n *\n * @name Phaser.GameObjects.DynamicBitmapText#cropWidth\n * @type {number}\n * @default 0\n * @since 3.0.0\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": "T000002R006628", "___s": true }, { "comment": "/**\n * The crop height of the Bitmap Text.\n *\n * @name Phaser.GameObjects.DynamicBitmapText#cropHeight\n * @type {number}\n * @default 0\n * @since 3.0.0\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": "T000002R006630", "___s": true }, { "comment": "/**\n * A callback that alters how each character of the Bitmap Text is rendered.\n *\n * @name Phaser.GameObjects.DynamicBitmapText#displayCallback\n * @type {Phaser.Types.GameObjects.BitmapText.DisplayCallback}\n * @since 3.0.0\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": "T000002R006632", "___s": true }, { "comment": "/**\n * The data object that is populated during rendering, then passed to the displayCallback.\n * You should modify this object then return it back from the callback. It's updated values\n * will be used to render the specific glyph.\n *\n * Please note that if you need a reference to this object locally in your game code then you\n * should shallow copy it, as it's updated and re-used for every glyph in the text.\n *\n * @name Phaser.GameObjects.DynamicBitmapText#callbackData\n * @type {Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig}\n * @since 3.11.0\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.\nYou should modify this object then return it back from the callback. It's updated values\nwill be used to render the specific glyph.\n\nPlease note that if you need a reference to this object locally in your game code then you\nshould shallow copy it, as it's updated and re-used for every glyph in the text.", "name": "callbackData", "type": { "names": [ "Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig" ], "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": "T000002R006634", "___s": true }, { "comment": "/**\n * Set the crop size of this Bitmap Text.\n *\n * @method Phaser.GameObjects.DynamicBitmapText#setSize\n * @since 3.0.0\n *\n * @param {number} width - The width of the crop.\n * @param {number} height - The height of the crop.\n *\n * @return {this} This Game Object.\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": "T000002R006650", "___s": true }, { "comment": "/**\n * Set a callback that alters how each character of the Bitmap Text is rendered.\n *\n * The callback receives a {@link Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig} object that contains information about the character that's\n * about to be rendered.\n *\n * It should return an object with `x`, `y`, `scale` and `rotation` properties that will be used instead of the\n * usual values when rendering.\n *\n * @method Phaser.GameObjects.DynamicBitmapText#setDisplayCallback\n * @since 3.0.0\n *\n * @param {Phaser.Types.GameObjects.BitmapText.DisplayCallback} callback - The display callback to set.\n *\n * @return {this} This Game Object.\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.\n\nThe callback receives a {@link Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig} object that contains information about the character that's\nabout to be rendered.\n\nIt should return an object with `x`, `y`, `scale` and `rotation` properties that will be used instead of the\nusual values when rendering.", "kind": "function", "name": "setDisplayCallback", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.BitmapText.DisplayCallback" ], "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": "T000002R006654", "___s": true }, { "comment": "/**\n * Set the horizontal scroll position of this Bitmap Text.\n *\n * @method Phaser.GameObjects.DynamicBitmapText#setScrollX\n * @since 3.0.0\n *\n * @param {number} value - The horizontal scroll position to set.\n *\n * @return {this} This Game Object.\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": "T000002R006657", "___s": true }, { "comment": "/**\n * Set the vertical scroll position of this Bitmap Text.\n *\n * @method Phaser.GameObjects.DynamicBitmapText#setScrollY\n * @since 3.0.0\n *\n * @param {number} value - The vertical scroll position to set.\n *\n * @return {this} This Game Object.\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": "T000002R006660", "___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\r²", "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": "T000002R006744", "___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 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 * 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): 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 for 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): 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": "T000002R006753", "___s": true }, { "comment": "/**\r\n * Parses a Retro Font configuration object so you can pass it to the BitmapText constructor\r\n * and create a BitmapText object using a fixed-width retro font.\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 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 so you can pass it to the BitmapText constructor\rand create a BitmapText object using a fixed-width retro font.", "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 for the Bitmap Font cache." } ], "memberof": "Phaser.GameObjects.RetroFont", "longname": "Phaser.GameObjects.RetroFont.Parse", "scope": "static", "___id": "T000002R007146", "___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": "T000002R007272", "___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.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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": 17, "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.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "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": "T000002R007286", "___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": 98, "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": "T000002R007293", "___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": 116, "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": "T000002R007296", "___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": 220, "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": "T000002R007314", "___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": 240, "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": "T000002R007318", "___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": 251, "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": "T000002R007320", "___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": 262, "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": "T000002R007322", "___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": 273, "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": "T000002R007324", "___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": 284, "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": "T000002R007326", "___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": 303, "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": "T000002R007328", "___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": 321, "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": "T000002R007332", "___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": 339, "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": "T000002R007336", "___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": 357, "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": "T000002R007340", "___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": 376, "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": "T000002R007344", "___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": 399, "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": "T000002R007349", "___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": 423, "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": "T000002R007353", "___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": 459, "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": "T000002R007359", "___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 works by taking the pixel color values from the Bitmap Text texture, and then\r\n * multiplying it by the color value of the tint. 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 swap this from being an additive tint to a fill based tint, set the `tintFill` parameter to `true`.\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 {boolean} [tintFill=false] - Use a fill-based tint (true), or an additive tint (false)\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the character. If not 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": 497, "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 works by taking the pixel color values from the Bitmap Text texture, and then\rmultiplying it by the color value of the tint. You 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 swap this from being an additive tint to a fill based tint, set the `tintFill` parameter to `true`.\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": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Use a fill-based tint (true), or an additive tint (false)", "name": "tintFill" }, { "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 not 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": "T000002R007369", "___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, if till that word, based on its offset within the text contents.\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 works by taking the pixel color values from the Bitmap Text texture, and then\r\n * multiplying it by the color value of the tint. 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 swap this from being an additive tint to a fill based tint, set the `tintFill` parameter to `true`.\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 {boolean} [tintFill=false] - Use a fill-based tint (true), or an additive tint (false)\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the word. If not 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": 606, "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, if till that word, based on its offset within the text contents.\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 works by taking the pixel color values from the Bitmap Text texture, and then\rmultiplying it by the color value of the tint. You 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 swap this from being an additive tint to a fill based tint, set the `tintFill` parameter to `true`.\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": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Use a fill-based tint (true), or an additive tint (false)", "name": "tintFill" }, { "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 not 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": "T000002R007399", "___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": 679, "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": "T000002R007408", "___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": 716, "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": "T000002R007412", "___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": 765, "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": "T000002R007420", "___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 test, 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": 783, "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 test, 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": "T000002R007423", "___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": 824, "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": "T000002R007433", "___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": 858, "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": "T000002R007438", "___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": 891, "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": "T000002R007444", "___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": 914, "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": "T000002R007448", "___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": 938, "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": "T000002R007454", "___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": 964, "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": "T000002R007460", "___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": 990, "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": "T000002R007466", "___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": 1019, "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": "T000002R007472", "___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": 1040, "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": "T000002R007475", "___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": 1061, "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": "T000002R007478", "___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": 1082, "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": "T000002R007481", "___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": 1103, "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": "T000002R007484", "___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": 1131, "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": "T000002R007495", "___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": 1147, "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": "T000002R007500", "___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": 1156, "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": "T000002R007502", "___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": 1165, "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": "T000002R007504", "___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": 1174, "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": "T000002R007506", "___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": 1194, "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": "T000002R007508", "___s": true }, { "comment": "/**\r\n * Creates a new Bitmap Text Game Object and returns it.\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\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": "T000002R007578", "___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 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): 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 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): 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": "T000002R007588", "___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": "T000002R007645", "___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": "T000002R007646", "___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": "T000002R007647", "___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": "T000002R007648", "___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": "T000002R007649", "___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": "T000002R007650", "___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": "T000002R007651", "___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 {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": [ "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": "T000002R007652", "___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": 16, "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": "T000002R007653", "___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": "T000002R007654", "___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": "T000002R007655", "___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": "T000002R007656", "___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": "T000002R007657", "___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": "T000002R007658", "___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": "T000002R007659", "___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": 15, "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": "T000002R007667", "___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.Mask\r\n * @extends Phaser.GameObjects.Components.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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": 22, "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.Mask", "Phaser.GameObjects.Components.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "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": "T000002R007668", "___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": "T000002R007673", "___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": "T000002R007677", "___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 Blitters 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": 125, "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 Blitters 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": "T000002R007679", "___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": 165, "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": "T000002R007687", "___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": 192, "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": "T000002R007692", "___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": 233, "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": "T000002R007700", "___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": 248, "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": "T000002R007702", "___s": true }, { "comment": "/**\r\n * Removes all Bobs from the children List and clears the dirty flag.\r\n *\r\n * @method Phaser.GameObjects.Blitter#clear\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Blitter.js", "lineno": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Removes all Bobs from the children List and clears the dirty flag.", "kind": "function", "name": "clear", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "longname": "Phaser.GameObjects.Blitter#clear", "scope": "instance", "___id": "T000002R007706", "___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": 280, "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": "T000002R007709", "___s": true }, { "comment": "/**\r\n * Creates a new Blitter Game Object and returns it.\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.\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\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.", "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": "T000002R007745", "___s": true }, { "comment": "/**\r\n * Creates a new Blitter Game Object and adds it to the Scene.\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\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": "T000002R007753", "___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": "T000002R007800", "___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": "T000002R007803", "___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": "T000002R007805", "___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": "T000002R007807", "___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": "T000002R007809", "___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": "T000002R007811", "___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": "T000002R007813", "___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": "T000002R007819", "___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": "T000002R007821", "___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": "T000002R007825", "___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": "T000002R007830", "___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 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 *\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 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" } ], "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": "T000002R007834", "___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 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 *\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 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" } ], "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": "T000002R007843", "___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": "T000002R007847", "___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": "T000002R007850", "___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 horizontal 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 horizontal 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": "T000002R007853", "___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": "T000002R007857", "___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": "T000002R007860", "___s": true }, { "comment": "/**\r\n * Sets the tint of this Bob.\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 of this Bob.", "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": "T000002R007863", "___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": 367, "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": "T000002R007866", "___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": 385, "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": "T000002R007872", "___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": 409, "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": "T000002R007878", "___s": true }, { "comment": "/**\r\n * Builds a Game Object using the provided configuration object.\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.", "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": "T000002R007887", "___s": true }, { "comment": "/**\n * Adds an Animation component to a Sprite and populates it based on the given config.\n *\n * @function Phaser.GameObjects.BuildGameObjectAnimation\n * @since 3.0.0\n *\n * @param {Phaser.GameObjects.Sprite} sprite - The sprite to add an Animation component to.\n * @param {object} config - The animation config.\n *\n * @return {Phaser.GameObjects.Sprite} The updated Sprite.\n */", "meta": { "filename": "BuildGameObjectAnimation.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Adds an Animation component to a Sprite and populates it based on the given config.", "kind": "function", "name": "BuildGameObjectAnimation", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "The sprite to add an Animation component to.", "name": "sprite" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The animation config.", "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": "T000002R007912", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the alpha properties of a Game Object.\r\n * Should be applied as a mixin and not 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 used for setting the alpha properties of a Game Object.\rShould be applied as a mixin and not used directly.", "kind": "namespace", "name": "Alpha", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.Alpha", "scope": "static", "___id": "T000002R007934", "___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": 77, "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": "T000002R007946", "___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": 92, "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": "T000002R007948", "___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 *\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": 129, "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.", "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": "T000002R007956", "___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": 167, "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": "T000002R007968", "___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": 197, "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": "T000002R007975", "___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": 227, "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": "T000002R007982", "___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": 257, "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": "T000002R007989", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the alpha property of a Game 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.\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": "T000002R007999", "___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.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": 33, "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.AlphaSingle", "longname": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "scope": "instance", "___id": "T000002R008003", "___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": 48, "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": "T000002R008005", "___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 *\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": 68, "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.", "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": "T000002R008009", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the blend mode of a Game Object.\r\n * Should be applied as a mixin and not used directly.\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.\rShould be applied as a mixin and not used directly.", "kind": "namespace", "name": "BlendMode", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.BlendMode", "scope": "static", "___id": "T000002R008019", "___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 of 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": 30, "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 of 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": "T000002R008023", "___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 in 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": 80, "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 in 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": "T000002R008030", "___s": true }, { "comment": "/**\r\n * Provides methods used for calculating and setting the size of a non-Frame based Game Object.\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.\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": "T000002R008034", "___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": 17, "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": "T000002R008036", "___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": 30, "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": "T000002R008038", "___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": 43, "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": "T000002R008040", "___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": 68, "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": "T000002R008045", "___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": 93, "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": "T000002R008050", "___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.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": 120, "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 scale.", "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": "T000002R008054", "___s": true }, { "comment": "/**\r\n * Provides methods used for getting and setting the texture of a Game Object.\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": "Provides methods used for getting and setting the texture of a Game Object.", "kind": "namespace", "name": "Crop", "since": "3.12.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.Crop", "scope": "static", "___id": "T000002R008059", "___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": 16, "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": "T000002R008061", "___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": 25, "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": "T000002R008063", "___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": 34, "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": "T000002R008065", "___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 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 rect 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. 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.\r\n * @param {number} [width] - The width of the crop rectangle in pixels.\r\n * @param {number} [height] - The height of the crop rectangle in pixels.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Crop.js", "lineno": 45, "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 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 rect 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. 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.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the crop rectangle in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the crop rectangle in pixels.", "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": "T000002R008067", "___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": "T000002R008089", "___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": 28, "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": "T000002R008093", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The depth of this Game Object within the Scene.\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.", "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": "T000002R008098", "___s": true }, { "comment": "/**\r\n * Provides methods used for visually flipping a Game Object.\r\n * Should be applied as a mixin and not 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.\rShould be applied as a mixin and not used directly.", "kind": "namespace", "name": "Flip", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.Flip", "scope": "static", "___id": "T000002R008103", "___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.Components.Flip#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 17, "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 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.0.0", "memberof": "Phaser.GameObjects.Components.Flip", "longname": "Phaser.GameObjects.Components.Flip#flipX", "scope": "instance", "kind": "member", "___id": "T000002R008105", "___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.Components.Flip#flipY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 31, "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 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.0.0", "memberof": "Phaser.GameObjects.Components.Flip", "longname": "Phaser.GameObjects.Components.Flip#flipY", "scope": "instance", "kind": "member", "___id": "T000002R008107", "___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 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 * @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": 45, "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 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.", "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": "T000002R008109", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Toggles the vertical flipped state of this Game Object.", "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": "T000002R008112", "___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 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 * @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": 79, "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 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.", "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": "T000002R008115", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\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": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the vertical flipped state of this Game Object.", "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": "T000002R008118", "___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 inversed 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 horizontal 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": 117, "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 inversed 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 horizontal 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": "T000002R008121", "___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": 140, "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": "T000002R008125", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The FX Component features a set of methods used for applying a range of special built-in effects to a Game Object.\r\n *\r\n * The effects include the following:\r\n *\r\n * * Barrel Distortion\r\n * * Bloom\r\n * * Blur\r\n * * Bokeh / Tilt Shift\r\n * * Circle Outline\r\n * * Color Matrix\r\n * * Glow\r\n * * Displacement\r\n * * Gradient\r\n * * Pixelate\r\n * * Shine\r\n * * Shadow\r\n * * Vignette\r\n * * Wipe / Reveal\r\n *\r\n * All Game Objects support Post FX. These are effects applied after the Game Object has been rendered.\r\n *\r\n * Texture-based Game Objects also support Pre FX, including:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * And any Game Object that extends the above.\r\n *\r\n * The difference between Pre FX and Post FX are that all Post FX take place in a canvas (renderer) sized frame buffer,\r\n * after the Game Object has been rendered. Pre FX, however, take place in a texture sized frame buffer, which is sized\r\n * based on the Game Object itself. The end result is then composited back to the main game canvas. For intensive effects,\r\n * such as blur, bloom or glow, which can require many iterations, this is a much more efficient way to apply the effect,\r\n * as only it only has to work on a Game Object sized texture and not all pixels in the canvas.\r\n *\r\n * In short, you should always try and use a Pre FX if you can.\r\n *\r\n * Due to the way that FX work they can be stacked-up. For example, you can apply a blur to a Game Object, then apply\r\n * a bloom effect to the same Game Object. The bloom effect will be applied to the blurred texture, not the original.\r\n * Keep the order in mind when stacking effects.\r\n *\r\n * All effects are WebGL only and do not have canvas counterparts.\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 component is created automatically by the `PostPipeline` class and does not need to be instantiated directly.\r\n *\r\n * @class FX\r\n * @memberof Phaser.GameObjects.Components\r\n * @constructor\r\n * @since 3.60.0\r\n * @webglOnly\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A reference to the Game Object that owns this FX Component.\r\n * @param {boolean} isPost - Is this a Pre or Post FX Component?\r\n */", "meta": { "filename": "FX.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "classdesc": "The FX Component features a set of methods used for applying a range of special built-in effects to a Game Object.\r\rThe effects include the following:\r\r* Barrel Distortion\r* Bloom\r* Blur\r* Bokeh / Tilt Shift\r* Circle Outline\r* Color Matrix\r* Glow\r* Displacement\r* Gradient\r* Pixelate\r* Shine\r* Shadow\r* Vignette\r* Wipe / Reveal\r\rAll Game Objects support Post FX. These are effects applied after the Game Object has been rendered.\r\rTexture-based Game Objects also support Pre FX, including:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAnd any Game Object that extends the above.\r\rThe difference between Pre FX and Post FX are that all Post FX take place in a canvas (renderer) sized frame buffer,\rafter the Game Object has been rendered. Pre FX, however, take place in a texture sized frame buffer, which is sized\rbased on the Game Object itself. The end result is then composited back to the main game canvas. For intensive effects,\rsuch as blur, bloom or glow, which can require many iterations, this is a much more efficient way to apply the effect,\ras only it only has to work on a Game Object sized texture and not all pixels in the canvas.\r\rIn short, you should always try and use a Pre FX if you can.\r\rDue to the way that FX work they can be stacked-up. For example, you can apply a blur to a Game Object, then apply\ra bloom effect to the same Game Object. The bloom effect will be applied to the blurred texture, not the original.\rKeep the order in mind when stacking effects.\r\rAll effects are WebGL only and do not have canvas counterparts.\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 component is created automatically by the `PostPipeline` class and does not need to be instantiated directly.", "kind": "class", "name": "FX", "memberof": "Phaser.GameObjects.Components", "since": "3.60.0", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A reference to the Game Object that owns this FX Component.", "name": "gameObject" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this a Pre or Post FX Component?", "name": "isPost" } ], "scope": "static", "longname": "Phaser.GameObjects.Components.FX", "___id": "T000002R008133", "___s": true }, { "comment": "/**\r\n * A reference to the Game Object that owns this FX Component.\r\n *\r\n * @name Phaser.GameObjects.Components.FX#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FX.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "A reference to the Game Object that owns this FX Component.", "name": "gameObject", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#gameObject", "scope": "instance", "kind": "member", "___id": "T000002R008136", "___s": true }, { "comment": "/**\r\n * Is this a Post FX Controller? or a Pre FX Controller?\r\n *\r\n * @name Phaser.GameObjects.Components.FX#isPost\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FX.js", "lineno": 90, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Is this a Post FX Controller? or a Pre FX Controller?", "name": "isPost", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#isPost", "scope": "instance", "kind": "member", "___id": "T000002R008138", "___s": true }, { "comment": "/**\r\n * Has this FX Component been enabled?\r\n *\r\n * You should treat this property as read-only, although it is toggled\r\n * automaticaly during internal use.\r\n *\r\n * @name Phaser.GameObjects.Components.FX#enabled\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FX.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Has this FX Component been enabled?\r\rYou should treat this property as read-only, although it is toggled\rautomaticaly during internal use.", "name": "enabled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#enabled", "scope": "instance", "kind": "member", "___id": "T000002R008140", "___s": true }, { "comment": "/**\r\n * An array containing all of the Pre FX Controllers that\r\n * have been added to this FX Component. They are processed in\r\n * the order they are added.\r\n *\r\n * This array is empty if this is a Post FX Component.\r\n *\r\n * @name Phaser.GameObjects.Components.FX#list\r\n * @type {Phaser.FX.Controller[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FX.js", "lineno": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "An array containing all of the Pre FX Controllers that\rhave been added to this FX Component. They are processed in\rthe order they are added.\r\rThis array is empty if this is a Post FX Component.", "name": "list", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.FX.Controller", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#list", "scope": "instance", "kind": "member", "___id": "T000002R008142", "___s": true }, { "comment": "/**\r\n * The amount of extra padding to be applied to this Game Object\r\n * when it is being rendered by a PreFX Pipeline.\r\n *\r\n * Lots of FX require additional spacing added to the texture the\r\n * Game Object uses, for example a glow or shadow effect, and this\r\n * method allows you to control how much extra padding is included\r\n * in addition to the texture size.\r\n *\r\n * You do not need to set this if you're only using Post FX.\r\n *\r\n * @name Phaser.GameObjects.Components.FX#padding\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FX.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The amount of extra padding to be applied to this Game Object\rwhen it is being rendered by a PreFX Pipeline.\r\rLots of FX require additional spacing added to the texture the\rGame Object uses, for example a glow or shadow effect, and this\rmethod allows you to control how much extra padding is included\rin addition to the texture size.\r\rYou do not need to set this if you're only using Post FX.", "name": "padding", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#padding", "scope": "instance", "kind": "member", "___id": "T000002R008144", "___s": true }, { "comment": "/**\r\n * Sets the amount of extra padding to be applied to this Game Object\r\n * when it is being rendered by a PreFX Pipeline.\r\n *\r\n * Lots of FX require additional spacing added to the texture the\r\n * Game Object uses, for example a glow or shadow effect, and this\r\n * method allows you to control how much extra padding is included\r\n * in addition to the texture size.\r\n *\r\n * You do not need to set this if you're only using Post FX.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#setPadding\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {number} [padding=0] - The amount of padding to add to this Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "FX.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the amount of extra padding to be applied to this Game Object\rwhen it is being rendered by a PreFX Pipeline.\r\rLots of FX require additional spacing added to the texture the\rGame Object uses, for example a glow or shadow effect, and this\rmethod allows you to control how much extra padding is included\rin addition to the texture size.\r\rYou do not need to set this if you're only using Post FX.", "kind": "function", "name": "setPadding", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount of padding to add to this Game Object.", "name": "padding" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#setPadding", "scope": "instance", "___id": "T000002R008146", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is copied by a PreFX Pipeline.\r\n *\r\n * This happens when the pipeline uses its `copySprite` method.\r\n *\r\n * It's invoked prior to the copy, allowing you to set shader uniforms, etc on the pipeline.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#onFXCopy\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.Pipelines.PreFXPipeline} pipeline - The PreFX Pipeline that invoked this callback.\r\n */", "meta": { "filename": "FX.js", "lineno": 172, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "This callback is invoked when this Game Object is copied by a PreFX Pipeline.\r\rThis happens when the pipeline uses its `copySprite` method.\r\rIt's invoked prior to the copy, allowing you to set shader uniforms, etc on the pipeline.", "kind": "function", "name": "onFXCopy", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline" } }, "description": "The PreFX Pipeline that invoked this callback.", "name": "pipeline" } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#onFXCopy", "scope": "instance", "___id": "T000002R008150", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is rendered by a PreFX Pipeline.\r\n *\r\n * This happens when the pipeline uses its `drawSprite` method.\r\n *\r\n * It's invoked prior to the draw, allowing you to set shader uniforms, etc on the pipeline.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#onFX\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.Pipelines.PreFXPipeline} pipeline - The PreFX Pipeline that invoked this callback.\r\n */", "meta": { "filename": "FX.js", "lineno": 188, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "This callback is invoked when this Game Object is rendered by a PreFX Pipeline.\r\rThis happens when the pipeline uses its `drawSprite` method.\r\rIt's invoked prior to the draw, allowing you to set shader uniforms, etc on the pipeline.", "kind": "function", "name": "onFX", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline" } }, "description": "The PreFX Pipeline that invoked this callback.", "name": "pipeline" } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#onFX", "scope": "instance", "___id": "T000002R008152", "___s": true }, { "comment": "/**\r\n * Enables this FX Component and applies the FXPipeline to the parent Game Object.\r\n *\r\n * This is called automatically whenever you call a method such as `addBloom`, etc.\r\n *\r\n * You can check the `enabled` property to see if the Game Object is already enabled, or not.\r\n *\r\n * This only applies to Pre FX. Post FX are always enabled.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#enable\r\n * @since 3.60.0\r\n *\r\n * @param {number} [padding=0] - The amount of padding to add to this Game Object.\r\n */", "meta": { "filename": "FX.js", "lineno": 204, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Enables this FX Component and applies the FXPipeline to the parent Game Object.\r\rThis is called automatically whenever you call a method such as `addBloom`, etc.\r\rYou can check the `enabled` property to see if the Game Object is already enabled, or not.\r\rThis only applies to Pre FX. Post FX are always enabled.", "kind": "function", "name": "enable", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount of padding to add to this Game Object.", "name": "padding" } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#enable", "scope": "instance", "___id": "T000002R008154", "___s": true }, { "comment": "/**\r\n * Destroys and removes all FX Controllers that are part of this FX Component,\r\n * then disables it.\r\n *\r\n * If this is a Pre FX Component it will only remove Pre FX.\r\n * If this is a Post FX Component it will only remove Post FX.\r\n *\r\n * To remove both at once use the `GameObject.clearFX` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#clear\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "FX.js", "lineno": 244, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Destroys and removes all FX Controllers that are part of this FX Component,\rthen disables it.\r\rIf this is a Pre FX Component it will only remove Pre FX.\rIf this is a Post FX Component it will only remove Post FX.\r\rTo remove both at once use the `GameObject.clearFX` method instead.", "kind": "function", "name": "clear", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#clear", "scope": "instance", "___id": "T000002R008161", "___s": true }, { "comment": "/**\r\n * Searches for the given FX Controller within this FX Component.\r\n *\r\n * If found, the controller is removed from this component and then destroyed.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#remove\r\n * @since 3.60.0\r\n *\r\n * @generic {Phaser.FX.Controller} T\r\n * @genericUse {T} - [fx]\r\n *\r\n * @param {Phaser.FX.Controller} fx - The FX Controller to remove from this FX Component.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "FX.js", "lineno": 281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Searches for the given FX Controller within this FX Component.\r\rIf found, the controller is removed from this component and then destroyed.", "kind": "function", "name": "remove", "since": "3.60.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.FX.Controller} T", "value": "{Phaser.FX.Controller} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [fx]", "value": "{T} - [fx]" } ], "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "description": "The FX Controller to remove from this FX Component.", "name": "fx" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#remove", "scope": "instance", "___id": "T000002R008167", "___s": true }, { "comment": "/**\r\n * Disables this FX Component.\r\n *\r\n * This will reset the pipeline on the Game Object that owns this component back to its\r\n * default and flag this component as disabled.\r\n *\r\n * You can re-enable it again by calling `enable` for Pre FX or by adding an FX for Post FX.\r\n *\r\n * Optionally, set `clear` to destroy all current FX Controllers.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#disable\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [clear=false] - Destroy and remove all FX Controllers that are part of this component.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "FX.js", "lineno": 341, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Disables this FX Component.\r\rThis will reset the pipeline on the Game Object that owns this component back to its\rdefault and flag this component as disabled.\r\rYou can re-enable it again by calling `enable` for Pre FX or by adding an FX for Post FX.\r\rOptionally, set `clear` to destroy all current FX Controllers.", "kind": "function", "name": "disable", "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy and remove all FX Controllers that are part of this component.", "name": "clear" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#disable", "scope": "instance", "___id": "T000002R008176", "___s": true }, { "comment": "/**\r\n * Adds the given FX Controler to this FX Component.\r\n *\r\n * Note that adding an FX Controller does not remove any existing FX. They all stack-up\r\n * on-top of each other. If you don't want this, make sure to call either `remove` or\r\n * `clear` first.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#add\r\n * @since 3.60.0\r\n *\r\n * @generic {Phaser.FX.Controller} T\r\n * @genericUse {T} - [fx]\r\n *\r\n * @param {Phaser.FX.Controller} fx - The FX Controller to add to this FX Component.\r\n * @param {object} [config] - Optional configuration object that is passed to the pipeline during instantiation.\r\n *\r\n * @return {Phaser.FX.Controller} The FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 377, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds the given FX Controler to this FX Component.\r\rNote that adding an FX Controller does not remove any existing FX. They all stack-up\ron-top of each other. If you don't want this, make sure to call either `remove` or\r`clear` first.", "kind": "function", "name": "add", "since": "3.60.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.FX.Controller} T", "value": "{Phaser.FX.Controller} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [fx]", "value": "{T} - [fx]" } ], "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "description": "The FX Controller to add to this FX Component.", "name": "fx" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional configuration object that is passed to the pipeline during instantiation.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "description": "The FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#add", "scope": "instance", "___id": "T000002R008180", "___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 Game Object. The color and strength of the glow can be modified.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#addGlow\r\n * @since 3.60.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 the Sprite.\r\n * @param {number} [innerStrength=0] - The strength of the glow inward from the edge of the Sprite.\r\n * @param {boolean} [knockout=false] - If `true` only the glow is drawn, not the texture itself.\r\n * @param {number} [quality=0.1] - Only available for PostFX. Sets the quality of this Glow effect. Default is 0.1. Cannot be changed post-creation.\r\n * @param {number} [distance=10] - Only available for PostFX. Sets the distance of this Glow effect. Default is 10. Cannot be changed post-creation.\r\n *\r\n * @return {Phaser.FX.Glow} The Glow FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 430, "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 Game Object. The color and strength of the glow can be modified.", "kind": "function", "name": "addGlow", "since": "3.60.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 the Sprite.", "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 the Sprite.", "name": "innerStrength" }, { "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": 0.1, "description": "Only available for PostFX. Sets the quality of this Glow effect. Default is 0.1. Cannot be changed post-creation.", "name": "quality" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "Only available for PostFX. Sets the distance of this Glow effect. Default is 10. Cannot be changed post-creation.", "name": "distance" } ], "returns": [ { "type": { "names": [ "Phaser.FX.Glow" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Glow" } }, "description": "The Glow FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#addGlow", "scope": "instance", "___id": "T000002R008186", "___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.FX#addShadow\r\n * @since 3.60.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 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.\r\n * @param {number} [samples=6] - The number of samples that the shadow effect will run for. An integer between 1 and 12.\r\n * @param {number} [intensity=1] - The intensity of the shadow effect.\r\n *\r\n * @return {Phaser.FX.Shadow} The Shadow FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 455, "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": "3.60.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 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.", "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. An integer between 1 and 12.", "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.FX.Shadow" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Shadow" } }, "description": "The Shadow FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#addShadow", "scope": "instance", "___id": "T000002R008190", "___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.FX#addPixelate\r\n * @since 3.60.0\r\n *\r\n * @param {number} [amount=1] - The amount of pixelation to apply.\r\n *\r\n * @return {Phaser.FX.Pixelate} The Pixelate FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 480, "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": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount of pixelation to apply.", "name": "amount" } ], "returns": [ { "type": { "names": [ "Phaser.FX.Pixelate" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Pixelate" } }, "description": "The Pixelate FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#addPixelate", "scope": "instance", "___id": "T000002R008192", "___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, or a Game Object, gradually darken or blur,\r\n * creating a frame-like appearance. This effect is used to draw the player's focus towards the central action or subject,\r\n * enhance immersion, and provide a cinematic or artistic quality to the game's visuals.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#addVignette\r\n * @since 3.60.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 *\r\n * @return {Phaser.FX.Vignette} The Vignette FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 500, "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, or a Game Object, gradually darken or blur,\rcreating a frame-like appearance. This effect is used to draw the player's focus towards the central action or subject,\renhance immersion, and provide a cinematic or artistic quality to the game's visuals.", "kind": "function", "name": "addVignette", "since": "3.60.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" } ], "returns": [ { "type": { "names": [ "Phaser.FX.Vignette" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Vignette" } }, "description": "The Vignette FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#addVignette", "scope": "instance", "___id": "T000002R008194", "___s": true }, { "comment": "/**\r\n * Adds a Shine effect.\r\n *\r\n * The shine effect is a visual technique that simulates the appearance of reflective\r\n * or glossy surfaces by passing a light beam across a Game Object. This effect is used to\r\n * enhance visual appeal, emphasize certain features, and create a sense of depth or\r\n * material properties.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#addShine\r\n * @since 3.60.0\r\n *\r\n * @param {number} [speed=0.5] - The speed of the Shine effect.\r\n * @param {number} [lineWidth=0.5] - The line width of the Shine effect.\r\n * @param {number} [gradient=3] - The gradient of the Shine effect.\r\n * @param {boolean} [reveal=false] - Does this Shine effect reveal or get added to its target?\r\n *\r\n * @return {Phaser.FX.Shine} The Shine FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 522, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Shine effect.\r\rThe shine effect is a visual technique that simulates the appearance of reflective\ror glossy surfaces by passing a light beam across a Game Object. This effect is used to\renhance visual appeal, emphasize certain features, and create a sense of depth or\rmaterial properties.", "kind": "function", "name": "addShine", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The speed of the Shine effect.", "name": "speed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The line width of the Shine effect.", "name": "lineWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 3, "description": "The gradient of the Shine effect.", "name": "gradient" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Shine effect reveal or get added to its target?", "name": "reveal" } ], "returns": [ { "type": { "names": [ "Phaser.FX.Shine" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Shine" } }, "description": "The Shine FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#addShine", "scope": "instance", "___id": "T000002R008196", "___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.FX#addBlur\r\n * @since 3.60.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.FX.Blur} The Blur FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 545, "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": "3.60.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.FX.Blur" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Blur" } }, "description": "The Blur FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#addBlur", "scope": "instance", "___id": "T000002R008198", "___s": true }, { "comment": "/**\r\n * Adds a Gradient effect.\r\n *\r\n * The gradient overlay effect is a visual technique where a smooth color transition is applied over Game Objects,\r\n * such as sprites or UI components. This effect is used to enhance visual appeal, emphasize depth, or create\r\n * stylistic and atmospheric variations. It can also be utilized to convey information, such as representing\r\n * progress or health status through color changes.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#addGradient\r\n * @since 3.60.0\r\n *\r\n * @param {number} [color1=0xff0000] - The first gradient color, given as a number value.\r\n * @param {number} [color2=0x00ff00] - The second gradient color, given as a number value.\r\n * @param {number} [alpha=0.2] - The alpha value of the gradient effect.\r\n * @param {number} [fromX=0] - The horizontal position the gradient will start from. This value is normalized, between 0 and 1, and is not in pixels.\r\n * @param {number} [fromY=0] - The vertical position the gradient will start from. This value is normalized, between 0 and 1, and is not in pixels.\r\n * @param {number} [toX=0] - The horizontal position the gradient will end at. This value is normalized, between 0 and 1, and is not in pixels.\r\n * @param {number} [toY=1] - The vertical position the gradient will end at. This value is normalized, between 0 and 1, and is not in pixels.\r\n * @param {number} [size=0] - How many 'chunks' the gradient is divided in to, as spread over the entire height of the texture. Leave this at zero for a smooth gradient, or set higher for a more retro chunky effect.\r\n *\r\n * @return {Phaser.FX.Gradient} The Gradient FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 570, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Gradient effect.\r\rThe gradient overlay effect is a visual technique where a smooth color transition is applied over Game Objects,\rsuch as sprites or UI components. This effect is used to enhance visual appeal, emphasize depth, or create\rstylistic and atmospheric variations. It can also be utilized to convey information, such as representing\rprogress or health status through color changes.", "kind": "function", "name": "addGradient", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xff0000", "description": "The first gradient color, given as a number value.", "name": "color1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x00ff00", "description": "The second gradient color, given as a number value.", "name": "color2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.2, "description": "The alpha value of the gradient effect.", "name": "alpha" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position the gradient will start from. This value is normalized, between 0 and 1, and is not in pixels.", "name": "fromX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position the gradient will start from. This value is normalized, between 0 and 1, and is not in pixels.", "name": "fromY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position the gradient will end at. This value is normalized, between 0 and 1, and is not in pixels.", "name": "toX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The vertical position the gradient will end at. This value is normalized, between 0 and 1, and is not in pixels.", "name": "toY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "How many 'chunks' the gradient is divided in to, as spread over the entire height of the texture. Leave this at zero for a smooth gradient, or set higher for a more retro chunky effect.", "name": "size" } ], "returns": [ { "type": { "names": [ "Phaser.FX.Gradient" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Gradient" } }, "description": "The Gradient FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#addGradient", "scope": "instance", "___id": "T000002R008200", "___s": true }, { "comment": "/**\r\n * Adds a Bloom effect.\r\n *\r\n * Bloom is an effect used to reproduce an imaging artifact of real-world cameras.\r\n * The effect produces fringes of light extending from the borders of bright areas in an image,\r\n * contributing to the illusion of an extremely bright light overwhelming the\r\n * camera or eye capturing the scene.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#addBloom\r\n * @since 3.60.0\r\n *\r\n * @param {number} [color] - The color of the Bloom, as a hex value.\r\n * @param {number} [offsetX=1] - The horizontal offset of the bloom effect.\r\n * @param {number} [offsetY=1] - The vertical offset of the bloom effect.\r\n * @param {number} [blurStrength=1] - The strength of the blur process of the bloom effect.\r\n * @param {number} [strength=1] - The strength of the blend process of the bloom effect.\r\n * @param {number} [steps=4] - The number of steps to run the Bloom effect for. This value should always be an integer.\r\n *\r\n * @return {Phaser.FX.Bloom} The Bloom FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 597, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Bloom effect.\r\rBloom is an effect used to reproduce an imaging artifact of real-world cameras.\rThe effect produces fringes of light extending from the borders of bright areas in an image,\rcontributing to the illusion of an extremely bright light overwhelming the\rcamera or eye capturing the scene.", "kind": "function", "name": "addBloom", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color of the Bloom, as a hex value.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The horizontal offset of the bloom effect.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The vertical offset of the bloom effect.", "name": "offsetY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blur process of the bloom effect.", "name": "blurStrength" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend process of the bloom effect.", "name": "strength" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 4, "description": "The number of steps to run the Bloom effect for. This value should always be an integer.", "name": "steps" } ], "returns": [ { "type": { "names": [ "Phaser.FX.Bloom" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Bloom" } }, "description": "The Bloom FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#addBloom", "scope": "instance", "___id": "T000002R008202", "___s": true }, { "comment": "/**\r\n * Adds a ColorMatrix 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.FX#addColorMatrix\r\n * @since 3.60.0\r\n *\r\n * @return {Phaser.FX.ColorMatrix} The ColorMatrix FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a ColorMatrix 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": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.FX.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.ColorMatrix" } }, "description": "The ColorMatrix FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#addColorMatrix", "scope": "instance", "___id": "T000002R008204", "___s": true }, { "comment": "/**\r\n * Adds a Circle effect.\r\n *\r\n * This effect will draw a circle around the texture of the Game Object, effectively masking off\r\n * any area outside of the circle without the need for an actual mask. You can control the thickness\r\n * of the circle, the color of the circle and the color of the background, should the texture be\r\n * transparent. You can also control the feathering applied to the circle, allowing for a harsh or soft edge.\r\n *\r\n * Please note that adding this effect to a Game Object will not change the input area or physics body of\r\n * the Game Object, should it have one.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#addCircle\r\n * @since 3.60.0\r\n *\r\n * @param {number} [thickness=8] - The width of the circle around the texture, in pixels.\r\n * @param {number} [color=0xfeedb6] - The color of the circular ring, given as a number value.\r\n * @param {number} [backgroundColor=0xff0000] - The color of the background, behind the texture, given as a number value.\r\n * @param {number} [scale=1] - The scale of the circle. The default scale is 1, which is a circle the full size of the underlying texture.\r\n * @param {number} [feather=0.005] - The amount of feathering to apply to the circle from the ring.\r\n *\r\n * @return {Phaser.FX.Circle} The Circle FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 641, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Circle effect.\r\rThis effect will draw a circle around the texture of the Game Object, effectively masking off\rany area outside of the circle without the need for an actual mask. You can control the thickness\rof the circle, the color of the circle and the color of the background, should the texture be\rtransparent. You can also control the feathering applied to the circle, allowing for a harsh or soft edge.\r\rPlease note that adding this effect to a Game Object will not change the input area or physics body of\rthe Game Object, should it have one.", "kind": "function", "name": "addCircle", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 8, "description": "The width of the circle around the texture, in pixels.", "name": "thickness" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xfeedb6", "description": "The color of the circular ring, given as a number value.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xff0000", "description": "The color of the background, behind the texture, given as a number value.", "name": "backgroundColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The scale of the circle. The default scale is 1, which is a circle the full size of the underlying texture.", "name": "scale" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.005, "description": "The amount of feathering to apply to the circle from the ring.", "name": "feather" } ], "returns": [ { "type": { "names": [ "Phaser.FX.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Circle" } }, "description": "The Circle FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#addCircle", "scope": "instance", "___id": "T000002R008206", "___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.FX#addBarrel\r\n * @since 3.60.0\r\n *\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 *\r\n * @return {Phaser.FX.Barrel} The Barrel FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 668, "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": "3.60.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.FX.Barrel" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Barrel" } }, "description": "The Barrel FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#addBarrel", "scope": "instance", "___id": "T000002R008208", "___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.FX#addDisplacement\r\n * @since 3.60.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.FX.Displacement} The Displacement FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 686, "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": "3.60.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.FX.Displacement" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Displacement" } }, "description": "The Displacement FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#addDisplacement", "scope": "instance", "___id": "T000002R008210", "___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 1, axis 1\r\n * * bottom to top: direction 1, axis 0\r\n *\r\n * It is up to you to set the `progress` value yourself, i.e. via a Tween, in order to transition the effect.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#addWipe\r\n * @since 3.60.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 or 1. Set in conjunction with the axis property.\r\n * @param {number} [axis=0] - The axis of the wipe effect. Either 0 or 1. Set in conjunction with the direction property.\r\n *\r\n * @return {Phaser.FX.Wipe} The Wipe FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 709, "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 1, axis 1\r* bottom to top: direction 1, axis 0\r\rIt is up to you to set the `progress` value yourself, i.e. via a Tween, in order to transition the effect.", "kind": "function", "name": "addWipe", "since": "3.60.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 or 1. 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 or 1. Set in conjunction with the direction property.", "name": "axis" } ], "returns": [ { "type": { "names": [ "Phaser.FX.Wipe" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Wipe" } }, "description": "The Wipe FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#addWipe", "scope": "instance", "___id": "T000002R008212", "___s": true }, { "comment": "/**\r\n * Adds a Reveal 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 1, axis 1\r\n * * bottom to top: direction 1, axis 0\r\n *\r\n * It is up to you to set the `progress` value yourself, i.e. via a Tween, in order to transition the effect.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#addReveal\r\n * @since 3.60.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 or 1. Set in conjunction with the axis property.\r\n * @param {number} [axis=0] - The axis of the wipe effect. Either 0 or 1. Set in conjunction with the direction property.\r\n *\r\n * @return {Phaser.FX.Wipe} The Wipe FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 740, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Reveal 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 1, axis 1\r* bottom to top: direction 1, axis 0\r\rIt is up to you to set the `progress` value yourself, i.e. via a Tween, in order to transition the effect.", "kind": "function", "name": "addReveal", "since": "3.60.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 or 1. 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 or 1. Set in conjunction with the direction property.", "name": "axis" } ], "returns": [ { "type": { "names": [ "Phaser.FX.Wipe" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Wipe" } }, "description": "The Wipe FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#addReveal", "scope": "instance", "___id": "T000002R008214", "___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.FX#addBokeh\r\n * @since 3.60.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.FX.Bokeh} The Bokeh FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 771, "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": "3.60.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.FX.Bokeh" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Bokeh" } }, "description": "The Bokeh FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#addBokeh", "scope": "instance", "___id": "T000002R008216", "___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.FX#addTiltShift\r\n * @since 3.60.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 * @param {number} [blurX=1] - The amount of horizontal blur.\r\n * @param {number} [blurY=1] - The amount of vertical blur.\r\n * @param {number} [strength=1] - The strength of the blur.\r\n *\r\n * @return {Phaser.FX.Bokeh} The Bokeh TiltShift FX Controller.\r\n */", "meta": { "filename": "FX.js", "lineno": 795, "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": "3.60.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" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount of horizontal blur.", "name": "blurX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount of vertical blur.", "name": "blurY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blur.", "name": "strength" } ], "returns": [ { "type": { "names": [ "Phaser.FX.Bokeh" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Bokeh" } }, "description": "The Bokeh TiltShift FX Controller." } ], "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#addTiltShift", "scope": "instance", "___id": "T000002R008218", "___s": true }, { "comment": "/**\r\n * Destroys this FX Component.\r\n *\r\n * Called automatically when Game Objects are destroyed.\r\n *\r\n * @method Phaser.GameObjects.Components.FX#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FX.js", "lineno": 821, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Destroys this FX Component.\r\rCalled automatically when Game Objects are destroyed.", "kind": "function", "name": "destroy", "since": "3.60.0", "memberof": "Phaser.GameObjects.Components.FX", "longname": "Phaser.GameObjects.Components.FX#destroy", "scope": "instance", "___id": "T000002R008220", "___s": true }, { "comment": "/**\r\n * Provides methods used for obtaining the bounds of a Game Object.\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.\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": "T000002R008227", "___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": 54, "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": "T000002R008233", "___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": 80, "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": "T000002R008238", "___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": 106, "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": "T000002R008243", "___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": 132, "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": "T000002R008248", "___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": 158, "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": "T000002R008253", "___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": 184, "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": "T000002R008258", "___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": 210, "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": "T000002R008263", "___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": 236, "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": "T000002R008268", "___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": 262, "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": "T000002R008273", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Gets the bounds of this Game Object, regardless of origin.\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": "T000002R008278", "___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": "T000002R008311", "___s": true }, { "comment": "/**\r\n * Provides methods used for getting and setting the mask of a Game Object.\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 getting and setting the mask of a Game Object.", "kind": "namespace", "name": "Mask", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.Mask", "scope": "static", "___id": "T000002R008338", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Mask this Game Object is using during render.", "name": "mask", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "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": "T000002R008340", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "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 can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "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": "T000002R008342", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Clears the mask that this Game Object was using.", "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": "T000002R008345", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "kind": "function", "name": "createBitmapMask", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Components.Mask", "longname": "Phaser.GameObjects.Components.Mask#createBitmapMask", "scope": "instance", "___id": "T000002R008349", "___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 * @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": 120, "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.", "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": "T000002R008352", "___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": "T000002R008356", "___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 * @readonly\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" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Origin", "longname": "Phaser.GameObjects.Components.Origin#originX", "scope": "instance", "kind": "member", "___id": "T000002R008360", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "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" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Origin", "longname": "Phaser.GameObjects.Components.Origin#originY", "scope": "instance", "kind": "member", "___id": "T000002R008362", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "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": "T000002R008366", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "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": "T000002R008372", "___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": "T000002R008378", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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.", "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": "T000002R008384", "___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": 159, "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": "T000002R008388", "___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": 182, "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": "T000002R008394", "___s": true }, { "comment": "/**\r\n * Provides methods used for managing a Game Object following a Path.\r\n * Should be applied as a mixin and not 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 used for managing a Game Object following a Path.\rShould be applied as a mixin and not used directly.", "kind": "namespace", "name": "PathFollower", "since": "3.17.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.PathFollower", "scope": "static", "___id": "T000002R008404", "___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": 23, "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": "T000002R008406", "___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": 32, "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": "T000002R008408", "___s": true }, { "comment": "/**\r\n * If the PathFollower is rotating to match the Path (@see Phaser.GameObjects.PathFollower#rotateToPath)\r\n * this value is added to the rotation value. 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.PathFollower#pathRotationOffset\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "If the PathFollower is rotating to match the Path (@see Phaser.GameObjects.PathFollower#rotateToPath)\rthis value is added to the rotation value. 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.PathFollower", "longname": "Phaser.GameObjects.PathFollower#pathRotationOffset", "scope": "instance", "kind": "member", "___id": "T000002R008410", "___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": 54, "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": "T000002R008412", "___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": 64, "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": "T000002R008414", "___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": 73, "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": "T000002R008416", "___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": 82, "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": "T000002R008418", "___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": 91, "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": "T000002R008420", "___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": 111, "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": "T000002R008424", "___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": 145, "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": "T000002R008429", "___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` is this PathFollower is actively following a Path, otherwise `false`.\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 167, "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` is this PathFollower is actively following a Path, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Components.PathFollower", "longname": "Phaser.GameObjects.Components.PathFollower#isFollowing", "scope": "instance", "___id": "T000002R008434", "___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": 184, "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": "T000002R008437", "___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": 285, "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": "T000002R008469", "___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": 306, "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": "T000002R008472", "___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": 328, "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": "T000002R008475", "___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": 350, "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": "T000002R008478", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the WebGL rendering pipeline of a Game Object.\r\n *\r\n * @namespace Phaser.GameObjects.Components.Pipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for setting the WebGL rendering pipeline of a Game Object.", "kind": "namespace", "name": "Pipeline", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.Pipeline", "scope": "static", "___id": "T000002R008492", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "name": "defaultPipeline", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Pipeline", "longname": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "scope": "instance", "kind": "member", "___id": "T000002R008494", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The current WebGL pipeline of this Game Object.", "name": "pipeline", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Pipeline", "longname": "Phaser.GameObjects.Components.Pipeline#pipeline", "scope": "instance", "kind": "member", "___id": "T000002R008496", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "name": "pipelineData", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Components.Pipeline", "longname": "Phaser.GameObjects.Components.Pipeline#pipelineData", "scope": "instance", "kind": "member", "___id": "T000002R008498", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "kind": "function", "name": "initPipeline", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Components.Pipeline", "longname": "Phaser.GameObjects.Components.Pipeline#initPipeline", "scope": "instance", "___id": "T000002R008500", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "kind": "function", "name": "setPipeline", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Pipeline", "longname": "Phaser.GameObjects.Components.Pipeline#setPipeline", "scope": "instance", "___id": "T000002R008509", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "kind": "function", "name": "setPipelineData", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Pipeline", "longname": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "scope": "instance", "___id": "T000002R008516", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "kind": "function", "name": "resetPipeline", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Components.Pipeline", "longname": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "scope": "instance", "___id": "T000002R008520", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "kind": "function", "name": "getPipelineName", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Components.Pipeline", "longname": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "scope": "instance", "___id": "T000002R008525", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the WebGL rendering post pipeline of a Game Object.\r\n *\r\n * @namespace Phaser.GameObjects.Components.PostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for setting the WebGL rendering post pipeline of a Game Object.", "kind": "namespace", "name": "PostPipeline", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.PostPipeline", "scope": "static", "___id": "T000002R008531", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Does this Game Object have any Post Pipelines set?", "name": "hasPostPipeline", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Components.PostPipeline", "longname": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "scope": "instance", "kind": "member", "___id": "T000002R008533", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "name": "postPipelines", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Components.PostPipeline", "longname": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "scope": "instance", "kind": "member", "___id": "T000002R008535", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "name": "postPipelineData", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Components.PostPipeline", "longname": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "scope": "instance", "kind": "member", "___id": "T000002R008537", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "name": "preFX", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Components.PostPipeline", "longname": "Phaser.GameObjects.Components.PostPipeline#preFX", "scope": "instance", "kind": "member", "___id": "T000002R008539", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "name": "postFX", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Components.PostPipeline", "longname": "Phaser.GameObjects.Components.PostPipeline#postFX", "scope": "instance", "kind": "member", "___id": "T000002R008541", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "kind": "function", "name": "initPostPipeline", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "memberof": "Phaser.GameObjects.Components.PostPipeline", "longname": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "scope": "instance", "___id": "T000002R008543", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "kind": "function", "name": "setPostPipeline", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.PostPipeline", "longname": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "scope": "instance", "___id": "T000002R008549", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "kind": "function", "name": "setPostPipelineData", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.PostPipeline", "longname": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "scope": "instance", "___id": "T000002R008558", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "kind": "function", "name": "getPostPipeline", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Components.PostPipeline", "longname": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "scope": "instance", "___id": "T000002R008562", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "kind": "function", "name": "resetPostPipeline", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "memberof": "Phaser.GameObjects.Components.PostPipeline", "longname": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "scope": "instance", "___id": "T000002R008569", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "kind": "function", "name": "removePostPipeline", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Components.PostPipeline", "longname": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "scope": "instance", "___id": "T000002R008577", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "kind": "function", "name": "clearFX", "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." } ], "memberof": "Phaser.GameObjects.Components.PostPipeline", "longname": "Phaser.GameObjects.Components.PostPipeline#clearFX", "scope": "instance", "___id": "T000002R008584", "___s": true }, { "comment": "/**\r\n * Provides methods used for getting and 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 getting and setting the Scroll Factor of a Game Object.", "kind": "namespace", "name": "ScrollFactor", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.ScrollFactor", "scope": "static", "___id": "T000002R008587", "___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 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.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 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.0.0", "memberof": "Phaser.GameObjects.Components.ScrollFactor", "longname": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "scope": "instance", "kind": "member", "___id": "T000002R008589", "___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 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.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 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.0.0", "memberof": "Phaser.GameObjects.Components.ScrollFactor", "longname": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "scope": "instance", "kind": "member", "___id": "T000002R008591", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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 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 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.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": "T000002R008593", "___s": true }, { "comment": "/**\r\n * Provides methods used for getting and setting the size of a Game Object.\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.", "kind": "namespace", "name": "Size", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.Size", "scope": "static", "___id": "T000002R008599", "___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": 27, "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": "T000002R008603", "___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": 40, "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": "T000002R008605", "___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": 53, "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": "T000002R008607", "___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": 78, "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": "T000002R008612", "___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": 103, "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": "T000002R008617", "___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": 139, "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": "T000002R008625", "___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.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": 166, "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 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 instance." } ], "memberof": "Phaser.GameObjects.Components.Size", "longname": "Phaser.GameObjects.Components.Size#setDisplaySize", "scope": "instance", "___id": "T000002R008629", "___s": true }, { "comment": "/**\r\n * Provides methods used for getting and setting the texture of a Game Object.\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 getting and setting the texture of a Game Object.", "kind": "namespace", "name": "Texture", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.Texture", "scope": "static", "___id": "T000002R008636", "___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": 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.Texture", "longname": "Phaser.GameObjects.Components.Texture#texture", "scope": "instance", "kind": "member", "___id": "T000002R008638", "___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": 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.Texture", "longname": "Phaser.GameObjects.Components.Texture#frame", "scope": "instance", "kind": "member", "___id": "T000002R008640", "___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": 49, "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": "T000002R008644", "___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": 75, "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": "T000002R008647", "___s": true }, { "comment": "/**\r\n * Provides methods used for getting and setting the texture of a Game Object.\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.", "kind": "namespace", "name": "TextureCrop", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.TextureCrop", "scope": "static", "___id": "T000002R008659", "___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": "T000002R008661", "___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": "T000002R008663", "___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": "T000002R008665", "___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 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 rect 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. 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.\r\n * @param {number} [width] - The width of the crop rectangle in pixels.\r\n * @param {number} [height] - The height of the crop rectangle in pixels.\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 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 rect 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. 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.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the crop rectangle in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the crop rectangle in pixels.", "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": "T000002R008667", "___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": 108, "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": "T000002R008672", "___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": 128, "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": "T000002R008675", "___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": 7, "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": "T000002R008701", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertice 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": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The tint value being applied to the top-left vertice 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": "T000002R008703", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-right vertice 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The tint value being applied to the top-right vertice 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": "T000002R008705", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-left vertice 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": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The tint value being applied to the bottom-left vertice 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": "T000002R008707", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-right vertice 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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The tint value being applied to the bottom-right vertice 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": "T000002R008709", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "name": "tintFill", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.11.0", "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#tintFill", "scope": "instance", "kind": "member", "___id": "T000002R008711", "___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 'additive',\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": 79, "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 type to 'additive',\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": "T000002R008713", "___s": true }, { "comment": "/**\r\n * Sets an additive tint 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 * multiplying it by 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 * To swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.\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": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets an additive tint on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by 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\rTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.", "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": "T000002R008715", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on this Game Object.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. You can provide either one color value, in which case the whole\r\n * Game Object will be rendered in that color. Or you can provide a color per corner. The colors\r\n * 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 * To swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintFill\r\n * @webglOnly\r\n * @since 3.11.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.\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": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets a fill-based tint on this Game Object.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. You can provide either one color value, in which case the whole\rGame Object will be rendered in that color. Or you can provide a color per corner. The colors\rare 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\rTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.", "kind": "function", "name": "setTintFill", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.11.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 not 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#setTintFill", "scope": "instance", "___id": "T000002R008726", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.\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": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.", "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": "T000002R008729", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * It checks to see if the 4 tint properties are set to the value 0xffffff\r\n * and that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.\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": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Does this Game Object have a tint applied?\r\rIt checks to see if the 4 tint properties are set to the value 0xffffff\rand that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.", "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": "T000002R008732", "___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": "T000002R008737", "___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": "T000002R008770", "___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": "T000002R008772", "___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": "T000002R008780", "___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": "T000002R008782", "___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": "T000002R008784", "___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": "T000002R008786", "___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": "T000002R008788", "___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": "T000002R008796", "___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": "T000002R008803", "___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": "T000002R008810", "___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 1\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": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#rotation", "scope": "instance", "kind": "member", "___id": "T000002R008815", "___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": "T000002R008820", "___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": "T000002R008830", "___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": "T000002R008836", "___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": "T000002R008844", "___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": "T000002R008848", "___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": "T000002R008852", "___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": "T000002R008858", "___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": "T000002R008862", "___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": "T000002R008866", "___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": "T000002R008870", "___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": "T000002R008874", "___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": "T000002R008877", "___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": 542, "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": "T000002R008883", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Gets the sum total rotation of all of this Game Objects 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": "T000002R008893", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Matrix used for display transformations for rendering.\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 Matrix used for display transformations for rendering.\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": "T000002R008903", "___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": 48, "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": "T000002R008912", "___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": 57, "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": "T000002R008914", "___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": 72, "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": "T000002R008921", "___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": 82, "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": "T000002R008923", "___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": 103, "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": "T000002R008928", "___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": 124, "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": "T000002R008933", "___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": 145, "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": "T000002R008938", "___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": 166, "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": "T000002R008943", "___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": 187, "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": "T000002R008948", "___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": 208, "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": "T000002R008953", "___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": 229, "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": "T000002R008958", "___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": 250, "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": "T000002R008963", "___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": 267, "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": "T000002R008966", "___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": 307, "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": "T000002R008974", "___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": 324, "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": "T000002R008977", "___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": 341, "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": "T000002R008980", "___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": 363, "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": "T000002R008989", "___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": 384, "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": "T000002R008994", "___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": 407, "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": "T000002R009001", "___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": 437, "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": "T000002R009014", "___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: `offsetY * 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": 483, "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: `offsetY * 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": "T000002R009037", "___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": 530, "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": "T000002R009061", "___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": 566, "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": "T000002R009076", "___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": 597, "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": "T000002R009090", "___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": 628, "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": "T000002R009106", "___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": 652, "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": "T000002R009115", "___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": 677, "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": "T000002R009124", "___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": 697, "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": "T000002R009127", "___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": 717, "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": "T000002R009130", "___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": 750, "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": "T000002R009140", "___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": 779, "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": "T000002R009149", "___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": 838, "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": "T000002R009171", "___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": 872, "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": "T000002R009182", "___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 x/y/xw/yh values.\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.\r\n * @param {number} y - The y value.\r\n * @param {number} xw - The xw value.\r\n * @param {number} yh - The yh value.\r\n * @param {boolean} roundPixels - Pass the results via Math.round?\r\n * @param {Float32Array} [quad] - Optional Float32Array to store the results in. Otherwises uses the local quad array.\r\n *\r\n * @return {Float32Array} The quad Float32Array.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 908, "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 x/y/xw/yh values.\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.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y value.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The xw value.", "name": "xw" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The yh value.", "name": "yh" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Pass the results via Math.round?", "name": "roundPixels" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "optional": true, "description": "Optional Float32Array to store the results in. Otherwises 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": "T000002R009195", "___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": 963, "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": "T000002R009213", "___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": 980, "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": "T000002R009215", "___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": 997, "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": "T000002R009217", "___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": 1023, "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": "T000002R009221", "___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": 1049, "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": "T000002R009225", "___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": 1064, "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": "T000002R009228", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the visibility of a Game Object.\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.\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": "T000002R009235", "___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": 31, "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": "T000002R009239", "___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": 63, "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": "T000002R009247", "___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. However, Container children cannot be masked.\r\n * The masks do not 'stack up'. Only a Container on the root of the display list will use its mask.\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 loose 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.PostPipeline\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": 19, "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. However, Container children cannot be masked.\rThe masks do not 'stack up'. Only a Container on the root of the display list will use its mask.\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 loose 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.PostPipeline", "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": "T000002R009261", "___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": 104, "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": "T000002R009266", "___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": 113, "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": "T000002R009268", "___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": 133, "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": "T000002R009270", "___s": true }, { "comment": "/**\r\n * The cursor position.\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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "The cursor position.", "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": "T000002R009272", "___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": 154, "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": "T000002R009274", "___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": 193, "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": "T000002R009282", "___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": 220, "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": "T000002R009284", "___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": 259, "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": "T000002R009286", "___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": 278, "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": "T000002R009289", "___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": 297, "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": "T000002R009292", "___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": 316, "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": "T000002R009295", "___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": 335, "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": "T000002R009298", "___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": 364, "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": "T000002R009302", "___s": true }, { "comment": "/**\r\n * Takes a Point-like object, such as a Vector2, Geom.Point 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": 481, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Takes a Point-like object, such as a Vector2, Geom.Point 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": "T000002R009319", "___s": true }, { "comment": "/**\r\n * Returns the world transform matrix as used for Bounds checks.\r\n *\r\n * The returned matrix is temporal 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": 519, "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 temporal 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": "T000002R009325", "___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 * @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": 534, "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.", "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": "T000002R009327", "___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": 556, "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": "T000002R009329", "___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": 581, "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": "T000002R009331", "___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": 599, "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": "T000002R009333", "___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 boolean.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 617, "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 boolean.", "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": "T000002R009335", "___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": 649, "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": "T000002R009338", "___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": 668, "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": "T000002R009340", "___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": 687, "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": "T000002R009342", "___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": 715, "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": "T000002R009344", "___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": 748, "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": "T000002R009346", "___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": 771, "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": "T000002R009348", "___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": 793, "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": "T000002R009350", "___s": true }, { "comment": "/**\r\n * Moves a Game Object above another one within this Container.\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": 819, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Moves a Game Object above another one within this Container.\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": "T000002R009352", "___s": true }, { "comment": "/**\r\n * Moves a Game Object below another one within this Container.\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": 842, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Moves a Game Object below another one within this Container.\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": "T000002R009354", "___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": 865, "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": "T000002R009356", "___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": 903, "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": "T000002R009361", "___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": 928, "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": "T000002R009364", "___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": 957, "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": "T000002R009368", "___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": 995, "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": "T000002R009373", "___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": 1016, "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": "T000002R009375", "___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": 1037, "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": "T000002R009377", "___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": 1057, "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": "T000002R009379", "___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": 1077, "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": "T000002R009381", "___s": true }, { "comment": "/**\r\n * Shuffles the 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": 1092, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Shuffles the all Game Objects in this Container using the Fisher-Yates implementation.", "kind": "function", "name": "shuffle", "since": "3.4.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#shuffle", "scope": "instance", "___id": "T000002R009383", "___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": 1107, "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": "T000002R009385", "___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": 1141, "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": "T000002R009388", "___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 get 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": 1161, "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 get 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": "T000002R009390", "___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": 1185, "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": "T000002R009392", "___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": 1193, "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": "T000002R009393", "___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": 1233, "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": "T000002R009402", "___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": 1268, "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": "T000002R009409", "___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": 1311, "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": "T000002R009415", "___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": 1328, "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": "T000002R009418", "___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": 1356, "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": "T000002R009422", "___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": 1384, "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": "T000002R009426", "___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": 1412, "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": "T000002R009429", "___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": 1440, "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": "T000002R009432", "___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": 13, "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": "T000002R009454", "___s": true }, { "comment": "/**\r\n * Creates a new Container Game Object and adds it to the Scene.\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 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\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 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": "T000002R009463", "___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": "T000002R009505", "___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": "T000002R009506", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Display List plugin.\r\n *\r\n * Display Lists belong to a Scene and maintain the list of Game Objects to render every frame.\r\n *\r\n * Some of these Game Objects may also be part of the Scene's [Update List]{@link Phaser.GameObjects.UpdateList}, for updating.\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 plugin.\r\rDisplay Lists belong to a Scene and maintain the list of Game Objects to render every frame.\r\rSome of these Game Objects may also be part of the Scene's [Update List]{@link Phaser.GameObjects.UpdateList}, for updating.", "kind": "class", "name": "DisplayList", "augments": [ "Phaser.Structs.List." ], "memberof": "Phaser.GameObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene that this Display List belongs to.", "name": "scene" } ], "scope": "static", "longname": "Phaser.GameObjects.DisplayList", "___id": "T000002R009513", "___s": true }, { "comment": "/**\r\n * The flag the 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": 40, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The flag the 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": "T000002R009517", "___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": 50, "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": "T000002R009519", "___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": 59, "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": "T000002R009521", "___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": 68, "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": "T000002R009523", "___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": 169, "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": "T000002R009537", "___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": 180, "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": "T000002R009540", "___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": 196, "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": "T000002R009543", "___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": 212, "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": "T000002R009545", "___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 * 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\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": "T000002R009566", "___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": 121, "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": "T000002R009571", "___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": 130, "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": "T000002R009573", "___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": 139, "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": "T000002R009575", "___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": 149, "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": "T000002R009577", "___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": 164, "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": "T000002R009579", "___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": 175, "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": "T000002R009581", "___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 * All values in the Vector4 are treated as degrees, unless the `rotate3dAngle` property is changed.\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": 186, "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\rAll values in the Vector4 are treated as degrees, unless the `rotate3dAngle` property is changed.\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": "T000002R009583", "___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": 201, "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": "T000002R009585", "___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": 213, "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": "T000002R009587", "___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": 226, "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": "T000002R009589", "___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": 240, "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": "T000002R009591", "___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": 254, "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": "T000002R009593", "___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": 266, "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": "T000002R009595", "___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": 332, "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": "T000002R009604", "___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": 356, "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": "T000002R009610", "___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": 380, "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": "T000002R009613", "___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": 408, "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": "T000002R009618", "___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": 444, "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": "T000002R009622", "___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 ready 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": 483, "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 ready 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": "T000002R009628", "___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 ready 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": 530, "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 ready 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": "T000002R009630", "___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} 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": 648, "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": "key of the html cache entry to use for this DOM Element.", "name": "The" }, { "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": "T000002R009645", "___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": 698, "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": "T000002R009648", "___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": 758, "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": "T000002R009658", "___s": true }, { "comment": "/**\r\n * Internal method that calls `getBoundingClientRect` on the `node` and then sets the bounds width\r\n * and height into the `displayWidth` and `displayHeight` properties, and the `clientWidth` and `clientHeight`\r\n * 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": 779, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "Internal method that calls `getBoundingClientRect` on the `node` and then sets the bounds width\rand height into the `displayWidth` and `displayHeight` properties, and the `clientWidth` and `clientHeight`\rvalues 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": "T000002R009661", "___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": "T000002R009669", "___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": "T000002R009673", "___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": "T000002R009675", "___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": "T000002R009677", "___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": "T000002R009680", "___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": "T000002R009683", "___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": "T000002R009691", "___s": true }, { "comment": "/**\n * DOM Element Game Objects are a way to control and manipulate HTML Elements over the top of your game.\n *\n * In order for DOM Elements to display you have to enable them by adding the following to your game\n * configuration object:\n *\n * ```javascript\n * dom {\n * createContainer: true\n * }\n * ```\n *\n * When this is added, Phaser will automatically create a DOM Container div that is positioned over the top\n * of the game canvas. This div is sized to match the canvas, and if the canvas size changes, as a result of\n * settings within the Scale Manager, the dom container is resized accordingly.\n *\n * You can create a DOM Element by either passing in DOMStrings, or by passing in a reference to an existing\n * Element that you wish to be placed under the control of Phaser. For example:\n *\n * ```javascript\n * this.add.dom(x, y, 'div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\n * ```\n *\n * The above code will insert a div element into the DOM Container at the given x/y coordinate. The DOMString in\n * the 4th argument sets the initial CSS style of the div and the final argument is the inner text. In this case,\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.\n *\n * You should nearly always, without exception, use explicitly sized HTML Elements, in order to fully control\n * alignment and positioning of the elements next to regular game content.\n *\n * Rather than specify the CSS and HTML directly you can use the `load.html` File Loader to load it into the\n * cache and then use the `createFromCache` method instead. You can also use `createFromHTML` and various other\n * methods available in this class to help construct your elements.\n *\n * Once the element has been created you can then control it like you would any other Game Object. You can set its\n * position, scale, rotation, alpha and other properties. It will move as the main Scene Camera moves and be clipped\n * at the edge of the canvas. It's important to remember some limitations of DOM Elements: The obvious one is that\n * they appear above or below your game canvas. You cannot blend them into the display list, meaning you cannot have\n * a DOM Element, then a Sprite, then another DOM Element behind it.\n *\n * They also cannot be enabled for input. To do that, you have to use the `addListener` method to add native event\n * listeners directly. The final limitation is to do with cameras. The DOM Container is sized to match the game canvas\n * entirely and clipped accordingly. DOM Elements respect camera scrolling and scrollFactor settings, but if you\n * change the size of the camera so it no longer matches the size of the canvas, they won't be clipped accordingly.\n *\n * Also, all DOM Elements are inserted into the same DOM Container, regardless of which Scene they are created in.\n *\n * DOM Elements are a powerful way to align native HTML with your Phaser Game Objects. For example, you can insert\n * a login form for a multiplayer game directly into your title screen. Or a text input box for a highscore table.\n * Or a banner ad from a 3rd party service. Or perhaps you'd like to use them for high resolution text display and\n * UI. The choice is up to you, just remember that you're dealing with standard HTML and CSS floating over the top\n * of your game, and should treat it accordingly.\n *\n * Note: This method will only be available if the DOM Element Game Object has been built into Phaser.\n *\n * @method Phaser.GameObjects.GameObjectFactory#dom\n * @since 3.17.0\n *\n * @param {number} x - The horizontal position of this DOM Element in the world.\n * @param {number} y - The vertical position of this DOM Element in the world.\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'.\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.\n * @param {string} [innerText] - If given, will be set directly as the elements `innerText` property value, replacing whatever was there before.\n *\n * @return {Phaser.GameObjects.DOMElement} The Game Object that was created.\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.\n\nIn order for DOM Elements to display you have to enable them by adding the following to your game\nconfiguration object:\n\n```javascript\ndom {\n createContainer: true\n}\n```\n\nWhen this is added, Phaser will automatically create a DOM Container div that is positioned over the top\nof the game canvas. This div is sized to match the canvas, and if the canvas size changes, as a result of\nsettings within the Scale Manager, the dom container is resized accordingly.\n\nYou can create a DOM Element by either passing in DOMStrings, or by passing in a reference to an existing\nElement that you wish to be placed under the control of Phaser. For example:\n\n```javascript\nthis.add.dom(x, y, 'div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\n```\n\nThe above code will insert a div element into the DOM Container at the given x/y coordinate. The DOMString in\nthe 4th argument sets the initial CSS style of the div and the final argument is the inner text. In this case,\nit will create a lime colored div that is 220px by 100px in size with the text Phaser in it, in an Arial font.\n\nYou should nearly always, without exception, use explicitly sized HTML Elements, in order to fully control\nalignment and positioning of the elements next to regular game content.\n\nRather than specify the CSS and HTML directly you can use the `load.html` File Loader to load it into the\ncache and then use the `createFromCache` method instead. You can also use `createFromHTML` and various other\nmethods available in this class to help construct your elements.\n\nOnce the element has been created you can then control it like you would any other Game Object. You can set its\nposition, scale, rotation, alpha and other properties. It will move as the main Scene Camera moves and be clipped\nat the edge of the canvas. It's important to remember some limitations of DOM Elements: The obvious one is that\nthey appear above or below your game canvas. You cannot blend them into the display list, meaning you cannot have\na DOM Element, then a Sprite, then another DOM Element behind it.\n\nThey also cannot be enabled for input. To do that, you have to use the `addListener` method to add native event\nlisteners directly. The final limitation is to do with cameras. The DOM Container is sized to match the game canvas\nentirely and clipped accordingly. DOM Elements respect camera scrolling and scrollFactor settings, but if you\nchange the size of the camera so it no longer matches the size of the canvas, they won't be clipped accordingly.\n\nAlso, all DOM Elements are inserted into the same DOM Container, regardless of which Scene they are created in.\n\nDOM Elements are a powerful way to align native HTML with your Phaser Game Objects. For example, you can insert\na login form for a multiplayer game directly into your title screen. Or a text input box for a highscore table.\nOr a banner ad from a 3rd party service. Or perhaps you'd like to use them for high resolution text display and\nUI. The choice is up to you, just remember that you're dealing with standard HTML and CSS floating over the top\nof your game, and should treat it accordingly.\n\nNote: This method will only be available if the DOM Element Game Object has been built into Phaser.", "kind": "function", "name": "dom", "since": "3.17.0", "params": [ { "type": { "names": [ "number" ], "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 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" } ], "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": "T000002R009737", "___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": "T000002R009747", "___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": "T000002R009749", "___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": "T000002R009751", "___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": "T000002R009770", "___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": "T000002R009772", "___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": "T000002R009774", "___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": "T000002R009776", "___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": "T000002R009778", "___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": "T000002R009780", "___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": "T000002R009782", "___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": "T000002R009784", "___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": "T000002R009786", "___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": "T000002R009788", "___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": "T000002R009790", "___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": "T000002R009792", "___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": "T000002R009794", "___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": "T000002R009796", "___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": "T000002R009798", "___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 * clear down the pipeline 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 * Once you've finished, you should free-up any of your resources.\r\n * The Extern will then rebind the Phaser pipeline 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 * @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,\rclear down the pipeline and 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\rOnce you've finished, you should free-up any of your resources.\rThe Extern will then rebind the Phaser pipeline 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.", "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": "T000002R009804", "___s": true }, { "comment": "/**\n * Creates a new Extern Game Object and adds it to the Scene.\n *\n * Note: This method will only be available if the Extern Game Object has been built into Phaser.\n *\n * @method Phaser.GameObjects.GameObjectFactory#extern\n * @since 3.16.0\n *\n * @return {Phaser.GameObjects.Extern} The Game Object that was created.\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.\n\nNote: This method will only be available if the Extern Game Object has been built into Phaser.", "kind": "function", "name": "extern", "since": "3.16.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Extern" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Extern" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#extern", "scope": "instance", "___id": "T000002R009816", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The base class that all Game Objects extend.\r\n * You don't create GameObjects directly and they cannot be added to the display list.\r\n * Instead, use them as the base for your own custom classes.\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 * @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": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "classdesc": "The base class that all Game Objects extend.\rYou don't create GameObjects directly and they cannot be added to the display list.\rInstead, use them as the base for your own custom classes.", "kind": "class", "name": "GameObject", "memberof": "Phaser.GameObjects", "augments": [ "Phaser.Events.EventEmitter" ], "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "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": "T000002R009837", "___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": 39, "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": "T000002R009841", "___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": 53, "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": "T000002R009843", "___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": 67, "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": "T000002R009845", "___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": 77, "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": "T000002R009847", "___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": 93, "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": "T000002R009849", "___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": 102, "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": "T000002R009851", "___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": 113, "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": "T000002R009853", "___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": 125, "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": "T000002R009855", "___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": 136, "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": "T000002R009857", "___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": 148, "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": "T000002R009859", "___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": 160, "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": "T000002R009861", "___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": 175, "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": "T000002R009863", "___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": 186, "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": "T000002R009865", "___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": 196, "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": "T000002R009867", "___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": 216, "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": "T000002R009869", "___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": 234, "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": "T000002R009872", "___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": 252, "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": "T000002R009875", "___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": 276, "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": "T000002R009878", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "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": "data" } ], "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": "T000002R009881", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": "T000002R009884", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": "T000002R009887", "___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": 416, "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": "T000002R009890", "___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": 456, "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": "T000002R009893", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "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", "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": "T000002R009895", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "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", "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": "T000002R009897", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "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 overriden 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": "T000002R009900", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "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 overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed 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": "T000002R009902", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "kind": "function", "name": "update", "since": "3.0.0", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#update", "scope": "instance", "___id": "T000002R009904", "___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": 591, "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": "T000002R009906", "___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": 604, "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": "T000002R009908", "___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": 622, "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": "T000002R009911", "___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 temporarly\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": 671, "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 temporarly\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": "T000002R009918", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` 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": "T000002R009922", "___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 move 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 temporarly\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": 747, "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 move 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 temporarly\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": "T000002R009924", "___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": 785, "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": "T000002R009928", "___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": 810, "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": "T000002R009930", "___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": 900, "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": "T000002R009942", "___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 a limited set of parameters such as with 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 Factory 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 a limited set of parameters such as with 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 Factory belongs.", "name": "scene" } ], "scope": "static", "longname": "Phaser.GameObjects.GameObjectCreator", "___id": "T000002R009948", "___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": "T000002R009951", "___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": "T000002R009953", "___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": "T000002R009955", "___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": "T000002R009957", "___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": "T000002R009959", "___s": true }, { "comment": "/**\r\n * Static method called directly by the Game Object creator functions.\r\n * With this method you can register a custom GameObject factory in the GameObjectCreator,\r\n * providing a name (`factoryType`) and the constructor (`factoryFunction`) in order\r\n * to be called when you invoke Phaser.Scene.make[ factoryType ] method.\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 to Phaser.Scene.make[ factoryType ] method.\r\n * @param {function} factoryFunction - The constructor function to be called when you invoke to the Phaser.Scene.make method.\r\n */", "meta": { "filename": "GameObjectCreator.js", "lineno": 154, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Static method called directly by the Game Object creator functions.\rWith this method you can register a custom GameObject factory in the GameObjectCreator,\rproviding a name (`factoryType`) and the constructor (`factoryFunction`) in order\rto be called when you invoke Phaser.Scene.make[ factoryType ] method.", "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 to Phaser.Scene.make[ factoryType ] method.", "name": "factoryType" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The constructor function to be called when you invoke to the Phaser.Scene.make method.", "name": "factoryFunction" } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator.register", "___id": "T000002R009976", "___s": true }, { "comment": "/**\r\n * Static method called directly by the Game Object Creator functions.\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": 175, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Static method called directly by the Game Object Creator functions.\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": "T000002R009979", "___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 *\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.\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": "T000002R009985", "___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": 32, "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": "T000002R009988", "___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": 42, "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": "T000002R009990", "___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": 52, "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": "T000002R009992", "___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": 62, "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": "T000002R009994", "___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": 72, "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": "T000002R009996", "___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": 116, "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": "T000002R010004", "___s": true }, { "comment": "/**\r\n * Static method called directly by the Game Object factory functions.\r\n * With this method you can register a custom GameObject factory in the GameObjectFactory,\r\n * providing a name (`factoryType`) and the constructor (`factoryFunction`) in order\r\n * to be called when you call to Phaser.Scene.add[ factoryType ] method.\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 of the factory that you will use to call to Phaser.Scene.add[ factoryType ] method.\r\n * @param {function} factoryFunction - The constructor function to be called when you invoke to the Phaser.Scene.add method.\r\n */", "meta": { "filename": "GameObjectFactory.js", "lineno": 185, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Static method called directly by the Game Object factory functions.\rWith this method you can register a custom GameObject factory in the GameObjectFactory,\rproviding a name (`factoryType`) and the constructor (`factoryFunction`) in order\rto be called when you call to Phaser.Scene.add[ factoryType ] method.", "kind": "function", "name": "register", "scope": "static", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the factory that you will use to call to Phaser.Scene.add[ factoryType ] method.", "name": "factoryType" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The constructor function to be called when you invoke to the Phaser.Scene.add method.", "name": "factoryFunction" } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory.register", "___id": "T000002R010015", "___s": true }, { "comment": "/**\r\n * Static method called directly by the Game Object factory functions.\r\n * With this method you can remove a custom GameObject factory registered in the GameObjectFactory,\r\n * providing a its `factoryType`.\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": 206, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Static method called directly by the Game Object factory functions.\rWith this method you can remove a custom GameObject factory registered in the GameObjectFactory,\rproviding a its `factoryType`.", "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": "T000002R010018", "___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 results 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 *\r\n * @return {Phaser.Types.GameObjects.GetCalcMatrixResults} The results object containing the updated transform matrices.\r\n */", "meta": { "filename": "GetCalcMatrix.js", "lineno": 15, "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 results 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" } ], "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": "T000002R010029", "___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 * 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.Mask\r\n * @extends Phaser.GameObjects.Components.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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": 18, "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\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.Mask", "Phaser.GameObjects.Components.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "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": "T000002R010069", "___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": 108, "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": "T000002R010076", "___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": 118, "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": "T000002R010078", "___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": 128, "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": "T000002R010080", "___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": 138, "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": "T000002R010082", "___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": 150, "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": "T000002R010084", "___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": 162, "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": "T000002R010086", "___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": 174, "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": "T000002R010088", "___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": 186, "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": "T000002R010090", "___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": 214, "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": "T000002R010094", "___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": 246, "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": "T000002R010101", "___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": 272, "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": "T000002R010105", "___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": 295, "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": "T000002R010108", "___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 tint being applied to the top-left of the 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 * @param {number} [alpha=1] - The fill alpha.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 341, "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 tint being applied to the top-left of the Game Object.", "name": "topLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint being applied to the top-right of the Game Object.", "name": "topRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint being applied to the bottom-left of the Game Object.", "name": "bottomLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint being applied to the bottom-right of the Game Object.", "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": "T000002R010114", "___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": 379, "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": "T000002R010117", "___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": 396, "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": "T000002R010119", "___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": 413, "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": "T000002R010121", "___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": 430, "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": "T000002R010123", "___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": 450, "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": "T000002R010125", "___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": 467, "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": "T000002R010127", "___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": 487, "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": "T000002R010129", "___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": 502, "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": "T000002R010131", "___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": 517, "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": "T000002R010133", "___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": 538, "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": "T000002R010135", "___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": 559, "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": "T000002R010137", "___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": 574, "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": "T000002R010139", "___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": 589, "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": "T000002R010141", "___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": 612, "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": "T000002R010143", "___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": 654, "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": "T000002R010148", "___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": 746, "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": "T000002R010167", "___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.Geom.Point|Phaser.Math.Vector2|object)} 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": 844, "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.Geom.Point", "Phaser.Math.Vector2", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "object" } ] } }, "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": "T000002R010187", "___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": 862, "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": "T000002R010189", "___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": 896, "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": "T000002R010194", "___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": 911, "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": "T000002R010196", "___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": 926, "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": "T000002R010198", "___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": 951, "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": "T000002R010200", "___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": 976, "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": "T000002R010202", "___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": 991, "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": "T000002R010204", "___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": 1014, "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": "T000002R010206", "___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": 1037, "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": "T000002R010208", "___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 {(array|Phaser.Geom.Point[])} 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": 1058, "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "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": "T000002R010210", "___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 {(array|Phaser.Geom.Point[])} 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 stroked.\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": 1105, "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "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 stroked.", "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": "T000002R010216", "___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": 1152, "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": "T000002R010222", "___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": 1172, "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": "T000002R010226", "___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": 1197, "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": "T000002R010231", "___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": 1217, "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": "T000002R010235", "___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": 1242, "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": "T000002R010240", "___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": 1283, "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": "T000002R010244", "___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": 1322, "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": "T000002R010248", "___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": 1341, "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": "T000002R010250", "___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": 1362, "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": "T000002R010252", "___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": 1389, "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": "T000002R010254", "___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": 1416, "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": "T000002R010256", "___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": 1442, "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": "T000002R010258", "___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 texture 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": 1467, "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 texture 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": "T000002R010261", "___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": 1551, "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": "T000002R010279", "___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": 1565, "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": "T000002R010282", "___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": "T000002R010334", "___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": "T000002R010340", "___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": "T000002R010451", "___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": "T000002R010452", "___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": "T000002R010453", "___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": "T000002R010454", "___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": "T000002R010455", "___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": "T000002R010456", "___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 * 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": 20, "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\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": "T000002R010469", "___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": 86, "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": "T000002R010478", "___s": true }, { "comment": "/**\r\n * Members of this group.\r\n *\r\n * @name Phaser.GameObjects.Group#children\r\n * @type {Phaser.Structs.Set.}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Group.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Members of this group.", "name": "children", "type": { "names": [ "Phaser.Structs.Set." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.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": "T000002R010480", "___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": 104, "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": "T000002R010482", "___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": 114, "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": "T000002R010484", "___s": true }, { "comment": "/**\r\n * The class to create new group members from.\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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "The class to create new group members from.", "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": "T000002R010486", "___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": 136, "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": "T000002R010488", "___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": 147, "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": "T000002R010490", "___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": 156, "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": "T000002R010492", "___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": 166, "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": "T000002R010494", "___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": 178, "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": "T000002R010496", "___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": 187, "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": "T000002R010498", "___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": 198, "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": "T000002R010500", "___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": 207, "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": "T000002R010502", "___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": 216, "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": "T000002R010504", "___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": 273, "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": "T000002R010512", "___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": 318, "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": "T000002R010522", "___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": 359, "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": "T000002R010529", "___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": 545, "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": "T000002R010584", "___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": 575, "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": "T000002R010589", "___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": 620, "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": "T000002R010592", "___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": 648, "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": "T000002R010596", "___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": 699, "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": "T000002R010600", "___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": 741, "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": "T000002R010607", "___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": 756, "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": "T000002R010609", "___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}\r\n */", "meta": { "filename": "Group.js", "lineno": 769, "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" } } } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#getLength", "scope": "instance", "___id": "T000002R010611", "___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": 782, "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": "T000002R010613", "___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": 806, "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": "T000002R010615", "___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 first matching group member, or a newly created member, or null.\r\n */", "meta": { "filename": "Group.js", "lineno": 831, "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 first matching group member, or a newly created member, or null." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#getFirstNth", "scope": "instance", "___id": "T000002R010617", "___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 first matching group member, or a newly created member, or null.\r\n */", "meta": { "filename": "Group.js", "lineno": 857, "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 first matching group member, or a newly created member, or null." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#getLast", "scope": "instance", "___id": "T000002R010619", "___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 first matching group member, or a newly created member, or null.\r\n */", "meta": { "filename": "Group.js", "lineno": 882, "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 first matching group member, or a newly created member, or null." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#getLastNth", "scope": "instance", "___id": "T000002R010621", "___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": 1011, "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": "T000002R010639", "___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": 1035, "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": "T000002R010641", "___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": 1059, "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": "T000002R010643", "___s": true }, { "comment": "/**\r\n * {@link Phaser.GameObjects.Components.Animation#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": 1084, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "{@link Phaser.GameObjects.Components.Animation#play Plays} an animation for all members of this group.", "kind": "function", "name": "playAnimation", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "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": "T000002R010645", "___s": true }, { "comment": "/**\r\n * Whether this group's size 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": 1102, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Whether this group's size at its {@link Phaser.GameObjects.Group#maxSize maximum}.", "kind": "function", "name": "isFull", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "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": "T000002R010647", "___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": 1122, "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": "T000002R010649", "___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": 1149, "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": "T000002R010654", "___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 numbers; or a large number (if maxSize is -1).\r\n */", "meta": { "filename": "Group.js", "lineno": 1162, "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 numbers; or a large number (if maxSize is -1)." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#getTotalFree", "scope": "instance", "___id": "T000002R010656", "___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": 1180, "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": "T000002R010660", "___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": 1198, "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": "T000002R010663", "___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": 1216, "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": "T000002R010666", "___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 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": 1237, "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 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#propertyValueInc", "scope": "instance", "___id": "T000002R010668", "___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": 1258, "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": "T000002R010670", "___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": 1276, "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": "T000002R010672", "___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": 1294, "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": "T000002R010674", "___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": 1314, "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": "T000002R010676", "___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": 1332, "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": "T000002R010678", "___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": 1350, "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": "T000002R010680", "___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": 1370, "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": "T000002R010682", "___s": true }, { "comment": "/**\r\n * Sets 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 set the angle to, 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": 1392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets 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 set the angle to, 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": "T000002R010684", "___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": 1410, "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": "T000002R010686", "___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": 1428, "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": "T000002R010688", "___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": 1446, "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": "T000002R010690", "___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": 1465, "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": "T000002R010692", "___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": 1483, "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": "T000002R010694", "___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": 1503, "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": "T000002R010696", "___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": 1523, "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": "T000002R010698", "___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": 1541, "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": "T000002R010700", "___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 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 *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1559, "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 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" } ], "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": "T000002R010702", "___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": 1579, "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": "T000002R010704", "___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 amount to set the property to.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1597, "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 amount to set the property to.", "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": "T000002R010706", "___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": 1614, "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": "T000002R010708", "___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": 1632, "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": "T000002R010710", "___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": 1647, "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": "T000002R010712", "___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": 1663, "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": "T000002R010714", "___s": true }, { "comment": "/**\r\n * Sets the visible 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": 1680, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets the visible 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": "T000002R010716", "___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": 1699, "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": "T000002R010718", "___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": 1714, "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": "T000002R010720", "___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": "T000002R010729", "___s": true }, { "comment": "/**\r\n * Creates a new Group Game Object and adds it to the Scene.\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\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": "T000002R010732", "___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": "T000002R010733", "___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": "T000002R010734", "___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": "T000002R010735", "___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]\r\n * @property {?number} [setXY.x=0] - The horizontal position of each new Game Object.\r\n * @property {?number} [setXY.y=0] - The vertical position of each new Game Object.\r\n * @property {?number} [setXY.stepX=0] - Increment each Game Object's horizontal position from the previous by this amount, starting from `setXY.x`.\r\n * @property {?number} [setXY.stepY=0] - Increment each Game Object's vertical position from the previous by this amount, starting from `setXY.y`.\r\n * @property {?object} [setRotation]\r\n * @property {?number} [setRotation.value=0] - Rotation of each new Game Object.\r\n * @property {?number} [setRotation.step=0] - Increment each Game Object's rotation from the previous by this amount, starting at `setRotation.value`.\r\n * @property {?object} [setScale]\r\n * @property {?number} [setScale.x=0] - The horizontal scale of each new Game Object.\r\n * @property {?number} [setScale.y=0] - The vertical scale of each new Game Object.\r\n * @property {?number} [setScale.stepX=0] - Increment each Game Object's horizontal scale from the previous by this amount, starting from `setScale.x`.\r\n * @property {?number} [setScale.stepY=0] - Increment each Game object's vertical scale from the previous by this amount, starting from `setScale.y`.\r\n * @property {?object} [setOrigin]\r\n * @property {?number} [setOrigin.x=0] - The horizontal origin of each new Game Object.\r\n * @property {?number} [setOrigin.y=0] - The vertical origin of each new Game Object.\r\n * @property {?number} [setOrigin.stepX=0] - Increment each Game Object's horizontal origin from the previous by this amount, starting from `setOrigin.x`.\r\n * @property {?number} [setOrigin.stepY=0] - Increment each Game object's vertical origin from the previous by this amount, starting from `setOrigin.y`.\r\n * @property {?object} [setAlpha]\r\n * @property {?number} [setAlpha.value=0] - The alpha value of each new Game Object.\r\n * @property {?number} [setAlpha.step=0] - Increment each Game Object's alpha from the previous by this amount, starting from `setAlpha.value`.\r\n * @property {?object} [setDepth]\r\n * @property {?number} [setDepth.value=0] - The depth value of each new Game Object.\r\n * @property {?number} [setDepth.step=0] - Increment each Game Object's depth from the previous by this amount, starting from `setDepth.value`.\r\n * @property {?object} [setScrollFactor]\r\n * @property {?number} [setScrollFactor.x=0] - The horizontal scroll factor of each new Game Object.\r\n * @property {?number} [setScrollFactor.y=0] - The vertical scroll factor of each new Game Object.\r\n * @property {?number} [setScrollFactor.stepX=0] - Increment each Game Object's horizontal scroll factor from the previous by this amount, starting from `setScrollFactor.x`.\r\n * @property {?number} [setScrollFactor.stepY=0] - Increment each Game object's vertical scroll factor from the previous by this amount, starting from `setScrollFactor.y`.\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.Actions.GridAlign\r\n * @see Phaser.Actions.SetAlpha\r\n * @see Phaser.Actions.SetHitArea\r\n * @see Phaser.Actions.SetRotation\r\n * @see Phaser.Actions.SetScale\r\n * @see Phaser.Actions.SetXY\r\n * @see Phaser.Actions.SetDepth\r\n * @see Phaser.Actions.SetScrollFactor\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, "name": "setXY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "The horizontal position of each new Game Object.", "name": "setXY.x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "The vertical position of each new Game Object.", "name": "setXY.y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "Increment each Game Object's horizontal position from the previous by this amount, starting from `setXY.x`.", "name": "setXY.stepX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "Increment each Game Object's vertical position from the previous by this amount, starting from `setXY.y`.", "name": "setXY.stepY" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "optional": true, "nullable": true, "name": "setRotation" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "Rotation of each new Game Object.", "name": "setRotation.value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "Increment each Game Object's rotation from the previous by this amount, starting at `setRotation.value`.", "name": "setRotation.step" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "optional": true, "nullable": true, "name": "setScale" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "The horizontal scale of each new Game Object.", "name": "setScale.x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "The vertical scale of each new Game Object.", "name": "setScale.y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "Increment each Game Object's horizontal scale from the previous by this amount, starting from `setScale.x`.", "name": "setScale.stepX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "Increment each Game object's vertical scale from the previous by this amount, starting from `setScale.y`.", "name": "setScale.stepY" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "optional": true, "nullable": true, "name": "setOrigin" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "The horizontal origin of each new Game Object.", "name": "setOrigin.x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "The vertical origin of each new Game Object.", "name": "setOrigin.y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "Increment each Game Object's horizontal origin from the previous by this amount, starting from `setOrigin.x`.", "name": "setOrigin.stepX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "Increment each Game object's vertical origin from the previous by this amount, starting from `setOrigin.y`.", "name": "setOrigin.stepY" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "optional": true, "nullable": true, "name": "setAlpha" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "The alpha value of each new Game Object.", "name": "setAlpha.value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "Increment each Game Object's alpha from the previous by this amount, starting from `setAlpha.value`.", "name": "setAlpha.step" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "optional": true, "nullable": true, "name": "setDepth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "The depth value of each new Game Object.", "name": "setDepth.value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "Increment each Game Object's depth from the previous by this amount, starting from `setDepth.value`.", "name": "setDepth.step" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "optional": true, "nullable": true, "name": "setScrollFactor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "The horizontal scroll factor of each new Game Object.", "name": "setScrollFactor.x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "The vertical scroll factor of each new Game Object.", "name": "setScrollFactor.y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "Increment each Game Object's horizontal scroll factor from the previous by this amount, starting from `setScrollFactor.x`.", "name": "setScrollFactor.stepX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 0, "description": "Increment each Game object's vertical scroll factor from the previous by this amount, starting from `setScrollFactor.y`.", "name": "setScrollFactor.stepY" }, { "type": { "names": [ "*" ], "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.Actions.GridAlign", "Phaser.Actions.SetAlpha", "Phaser.Actions.SetHitArea", "Phaser.Actions.SetRotation", "Phaser.Actions.SetScale", "Phaser.Actions.SetXY", "Phaser.Actions.SetDepth", "Phaser.Actions.SetScrollFactor", "Phaser.GameObjects.Group#createFromConfig", "Phaser.Utils.Array.Range" ], "memberof": "Phaser.Types.GameObjects.Group", "longname": "Phaser.Types.GameObjects.Group.GroupCreateConfig", "scope": "static", "___id": "T000002R010736", "___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": "T000002R010737", "___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": "T000002R010738", "___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.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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": 12, "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.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "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": "T000002R010743", "___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.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.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.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.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": "T000002R010758", "___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": "T000002R010766", "___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": "T000002R010778", "___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 can have Post FX Pipelines set, which allows you to easily enable a post pipeline across\r\n * a whole range of children, which, depending on the effect, can often be far more efficient that doing so\r\n * on a per-child basis.\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 * @class Layer\r\n * @extends Phaser.Structs.List.\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.PostPipeline\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": 19, "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 can have Post FX Pipelines set, which allows you to easily enable a post pipeline across\ra whole range of children, which, depending on the effect, can often be far more efficient that doing so\ron a per-child basis.\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.", "kind": "class", "name": "Layer", "augments": [ "Phaser.Structs.List.", "Phaser.GameObjects.Components.AlphaSingle", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.PostPipeline", "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": "T000002R010904", "___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": 101, "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", "___id": "T000002R010909", "___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.Layer#displayList\r\n * @type {(Phaser.GameObjects.DisplayList|Phaser.GameObjects.Layer)}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 115, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "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.Layer", "longname": "Phaser.GameObjects.Layer#displayList", "scope": "instance", "kind": "member", "___id": "T000002R010911", "___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.Layer#type\r\n * @type {string}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 129, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "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.50.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#type", "scope": "instance", "kind": "member", "___id": "T000002R010913", "___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.Layer#state\r\n * @type {(number|string)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "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.50.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#state", "scope": "instance", "kind": "member", "___id": "T000002R010915", "___s": true }, { "comment": "/**\r\n * A Layer cannot be placed inside a Container.\r\n *\r\n * This property is kept purely so a Layer has the same\r\n * shape as a Game Object.\r\n *\r\n * @name Phaser.GameObjects.Layer#parentContainer\r\n * @type {Phaser.GameObjects.Container}\r\n * @since 3.51.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 155, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "A Layer cannot be placed inside a Container.\r\rThis property is kept purely so a Layer has the same\rshape as a Game Object.", "name": "parentContainer", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.51.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#parentContainer", "scope": "instance", "kind": "member", "___id": "T000002R010917", "___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.Layer#name\r\n * @type {string}\r\n * @default ''\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 167, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "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.50.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#name", "scope": "instance", "kind": "member", "___id": "T000002R010919", "___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.Layer#active\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 178, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "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.50.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#active", "scope": "instance", "kind": "member", "___id": "T000002R010921", "___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.Layer#tabIndex\r\n * @type {number}\r\n * @default -1\r\n * @since 3.51.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 190, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "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.51.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#tabIndex", "scope": "instance", "kind": "member", "___id": "T000002R010923", "___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.Layer#data\r\n * @type {Phaser.Data.DataManager}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 201, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "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.50.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#data", "scope": "instance", "kind": "member", "___id": "T000002R010925", "___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.Layer#renderFlags\r\n * @type {number}\r\n * @default 15\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 213, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "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.50.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#renderFlags", "scope": "instance", "kind": "member", "___id": "T000002R010927", "___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.Layer#cameraFilter\r\n * @type {number}\r\n * @default 0\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "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.50.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#cameraFilter", "scope": "instance", "kind": "member", "___id": "T000002R010929", "___s": true }, { "comment": "/**\r\n * This property is kept purely so a Layer has the same\r\n * shape as a Game Object. You cannot input enable a Layer.\r\n *\r\n * @name Phaser.GameObjects.Layer#input\r\n * @type {?Phaser.Types.Input.InteractiveObject}\r\n * @default null\r\n * @since 3.51.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 240, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "This property is kept purely so a Layer has the same\rshape as a Game Object. You cannot input enable a Layer.", "name": "input", "type": { "names": [ "Phaser.Types.Input.InteractiveObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.InteractiveObject", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.51.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#input", "scope": "instance", "kind": "member", "___id": "T000002R010931", "___s": true }, { "comment": "/**\r\n * This property is kept purely so a Layer has the same\r\n * shape as a Game Object. You cannot give a Layer a physics body.\r\n *\r\n * @name Phaser.GameObjects.Layer#body\r\n * @type {?(Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody|MatterJS.BodyType)}\r\n * @default null\r\n * @since 3.51.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 251, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "This property is kept purely so a Layer has the same\rshape as a Game Object. You cannot give a Layer 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.51.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#body", "scope": "instance", "kind": "member", "___id": "T000002R010933", "___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.Layer#ignoreDestroy\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 262, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "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.50.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#ignoreDestroy", "scope": "instance", "kind": "member", "___id": "T000002R010935", "___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": 275, "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": "T000002R010937", "___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": 284, "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": "T000002R010939", "___s": true }, { "comment": "/**\r\n * The flag the 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": 293, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "The flag the 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": "T000002R010941", "___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.Layer#setActive\r\n * @since 3.50.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": "Layer.js", "lineno": 322, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "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.50.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.Layer", "longname": "Phaser.GameObjects.Layer#setActive", "scope": "instance", "___id": "T000002R010945", "___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.Layer#setName\r\n * @since 3.50.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": "Layer.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "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.50.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.Layer", "longname": "Phaser.GameObjects.Layer#setName", "scope": "instance", "___id": "T000002R010948", "___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.Layer#setState\r\n * @since 3.50.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": "Layer.js", "lineno": 358, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "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.50.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.Layer", "longname": "Phaser.GameObjects.Layer#setState", "scope": "instance", "___id": "T000002R010951", "___s": true }, { "comment": "/**\r\n * Adds a Data Manager component to this Game Object.\r\n *\r\n * @method Phaser.GameObjects.Layer#setDataEnabled\r\n * @since 3.50.0\r\n * @see Phaser.Data.DataManager\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "Layer.js", "lineno": 382, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Adds a Data Manager component to this Game Object.", "kind": "function", "name": "setDataEnabled", "since": "3.50.0", "see": [ "Phaser.Data.DataManager" ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#setDataEnabled", "scope": "instance", "___id": "T000002R010954", "___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.Layer#setData\r\n * @since 3.50.0\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 GameObject.\r\n */", "meta": { "filename": "Layer.js", "lineno": 401, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "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.50.0", "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 GameObject." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#setData", "scope": "instance", "___id": "T000002R010957", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.Layer#incData\r\n * @since 3.50.0\r\n *\r\n * @param {(string|object)} key - The key to increase the value for.\r\n * @param {*} [data] - The value to increase for the given key.\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "Layer.js", "lineno": 460, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.50.0", "params": [ { "type": { "names": [ "string", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The key to increase the value for.", "name": "key" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The value to increase for the given key.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#incData", "scope": "instance", "___id": "T000002R010960", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.Layer#toggleData\r\n * @since 3.50.0\r\n *\r\n * @param {(string|object)} key - The key to toggle the value for.\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "Layer.js", "lineno": 490, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.50.0", "params": [ { "type": { "names": [ "string", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "object" } ] } }, "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.Layer", "longname": "Phaser.GameObjects.Layer#toggleData", "scope": "instance", "___id": "T000002R010963", "___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.Layer#getData\r\n * @since 3.50.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": "Layer.js", "lineno": 519, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "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.50.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.Layer", "longname": "Phaser.GameObjects.Layer#getData", "scope": "instance", "___id": "T000002R010966", "___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": 559, "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", "___id": "T000002R010969", "___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": 575, "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", "___id": "T000002R010971", "___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": 591, "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", "___id": "T000002R010973", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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.Layer#addedToScene\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 607, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.Layer", "longname": "Phaser.GameObjects.Layer#addedToScene", "scope": "instance", "___id": "T000002R010975", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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.Layer#removedFromScene\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed 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.Layer", "longname": "Phaser.GameObjects.Layer#removedFromScene", "scope": "instance", "___id": "T000002R010977", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.Layer#update\r\n * @since 3.50.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "Layer.js", "lineno": 637, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "kind": "function", "name": "update", "since": "3.50.0", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#update", "scope": "instance", "___id": "T000002R010979", "___s": true }, { "comment": "/**\r\n * Returns a JSON representation of the Game Object.\r\n *\r\n * @method Phaser.GameObjects.Layer#toJSON\r\n * @since 3.50.0\r\n *\r\n * @return {Phaser.Types.GameObjects.JSONGameObject} A JSON representation of the Game Object.\r\n */", "meta": { "filename": "Layer.js", "lineno": 649, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Returns a JSON representation of the Game Object.", "kind": "function", "name": "toJSON", "since": "3.50.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.Layer", "longname": "Phaser.GameObjects.Layer#toJSON", "scope": "instance", "___id": "T000002R010981", "___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": 662, "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", "___id": "T000002R010983", "___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.Layer#getIndexList\r\n * @since 3.51.0\r\n *\r\n * @return {number[]} An array of display list position indexes.\r\n */", "meta": { "filename": "Layer.js", "lineno": 678, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "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.51.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.Layer", "longname": "Phaser.GameObjects.Layer#getIndexList", "scope": "instance", "___id": "T000002R010985", "___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": 772, "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": "T000002R010998", "___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": 783, "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": "T000002R011001", "___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": 799, "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": "T000002R011004", "___s": true }, { "comment": "/**\r\n * Returns an array which contains all Game Objects within this Layer.\r\n *\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.Layer#getChildren\r\n * @since 3.50.0\r\n *\r\n * @return {Phaser.GameObjects.GameObject[]} The group members.\r\n */", "meta": { "filename": "Layer.js", "lineno": 815, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Returns an array which contains all Game Objects within this Layer.\r\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.50.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.Layer", "longname": "Phaser.GameObjects.Layer#getChildren", "scope": "instance", "___id": "T000002R011006", "___s": true }, { "comment": "/**\r\n * Adds this Layer 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 Layer belongs.\r\n *\r\n * A Layer can only exist on one Display List at any given time, but may move freely between them.\r\n *\r\n * If this Layer 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.Layer#displayList` property.\r\n *\r\n * If a Layer 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.Layer#addToDisplayList\r\n * @fires Phaser.Scenes.Events#ADDED_TO_SCENE\r\n * @fires Phaser.GameObjects.Events#ADDED_TO_SCENE\r\n * @since 3.60.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 Layer.\r\n */", "meta": { "filename": "Layer.js", "lineno": 830, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Adds this Layer 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 Layer belongs.\r\rA Layer can only exist on one Display List at any given time, but may move freely between them.\r\rIf this Layer 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.Layer#displayList` property.\r\rIf a Layer 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.60.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 Layer." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#addToDisplayList", "scope": "instance", "___id": "T000002R011008", "___s": true }, { "comment": "/**\r\n * Removes this Layer from the Display List it is currently on.\r\n *\r\n * A Layer can only exist on one Display List at any given time, but may move 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 Layer 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.Layer#removeFromDisplayList\r\n * @fires Phaser.Scenes.Events#REMOVED_FROM_SCENE\r\n * @fires Phaser.GameObjects.Events#REMOVED_FROM_SCENE\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Layer.\r\n */", "meta": { "filename": "Layer.js", "lineno": 881, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Removes this Layer from the Display List it is currently on.\r\rA Layer can only exist on one Display List at any given time, but may move 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 Layer 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.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Layer." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#removeFromDisplayList", "scope": "instance", "___id": "T000002R011012", "___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": 919, "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", "___id": "T000002R011016", "___s": true }, { "comment": "/**\r\n * Creates a new Layer Game Object and returns it.\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.\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\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.", "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": "T000002R011041", "___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": "T000002R011048", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A 2D point light.\r\n *\r\n * These are typically created by a {@link Phaser.GameObjects.LightsManager}, available from within a scene via `this.lights`.\r\n *\r\n * Any Game Objects using the Light2D pipeline will then be affected by these Lights as long as they have a normal map.\r\n *\r\n * They can also simply be used to represent a point light for your own purposes.\r\n *\r\n * As of Phaser 3.60 this Game Object now has the Transform and Origin components. However, changing the scale,\r\n * rotation or origin properties will not make any difference to the Light. They are simply present to allow you\r\n * to add this Light to a Container, or enable it for Physics.\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.Transform\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 */", "meta": { "filename": "Light.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "classdesc": "A 2D point light.\r\rThese are typically created by a {@link Phaser.GameObjects.LightsManager}, available from within a scene via `this.lights`.\r\rAny Game Objects using the Light2D pipeline will then be affected by these Lights as long as they have a normal map.\r\rThey can also simply be used to represent a point light for your own purposes.\r\rAs of Phaser 3.60 this Game Object now has the Transform and Origin components. However, changing the scale,\rrotation or origin properties will not make any difference to the Light. They are simply present to allow you\rto add this Light to a Container, or enable it for Physics.", "kind": "class", "name": "Light", "augments": [ "Phaser.Geom.Circle", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.ScrollFactor", "Phaser.GameObjects.Components.Transform", "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" } ], "scope": "static", "longname": "Phaser.GameObjects.Light", "___id": "T000002R011090", "___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": "T000002R011095", "___s": true }, { "comment": "/**\r\n * The intensity of the 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.", "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": "T000002R011097", "___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.Light#renderFlags\r\n * @type {number}\r\n * @default 15\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Light.js", "lineno": 81, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "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.Light", "longname": "Phaser.GameObjects.Light#renderFlags", "scope": "instance", "kind": "member", "___id": "T000002R011099", "___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": 93, "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": "T000002R011101", "___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": 113, "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": "T000002R011103", "___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": 134, "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": "T000002R011108", "___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": 155, "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": "T000002R011113", "___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": 176, "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": "T000002R011118", "___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": 197, "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": "T000002R011123", "___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": 213, "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": "T000002R011125", "___s": true }, { "comment": "/**\r\n * Set the intensity of the 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 of the light.\r\n *\r\n * @return {this} This Light object.\r\n */", "meta": { "filename": "Light.js", "lineno": 232, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Set the intensity of the light.", "kind": "function", "name": "setIntensity", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The intensity 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": "T000002R011128", "___s": true }, { "comment": "/**\r\n * Set the radius of the 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.\r\n *\r\n * @return {this} This Light object.\r\n */", "meta": { "filename": "Light.js", "lineno": 249, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Set the radius of the light.", "kind": "function", "name": "setRadius", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the light.", "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": "T000002R011131", "___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": 268, "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": "T000002R011134", "___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": "T000002R011146", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Manages Lights for a Scene.\r\n *\r\n * Affects the rendering of Game Objects using the `Light2D` pipeline.\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": "Manages Lights for a Scene.\r\rAffects the rendering of Game Objects using the `Light2D` pipeline.", "kind": "class", "name": "LightsManager", "memberof": "Phaser.GameObjects", "since": "3.0.0", "scope": "static", "longname": "Phaser.GameObjects.LightsManager", "___id": "T000002R011147", "___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": 40, "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": "T000002R011150", "___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": 50, "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": "T000002R011152", "___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": 59, "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": "T000002R011154", "___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": 69, "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": "T000002R011156", "___s": true }, { "comment": "/**\r\n * The number of lights that the LightPipeline 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": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The number of lights that the LightPipeline 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": "T000002R011158", "___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 calcuations. 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 dislay 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": 91, "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 calcuations. 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 dislay 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": "T000002R011160", "___s": true }, { "comment": "/**\r\n * Enable the Lights Manager.\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": 137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Enable the Lights Manager.", "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": "T000002R011162", "___s": true }, { "comment": "/**\r\n * Disable the Lights Manager.\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": 157, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Disable the Lights Manager.", "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": "T000002R011166", "___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 pipeline, 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": 172, "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 pipeline, 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": "T000002R011169", "___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": 228, "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": "T000002R011181", "___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": 247, "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": "T000002R011184", "___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": 260, "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": "T000002R011186", "___s": true }, { "comment": "/**\r\n * Add a Light.\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 *\r\n * @return {Phaser.GameObjects.Light} The Light that was added.\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 273, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Add a Light.", "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" } ], "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": "T000002R011188", "___s": true }, { "comment": "/**\r\n * Remove a Light.\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": 304, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Remove a Light.", "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": "T000002R011197", "___s": true }, { "comment": "/**\r\n * Shut down the Lights Manager.\r\n *\r\n * Recycles all active Lights into the Light pool, resets ambient light color and clears the lists of Lights and\r\n * culled Lights.\r\n *\r\n * @method Phaser.GameObjects.LightsManager#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Shut down the Lights Manager.\r\rRecycles all active Lights into the Light pool, resets ambient light color and clears the lists of Lights and\rculled Lights.", "kind": "function", "name": "shutdown", "since": "3.0.0", "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#shutdown", "scope": "instance", "___id": "T000002R011200", "___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": 340, "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": "T000002R011203", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Scene plugin that provides a {@link Phaser.GameObjects.LightsManager} for the Light2D pipeline.\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 the `Light2D` pipeline like so:\r\n *\r\n * ```javascript\r\n * sprite.setPipeline('Light2D');\r\n * ```\r\n *\r\n * Note that you cannot use this pipeline on Graphics Game Objects or Shape Game Objects.\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 the Light2D pipeline.\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 the `Light2D` pipeline like so:\r\r```javascript\rsprite.setPipeline('Light2D');\r```\r\rNote that you cannot use this pipeline on Graphics Game Objects or Shape Game Objects.", "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": "T000002R011210", "___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": 52, "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": "T000002R011214", "___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": 61, "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": "T000002R011216", "___s": true }, { "comment": "/**\r\n * Boot the Lights Plugin.\r\n *\r\n * @method Phaser.GameObjects.LightsPlugin#boot\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LightsPlugin.js", "lineno": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Boot the Lights Plugin.", "kind": "function", "name": "boot", "since": "3.0.0", "memberof": "Phaser.GameObjects.LightsPlugin", "longname": "Phaser.GameObjects.LightsPlugin#boot", "scope": "instance", "___id": "T000002R011218", "___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": "T000002R011221", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Mesh Game Object.\r\n *\r\n * The Mesh Game Object allows you to render a group of textured vertices and manipulate\r\n * the view of those vertices, such as rotation, translation or scaling.\r\n *\r\n * Support for generating mesh data from grids, model data or Wavefront OBJ Files is included.\r\n *\r\n * Although you can use this to render 3D objects, its primary use is for displaying more complex\r\n * Sprites, or Sprites where you need fine-grained control over the vertex positions in order to\r\n * achieve special effects in your games. Note that rendering still takes place using Phaser's\r\n * orthographic camera (after being transformed via `projectionMesh`, see `setPerspective`,\r\n * `setOrtho`, and `panZ` methods). As a result, all depth and face tests are done in an eventually\r\n * orthographic space.\r\n *\r\n * The rendering process will iterate through the faces of this Mesh and render out each face\r\n * that is considered as being in view of the camera. No depth buffer is used, and because of this,\r\n * you should be careful not to use model data with too many vertices, or overlapping geometry,\r\n * or you'll probably encounter z-depth fighting. The Mesh was designed to allow for more advanced\r\n * 2D layouts, rather than displaying 3D objects, even though it can do this to a degree.\r\n *\r\n * In short, if you want to remake Crysis, use a 3D engine, not a Mesh. However, if you want\r\n * to easily add some small fun 3D elements into your game, or create some special effects involving\r\n * vertex warping, this is the right object for you. Mesh data becomes part of the WebGL batch,\r\n * just like standard Sprites, so doesn't introduce any additional shader overhead. Because\r\n * the Mesh just generates vertices into the WebGL batch, like any other Sprite, you can use all of\r\n * the common Game Object components on a Mesh too, such as a custom pipeline, mask, blend mode\r\n * or texture.\r\n *\r\n * Note that the Mesh object is WebGL only and does not have a Canvas counterpart.\r\n *\r\n * The Mesh origin is always 0.5 x 0.5 and cannot be changed.\r\n *\r\n * @class Mesh\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @webglOnly\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.Mask\r\n * @extends Phaser.GameObjects.Components.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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. 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 * @param {number[]} [vertices] - The vertices array. Either `xy` pairs, or `xyz` if the `containsZ` parameter is `true` (but see note).\r\n * @param {number[]} [uvs] - The UVs pairs array.\r\n * @param {number[]} [indicies] - Optional vertex indicies array. If you don't have one, pass `null` or an empty array.\r\n * @param {boolean} [containsZ=false] - Does the vertices data include a `z` component? Note: If not, it will be assumed `z=0`, see method `panZ` or `setOrtho`.\r\n * @param {number[]} [normals] - Optional vertex normals array. If you don't have one, pass `null` or an empty array.\r\n * @param {number|number[]} [colors=0xffffff] - An array of colors, one per vertex, or a single color value applied to all vertices.\r\n * @param {number|number[]} [alphas=1] - An array of alpha values, one per vertex, or a single alpha value applied to all vertices.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 22, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "classdesc": "A Mesh Game Object.\r\rThe Mesh Game Object allows you to render a group of textured vertices and manipulate\rthe view of those vertices, such as rotation, translation or scaling.\r\rSupport for generating mesh data from grids, model data or Wavefront OBJ Files is included.\r\rAlthough you can use this to render 3D objects, its primary use is for displaying more complex\rSprites, or Sprites where you need fine-grained control over the vertex positions in order to\rachieve special effects in your games. Note that rendering still takes place using Phaser's\rorthographic camera (after being transformed via `projectionMesh`, see `setPerspective`,\r`setOrtho`, and `panZ` methods). As a result, all depth and face tests are done in an eventually\rorthographic space.\r\rThe rendering process will iterate through the faces of this Mesh and render out each face\rthat is considered as being in view of the camera. No depth buffer is used, and because of this,\ryou should be careful not to use model data with too many vertices, or overlapping geometry,\ror you'll probably encounter z-depth fighting. The Mesh was designed to allow for more advanced\r2D layouts, rather than displaying 3D objects, even though it can do this to a degree.\r\rIn short, if you want to remake Crysis, use a 3D engine, not a Mesh. However, if you want\rto easily add some small fun 3D elements into your game, or create some special effects involving\rvertex warping, this is the right object for you. Mesh data becomes part of the WebGL batch,\rjust like standard Sprites, so doesn't introduce any additional shader overhead. Because\rthe Mesh just generates vertices into the WebGL batch, like any other Sprite, you can use all of\rthe common Game Object components on a Mesh too, such as a custom pipeline, mask, blend mode\ror texture.\r\rNote that the Mesh object is WebGL only and does not have a Canvas counterpart.\r\rThe Mesh origin is always 0.5 x 0.5 and cannot be changed.", "kind": "class", "name": "Mesh", "augments": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Components.AlphaSingle", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "Phaser.GameObjects.Components.ScrollFactor", "Phaser.GameObjects.Components.Size", "Phaser.GameObjects.Components.Texture", "Phaser.GameObjects.Components.Transform", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.GameObjects", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "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" } }, "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": [ "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": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "The vertices array. Either `xy` pairs, or `xyz` if the `containsZ` parameter is `true` (but see note).", "name": "vertices" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "The UVs pairs array.", "name": "uvs" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "Optional vertex indicies array. If you don't have one, pass `null` or an empty array.", "name": "indicies" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does the vertices data include a `z` component? Note: If not, it will be assumed `z=0`, see method `panZ` or `setOrtho`.", "name": "containsZ" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "Optional vertex normals array. If you don't have one, pass `null` or an empty array.", "name": "normals" }, { "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": "0xffffff", "description": "An array of colors, one per vertex, or a single color value applied to all vertices.", "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, "defaultvalue": 1, "description": "An array of alpha values, one per vertex, or a single alpha value applied to all vertices.", "name": "alphas" } ], "scope": "static", "longname": "Phaser.GameObjects.Mesh", "___id": "T000002R011240", "___s": true }, { "comment": "/**\r\n * An array containing the Face instances belonging to this Mesh.\r\n *\r\n * A Face consists of 3 Vertex objects.\r\n *\r\n * This array is populated during calls such as `addVertices` or `addOBJ`.\r\n *\r\n * @name Phaser.GameObjects.Mesh#faces\r\n * @type {Phaser.Geom.Mesh.Face[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 117, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "An array containing the Face instances belonging to this Mesh.\r\rA Face consists of 3 Vertex objects.\r\rThis array is populated during calls such as `addVertices` or `addOBJ`.", "name": "faces", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Mesh.Face", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#faces", "scope": "instance", "kind": "member", "___id": "T000002R011248", "___s": true }, { "comment": "/**\r\n * An array containing Vertex instances. One instance per vertex in this Mesh.\r\n *\r\n * This array is populated during calls such as `addVertex` or `addOBJ`.\r\n *\r\n * @name Phaser.GameObjects.Mesh#vertices\r\n * @type {Phaser.Geom.Mesh.Vertex[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "An array containing Vertex instances. One instance per vertex in this Mesh.\r\rThis array is populated during calls such as `addVertex` or `addOBJ`.", "name": "vertices", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Mesh.Vertex", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#vertices", "scope": "instance", "kind": "member", "___id": "T000002R011250", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertex colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Mesh#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertex colors replace the texture, but respects texture alpha.", "name": "tintFill", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#tintFill", "scope": "instance", "kind": "member", "___id": "T000002R011252", "___s": true }, { "comment": "/**\r\n * You can optionally choose to render the vertices of this Mesh 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 `Mesh.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 Mesh 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 * Please note that high vertex count Meshes will struggle to debug properly.\r\n *\r\n * @name Phaser.GameObjects.Mesh#debugCallback\r\n * @type {function}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "You can optionally choose to render the vertices of this Mesh 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 `Mesh.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 Mesh 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`.\r\rPlease note that high vertex count Meshes will struggle to debug properly.", "name": "debugCallback", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#debugCallback", "scope": "instance", "kind": "member", "___id": "T000002R011254", "___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.Mesh#debugGraphic\r\n * @type {Phaser.GameObjects.Graphics}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "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.50.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#debugGraphic", "scope": "instance", "kind": "member", "___id": "T000002R011256", "___s": true }, { "comment": "/**\r\n * When rendering, skip any Face that isn't counter clockwise?\r\n *\r\n * Enable this to hide backward-facing Faces during rendering.\r\n *\r\n * Disable it to render all Faces.\r\n *\r\n * @name Phaser.GameObjects.Mesh#hideCCW\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 189, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "When rendering, skip any Face that isn't counter clockwise?\r\rEnable this to hide backward-facing Faces during rendering.\r\rDisable it to render all Faces.", "name": "hideCCW", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#hideCCW", "scope": "instance", "kind": "member", "___id": "T000002R011258", "___s": true }, { "comment": "/**\r\n * A Vector3 containing the 3D position of the vertices in this Mesh.\r\n *\r\n * Modifying the components of this property will allow you to reposition where\r\n * the vertices are rendered within the Mesh. This happens in the `preUpdate` phase,\r\n * where each vertex is transformed using the view and projection matrices.\r\n *\r\n * Changing this property will impact all vertices being rendered by this Mesh.\r\n *\r\n * You can also adjust the 'view' by using the `pan` methods.\r\n *\r\n * @name Phaser.GameObjects.Mesh#modelPosition\r\n * @type {Phaser.Math.Vector3}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 202, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "A Vector3 containing the 3D position of the vertices in this Mesh.\r\rModifying the components of this property will allow you to reposition where\rthe vertices are rendered within the Mesh. This happens in the `preUpdate` phase,\rwhere each vertex is transformed using the view and projection matrices.\r\rChanging this property will impact all vertices being rendered by this Mesh.\r\rYou can also adjust the 'view' by using the `pan` methods.", "name": "modelPosition", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#modelPosition", "scope": "instance", "kind": "member", "___id": "T000002R011260", "___s": true }, { "comment": "/**\r\n * A Vector3 containing the 3D scale of the vertices in this Mesh.\r\n *\r\n * Modifying the components of this property will allow you to scale\r\n * the vertices within the Mesh. This happens in the `preUpdate` phase,\r\n * where each vertex is transformed using the view and projection matrices.\r\n *\r\n * Changing this property will impact all vertices being rendered by this Mesh.\r\n *\r\n * @name Phaser.GameObjects.Mesh#modelScale\r\n * @type {Phaser.Math.Vector3}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 219, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "A Vector3 containing the 3D scale of the vertices in this Mesh.\r\rModifying the components of this property will allow you to scale\rthe vertices within the Mesh. This happens in the `preUpdate` phase,\rwhere each vertex is transformed using the view and projection matrices.\r\rChanging this property will impact all vertices being rendered by this Mesh.", "name": "modelScale", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#modelScale", "scope": "instance", "kind": "member", "___id": "T000002R011262", "___s": true }, { "comment": "/**\r\n * A Vector3 containing the 3D rotation of the vertices in this Mesh.\r\n *\r\n * The values should be given in radians, i.e. to rotate the vertices by 90\r\n * degrees you can use `modelRotation.x = Phaser.Math.DegToRad(90)`.\r\n *\r\n * Modifying the components of this property will allow you to rotate\r\n * the vertices within the Mesh. This happens in the `preUpdate` phase,\r\n * where each vertex is transformed using the view and projection matrices.\r\n *\r\n * Changing this property will impact all vertices being rendered by this Mesh.\r\n *\r\n * @name Phaser.GameObjects.Mesh#modelRotation\r\n * @type {Phaser.Math.Vector3}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "A Vector3 containing the 3D rotation of the vertices in this Mesh.\r\rThe values should be given in radians, i.e. to rotate the vertices by 90\rdegrees you can use `modelRotation.x = Phaser.Math.DegToRad(90)`.\r\rModifying the components of this property will allow you to rotate\rthe vertices within the Mesh. This happens in the `preUpdate` phase,\rwhere each vertex is transformed using the view and projection matrices.\r\rChanging this property will impact all vertices being rendered by this Mesh.", "name": "modelRotation", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#modelRotation", "scope": "instance", "kind": "member", "___id": "T000002R011264", "___s": true }, { "comment": "/**\r\n * The transformation matrix for this Mesh.\r\n *\r\n * @name Phaser.GameObjects.Mesh#transformMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 265, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "The transformation matrix for this Mesh.", "name": "transformMatrix", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#transformMatrix", "scope": "instance", "kind": "member", "___id": "T000002R011268", "___s": true }, { "comment": "/**\r\n * The view position for this Mesh.\r\n *\r\n * Use the methods`panX`, `panY` and `panZ` to adjust the view.\r\n *\r\n * @name Phaser.GameObjects.Mesh#viewPosition\r\n * @type {Phaser.Math.Vector3}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 274, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "The view position for this Mesh.\r\rUse the methods`panX`, `panY` and `panZ` to adjust the view.", "name": "viewPosition", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#viewPosition", "scope": "instance", "kind": "member", "___id": "T000002R011270", "___s": true }, { "comment": "/**\r\n * The view matrix for this Mesh.\r\n *\r\n * @name Phaser.GameObjects.Mesh#viewMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 285, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "The view matrix for this Mesh.", "name": "viewMatrix", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#viewMatrix", "scope": "instance", "kind": "member", "___id": "T000002R011272", "___s": true }, { "comment": "/**\r\n * The projection matrix for this Mesh.\r\n *\r\n * Update it with the `setPerspective` or `setOrtho` methods.\r\n *\r\n * @name Phaser.GameObjects.Mesh#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 294, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "The projection matrix for this Mesh.\r\rUpdate it with the `setPerspective` or `setOrtho` methods.", "name": "projectionMatrix", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#projectionMatrix", "scope": "instance", "kind": "member", "___id": "T000002R011274", "___s": true }, { "comment": "/**\r\n * How many faces were rendered by this Mesh Game Object in the last\r\n * draw? This is reset in the `preUpdate` method and then incremented\r\n * each time a face is drawn. Note that in multi-camera Scenes this\r\n * value may exceed that found in `Mesh.getFaceCount` due to\r\n * cameras drawing the same faces more than once.\r\n *\r\n * @name Phaser.GameObjects.Mesh#totalRendered\r\n * @type {number}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 305, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "How many faces were rendered by this Mesh Game Object in the last\rdraw? This is reset in the `preUpdate` method and then incremented\reach time a face is drawn. Note that in multi-camera Scenes this\rvalue may exceed that found in `Mesh.getFaceCount` due to\rcameras drawing the same faces more than once.", "name": "totalRendered", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#totalRendered", "scope": "instance", "kind": "member", "___id": "T000002R011276", "___s": true }, { "comment": "/**\r\n * By default, the Mesh will check to see if its model or view transform has\r\n * changed each frame and only recalculate the vertex positions if they have.\r\n *\r\n * This avoids lots of additional math in the `preUpdate` step when not required.\r\n *\r\n * However, if you are performing per-Face or per-Vertex manipulation on this Mesh,\r\n * such as tweening a Face, or moving it without moving the rest of the Mesh,\r\n * then you may need to disable the dirty cache in order for the Mesh to re-render\r\n * correctly. You can toggle this property to do that. Please note that leaving\r\n * this set to `true` will cause the Mesh to recalculate the position of every single\r\n * vertex in it, every single frame. So only really do this if you know you\r\n * need it.\r\n *\r\n * @name Phaser.GameObjects.Mesh#ignoreDirtyCache\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 331, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "By default, the Mesh will check to see if its model or view transform has\rchanged each frame and only recalculate the vertex positions if they have.\r\rThis avoids lots of additional math in the `preUpdate` step when not required.\r\rHowever, if you are performing per-Face or per-Vertex manipulation on this Mesh,\rsuch as tweening a Face, or moving it without moving the rest of the Mesh,\rthen you may need to disable the dirty cache in order for the Mesh to re-render\rcorrectly. You can toggle this property to do that. Please note that leaving\rthis set to `true` will cause the Mesh to recalculate the position of every single\rvertex in it, every single frame. So only really do this if you know you\rneed it.", "name": "ignoreDirtyCache", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#ignoreDirtyCache", "scope": "instance", "kind": "member", "___id": "T000002R011280", "___s": true }, { "comment": "/**\r\n * The Camera fov (field of view) in degrees.\r\n *\r\n * This is set automatically as part of the `Mesh.setPerspective` call, but exposed\r\n * here for additional math.\r\n *\r\n * Do not modify this property directly, doing so will not change the fov. For that,\r\n * call the respective Mesh methods.\r\n *\r\n * @name Phaser.GameObjects.Mesh#fov\r\n * @type {number}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 351, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "The Camera fov (field of view) in degrees.\r\rThis is set automatically as part of the `Mesh.setPerspective` call, but exposed\rhere for additional math.\r\rDo not modify this property directly, doing so will not change the fov. For that,\rcall the respective Mesh methods.", "name": "fov", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#fov", "scope": "instance", "kind": "member", "___id": "T000002R011282", "___s": true }, { "comment": "/**\r\n * Translates the view position of this Mesh on the x axis by the given amount.\r\n *\r\n * @method Phaser.GameObjects.Mesh#panX\r\n * @since 3.50.0\r\n *\r\n * @param {number} v - The amount to pan by.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 399, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Translates the view position of this Mesh on the x axis by the given amount.", "kind": "function", "name": "panX", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to pan by.", "name": "v" } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#panX", "scope": "instance", "___id": "T000002R011289", "___s": true }, { "comment": "/**\r\n * Translates the view position of this Mesh on the y axis by the given amount.\r\n *\r\n * @method Phaser.GameObjects.Mesh#panY\r\n * @since 3.50.0\r\n *\r\n * @param {number} v - The amount to pan by.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Translates the view position of this Mesh on the y axis by the given amount.", "kind": "function", "name": "panY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to pan by.", "name": "v" } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#panY", "scope": "instance", "___id": "T000002R011292", "___s": true }, { "comment": "/**\r\n * Translates the view position of this Mesh on the z axis by the given amount.\r\n *\r\n * As the default `panZ` value is 0, vertices with `z=0` (the default) need special\r\n * care or else they will not display as they are \"behind\" the camera.\r\n *\r\n * Consider using `mesh.panZ(mesh.height / (2 * Math.tan(Math.PI / 16)))`,\r\n * which will interpret vertex geometry 1:1 with pixel geometry (or see `setOrtho`).\r\n *\r\n * @method Phaser.GameObjects.Mesh#panZ\r\n * @since 3.50.0\r\n *\r\n * @param {number} v - The amount to pan by.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Translates the view position of this Mesh on the z axis by the given amount.\r\rAs the default `panZ` value is 0, vertices with `z=0` (the default) need special\rcare or else they will not display as they are \"behind\" the camera.\r\rConsider using `mesh.panZ(mesh.height / (2 * Math.tan(Math.PI / 16)))`,\rwhich will interpret vertex geometry 1:1 with pixel geometry (or see `setOrtho`).", "kind": "function", "name": "panZ", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to pan by.", "name": "v" } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#panZ", "scope": "instance", "___id": "T000002R011296", "___s": true }, { "comment": "/**\r\n * Builds a new perspective projection matrix from the given values.\r\n *\r\n * These are also the initial projection matrix and parameters for `Mesh` (see `Mesh.panZ` for more discussion).\r\n *\r\n * See also `setOrtho`.\r\n *\r\n * @method Phaser.GameObjects.Mesh#setPerspective\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The width of the projection matrix. Typically the same as the Mesh and/or Renderer.\r\n * @param {number} height - The height of the projection matrix. Typically the same as the Mesh and/or Renderer.\r\n * @param {number} [fov=45] - The field of view, in degrees.\r\n * @param {number} [near=0.01] - The near value of the view.\r\n * @param {number} [far=1000] - The far value of the view.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Builds a new perspective projection matrix from the given values.\r\rThese are also the initial projection matrix and parameters for `Mesh` (see `Mesh.panZ` for more discussion).\r\rSee also `setOrtho`.", "kind": "function", "name": "setPerspective", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the projection matrix. Typically the same as the Mesh and/or Renderer.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the projection matrix. Typically the same as the Mesh and/or Renderer.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 45, "description": "The field of view, in degrees.", "name": "fov" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.01, "description": "The near value of the view.", "name": "near" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The far value of the view.", "name": "far" } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#setPerspective", "scope": "instance", "___id": "T000002R011300", "___s": true }, { "comment": "/**\r\n * Builds a new orthographic projection matrix from the given values.\r\n *\r\n * If using this mode you will often need to set `Mesh.hideCCW` to `false` as well.\r\n *\r\n * By default, calling this method with no parameters will set the scaleX value to\r\n * match the renderer's aspect ratio. If you would like to render vertex positions 1:1\r\n * to pixel positions, consider calling as `mesh.setOrtho(mesh.width, mesh.height)`.\r\n *\r\n * See also `setPerspective`.\r\n *\r\n * @method Phaser.GameObjects.Mesh#setOrtho\r\n * @since 3.50.0\r\n *\r\n * @param {number} [scaleX=1] - The default horizontal scale in relation to the Mesh / Renderer dimensions.\r\n * @param {number} [scaleY=1] - The default vertical scale in relation to the Mesh / Renderer dimensions.\r\n * @param {number} [near=-1000] - The near value of the view.\r\n * @param {number} [far=1000] - The far value of the view.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 488, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Builds a new orthographic projection matrix from the given values.\r\rIf using this mode you will often need to set `Mesh.hideCCW` to `false` as well.\r\rBy default, calling this method with no parameters will set the scaleX value to\rmatch the renderer's aspect ratio. If you would like to render vertex positions 1:1\rto pixel positions, consider calling as `mesh.setOrtho(mesh.width, mesh.height)`.\r\rSee also `setPerspective`.", "kind": "function", "name": "setOrtho", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The default horizontal scale in relation to the Mesh / Renderer dimensions.", "name": "scaleX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The default vertical scale in relation to the Mesh / Renderer dimensions.", "name": "scaleY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": -1000, "description": "The near value of the view.", "name": "near" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The far value of the view.", "name": "far" } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#setOrtho", "scope": "instance", "___id": "T000002R011308", "___s": true }, { "comment": "/**\r\n * Iterates and destroys all current Faces in this Mesh, then resets the\r\n * `faces` and `vertices` arrays.\r\n *\r\n * @method Phaser.GameObjects.Mesh#clear\r\n * @since 3.50.0\r\n *\r\n * @return {this} This Mesh Game Object.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 524, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Iterates and destroys all current Faces in this Mesh, then resets the\r`faces` and `vertices` arrays.", "kind": "function", "name": "clear", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Mesh Game Object." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#clear", "scope": "instance", "___id": "T000002R011317", "___s": true }, { "comment": "/**\r\n * This method will add the data from a triangulated Wavefront OBJ model file to this Mesh.\r\n *\r\n * The data should have been loaded via the OBJFile:\r\n *\r\n * ```javascript\r\n * this.load.obj(key, url);\r\n * ```\r\n *\r\n * Then use the same `key` as the first parameter to this method.\r\n *\r\n * Multiple Mesh Game Objects can use the same model data without impacting on each other.\r\n *\r\n * Make sure your 3D package has triangulated the model data prior to exporting it.\r\n *\r\n * You can add multiple models to a single Mesh, although they will act as one when\r\n * moved or rotated. You can scale the model data, should it be too small, or too large, to see.\r\n * You can also offset the vertices of the model via the `x`, `y` and `z` parameters.\r\n *\r\n * @method Phaser.GameObjects.Mesh#addVerticesFromObj\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the model data in the OBJ Cache to add to this Mesh.\r\n * @param {number} [scale=1] - An amount to scale the model data by. Use this if the model has exported too small, or large, to see.\r\n * @param {number} [x=0] - Translate the model x position by this amount.\r\n * @param {number} [y=0] - Translate the model y position by this amount.\r\n * @param {number} [z=0] - Translate the model z position by this amount.\r\n * @param {number} [rotateX=0] - Rotate the model on the x axis by this amount, in radians.\r\n * @param {number} [rotateY=0] - Rotate the model on the y axis by this amount, in radians.\r\n * @param {number} [rotateZ=0] - Rotate the model on the z axis by this amount, in radians.\r\n * @param {boolean} [zIsUp=true] - Is the z axis up (true), or is y axis up (false)?\r\n *\r\n * @return {this} This Mesh Game Object.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 546, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "This method will add the data from a triangulated Wavefront OBJ model file to this Mesh.\r\rThe data should have been loaded via the OBJFile:\r\r```javascript\rthis.load.obj(key, url);\r```\r\rThen use the same `key` as the first parameter to this method.\r\rMultiple Mesh Game Objects can use the same model data without impacting on each other.\r\rMake sure your 3D package has triangulated the model data prior to exporting it.\r\rYou can add multiple models to a single Mesh, although they will act as one when\rmoved or rotated. You can scale the model data, should it be too small, or too large, to see.\rYou can also offset the vertices of the model via the `x`, `y` and `z` parameters.", "kind": "function", "name": "addVerticesFromObj", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the model data in the OBJ Cache to add to this Mesh.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "An amount to scale the model data by. Use this if the model has exported too small, or large, to see.", "name": "scale" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Translate the model x position by this amount.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Translate the model y position by this amount.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Translate the model z position by this amount.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Rotate the model on the x axis by this amount, in radians.", "name": "rotateX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Rotate the model on the y axis by this amount, in radians.", "name": "rotateY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Rotate the model on the z axis by this amount, in radians.", "name": "rotateZ" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Is the z axis up (true), or is y axis up (false)?", "name": "zIsUp" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Mesh Game Object." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#addVerticesFromObj", "scope": "instance", "___id": "T000002R011321", "___s": true }, { "comment": "/**\r\n * Compare the depth of two Faces.\r\n *\r\n * @method Phaser.GameObjects.Mesh#sortByDepth\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Geom.Mesh.Face} faceA - The first Face.\r\n * @param {Phaser.Geom.Mesh.Face} faceB - The second Face.\r\n *\r\n * @return {number} The difference between the depths of each Face.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 598, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Compare the depth of two Faces.", "kind": "function", "name": "sortByDepth", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Geom.Mesh.Face" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Face" } }, "description": "The first Face.", "name": "faceA" }, { "type": { "names": [ "Phaser.Geom.Mesh.Face" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Face" } }, "description": "The second Face.", "name": "faceB" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The difference between the depths of each Face." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#sortByDepth", "scope": "instance", "___id": "T000002R011326", "___s": true }, { "comment": "/**\r\n * Runs a depth sort across all Faces in this Mesh, comparing their averaged depth.\r\n *\r\n * This is called automatically if you use any of the `rotate` methods, but you can\r\n * also invoke it to sort the Faces should you manually position them.\r\n *\r\n * @method Phaser.GameObjects.Mesh#depthSort\r\n * @since 3.50.0\r\n *\r\n * @return {this} This Mesh Game Object.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 614, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Runs a depth sort across all Faces in this Mesh, comparing their averaged depth.\r\rThis is called automatically if you use any of the `rotate` methods, but you can\ralso invoke it to sort the Faces should you manually position them.", "kind": "function", "name": "depthSort", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Mesh Game Object." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#depthSort", "scope": "instance", "___id": "T000002R011328", "___s": true }, { "comment": "/**\r\n * Adds a new Vertex into the vertices array of this Mesh.\r\n *\r\n * Just adding a vertex isn't enough to render it. You need to also\r\n * make it part of a Face, with 3 Vertex instances per Face.\r\n *\r\n * @method Phaser.GameObjects.Mesh#addVertex\r\n * @since 3.50.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} z - The z 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 * @param {number} [color=0xffffff] - The color value of the vertex.\r\n * @param {number} [alpha=1] - The alpha value of the vertex.\r\n *\r\n * @return {this} This Mesh Game Object.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 632, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Adds a new Vertex into the vertices array of this Mesh.\r\rJust adding a vertex isn't enough to render it. You need to also\rmake it part of a Face, with 3 Vertex instances per Face.", "kind": "function", "name": "addVertex", "since": "3.50.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 z position of the vertex.", "name": "z" }, { "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" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color value of the vertex.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The alpha value of the vertex.", "name": "alpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Mesh Game Object." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#addVertex", "scope": "instance", "___id": "T000002R011330", "___s": true }, { "comment": "/**\r\n * Adds a new Face into the faces array of this Mesh.\r\n *\r\n * A Face consists of references to 3 Vertex instances, which must be provided.\r\n *\r\n * @method Phaser.GameObjects.Mesh#addFace\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Geom.Mesh.Vertex} vertex1 - The first vertex of the Face.\r\n * @param {Phaser.Geom.Mesh.Vertex} vertex2 - The second vertex of the Face.\r\n * @param {Phaser.Geom.Mesh.Vertex} vertex3 - The third vertex of the Face.\r\n *\r\n * @return {this} This Mesh Game Object.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 660, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Adds a new Face into the faces array of this Mesh.\r\rA Face consists of references to 3 Vertex instances, which must be provided.", "kind": "function", "name": "addFace", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Geom.Mesh.Vertex" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Vertex" } }, "description": "The first vertex of the Face.", "name": "vertex1" }, { "type": { "names": [ "Phaser.Geom.Mesh.Vertex" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Vertex" } }, "description": "The second vertex of the Face.", "name": "vertex2" }, { "type": { "names": [ "Phaser.Geom.Mesh.Vertex" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Vertex" } }, "description": "The third vertex of the Face.", "name": "vertex3" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Mesh Game Object." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#addFace", "scope": "instance", "___id": "T000002R011333", "___s": true }, { "comment": "/**\r\n * Adds new vertices to this Mesh by parsing the given data.\r\n *\r\n * This method will take vertex data in one of two formats, based on the `containsZ` parameter.\r\n *\r\n * If your vertex data are `x`, `y` pairs, then `containsZ` should be `false` (this is the default, and will result in `z=0` for each vertex).\r\n *\r\n * If your vertex data is groups of `x`, `y` and `z` values, then the `containsZ` parameter must be true.\r\n *\r\n * The `uvs` parameter is a numeric array consisting of `u` and `v` pairs.\r\n *\r\n * The `normals` parameter is a numeric array consisting of `x`, `y` vertex normal values and, if `containsZ` is true, `z` values as well.\r\n *\r\n * The `indicies` parameter is an optional array that, if given, is an indexed list of vertices to be added.\r\n *\r\n * The `colors` parameter is an optional array, or single value, that if given sets the color of each vertex created.\r\n *\r\n * The `alphas` parameter is an optional array, or single value, that if given sets the alpha of each vertex created.\r\n *\r\n * When providing indexed data it is assumed that _all_ of the arrays are indexed, not just the vertices.\r\n *\r\n * The following example will create a 256 x 256 sized quad using an index array:\r\n *\r\n * ```javascript\r\n * let mesh = new Mesh(this); // Assuming `this` is a scene!\r\n * const vertices = [\r\n * -128, 128,\r\n * 128, 128,\r\n * -128, -128,\r\n * 128, -128\r\n * ];\r\n *\r\n * const uvs = [\r\n * 0, 1,\r\n * 1, 1,\r\n * 0, 0,\r\n * 1, 0\r\n * ];\r\n *\r\n * const indices = [ 0, 2, 1, 2, 3, 1 ];\r\n *\r\n * mesh.addVertices(vertices, uvs, indicies);\r\n * // Note: Otherwise the added points will be \"behind\" the camera! This value will project vertex `x` & `y` values 1:1 to pixel values.\r\n * mesh.hideCCW = false;\r\n * mesh.setOrtho(mesh.width, mesh.height);\r\n * ```\r\n *\r\n * If the data is not indexed, it's assumed that the arrays all contain sequential data.\r\n *\r\n * @method Phaser.GameObjects.Mesh#addVertices\r\n * @since 3.50.0\r\n *\r\n * @param {number[]} vertices - The vertices array. Either `xy` pairs, or `xyz` if the `containsZ` parameter is `true`.\r\n * @param {number[]} uvs - The UVs pairs array.\r\n * @param {number[]} [indicies] - Optional vertex indicies array. If you don't have one, pass `null` or an empty array.\r\n * @param {boolean} [containsZ=false] - Does the vertices data include a `z` component? If not, it will be assumed `z=0`, see methods `panZ` or `setOrtho`.\r\n * @param {number[]} [normals] - Optional vertex normals array. If you don't have one, pass `null` or an empty array.\r\n * @param {number|number[]} [colors=0xffffff] - An array of colors, one per vertex, or a single color value applied to all vertices.\r\n * @param {number|number[]} [alphas=1] - An array of alpha values, one per vertex, or a single alpha value applied to all vertices.\r\n *\r\n * @return {this} This Mesh Game Object.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 685, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Adds new vertices to this Mesh by parsing the given data.\r\rThis method will take vertex data in one of two formats, based on the `containsZ` parameter.\r\rIf your vertex data are `x`, `y` pairs, then `containsZ` should be `false` (this is the default, and will result in `z=0` for each vertex).\r\rIf your vertex data is groups of `x`, `y` and `z` values, then the `containsZ` parameter must be true.\r\rThe `uvs` parameter is a numeric array consisting of `u` and `v` pairs.\r\rThe `normals` parameter is a numeric array consisting of `x`, `y` vertex normal values and, if `containsZ` is true, `z` values as well.\r\rThe `indicies` parameter is an optional array that, if given, is an indexed list of vertices to be added.\r\rThe `colors` parameter is an optional array, or single value, that if given sets the color of each vertex created.\r\rThe `alphas` parameter is an optional array, or single value, that if given sets the alpha of each vertex created.\r\rWhen providing indexed data it is assumed that _all_ of the arrays are indexed, not just the vertices.\r\rThe following example will create a 256 x 256 sized quad using an index array:\r\r```javascript\rlet mesh = new Mesh(this); // Assuming `this` is a scene!\rconst vertices = [\r -128, 128,\r 128, 128,\r -128, -128,\r 128, -128\r];\r\rconst uvs = [\r 0, 1,\r 1, 1,\r 0, 0,\r 1, 0\r];\r\rconst indices = [ 0, 2, 1, 2, 3, 1 ];\r\rmesh.addVertices(vertices, uvs, indicies);\r// Note: Otherwise the added points will be \"behind\" the camera! This value will project vertex `x` & `y` values 1:1 to pixel values.\rmesh.hideCCW = false;\rmesh.setOrtho(mesh.width, mesh.height);\r```\r\rIf the data is not indexed, it's assumed that the arrays all contain sequential data.", "kind": "function", "name": "addVertices", "since": "3.50.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The vertices array. Either `xy` pairs, or `xyz` if the `containsZ` parameter is `true`.", "name": "vertices" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The UVs pairs array.", "name": "uvs" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "Optional vertex indicies array. If you don't have one, pass `null` or an empty array.", "name": "indicies" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does the vertices data include a `z` component? If not, it will be assumed `z=0`, see methods `panZ` or `setOrtho`.", "name": "containsZ" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "Optional vertex normals array. If you don't have one, pass `null` or an empty array.", "name": "normals" }, { "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": "0xffffff", "description": "An array of colors, one per vertex, or a single color value applied to all vertices.", "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, "defaultvalue": 1, "description": "An array of alpha values, one per vertex, or a single alpha value applied to all vertices.", "name": "alphas" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Mesh Game Object." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#addVertices", "scope": "instance", "___id": "T000002R011337", "___s": true }, { "comment": "/**\r\n * Returns the total number of Faces in this Mesh Game Object.\r\n *\r\n * @method Phaser.GameObjects.Mesh#getFaceCount\r\n * @since 3.50.0\r\n *\r\n * @return {number} The number of Faces in this Mesh Game Object.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 766, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Returns the total number of Faces in this Mesh Game Object.", "kind": "function", "name": "getFaceCount", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of Faces in this Mesh Game Object." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#getFaceCount", "scope": "instance", "___id": "T000002R011343", "___s": true }, { "comment": "/**\r\n * Returns the total number of Vertices in this Mesh Game Object.\r\n *\r\n * @method Phaser.GameObjects.Mesh#getVertexCount\r\n * @since 3.50.0\r\n *\r\n * @return {number} The number of Vertices in this Mesh Game Object.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 779, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Returns the total number of Vertices in this Mesh Game Object.", "kind": "function", "name": "getVertexCount", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of Vertices in this Mesh Game Object." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#getVertexCount", "scope": "instance", "___id": "T000002R011345", "___s": true }, { "comment": "/**\r\n * Returns the Face at the given index in this Mesh Game Object.\r\n *\r\n * @method Phaser.GameObjects.Mesh#getFace\r\n * @since 3.50.0\r\n *\r\n * @param {number} index - The index of the Face to get.\r\n *\r\n * @return {Phaser.Geom.Mesh.Face} The Face at the given index, or `undefined` if index out of range.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 792, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Returns the Face at the given index in this Mesh Game Object.", "kind": "function", "name": "getFace", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the Face to get.", "name": "index" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Mesh.Face" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Face" } }, "description": "The Face at the given index, or `undefined` if index out of range." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#getFace", "scope": "instance", "___id": "T000002R011347", "___s": true }, { "comment": "/**\r\n * Tests to see if _any_ face in this Mesh intersects with the given coordinates.\r\n *\r\n * The given position is translated through the matrix of this Mesh and the given Camera,\r\n * before being compared against the vertices.\r\n *\r\n * @method Phaser.GameObjects.Mesh#hasFaceAt\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - The x position to check against.\r\n * @param {number} y - The y position to check against.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The camera to pass the coordinates through. If not give, the default Scene Camera is used.\r\n *\r\n * @return {boolean} Returns `true` if _any_ face of this Mesh intersects with the given coordinate, otherwise `false`.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 807, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Tests to see if _any_ face in this Mesh intersects with the given coordinates.\r\rThe given position is translated through the matrix of this Mesh and the given Camera,\rbefore being compared against the vertices.", "kind": "function", "name": "hasFaceAt", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position to check against.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position to check against.", "name": "y" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The camera to pass the coordinates through. If not give, the default Scene Camera is used.", "name": "camera" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `true` if _any_ face of this Mesh intersects with the given coordinate, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#hasFaceAt", "scope": "instance", "___id": "T000002R011349", "___s": true }, { "comment": "/**\r\n * Return an array of Face objects from this Mesh that intersect with the given coordinates.\r\n *\r\n * The given position is translated through the matrix of this Mesh and the given Camera,\r\n * before being compared against the vertices.\r\n *\r\n * If more than one Face intersects, they will all be returned in the array, but the array will\r\n * be depth sorted first, so the first element will always be that closest to the camera.\r\n *\r\n * @method Phaser.GameObjects.Mesh#getFaceAt\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The x position to check against.\r\n * @param {number} y - The y position to check against.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The camera to pass the coordinates through. If not give, the default Scene Camera is used.\r\n *\r\n * @return {Phaser.Geom.Mesh.Face[]} An array of Face objects that intersect with the given point, ordered by depth.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 843, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Return an array of Face objects from this Mesh that intersect with the given coordinates.\r\rThe given position is translated through the matrix of this Mesh and the given Camera,\rbefore being compared against the vertices.\r\rIf more than one Face intersects, they will all be returned in the array, but the array will\rbe depth sorted first, so the first element will always be that closest to the camera.", "kind": "function", "name": "getFaceAt", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position to check against.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position to check against.", "name": "y" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The camera to pass the coordinates through. If not give, the default Scene Camera is used.", "name": "camera" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Mesh.Face", "type": "NameExpression" } ] } }, "description": "An array of Face objects that intersect with the given point, ordered by depth." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#getFaceAt", "scope": "instance", "___id": "T000002R011356", "___s": true }, { "comment": "/**\r\n * This method enables rendering of the Mesh 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 Mesh objects to a single Graphics instance.\r\n *\r\n * The Mesh class has a built-in debug rendering callback `Mesh.renderDebug`, 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, faces)`\r\n *\r\n * `src` is the Mesh instance being debugged.\r\n * `faces` is an array of the Faces that were rendered.\r\n *\r\n * You can get the final drawn vertex position from a Face object like this:\r\n *\r\n * ```javascript\r\n * let face = faces[i];\r\n *\r\n * let x0 = face.vertex1.tx;\r\n * let y0 = face.vertex1.ty;\r\n * let x1 = face.vertex2.tx;\r\n * let y1 = face.vertex2.ty;\r\n * let x2 = face.vertex3.tx;\r\n * let y2 = face.vertex3.ty;\r\n *\r\n * graphic.strokeTriangle(x0, y0, x1, y1, x2, y2);\r\n * ```\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.Mesh#setDebug\r\n * @since 3.50.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": "Mesh.js", "lineno": 883, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "This method enables rendering of the Mesh 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 Mesh objects to a single Graphics instance.\r\rThe Mesh class has a built-in debug rendering callback `Mesh.renderDebug`, 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, faces)`\r\r`src` is the Mesh instance being debugged.\r`faces` is an array of the Faces that were rendered.\r\rYou can get the final drawn vertex position from a Face object like this:\r\r```javascript\rlet face = faces[i];\r\rlet x0 = face.vertex1.tx;\rlet y0 = face.vertex1.ty;\rlet x1 = face.vertex2.tx;\rlet y1 = face.vertex2.ty;\rlet x2 = face.vertex3.tx;\rlet y2 = face.vertex3.ty;\r\rgraphic.strokeTriangle(x0, y0, x1, y1, x2, y2);\r```\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.50.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.Mesh", "longname": "Phaser.GameObjects.Mesh#setDebug", "scope": "instance", "___id": "T000002R011364", "___s": true }, { "comment": "/**\r\n * Checks if the transformation data in this mesh is dirty.\r\n *\r\n * This is used internally by the `preUpdate` step to determine if the vertices should\r\n * be recalculated or not.\r\n *\r\n * @method Phaser.GameObjects.Mesh#isDirty\r\n * @since 3.50.0\r\n *\r\n * @return {boolean} Returns `true` if the data of this mesh is dirty, otherwise `false`.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 949, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Checks if the transformation data in this mesh is dirty.\r\rThis is used internally by the `preUpdate` step to determine if the vertices should\rbe recalculated or not.", "kind": "function", "name": "isDirty", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `true` if the data of this mesh is dirty, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#isDirty", "scope": "instance", "___id": "T000002R011370", "___s": true }, { "comment": "/**\r\n * The Mesh update loop. The following takes place in this method:\r\n *\r\n * First, the `totalRendered` and `totalFrame` properties are set.\r\n *\r\n * If the view matrix of this Mesh isn't dirty, and the model position, rotate or scale properties are\r\n * all clean, then the method returns at this point.\r\n *\r\n * Otherwise, if the viewPosition is dirty (i.e. from calling a method like `panZ`), then it will\r\n * refresh the viewMatrix.\r\n *\r\n * After this, a new transformMatrix is built and it then iterates through all Faces in this\r\n * Mesh, calling `transformCoordinatesLocal` on all of them. Internally, this updates every\r\n * vertex, calculating its new transformed position, based on the new transform matrix.\r\n *\r\n * Finally, the faces are depth sorted.\r\n *\r\n * @method Phaser.GameObjects.Mesh#preUpdate\r\n * @protected\r\n * @since 3.50.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": "Mesh.js", "lineno": 1017, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "The Mesh update loop. The following takes place in this method:\r\rFirst, the `totalRendered` and `totalFrame` properties are set.\r\rIf the view matrix of this Mesh isn't dirty, and the model position, rotate or scale properties are\rall clean, then the method returns at this point.\r\rOtherwise, if the viewPosition is dirty (i.e. from calling a method like `panZ`), then it will\rrefresh the viewMatrix.\r\rAfter this, a new transformMatrix is built and it then iterates through all Faces in this\rMesh, calling `transformCoordinatesLocal` on all of them. Internally, this updates every\rvertex, calculating its new transformed position, based on the new transform matrix.\r\rFinally, the faces are depth sorted.", "kind": "function", "name": "preUpdate", "access": "protected", "since": "3.50.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.Mesh", "longname": "Phaser.GameObjects.Mesh#preUpdate", "scope": "instance", "___id": "T000002R011406", "___s": true }, { "comment": "/**\r\n * The built-in Mesh debug rendering method.\r\n *\r\n * See `Mesh.setDebug` for more details.\r\n *\r\n * @method Phaser.GameObjects.Mesh#renderDebug\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.Mesh} src - The Mesh object being rendered.\r\n * @param {Phaser.Geom.Mesh.Face[]} faces - An array of Faces.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1091, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "The built-in Mesh debug rendering method.\r\rSee `Mesh.setDebug` for more details.", "kind": "function", "name": "renderDebug", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Mesh" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Mesh" } }, "description": "The Mesh object being rendered.", "name": "src" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Mesh.Face", "type": "NameExpression" } ] } }, "description": "An array of Faces.", "name": "faces" } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#renderDebug", "scope": "instance", "___id": "T000002R011420", "___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 on all vertices,\r\n * which results in no visible change to the texture.\r\n *\r\n * @method Phaser.GameObjects.Mesh#clearTint\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1136, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff on all vertices,\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.Mesh", "longname": "Phaser.GameObjects.Mesh#clearTint", "scope": "instance", "___id": "T000002R011435", "___s": true }, { "comment": "/**\r\n * Pass this Mesh Game Object to the Input Manager to enable it for Input.\r\n *\r\n * Unlike other Game Objects, the Mesh Game Object uses its own special hit area callback, which you cannot override.\r\n *\r\n * @example\r\n * mesh.setInteractive();\r\n *\r\n * @method Phaser.GameObjects.Mesh#setInteractive\r\n * @since 3.60.0\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1153, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Pass this Mesh Game Object to the Input Manager to enable it for Input.\r\rUnlike other Game Objects, the Mesh Game Object uses its own special hit area callback, which you cannot override.", "examples": [ "mesh.setInteractive();" ], "kind": "function", "name": "setInteractive", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#setInteractive", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#setInteractive", "___id": "T000002R011437", "___s": true }, { "comment": "/**\r\n * Sets an additive tint on all vertices of this Mesh Game Object.\r\n *\r\n * The tint works by taking the pixel color values from the Game Objects texture, and then\r\n * multiplying it by the color value of the tint.\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.\r\n *\r\n * To remove a tint call `clearTint`.\r\n *\r\n * @method Phaser.GameObjects.Mesh#setTint\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {number} [tint=0xffffff] - The tint being applied to all vertices of this Mesh Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Sets an additive tint on all vertices of this Mesh Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by the color value of the tint.\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.\r\rTo remove a tint call `clearTint`.", "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 all vertices of this Mesh Game Object.", "name": "tint" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#setTint", "scope": "instance", "___id": "T000002R011443", "___s": true }, { "comment": "/**\r\n * Scrolls the UV texture coordinates of all faces in this Mesh by\r\n * adding the given x/y amounts to them.\r\n *\r\n * If you only wish to scroll one coordinate, pass a value of zero\r\n * to the other.\r\n *\r\n * Use small values for scrolling. UVs are set from the range 0\r\n * to 1, so you should increment (or decrement) them by suitably\r\n * small values, such as 0.01.\r\n *\r\n * Due to a limitation in WebGL1 you can only UV scroll textures\r\n * that are a power-of-two in size. Scrolling NPOT textures will\r\n * work but will result in clamping the pixels to the edges.\r\n *\r\n * Note that if this Mesh is using a _frame_ from a texture atlas\r\n * then you will be unable to UV scroll its texture.\r\n *\r\n * @method Phaser.GameObjects.Mesh#uvScroll\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - The amount to horizontally shift the UV coordinates by.\r\n * @param {number} y - The amount to vertically shift the UV coordinates by.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1224, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Scrolls the UV texture coordinates of all faces in this Mesh by\radding the given x/y amounts to them.\r\rIf you only wish to scroll one coordinate, pass a value of zero\rto the other.\r\rUse small values for scrolling. UVs are set from the range 0\rto 1, so you should increment (or decrement) them by suitably\rsmall values, such as 0.01.\r\rDue to a limitation in WebGL1 you can only UV scroll textures\rthat are a power-of-two in size. Scrolling NPOT textures will\rwork but will result in clamping the pixels to the edges.\r\rNote that if this Mesh is using a _frame_ from a texture atlas\rthen you will be unable to UV scroll its texture.", "kind": "function", "name": "uvScroll", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to horizontally shift the UV coordinates by.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to vertically shift the UV coordinates by.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#uvScroll", "scope": "instance", "___id": "T000002R011449", "___s": true }, { "comment": "/**\r\n * Scales the UV texture coordinates of all faces in this Mesh by\r\n * the exact given amounts.\r\n *\r\n * If you only wish to scale one coordinate, pass a value of one\r\n * to the other.\r\n *\r\n * Due to a limitation in WebGL1 you can only UV scale textures\r\n * that are a power-of-two in size. Scaling NPOT textures will\r\n * work but will result in clamping the pixels to the edges if\r\n * you scale beyond a value of 1. Scaling below 1 will work\r\n * regardless of texture size.\r\n *\r\n * Note that if this Mesh is using a _frame_ from a texture atlas\r\n * then you will be unable to UV scale its texture.\r\n *\r\n * @method Phaser.GameObjects.Mesh#uvScale\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - The amount to horizontally scale the UV coordinates by.\r\n * @param {number} y - The amount to vertically scale the UV coordinates by.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1263, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Scales the UV texture coordinates of all faces in this Mesh by\rthe exact given amounts.\r\rIf you only wish to scale one coordinate, pass a value of one\rto the other.\r\rDue to a limitation in WebGL1 you can only UV scale textures\rthat are a power-of-two in size. Scaling NPOT textures will\rwork but will result in clamping the pixels to the edges if\ryou scale beyond a value of 1. Scaling below 1 will work\rregardless of texture size.\r\rNote that if this Mesh is using a _frame_ from a texture atlas\rthen you will be unable to UV scale its texture.", "kind": "function", "name": "uvScale", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to horizontally scale the UV coordinates by.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to vertically scale the UV coordinates by.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#uvScale", "scope": "instance", "___id": "T000002R011453", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only.\r\n *\r\n * @method Phaser.GameObjects.Mesh#tint\r\n * @type {number}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1300, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only.", "kind": "function", "name": "tint", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } } } ], "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#tint", "scope": "instance", "___id": "T000002R011457", "___s": true }, { "comment": "/**\r\n * The x rotation of the Model in 3D space, as specified in degrees.\r\n *\r\n * If you need the value in radians use the `modelRotation.x` property directly.\r\n *\r\n * @method Phaser.GameObjects.Mesh#rotateX\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1317, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "The x rotation of the Model in 3D space, as specified in degrees.\r\rIf you need the value in radians use the `modelRotation.x` property directly.", "kind": "function", "name": "rotateX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } } } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#rotateX", "scope": "instance", "___id": "T000002R011460", "___s": true }, { "comment": "/**\r\n * The y rotation of the Model in 3D space, as specified in degrees.\r\n *\r\n * If you need the value in radians use the `modelRotation.y` property directly.\r\n *\r\n * @method Phaser.GameObjects.Mesh#rotateY\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "The y rotation of the Model in 3D space, as specified in degrees.\r\rIf you need the value in radians use the `modelRotation.y` property directly.", "kind": "function", "name": "rotateY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } } } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#rotateY", "scope": "instance", "___id": "T000002R011465", "___s": true }, { "comment": "/**\r\n * The z rotation of the Model in 3D space, as specified in degrees.\r\n *\r\n * If you need the value in radians use the `modelRotation.z` property directly.\r\n *\r\n * @method Phaser.GameObjects.Mesh#rotateZ\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1363, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "The z rotation of the Model in 3D space, as specified in degrees.\r\rIf you need the value in radians use the `modelRotation.z` property directly.", "kind": "function", "name": "rotateZ", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } } } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Mesh", "longname": "Phaser.GameObjects.Mesh#rotateZ", "scope": "instance", "___id": "T000002R011470", "___s": true }, { "comment": "/**\r\n * Creates a new Mesh Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Mesh Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#mesh\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Mesh.MeshConfig} 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.Mesh} The Game Object that was created.\r\n */", "meta": { "filename": "MeshCreator.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Creates a new Mesh Game Object and returns it.\r\rNote: This method will only be available if the Mesh Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "mesh", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Mesh.MeshConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Mesh.MeshConfig" } }, "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.Mesh" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Mesh" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#mesh", "scope": "instance", "___id": "T000002R011484", "___s": true }, { "comment": "/**\n * Creates a new Mesh Game Object and adds it to the Scene.\n *\n * Note: This method will only be available if the Mesh Game Object and WebGL support have been built into Phaser.\n *\n * @method Phaser.GameObjects.GameObjectFactory#mesh\n * @webglOnly\n * @since 3.0.0\n *\n * @param {number} [x] - The horizontal position of this Game Object in the world.\n * @param {number} [y] - The vertical position of this Game Object in the world.\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.\n * @param {string|number} [frame] - An optional frame from the Texture this Game Object is rendering with.\n * @param {number[]} [vertices] - The vertices array. Either `xy` pairs, or `xyz` if the `containsZ` parameter is `true`.\n * @param {number[]} [uvs] - The UVs pairs array.\n * @param {number[]} [indicies] - Optional vertex indicies array. If you don't have one, pass `null` or an empty array.\n * @param {boolean} [containsZ=false] - Does the vertices data include a `z` component?\n * @param {number[]} [normals] - Optional vertex normals array. If you don't have one, pass `null` or an empty array.\n * @param {number|number[]} [colors=0xffffff] - An array of colors, one per vertex, or a single color value applied to all vertices.\n * @param {number|number[]} [alphas=1] - An array of alpha values, one per vertex, or a single alpha value applied to all vertices.\n *\n * @return {Phaser.GameObjects.Mesh} The Game Object that was created.\n */", "meta": { "filename": "MeshFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "description": "Creates a new Mesh Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Mesh Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "mesh", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.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": [ "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": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "The vertices array. Either `xy` pairs, or `xyz` if the `containsZ` parameter is `true`.", "name": "vertices" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "The UVs pairs array.", "name": "uvs" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "Optional vertex indicies array. If you don't have one, pass `null` or an empty array.", "name": "indicies" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does the vertices data include a `z` component?", "name": "containsZ" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "Optional vertex normals array. If you don't have one, pass `null` or an empty array.", "name": "normals" }, { "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": "0xffffff", "description": "An array of colors, one per vertex, or a single color value applied to all vertices.", "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, "defaultvalue": 1, "description": "An array of alpha values, one per vertex, or a single alpha value applied to all vertices.", "name": "alphas" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Mesh" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Mesh" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#mesh", "scope": "instance", "___id": "T000002R011499", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.Mesh\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh\\typedefs", "code": {} }, "kind": "namespace", "name": "Mesh", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Mesh", "scope": "static", "___id": "T000002R011542", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Mesh.MeshConfig\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 {number[]} [vertices] - The vertices array. Either `xy` pairs, or `xyz` if the `containsZ` parameter is `true`.\r\n * @property {number[]} [uvs] - The UVs pairs array.\r\n * @property {number[]} [indicies] - Optional vertex indicies array. If you don't have one, pass `null` or an empty array.\r\n * @property {boolean} [containsZ=false] - Does the vertices data include a `z` component?\r\n * @property {number[]} [normals] - Optional vertex normals array. If you don't have one, pass `null` or an empty array.\r\n * @property {number|number[]} [colors=0xffffff] - An array of colors, one per vertex, or a single color value applied to all vertices.\r\n * @property {number|number[]} [alphas=1] - An array of alpha values, one per vertex, or a single alpha value applied to all vertices.\r\n */", "meta": { "filename": "MeshConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh\\typedefs", "code": {} }, "kind": "typedef", "name": "MeshConfig", "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": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "The vertices array. Either `xy` pairs, or `xyz` if the `containsZ` parameter is `true`.", "name": "vertices" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "The UVs pairs array.", "name": "uvs" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "Optional vertex indicies array. If you don't have one, pass `null` or an empty array.", "name": "indicies" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does the vertices data include a `z` component?", "name": "containsZ" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "Optional vertex normals array. If you don't have one, pass `null` or an empty array.", "name": "normals" }, { "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": "0xffffff", "description": "An array of colors, one per vertex, or a single color value applied to all vertices.", "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, "defaultvalue": 1, "description": "An array of alpha values, one per vertex, or a single alpha value applied to all vertices.", "name": "alphas" } ], "memberof": "Phaser.Types.GameObjects.Mesh", "longname": "Phaser.Types.GameObjects.Mesh.MeshConfig", "scope": "static", "___id": "T000002R011543", "___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 * As of Phaser 3.60 this Game Object is WebGL only.\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.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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 horiztonal row (C). Set to zero or undefined to create a 3 slice object.\r\n * @param {number} [bottomHeight=0] - The size of the bottom horiztonal row (D). Set to zero or undefined to create a 3 slice object.\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 13, "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\rAs of Phaser 3.60 this Game Object is WebGL only.", "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.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "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 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" } ], "scope": "static", "longname": "Phaser.GameObjects.NineSlice", "___id": "T000002R011549", "___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.Geom.Mesh.Vertex[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 199, "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.Geom.Mesh.Vertex", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#vertices", "scope": "instance", "kind": "member", "___id": "T000002R011570", "___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": 226, "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": "T000002R011572", "___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": 236, "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": "T000002R011574", "___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": 246, "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": "T000002R011576", "___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": 259, "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": "T000002R011578", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertice 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.NineSlice#tint\r\n * @type {number}\r\n * @default 0xffffff\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 271, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "The tint value being applied to the top-left vertice 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": "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": "T000002R011580", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.NineSlice#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 283, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "name": "tintFill", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#tintFill", "scope": "instance", "kind": "member", "___id": "T000002R011582", "___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": 296, "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": "T000002R011584", "___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 horiztonal row (C). Set to zero or undefined to create a 3 slice object.\r\n * @param {number} [bottomHeight=0] - The size of the bottom horiztonal row (D). Set to zero or undefined to create a 3 slice object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 326, "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 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" } ], "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": "T000002R011588", "___s": true }, { "comment": "/**\r\n * Updates all of the vertice 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 `updateVertice` 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": 388, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Updates all of the vertice UV coordinates. This is called automatically\rwhen the NineSlice Game Object is created, or if the texture frame changes.\r\rUnlike with the `updateVertice` 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": "T000002R011607", "___s": true }, { "comment": "/**\r\n * Recalculates all of the vertices in this Nine Slice Game Object\r\n * based on the `leftWidth`, `rightWidth`, `topHeight` and `bottomHeight`\r\n * 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 it's 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": 423, "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` and `bottomHeight`\rproperties, combined with the Game Object size.\r\rThis method is called automatically when this object is created\ror if it's 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": "T000002R011615", "___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 quad coordinate.\r\n * @param {number} y1 - The top-left quad coordinate.\r\n * @param {number} x2 - The bottom-right quad coordinate.\r\n * @param {number} y2 - The bottom-right quad coordinate.\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 463, "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 quad coordinate.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left quad coordinate.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right quad coordinate.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right quad coordinate.", "name": "y2" } ], "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#updateQuad", "scope": "instance", "___id": "T000002R011623", "___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 UV coordinate.\r\n * @param {number} v1 - The top-left UV coordinate.\r\n * @param {number} u2 - The bottom-right UV coordinate.\r\n * @param {number} v2 - The bottom-right UV coordinate.\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 496, "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 UV coordinate.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left UV coordinate.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right UV coordinate.", "name": "u2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right UV coordinate.", "name": "v2" } ], "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#updateQuadUVs", "scope": "instance", "___id": "T000002R011630", "___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 'additive',\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": 549, "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 'additive',\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": "T000002R011644", "___s": true }, { "comment": "/**\r\n * Sets an additive tint 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 * multiplying it by the color value of the tint.\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 * To swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.\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": 568, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Sets an additive tint on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by the color value of the tint.\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.\r\rTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.", "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": "T000002R011646", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on this Game Object.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. The whole Game Object will be rendered in the given color.\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 * To swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.\r\n *\r\n * @method Phaser.GameObjects.NineSlice#setTintFill\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": 600, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Sets a fill-based tint on this Game Object.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. The whole Game Object will be rendered in the given color.\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.\r\rTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.", "kind": "function", "name": "setTintFill", "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#setTintFill", "scope": "instance", "___id": "T000002R011651", "___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 * 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": 631, "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.\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": "T000002R011654", "___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": 652, "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": "T000002R011657", "___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": 682, "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": "T000002R011662", "___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": 718, "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": "T000002R011667", "___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": 743, "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": "T000002R011672", "___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": 768, "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": "T000002R011677", "___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": 805, "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": "T000002R011684", "___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": 826, "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": "T000002R011688", "___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": 851, "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": "T000002R011693", "___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": 876, "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": "T000002R011698", "___s": true }, { "comment": "/**\r\n * This method is included but does nothing for the Nine Slice Game Object,\r\n * because the size of the object isn't based on the texture frame.\r\n *\r\n * You should not call this method.\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": 902, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "This method is included but does nothing for the Nine Slice Game Object,\rbecause the size of the object isn't based on the texture frame.\r\rYou should not call this method.", "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": "T000002R011704", "___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": "T000002R011719", "___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 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 * 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 horiztonal row (C). Set to zero or undefined to create a 3 slice object.\r\n * @param {number} [bottomHeight=0] - The size of the bottom horiztonal row (D). Set to zero or undefined to create a 3 slice object.\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 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\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 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" } ], "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": "T000002R011733", "___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": "T000002R011773", "___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 */", "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" } ], "memberof": "Phaser.Types.GameObjects.NineSlice", "longname": "Phaser.Types.GameObjects.NineSlice.NineSliceConfig", "scope": "static", "___id": "T000002R011774", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * This class is responsible for taking control over the color property\r\n * in the Particle class and managing its emission and updating functions.\r\n *\r\n * See the `ParticleEmitter` class for more details on emitter op configuration.\r\n *\r\n * @class EmitterColorOp\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": "This class is responsible for taking control over the color property\rin the Particle class and managing its emission and updating functions.\r\rSee the `ParticleEmitter` class for more details on emitter op configuration.", "kind": "class", "name": "EmitterColorOp", "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": "T000002R011781", "___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": 42, "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": "T000002R011787", "___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": 53, "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": "T000002R011789", "___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": 64, "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": "T000002R011791", "___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} A number between 0 and 9 which should be passed to `setMethods`.\r\n */", "meta": { "filename": "EmitterColorOp.js", "lineno": 76, "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.EmitterColorOp", "longname": "Phaser.GameObjects.Particles.EmitterColorOp#getMethod", "scope": "instance", "___id": "T000002R011793", "___s": true }, { "comment": "/**\r\n * Sets the EmitterColorOp method values, if in use.\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": 90, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Sets the EmitterColorOp method values, if in use.", "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", "___id": "T000002R011795", "___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": 137, "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": "T000002R011813", "___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": 152, "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", "___id": "T000002R011817", "___s": true }, { "comment": "/**\r\n * An `onUpdate` callback that returns an eased value between the\r\n * {@link Phaser.GameObjects.Particles.EmitterColorOp#start} and {@link Phaser.GameObjects.Particles.EmitterColorOp#end}\r\n * range.\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": 172, "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.EmitterColorOp#start} and {@link Phaser.GameObjects.Particles.EmitterColorOp#end}\rrange.", "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", "___id": "T000002R011820", "___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} 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "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": "T000002R011838", "___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": "T000002R011842", "___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}\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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#propertyValue", "scope": "instance", "kind": "member", "___id": "T000002R011844", "___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}\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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#defaultValue", "scope": "instance", "kind": "member", "___id": "T000002R011846", "___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": "T000002R011848", "___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": "T000002R011850", "___s": true }, { "comment": "/**\r\n * When the step counter reaches it's 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 it's 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": "T000002R011852", "___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": "T000002R011854", "___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": "T000002R011856", "___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": "T000002R011858", "___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": "T000002R011860", "___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": "T000002R011862", "___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": "T000002R011864", "___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": "T000002R011866", "___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": "T000002R011868", "___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": "T000002R011870", "___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": "T000002R011872", "___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": "T000002R011874", "___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": "T000002R011880", "___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": "T000002R011887", "___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": "T000002R011889", "___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": "T000002R011900", "___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": "T000002R011904", "___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": 546, "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": "T000002R011953", "___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": 562, "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": "T000002R011955", "___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": 579, "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": "T000002R011957", "___s": true }, { "comment": "/**\r\n * The returned value sets what the property will be at the START of the particles life, on emit.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#defaultEmit\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": "EmitterOp.js", "lineno": 596, "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 particles life, on emit.", "kind": "function", "name": "defaultEmit", "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" } }, "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#defaultEmit", "scope": "instance", "___id": "T000002R011959", "___s": true }, { "comment": "/**\r\n * The returned value updates the property for the duration of the particles 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": 613, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The returned value updates the property for the duration of the particles life.", "kind": "function", "name": "defaultUpdate", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "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": "T000002R011961", "___s": true }, { "comment": "/**\r\n * The returned value sets what the property will be at the START of the particles 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": 631, "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 particles 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": "T000002R011963", "___s": true }, { "comment": "/**\r\n * The returned value updates the property for the duration of the particles 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": 654, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The returned value updates the property for the duration of the particles 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": "T000002R011967", "___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": 678, "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": "T000002R011971", "___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": 691, "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": "T000002R011973", "___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": 704, "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": "T000002R011975", "___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": 721, "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": "T000002R011979", "___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#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": 748, "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": "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": "T000002R011985", "___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": 775, "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": "T000002R011991", "___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": 838, "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": "T000002R012008", "___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": 866, "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": "T000002R012014", "___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": 901, "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": "T000002R012022", "___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": "T000002R012031", "___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": "T000002R012033", "___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": "T000002R012035", "___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": "T000002R012037", "___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": "T000002R012044", "___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": "T000002R012046", "___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": "T000002R012051", "___s": true }, { "comment": "/**\r\n * Takes a Particle and updates it based on the properties of this Gravity Well.\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 it based on the properties of this Gravity Well.", "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": "T000002R012072", "___s": true }, { "comment": "/**\r\n * The minimum distance for which the gravity force is calculated.\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The minimum distance for which the gravity force is calculated.\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": "T000002R012082", "___s": true }, { "comment": "/**\r\n * The strength of the gravity force - larger numbers produce a stronger force.\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": 152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The strength of the gravity force - larger numbers produce a stronger force.\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": "T000002R012087", "___s": true }, { "comment": "/**\r\n * The gravitational force of this Gravity Well.\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": 175, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The gravitational force of this Gravity Well.\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": "T000002R012092", "___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": "T000002R012100", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Particle is a simple object owned and controlled by a Particle Emitter.\r\n *\r\n * It encapsulates all of the properties required to move and update according\r\n * to the Emitters operations.\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 simple object owned and controlled by a Particle Emitter.\r\rIt encapsulates all of the properties required to move and update according\rto the Emitters operations.", "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": "T000002R012118", "___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": 35, "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": "T000002R012121", "___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": 46, "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": "T000002R012123", "___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": 56, "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": "T000002R012125", "___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": 66, "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": "T000002R012127", "___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": 76, "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": "T000002R012129", "___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": 86, "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": "T000002R012131", "___s": true }, { "comment": "/**\r\n * The x velocity of this Particle.\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": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The x velocity of this Particle.", "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": "T000002R012133", "___s": true }, { "comment": "/**\r\n * The y velocity of this Particle.\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": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The y velocity of this Particle.", "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": "T000002R012135", "___s": true }, { "comment": "/**\r\n * The x acceleration of this Particle.\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": 117, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The x acceleration of this Particle.", "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": "T000002R012137", "___s": true }, { "comment": "/**\r\n * The y acceleration of this Particle.\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": 127, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The y acceleration of this Particle.", "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": "T000002R012139", "___s": true }, { "comment": "/**\r\n * The maximum horizontal velocity this Particle can travel at.\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": 137, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The maximum horizontal velocity this Particle can travel at.", "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": "T000002R012141", "___s": true }, { "comment": "/**\r\n * The maximum vertical velocity this Particle can travel at.\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": 147, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The maximum vertical velocity this Particle can travel at.", "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": "T000002R012143", "___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": 157, "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": "T000002R012145", "___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": 167, "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": "T000002R012147", "___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": 177, "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": "T000002R012149", "___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": 187, "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": "T000002R012151", "___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": 197, "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": "T000002R012153", "___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": 207, "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": "T000002R012155", "___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": 217, "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": "T000002R012157", "___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": 227, "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": "T000002R012159", "___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": 237, "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": "T000002R012161", "___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": 247, "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": "T000002R012163", "___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": 257, "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": "T000002R012165", "___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": 267, "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": "T000002R012167", "___s": true }, { "comment": "/**\r\n * The data used by the ease equation.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#data\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 277, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The data used by the ease equation.", "name": "data", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#data", "scope": "instance", "kind": "member", "___id": "T000002R012169", "___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": 312, "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": "T000002R012215", "___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 * @name Phaser.GameObjects.Particles.Particle#anims\r\n * @type {Phaser.Animations.AnimationState}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 326, "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.", "name": "anims", "type": { "names": [ "Phaser.Animations.AnimationState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationState" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#anims", "scope": "instance", "kind": "member", "___id": "T000002R012217", "___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": 339, "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": "T000002R012219", "___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": 350, "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": "T000002R012221", "___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": 372, "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": "T000002R012223", "___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": 385, "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": "T000002R012225", "___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 0x0.\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": 397, "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 0x0.", "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": "T000002R012228", "___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": 417, "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": "T000002R012234", "___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": 555, "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": "T000002R012277", "___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": 657, "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": "T000002R012302", "___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": 713, "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": "T000002R012322", "___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": 724, "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": "T000002R012324", "___s": true }, { "comment": "/**\r\n * Destroys this Particle.\r\n *\r\n * @method Phaser.GameObjects.Particles.Particle#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 778, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Destroys this Particle.", "kind": "function", "name": "destroy", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#destroy", "scope": "instance", "___id": "T000002R012343", "___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": "T000002R012354", "___s": true }, { "comment": "/**\r\n * A rectangular boundary constraining particle movement. Use the Emitter 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 Emitter 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": "T000002R012362", "___s": true }, { "comment": "/**\r\n * Whether particles interact with the left edge of the emitter {@link Phaser.GameObjects.Particles.ParticleEmitter#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 emitter {@link Phaser.GameObjects.Particles.ParticleEmitter#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": "T000002R012364", "___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": "T000002R012366", "___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": "T000002R012368", "___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": "T000002R012370", "___s": true }, { "comment": "/**\r\n * Takes a Particle and updates it against the bounds.\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": "Takes a Particle and updates it against the bounds.", "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": "T000002R012372", "___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, given 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 it's 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 about of\r\n * control over how your particles behave.\r\n *\r\n * ## v3.55 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.Mask\r\n * @extends Phaser.GameObjects.Components.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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": 103, "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, given 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 it's 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 about of\rcontrol over how your particles behave.\r\r## v3.55 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.Mask", "Phaser.GameObjects.Components.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "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": "T000002R012417", "___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": 360, "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": "T000002R012422", "___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": 371, "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": "T000002R012424", "___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": 408, "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": "T000002R012450", "___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": 421, "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": "T000002R012452", "___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": 432, "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": "T000002R012454", "___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": 443, "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": "T000002R012456", "___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": 453, "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": "T000002R012458", "___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": 466, "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": "T000002R012460", "___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": 476, "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": "T000002R012462", "___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": 486, "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": "T000002R012464", "___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": 496, "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": "T000002R012466", "___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": 506, "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": "T000002R012468", "___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": 520, "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": "T000002R012470", "___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": 533, "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": "T000002R012472", "___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": 556, "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": "T000002R012474", "___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": 577, "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": "T000002R012476", "___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": 592, "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": "T000002R012478", "___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": 606, "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": "T000002R012480", "___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": 620, "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": "T000002R012482", "___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.GameObjects.Particles.Zones.EdgeZone[]|Phaser.GameObjects.Particles.Zones.RandomZone[]}\r\n * @since 3.60.0\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 630, "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.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Particles.Zones.EdgeZone", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Particles.Zones.RandomZone", "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": "T000002R012484", "___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": 645, "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": "T000002R012486", "___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": 659, "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": "T000002R012488", "___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.GameObjects.GameObject}\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": 684, "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.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "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": "T000002R012490", "___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": 696, "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": "T000002R012492", "___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": 706, "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": "T000002R012494", "___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": 718, "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": "T000002R012496", "___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": 727, "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": "T000002R012498", "___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": 738, "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": "T000002R012500", "___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": 749, "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": "T000002R012502", "___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": 758, "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": "T000002R012504", "___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": 769, "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": "T000002R012506", "___s": true }, { "comment": "/**\r\n * An internal property used to tell when the emitter is in fast-forwarc 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": 821, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An internal property used to tell when the emitter is in fast-forwarc 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": "T000002R012514", "___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": 831, "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": "T000002R012516", "___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, so 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": 840, "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, so 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": "T000002R012518", "___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": 855, "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": "T000002R012520", "___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": 865, "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": "T000002R012522", "___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": 875, "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": "T000002R012524", "___s": true }, { "comment": "/**\r\n * The tint fill mode used by the Particles in this Emitter.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 884, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The tint fill mode used by the Particles in this Emitter.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "name": "tintFill", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#tintFill", "scope": "instance", "kind": "member", "___id": "T000002R012526", "___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": 921, "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": "T000002R012530", "___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": 1055, "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": "T000002R012553", "___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": 1106, "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": "T000002R012567", "___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.GameObjects.GameObject} target - The Game 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": 1131, "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.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game 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": "T000002R012572", "___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": 1157, "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": "T000002R012579", "___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": 1174, "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": "T000002R012583", "___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": 1218, "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": "T000002R012593", "___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": 1285, "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": "T000002R012611", "___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 * @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": 1326, "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] }", "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": "T000002R012618", "___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 (true).\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1391, "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 (true).", "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": "T000002R012636", "___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": 1410, "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": "T000002R012640", "___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": 1461, "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": "T000002R012647", "___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": 1495, "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": "T000002R012652", "___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": 1519, "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": "T000002R012656", "___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": 1538, "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": "T000002R012660", "___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": 1557, "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": "T000002R012662", "___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": 1577, "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": "T000002R012664", "___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": 1596, "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": "T000002R012666", "___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": 1613, "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": "T000002R012668", "___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": 1630, "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": "T000002R012671", "___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} The Death Zone that was added to this Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1656, "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": [ "Phaser.GameObjects.Particles.Zones.DeathZone" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Zones.DeathZone" } }, "description": "The Death Zone that was added to this Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#addDeathZone", "scope": "instance", "___id": "T000002R012676", "___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": 1720, "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": "T000002R012688", "___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.61.0\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1737, "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.61.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": "T000002R012690", "___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 RandomZoneSource source} can be a Circle, Ellipse, Line, Polygon, Rectangle, or Triangle; or any object with a suitable {@link Phaser.Types.GameObjects.Particles.RandomZoneSourceCallback getRandomPoint} method.\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.EmitZoneObject|Phaser.Types.GameObjects.Particles.EmitZoneObject[]} zone - An Emission Zone configuration object, a RandomZone or EdgeZone instance, or an array of them.\r\n *\r\n * @return {Phaser.GameObjects.Particles.Zones.EdgeZone[]|Phaser.GameObjects.Particles.Zones.RandomZone[]} An array of the Emission Zones that were added to this Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1752, "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 RandomZoneSource source} can be a Circle, Ellipse, Line, Polygon, Rectangle, or Triangle; or any object with a suitable {@link Phaser.Types.GameObjects.Particles.RandomZoneSourceCallback getRandomPoint} method.\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.EmitZoneObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitZoneObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.GameObjects.Particles.EmitZoneObject", "type": "NameExpression" } ] } ] } }, "description": "An Emission Zone configuration object, a RandomZone or EdgeZone instance, or an array of them.", "name": "zone" } ], "returns": [ { "type": { "names": [ "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Particles.Zones.EdgeZone", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Particles.Zones.RandomZone", "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": "T000002R012693", "___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": 1826, "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": "T000002R012710", "___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.61.0\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1845, "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.61.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": "T000002R012713", "___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": 1862, "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": "T000002R012717", "___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": 1909, "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": "T000002R012724", "___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": 1941, "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": "T000002R012729", "___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": 1981, "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": "T000002R012735", "___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": 2012, "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": "T000002R012738", "___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": 2040, "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": "T000002R012741", "___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": 2053, "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": "T000002R012743", "___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": 2068, "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": "T000002R012745", "___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": 2103, "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": "T000002R012751", "___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": 2116, "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": "T000002R012753", "___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": 2129, "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": "T000002R012755", "___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": 2142, "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": "T000002R012757", "___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": 2161, "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": "T000002R012759", "___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": 2193, "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": "T000002R012765", "___s": true }, { "comment": "/**\r\n * Deactivates every particle in this emitter immediately.\r\n *\r\n * This 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": 2225, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Deactivates every particle in this emitter immediately.\r\rThis 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": "T000002R012771", "___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 functions calling context.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2248, "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 functions 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": "T000002R012775", "___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 functions calling context.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2274, "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 functions 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": "T000002R012780", "___s": true }, { "comment": "/**\r\n * Turns {@link Phaser.GameObjects.Particles.ParticleEmitter#on} the emitter 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": 2298, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Turns {@link Phaser.GameObjects.Particles.ParticleEmitter#on} the emitter 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": "T000002R012785", "___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": 2343, "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": "T000002R012790", "___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": 2378, "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": "T000002R012794", "___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": 2393, "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": "T000002R012797", "___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": 2408, "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": "T000002R012800", "___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": 2441, "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": "T000002R012807", "___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": 2479, "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": "T000002R012812", "___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": 2494, "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": "T000002R012814", "___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": 2519, "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": "T000002R012817", "___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.x] - 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": 2551, "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.x", "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": "T000002R012824", "___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.x] - 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": 2577, "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.x", "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": "T000002R012828", "___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.x] - 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": 2595, "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.x", "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": "T000002R012830", "___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": 2676, "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": "T000002R012840", "___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": 2717, "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": "T000002R012847", "___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": 2841, "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": "T000002R012871", "___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": 2877, "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": "T000002R012879", "___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": 2979, "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": "T000002R012900", "___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": 2991, "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": "T000002R012902", "___s": true }, { "comment": "/**\r\n * The y 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#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": 3017, "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 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": "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": "T000002R012906", "___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": 3043, "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": "T000002R012910", "___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": 3067, "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": "T000002R012914", "___s": true }, { "comment": "/**\r\n * The maximum horizontal velocity emitted particles can reach, 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#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": 3091, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The maximum horizontal velocity emitted particles can reach, 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": "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": "T000002R012918", "___s": true }, { "comment": "/**\r\n * The maximum vertical velocity emitted particles can reach, 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#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": 3116, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The maximum vertical velocity emitted particles can reach, 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": "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": "T000002R012922", "___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": 3141, "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": "T000002R012926", "___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": 3171, "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": "T000002R012930", "___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": 3195, "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": "T000002R012934", "___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": 3219, "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": "T000002R012938", "___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": 3243, "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": "T000002R012942", "___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": 3267, "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": "T000002R012946", "___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": 3293, "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": "T000002R012950", "___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": 3319, "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": "T000002R012954", "___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 additive, meaning a tint value of white (0xffffff) will\r\n * effectively reset the tint to nothing.\r\n *\r\n * Modify the `ParticleEmitter.tintFill` property to change between\r\n * an additive and replacement 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": 3345, "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 additive, meaning a tint value of white (0xffffff) will\reffectively reset the tint to nothing.\r\rModify the `ParticleEmitter.tintFill` property to change between\ran additive and replacement 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": "T000002R012958", "___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": 3384, "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": "T000002R012962", "___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 additive, meaning a tint value of white (0xffffff) will\r\n * effectively reset the tint to nothing.\r\n *\r\n * Modify the `ParticleEmitter.tintFill` property to change between\r\n * an additive and replacement tint mode.\r\n *\r\n * The `tint` value will be overriden 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": 3410, "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 additive, meaning a tint value of white (0xffffff) will\reffectively reset the tint to nothing.\r\rModify the `ParticleEmitter.tintFill` property to change between\ran additive and replacement tint mode.\r\rThe `tint` value will be overriden 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": "T000002R012966", "___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": 3446, "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": "T000002R012970", "___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": 3473, "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": "T000002R012974", "___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": 3499, "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": "T000002R012978", "___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": 3526, "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": "T000002R012982", "___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": 3553, "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": "T000002R012986", "___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": 3582, "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": "T000002R012990", "___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": 3609, "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": "T000002R012994", "___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": 3639, "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": "T000002R012998", "___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": 3662, "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": "T000002R013003", "___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": 3685, "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": "T000002R013008", "___s": true }, { "comment": "/**\r\n * The internal elasped 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": 3708, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The internal elasped 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": "T000002R013013", "___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": 3731, "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": "T000002R013018", "___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": 3754, "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": "T000002R013023", "___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": 3777, "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": "T000002R013028", "___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": 3800, "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": "T000002R013033", "___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": 3823, "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": "T000002R013038", "___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": 3846, "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": "T000002R013043", "___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": 3869, "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": "T000002R013048", "___s": true }, { "comment": "/**\r\n * Creates a new Particle Emitter Game Object and returns it.\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\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": "T000002R013113", "___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": "T000002R013121", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * This class provides the structured 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 structured 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": "T000002R013169", "___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#manager\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": "manager", "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#manager", "scope": "instance", "kind": "member", "___id": "T000002R013175", "___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": "T000002R013177", "___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": "T000002R013179", "___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": "T000002R013181", "___s": true }, { "comment": "/**\r\n * The Particle Processor update method should be overriden 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 overriden 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": "T000002R013183", "___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": "T000002R013185", "___s": true }, { "comment": "/**\r\n * @typedef {Phaser.GameObjects.Particles.Zones.DeathZone|Phaser.Types.GameObjects.Particles.ParticleEmitterDeathZoneConfig|Phaser.Geom.Circle|Phaser.Geom.Ellipse|Phaser.Geom.Polygon|Phaser.Geom.Triangle} 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.Geom.Circle", "Phaser.Geom.Ellipse", "Phaser.Geom.Polygon", "Phaser.Geom.Triangle" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Zones.DeathZone" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterDeathZoneConfig" }, { "type": "NameExpression", "name": "Phaser.Geom.Circle" }, { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" }, { "type": "NameExpression", "name": "Phaser.Geom.Polygon" }, { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } ] } }, "since": "3.60.0", "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.DeathZoneObject", "scope": "static", "___id": "T000002R013189", "___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": "T000002R013190", "___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": "T000002R013191", "___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": "T000002R013192", "___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": "T000002R013193", "___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": "T000002R013194", "___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": "T000002R013195", "___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 {(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": [ "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": "T000002R013196", "___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": "T000002R013197", "___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" } }, "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 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": "T000002R013198", "___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.EmitterOpRandomStartEndConfig|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.EmitterOpRandomStartEndConfig", "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.EmitterOpRandomStartEndConfig" }, { "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": "T000002R013199", "___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": "T000002R013200", "___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": "T000002R013201", "___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": "T000002R013202", "___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 */", "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" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.EmitterOpRandomMinMaxConfig", "scope": "static", "___id": "T000002R013203", "___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.EmitterOpRandomStartEndConfig\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 false, this becomes {@link EmitterOpEaseConfig}.\r\n */", "meta": { "filename": "EmitterOpRandomStartEndConfig.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": "EmitterOpRandomStartEndConfig", "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" } }, "description": "If false, this becomes {@link EmitterOpEaseConfig}.", "name": "random" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.EmitterOpRandomStartEndConfig", "scope": "static", "___id": "T000002R013204", "___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": "T000002R013205", "___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.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.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.EmitZoneObject", "scope": "static", "___id": "T000002R013206", "___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": "T000002R013207", "___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": "T000002R013208", "___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": "T000002R013209", "___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": "T000002R013210", "___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": "T000002R013211", "___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": "T000002R013212", "___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": "T000002R013213", "___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": "T000002R013214", "___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.GameObjects.GameObject} [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.EmitZoneObject|Phaser.Types.GameObjects.Particles.EmitZoneObject[]} [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 {object} [followOffset] - Assigns to {@link Phaser.GameObjects.Particles.ParticleEmitter#followOffset}.\r\n * @property {number} [followOffset.x] - x coordinate of the offset.\r\n * @property {number} [followOffset.y] - y coordinate of the offset.\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.\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 {boolean} [tintFill] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#tintFill}.\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.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "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.EmitZoneObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitZoneObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.GameObjects.Particles.EmitZoneObject", "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": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Assigns to {@link Phaser.GameObjects.Particles.ParticleEmitter#followOffset}.", "name": "followOffset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "x coordinate of the offset.", "name": "followOffset.x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "y coordinate of the offset.", "name": "followOffset.y" }, { "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.", "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": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#tintFill}.", "name": "tintFill" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.ParticleEmitterConfig", "scope": "static", "___id": "T000002R013215", "___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": "T000002R013216", "___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": "T000002R013217", "___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": "T000002R013218", "___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": "T000002R013219", "___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": "T000002R013220", "___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": "T000002R013221", "___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": "T000002R013222", "___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": "T000002R013223", "___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": "T000002R013224", "___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": "T000002R013226", "___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": "T000002R013229", "___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": "T000002R013231", "___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 Zones.\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 Zones.", "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": "T000002R013233", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A zone that places particles on a shape's edges.\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": "A zone that places particles on a shape's edges.", "kind": "class", "name": "EdgeZone", "memberof": "Phaser.GameObjects.Particles.Zones", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EdgeZoneSource" ], "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" } }, "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": "T000002R013239", "___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": 35, "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": "T000002R013245", "___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.Geom.Point[]}\r\n * @default []\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EdgeZone.js", "lineno": 44, "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.Geom.Point", "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": "T000002R013247", "___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": 54, "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": "T000002R013249", "___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": 63, "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": "T000002R013251", "___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": 72, "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": "T000002R013253", "___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": 81, "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": "T000002R013255", "___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": 91, "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": "T000002R013257", "___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": 124, "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": "T000002R013263", "___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": 145, "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": "T000002R013265", "___s": true }, { "comment": "/**\r\n * Change the source of the EdgeZone.\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": 185, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "description": "Change the source of the EdgeZone.", "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": "T000002R013273", "___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.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": 202, "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.EdgeZone", "longname": "Phaser.GameObjects.Particles.Zones.EdgeZone#getPoint", "scope": "instance", "___id": "T000002R013276", "___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": "T000002R013288", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A zone that places particles randomly within a shapes area.\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 zone that places particles randomly within a shapes area.", "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": "T000002R013295", "___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": 27, "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": "T000002R013298", "___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": 46, "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": "T000002R013302", "___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": 65, "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": "T000002R013304", "___s": true }, { "comment": "/**\n * @classdesc\n * A PathFollower Game Object.\n *\n * A PathFollower is a Sprite Game Object with some extra helpers to allow it to follow a Path automatically.\n *\n * Anything you can do with a standard Sprite can be done with this PathFollower, such as animate it, tint it,\n * scale it and so on.\n *\n * PathFollowers are bound to a single Path at any one time and can traverse the length of the Path, from start\n * to finish, forwards or backwards, or from any given point on the Path to its end. They can optionally rotate\n * to face the direction of the path, be offset from the path coordinates or rotate independently of the Path.\n *\n * @class PathFollower\n * @extends Phaser.GameObjects.Sprite\n * @memberof Phaser.GameObjects\n * @constructor\n * @since 3.0.0\n *\n * @extends Phaser.GameObjects.Components.PathFollower\n *\n * @param {Phaser.Scene} scene - The Scene to which this PathFollower belongs.\n * @param {Phaser.Curves.Path} path - The Path this PathFollower is following. It can only follow one Path at a time.\n * @param {number} x - The horizontal position of this Game Object in the world.\n * @param {number} y - The vertical position of this Game Object in the world.\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.\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.\n */", "meta": { "filename": "PathFollower.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pathfollower", "code": {} }, "classdesc": "A PathFollower Game Object.\n\nA PathFollower is a Sprite Game Object with some extra helpers to allow it to follow a Path automatically.\n\nAnything you can do with a standard Sprite can be done with this PathFollower, such as animate it, tint it,\nscale it and so on.\n\nPathFollowers are bound to a single Path at any one time and can traverse the length of the Path, from start\nto finish, forwards or backwards, or from any given point on the Path to its end. They can optionally rotate\nto face the direction of the path, be offset from the path coordinates or rotate independently of the Path.", "kind": "class", "name": "PathFollower", "augments": [ "Phaser.GameObjects.Sprite", "Phaser.GameObjects.Components.PathFollower" ], "memberof": "Phaser.GameObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "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": "T000002R013313", "___s": true }, { "comment": "/**\n * Internal update handler that advances this PathFollower along the path.\n *\n * Called automatically by the Scene step, should not typically be called directly.\n *\n * @method Phaser.GameObjects.PathFollower#preUpdate\n * @protected\n * @since 3.0.0\n *\n * @param {number} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\n */", "meta": { "filename": "PathFollower.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pathfollower", "code": {} }, "description": "Internal update handler that advances this PathFollower along the path.\n\nCalled automatically by the Scene step, should not typically be called directly.", "kind": "function", "name": "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": "T000002R013319", "___s": true }, { "comment": "/**\n * Creates a new PathFollower Game Object and adds it to the Scene.\n *\n * Note: This method will only be available if the PathFollower Game Object has been built into Phaser.\n *\n * @method Phaser.GameObjects.GameObjectFactory#follower\n * @since 3.0.0\n *\n * @param {Phaser.Curves.Path} path - The Path this PathFollower is connected to.\n * @param {number} x - The horizontal position of this Game Object in the world.\n * @param {number} y - The vertical position of this Game Object in the world.\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.\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.\n *\n * @return {Phaser.GameObjects.PathFollower} The Game Object that was created.\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.\n\nNote: This method will only be available if the PathFollower Game Object has been built into Phaser.", "kind": "function", "name": "follower", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Curves.Path" ], "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": "T000002R013324", "___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": "T000002R013326", "___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": "T000002R013327", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Plane Game Object.\r\n *\r\n * The Plane Game Object is a helper class that takes the Mesh Game Object and extends it,\r\n * allowing for fast and easy creation of Planes. A Plane is a one-sided grid of cells,\r\n * where you specify the number of cells in each dimension. The Plane can have a texture\r\n * that is either repeated (tiled) across each cell, or applied to the full Plane.\r\n *\r\n * The Plane can then be manipulated in 3D space, with rotation across all 3 axis.\r\n *\r\n * This allows you to create effects not possible with regular Sprites, such as perspective\r\n * distortion. You can also adjust the vertices on a per-vertex basis. Plane data becomes\r\n * part of the WebGL batch, just like standard Sprites, so doesn't introduce any additional\r\n * shader overhead. Because the Plane just generates vertices into the WebGL batch, like any\r\n * other Sprite, you can use all of the common Game Object components on a Plane too,\r\n * such as a custom pipeline, mask, blend mode or texture.\r\n *\r\n * You can use the `uvScroll` and `uvScale` methods to adjust the placement and scaling\r\n * of the texture if this Plane is using a single texture, and not a frame from a texture\r\n * atlas or sprite sheet.\r\n *\r\n * The Plane Game Object also has the Animation component, allowing you to play animations\r\n * across the Plane just as you would with a Sprite.\r\n *\r\n * Note that the Plane object is WebGL only and does not have a Canvas counterpart.\r\n *\r\n * The Plane origin is always 0.5 x 0.5 and cannot be changed.\r\n *\r\n * @class Plane\r\n * @extends Phaser.GameObjects.Mesh\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Plane belongs. A Plane can only belong to one Scene at a time.\r\n * @param {number} [x] - The horizontal position of this Plane in the world.\r\n * @param {number} [y] - The vertical position of this Plane in the world.\r\n * @param {string|Phaser.Textures.Texture} [texture] - The key, or instance of the Texture this Plane will use to render with, as stored in the Texture Manager.\r\n * @param {string|number} [frame] - An optional frame from the Texture this Plane is rendering with.\r\n * @param {number} [width=8] - The width of this Plane, in cells, not pixels.\r\n * @param {number} [height=8] - The height of this Plane, in cells, not pixels.\r\n * @param {boolean} [tile=false] - Is the texture tiled? I.e. repeated across each cell.\r\n */", "meta": { "filename": "Plane.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "code": {} }, "classdesc": "A Plane Game Object.\r\rThe Plane Game Object is a helper class that takes the Mesh Game Object and extends it,\rallowing for fast and easy creation of Planes. A Plane is a one-sided grid of cells,\rwhere you specify the number of cells in each dimension. The Plane can have a texture\rthat is either repeated (tiled) across each cell, or applied to the full Plane.\r\rThe Plane can then be manipulated in 3D space, with rotation across all 3 axis.\r\rThis allows you to create effects not possible with regular Sprites, such as perspective\rdistortion. You can also adjust the vertices on a per-vertex basis. Plane data becomes\rpart of the WebGL batch, just like standard Sprites, so doesn't introduce any additional\rshader overhead. Because the Plane just generates vertices into the WebGL batch, like any\rother Sprite, you can use all of the common Game Object components on a Plane too,\rsuch as a custom pipeline, mask, blend mode or texture.\r\rYou can use the `uvScroll` and `uvScale` methods to adjust the placement and scaling\rof the texture if this Plane is using a single texture, and not a frame from a texture\ratlas or sprite sheet.\r\rThe Plane Game Object also has the Animation component, allowing you to play animations\racross the Plane just as you would with a Sprite.\r\rNote that the Plane object is WebGL only and does not have a Canvas counterpart.\r\rThe Plane origin is always 0.5 x 0.5 and cannot be changed.", "kind": "class", "name": "Plane", "augments": [ "Phaser.GameObjects.Mesh" ], "memberof": "Phaser.GameObjects", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Plane belongs. A Plane 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 Plane in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The vertical position of this Plane 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 Plane 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 Plane is rendering with.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 8, "description": "The width of this Plane, in cells, not pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 8, "description": "The height of this Plane, in cells, not pixels.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is the texture tiled? I.e. repeated across each cell.", "name": "tile" } ], "scope": "static", "longname": "Phaser.GameObjects.Plane", "___id": "T000002R013334", "___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.Plane#anims\r\n * @type {Phaser.Animations.AnimationState}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Plane.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "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.60.0", "memberof": "Phaser.GameObjects.Plane", "longname": "Phaser.GameObjects.Plane#anims", "scope": "instance", "kind": "member", "___id": "T000002R013340", "___s": true }, { "comment": "/**\r\n * The width of this Plane in cells, not pixels.\r\n *\r\n * This value is read-only. To adjust it, see the `setGridSize` method.\r\n *\r\n * @name Phaser.GameObjects.Plane#gridWidth\r\n * @type {number}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Plane.js", "lineno": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "code": {} }, "description": "The width of this Plane in cells, not pixels.\r\rThis value is read-only. To adjust it, see the `setGridSize` method.", "name": "gridWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "longname": "Phaser.GameObjects.Plane#gridWidth", "scope": "instance", "kind": "member", "___id": "T000002R013342", "___s": true }, { "comment": "/**\r\n * The height of this Plane in cells, not pixels.\r\n *\r\n * This value is read-only. To adjust it, see the `setGridSize` method.\r\n *\r\n * @name Phaser.GameObjects.Plane#gridHeight\r\n * @type {number}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Plane.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "code": {} }, "description": "The height of this Plane in cells, not pixels.\r\rThis value is read-only. To adjust it, see the `setGridSize` method.", "name": "gridHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "longname": "Phaser.GameObjects.Plane#gridHeight", "scope": "instance", "kind": "member", "___id": "T000002R013344", "___s": true }, { "comment": "/**\r\n * Is the texture of this Plane tiled across all cells, or not?\r\n *\r\n * This value is read-only. To adjust it, see the `setGridSize` method.\r\n *\r\n * @name Phaser.GameObjects.Plane#isTiled\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Plane.js", "lineno": 109, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "code": {} }, "description": "Is the texture of this Plane tiled across all cells, or not?\r\rThis value is read-only. To adjust it, see the `setGridSize` method.", "name": "isTiled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "longname": "Phaser.GameObjects.Plane#isTiled", "scope": "instance", "kind": "member", "___id": "T000002R013346", "___s": true }, { "comment": "/** \r\n * Do not change this value. It has no effect other than to break things.\r\n *\r\n * @name Phaser.GameObjects.Plane#originX\r\n * @type {number}\r\n * @readonly\r\n * @override\r\n * @since 3.61.0\r\n */", "meta": { "filename": "Plane.js", "lineno": 139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "code": {} }, "description": "Do 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.61.0", "memberof": "Phaser.GameObjects.Plane", "longname": "Phaser.GameObjects.Plane#originX", "scope": "instance", "kind": "member", "___id": "T000002R013351", "___s": true }, { "comment": "/** \r\n * Do not change this value. It has no effect other than to break things.\r\n *\r\n * @name Phaser.GameObjects.Plane#originY\r\n * @type {number}\r\n * @readonly\r\n * @override\r\n * @since 3.61.0\r\n */", "meta": { "filename": "Plane.js", "lineno": 157, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "code": {} }, "description": "Do 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.61.0", "memberof": "Phaser.GameObjects.Plane", "longname": "Phaser.GameObjects.Plane#originY", "scope": "instance", "kind": "member", "___id": "T000002R013354", "___s": true }, { "comment": "/**\r\n * Modifies the layout of this Plane by adjusting the grid dimensions to the\r\n * given width and height. The values are given in cells, not pixels.\r\n *\r\n * The `tile` parameter allows you to control if the texture is tiled, or\r\n * applied across the entire Plane? A tiled texture will repeat with one\r\n * iteration per cell. A non-tiled texture will be applied across the whole\r\n * Plane.\r\n *\r\n * Note that if this Plane is using a single texture, not from a texture atlas\r\n * or sprite sheet, then you can use the `Plane.uvScale` method to have much\r\n * more fine-grained control over the texture tiling.\r\n *\r\n * @method Phaser.GameObjects.Plane#preDestroy\r\n * @since 3.60.0\r\n *\r\n * @param {number} [width=8] - The width of this Plane, in cells, not pixels.\r\n * @param {number} [height=8] - The height of this Plane, in cells, not pixels.\r\n * @param {boolean} [tile=false] - Is the texture tiled? I.e. repeated across each cell.\r\n */", "meta": { "filename": "Plane.js", "lineno": 175, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "code": {} }, "description": "Modifies the layout of this Plane by adjusting the grid dimensions to the\rgiven width and height. The values are given in cells, not pixels.\r\rThe `tile` parameter allows you to control if the texture is tiled, or\rapplied across the entire Plane? A tiled texture will repeat with one\riteration per cell. A non-tiled texture will be applied across the whole\rPlane.\r\rNote that if this Plane is using a single texture, not from a texture atlas\ror sprite sheet, then you can use the `Plane.uvScale` method to have much\rmore fine-grained control over the texture tiling.", "kind": "function", "name": "preDestroy", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 8, "description": "The width of this Plane, in cells, not pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 8, "description": "The height of this Plane, in cells, not pixels.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is the texture tiled? I.e. repeated across each cell.", "name": "tile" } ], "memberof": "Phaser.GameObjects.Plane", "longname": "Phaser.GameObjects.Plane#preDestroy", "scope": "instance", "overrides": "Phaser.GameObjects.Mesh#preDestroy", "___id": "T000002R013357", "___s": true }, { "comment": "/**\r\n * Sets the height of this Plane to match the given value, in pixels.\r\n *\r\n * This adjusts the `Plane.viewPosition.z` value to achieve this.\r\n *\r\n * If no `value` parameter is given, it will set the view height to match\r\n * that of the current texture frame the Plane is using.\r\n *\r\n * @method Phaser.GameObjects.Plane#setViewHeight\r\n * @since 3.60.0\r\n *\r\n * @param {number} [value] - The height, in pixels, to set this Plane view height to.\r\n */", "meta": { "filename": "Plane.js", "lineno": 335, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "code": {} }, "description": "Sets the height of this Plane to match the given value, in pixels.\r\rThis adjusts the `Plane.viewPosition.z` value to achieve this.\r\rIf no `value` parameter is given, it will set the view height to match\rthat of the current texture frame the Plane is using.", "kind": "function", "name": "setViewHeight", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height, in pixels, to set this Plane view height to.", "name": "value" } ], "memberof": "Phaser.GameObjects.Plane", "longname": "Phaser.GameObjects.Plane#setViewHeight", "scope": "instance", "___id": "T000002R013406", "___s": true }, { "comment": "/**\r\n * Creates a checkerboard style texture, based on the given colors and alpha\r\n * values and applies it to this Plane, replacing any current texture it may\r\n * have.\r\n *\r\n * The colors are used in an alternating pattern, like a chess board.\r\n *\r\n * Calling this method generates a brand new 16x16 pixel WebGLTexture internally\r\n * and applies it to this Plane. While quite fast to do, you should still be\r\n * mindful of calling this method either extensively, or in tight parts of\r\n * your game.\r\n *\r\n * @method Phaser.GameObjects.Plane#createCheckerboard\r\n * @since 3.60.0\r\n *\r\n * @param {number} [color1=0xffffff] - The odd cell color, specified as a hex value.\r\n * @param {number} [color2=0x0000ff] - The even cell color, specified as a hex value.\r\n * @param {number} [alpha1=255] - The odd cell alpha value, specified as a number between 0 and 255.\r\n * @param {number} [alpha2=255] - The even cell alpha value, specified as a number between 0 and 255.\r\n * @param {number} [height=128] - The view height of the Plane after creation, in pixels.\r\n */", "meta": { "filename": "Plane.js", "lineno": 359, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "code": {} }, "description": "Creates a checkerboard style texture, based on the given colors and alpha\rvalues and applies it to this Plane, replacing any current texture it may\rhave.\r\rThe colors are used in an alternating pattern, like a chess board.\r\rCalling this method generates a brand new 16x16 pixel WebGLTexture internally\rand applies it to this Plane. While quite fast to do, you should still be\rmindful of calling this method either extensively, or in tight parts of\ryour game.", "kind": "function", "name": "createCheckerboard", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The odd cell color, specified as a hex value.", "name": "color1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x0000ff", "description": "The even cell color, specified as a hex value.", "name": "color2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 255, "description": "The odd cell alpha value, specified as a number between 0 and 255.", "name": "alpha1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 255, "description": "The even cell alpha value, specified as a number between 0 and 255.", "name": "alpha2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The view height of the Plane after creation, in pixels.", "name": "height" } ], "memberof": "Phaser.GameObjects.Plane", "longname": "Phaser.GameObjects.Plane#createCheckerboard", "scope": "instance", "___id": "T000002R013412", "___s": true }, { "comment": "/**\r\n * If this Plane has a Checkerboard Texture, this method will destroy it\r\n * and reset the internal flag for it.\r\n *\r\n * @method Phaser.GameObjects.Plane#removeCheckerboard\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Plane.js", "lineno": 445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "code": {} }, "description": "If this Plane has a Checkerboard Texture, this method will destroy it\rand reset the internal flag for it.", "kind": "function", "name": "removeCheckerboard", "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "longname": "Phaser.GameObjects.Plane#removeCheckerboard", "scope": "instance", "___id": "T000002R013432", "___s": true }, { "comment": "/**\r\n * Start playing the given animation on this Plane.\r\n *\r\n * Animations in Phaser can either belong to the global Animation Manager, or specifically to this Plane.\r\n *\r\n * The benefit of a global animation is that multiple Game Objects 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 animating Game Object.\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 Plane, and this Plane 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 Plane.\r\n *\r\n * With the animation created, either globally or locally, you can now play it on this Plane:\r\n *\r\n * ```javascript\r\n * const plane = this.add.plane(...);\r\n * plane.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 * const plane = this.add.plane(...);\r\n * plane.play({ key: 'run', frameRate: 24 });\r\n * ```\r\n *\r\n * When playing an animation on a Plane it will first check to see if it can find a matching key\r\n * locally within the Plane. 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 Plane 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.Plane#play\r\n * @fires Phaser.Animations.Events#ANIMATION_START\r\n * @since 3.60.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": "Plane.js", "lineno": 462, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "code": {} }, "description": "Start playing the given animation on this Plane.\r\rAnimations in Phaser can either belong to the global Animation Manager, or specifically to this Plane.\r\rThe benefit of a global animation is that multiple Game Objects can all play the same animation, without\rhaving to duplicate the data. You can just create it once and then play it on any animating Game Object.\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 Plane, and this Plane 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 Plane.\r\rWith the animation created, either globally or locally, you can now play it on this Plane:\r\r```javascript\rconst plane = this.add.plane(...);\rplane.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\rconst plane = this.add.plane(...);\rplane.play({ key: 'run', frameRate: 24 });\r```\r\rWhen playing an animation on a Plane it will first check to see if it can find a matching key\rlocally within the Plane. 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 Plane 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.60.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.Plane", "longname": "Phaser.GameObjects.Plane#play", "scope": "instance", "___id": "T000002R013435", "___s": true }, { "comment": "/**\r\n * Start playing the given animation on this Plane, in reverse.\r\n *\r\n * Animations in Phaser can either belong to the global Animation Manager, or specifically to a Game Object.\r\n *\r\n * The benefit of a global animation is that multiple Game Objects 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 animating Game Object.\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 Game Object, and this Game Object 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 Game Object.\r\n *\r\n * With the animation created, either globally or locally, you can now play it on this Game Object:\r\n *\r\n * ```javascript\r\n * const plane = this.add.plane(...);\r\n * plane.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 * const plane = this.add.plane(...);\r\n * plane.playReverse({ key: 'run', frameRate: 24 });\r\n * ```\r\n *\r\n * When playing an animation on a Game Object it will first check to see if it can find a matching key\r\n * locally within the Game Object. 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 Game Object 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.Plane#playReverse\r\n * @fires Phaser.Animations.Events#ANIMATION_START\r\n * @since 3.60.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": "Plane.js", "lineno": 529, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "code": {} }, "description": "Start playing the given animation on this Plane, in reverse.\r\rAnimations in Phaser can either belong to the global Animation Manager, or specifically to a Game Object.\r\rThe benefit of a global animation is that multiple Game Objects can all play the same animation, without\rhaving to duplicate the data. You can just create it once and then play it on any animating Game Object.\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 Game Object, and this Game Object 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 Game Object.\r\rWith the animation created, either globally or locally, you can now play it on this Game Object:\r\r```javascript\rconst plane = this.add.plane(...);\rplane.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\rconst plane = this.add.plane(...);\rplane.playReverse({ key: 'run', frameRate: 24 });\r```\r\rWhen playing an animation on a Game Object it will first check to see if it can find a matching key\rlocally within the Game Object. 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 Game Object 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.60.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.Plane", "longname": "Phaser.GameObjects.Plane#playReverse", "scope": "instance", "___id": "T000002R013437", "___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 Game Object it will first check to see if it can find a matching key\r\n * locally within the Game Object. 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.Plane#playAfterDelay\r\n * @fires Phaser.Animations.Events#ANIMATION_START\r\n * @since 3.60.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": "Plane.js", "lineno": 596, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "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 Game Object it will first check to see if it can find a matching key\rlocally within the Game Object. 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": "playAfterDelay", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.60.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.Plane", "longname": "Phaser.GameObjects.Plane#playAfterDelay", "scope": "instance", "___id": "T000002R013439", "___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 Game Object it will first check to see if it can find a matching key\r\n * locally within the Game Object. 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.Plane#playAfterRepeat\r\n * @fires Phaser.Animations.Events#ANIMATION_START\r\n * @since 3.60.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": "Plane.js", "lineno": 624, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "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 Game Object it will first check to see if it can find a matching key\rlocally within the Game Object. 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.60.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.Plane", "longname": "Phaser.GameObjects.Plane#playAfterRepeat", "scope": "instance", "___id": "T000002R013441", "___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.Plane#stop\r\n * @fires Phaser.Animations.Events#ANIMATION_STOP\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Plane.js", "lineno": 651, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "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.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Plane", "longname": "Phaser.GameObjects.Plane#stop", "scope": "instance", "___id": "T000002R013443", "___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.Plane#stopAfterDelay\r\n * @fires Phaser.Animations.Events#ANIMATION_STOP\r\n * @since 3.60.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": "Plane.js", "lineno": 669, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "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.60.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.Plane", "longname": "Phaser.GameObjects.Plane#stopAfterDelay", "scope": "instance", "___id": "T000002R013445", "___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.Plane#stopAfterRepeat\r\n * @fires Phaser.Animations.Events#ANIMATION_STOP\r\n * @since 3.60.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": "Plane.js", "lineno": 692, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "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.60.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.Plane", "longname": "Phaser.GameObjects.Plane#stopAfterRepeat", "scope": "instance", "___id": "T000002R013447", "___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.Plane#stopOnFrame\r\n * @fires Phaser.Animations.Events#ANIMATION_STOP\r\n * @since 3.60.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": "Plane.js", "lineno": 715, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "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.60.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.Plane", "longname": "Phaser.GameObjects.Plane#stopOnFrame", "scope": "instance", "___id": "T000002R013449", "___s": true }, { "comment": "/**\r\n * Runs the preUpdate for this Plane, which will check its Animation State,\r\n * if one is playing, and refresh view / model matrices, if updated.\r\n *\r\n * @method Phaser.GameObjects.Plane#preUpdate\r\n * @protected\r\n * @since 3.60.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": "Plane.js", "lineno": 739, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "code": {} }, "description": "Runs the preUpdate for this Plane, which will check its Animation State,\rif one is playing, and refresh view / model matrices, if updated.", "kind": "function", "name": "preUpdate", "access": "protected", "since": "3.60.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.Plane", "longname": "Phaser.GameObjects.Plane#preUpdate", "scope": "instance", "overrides": "Phaser.GameObjects.Mesh#preUpdate", "___id": "T000002R013451", "___s": true }, { "comment": "/**\r\n * Creates a new Plane Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Plane Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#plane\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Plane.PlaneConfig} 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.Plane} The Game Object that was created.\r\n */", "meta": { "filename": "PlaneCreator.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "code": {} }, "description": "Creates a new Plane Game Object and returns it.\r\rNote: This method will only be available if the Plane Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "plane", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Plane.PlaneConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Plane.PlaneConfig" } }, "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.Plane" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Plane" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#plane", "scope": "instance", "___id": "T000002R013465", "___s": true }, { "comment": "/**\r\n * Creates a new Plane Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Plane Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#plane\r\n * @since 3.60.0\r\n *\r\n * @param {number} [x] - The horizontal position of this Plane in the world.\r\n * @param {number} [y] - The vertical position of this Plane in the world.\r\n * @param {string|Phaser.Textures.Texture} [texture] - The key, or instance of the Texture this Plane will use to render with, as stored in the Texture Manager.\r\n * @param {string|number} [frame] - An optional frame from the Texture this Plane is rendering with.\r\n * @param {number} [width=8] - The width of this Plane, in cells, not pixels.\r\n * @param {number} [height=8] - The height of this Plane, in cells, not pixels.\r\n * @param {boolean} [tile=false] - Is the texture tiled? I.e. repeated across each cell.\r\n *\r\n * @return {Phaser.GameObjects.Plane} The Plane Game Object that was created.\r\n */", "meta": { "filename": "PlaneFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "code": {} }, "description": "Creates a new Plane Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Plane Game Object has been built into Phaser.", "kind": "function", "name": "plane", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position of this Plane in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The vertical position of this Plane 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 Plane 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 Plane is rendering with.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 8, "description": "The width of this Plane, in cells, not pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 8, "description": "The height of this Plane, in cells, not pixels.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is the texture tiled? I.e. repeated across each cell.", "name": "tile" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Plane" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Plane" } }, "description": "The Plane Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#plane", "scope": "instance", "___id": "T000002R013482", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.Plane\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane\\typedefs", "code": {} }, "kind": "namespace", "name": "Plane", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Plane", "scope": "static", "___id": "T000002R013483", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Plane.PlaneCheckerboardConfig\r\n * @since 3.60.0\r\n *\r\n * @property {number} [color1=0xffffff] - The odd cell color, specified as a hex value.\r\n * @property {number} [color2=0x0000ff] - The even cell color, specified as a hex value.\r\n * @property {number} [alpha1=255] - The odd cell alpha value, specified as a number between 0 and 255.\r\n * @property {number} [alpha2=255] - The even cell alpha value, specified as a number between 0 and 255.\r\n * @property {number} [height=128] - The view height of the Plane after creation, in pixels.\r\n */", "meta": { "filename": "PlaneCheckerboardConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane\\typedefs", "code": {} }, "kind": "typedef", "name": "PlaneCheckerboardConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The odd cell color, specified as a hex value.", "name": "color1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x0000ff", "description": "The even cell color, specified as a hex value.", "name": "color2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 255, "description": "The odd cell alpha value, specified as a number between 0 and 255.", "name": "alpha1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 255, "description": "The even cell alpha value, specified as a number between 0 and 255.", "name": "alpha2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The view height of the Plane after creation, in pixels.", "name": "height" } ], "memberof": "Phaser.Types.GameObjects.Plane", "longname": "Phaser.Types.GameObjects.Plane.PlaneCheckerboardConfig", "scope": "static", "___id": "T000002R013484", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Plane.PlaneConfig\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=8] - The width of this Plane, in cells, not pixels.\r\n * @property {number} [height=8] - The height of this Plane, in cells, not pixels.\r\n * @property {boolean} [tile=false] - Is the texture tiled? I.e. repeated across each cell.\r\n * @property {Phaser.Types.GameObjects.Plane.PlaneCheckerboardConfig} [checkerboard] - Plane checkerboard configuration object.\r\n */", "meta": { "filename": "PlaneConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane\\typedefs", "code": {} }, "kind": "typedef", "name": "PlaneConfig", "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": 8, "description": "The width of this Plane, in cells, not pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 8, "description": "The height of this Plane, in cells, not pixels.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is the texture tiled? I.e. repeated across each cell.", "name": "tile" }, { "type": { "names": [ "Phaser.Types.GameObjects.Plane.PlaneCheckerboardConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Plane.PlaneCheckerboardConfig" } }, "optional": true, "description": "Plane checkerboard configuration object.", "name": "checkerboard" } ], "memberof": "Phaser.Types.GameObjects.Plane", "longname": "Phaser.Types.GameObjects.Plane.PlaneConfig", "scope": "static", "___id": "T000002R013485", "___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 calcuations. 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 dislay 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.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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 calcuations. 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 dislay 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.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "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": "T000002R013492", "___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": 98, "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": "T000002R013501", "___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": 109, "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": "T000002R013503", "___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": 120, "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": "T000002R013505", "___s": true }, { "comment": "/**\r\n * The radius of the Point Light.\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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pointlight", "code": {} }, "description": "The radius of the Point Light.", "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": "T000002R013510", "___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.\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.", "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": "T000002R013530", "___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 calcuations. 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 dislay 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 calcuations. 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 dislay 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": "T000002R013540", "___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 * @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 */", "meta": { "filename": "RenderTexture.js", "lineno": 11, "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.", "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" } ], "scope": "static", "longname": "Phaser.GameObjects.RenderTexture", "___id": "T000002R013573", "___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": 79, "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": "T000002R013583", "___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.\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.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": 106, "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.\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.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#setSize", "scope": "instance", "overrides": "Phaser.GameObjects.Image#setSize", "___id": "T000002R013587", "___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 * 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 *\r\n * @return {this} This Render Texture.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 145, "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\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" } ], "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": "T000002R013594", "___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 * @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": 170, "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.", "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": "T000002R013596", "___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": 219, "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": "T000002R013601", "___s": true }, { "comment": "/**\r\n * Fully clears this Render Texture, erasing everything from it and resetting it back to\r\n * a blank, transparent, texture.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#clear\r\n * @since 3.2.0\r\n *\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 246, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Fully clears this Render Texture, erasing everything from it and resetting it back to\ra blank, transparent, texture.", "kind": "function", "name": "clear", "since": "3.2.0", "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": "T000002R013603", "___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 * @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": 262, "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.", "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": "T000002R013605", "___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 * 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: You cannot erase a Render Texture from itself.\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.\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 *\r\n * Calling this method causes the WebGL batch to flush, so it can write the texture\r\n * data to the framebuffer being used internally. The batch is flushed at the end,\r\n * after the entries have been iterated. So if you've a bunch of objects to draw,\r\n * try and pass them in an array in one single call, rather than making lots of\r\n * separate calls.\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": 291, "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\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: You cannot erase a Render Texture from itself.\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.\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.\r\rCalling this method causes the WebGL batch to flush, so it can write the texture\rdata to the framebuffer being used internally. The batch is flushed at the end,\rafter the entries have been iterated. So if you've a bunch of objects to draw,\rtry and pass them in an array in one single call, rather than making lots of\rseparate calls.", "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": "T000002R013607", "___s": true }, { "comment": "/**\r\n * Draws the given object, or an array of objects, to this Render Texture.\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: For Game Objects that have Post FX Pipelines, the pipeline _cannot_ be\r\n * used when drawn to this texture.\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 *\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 * Calling this method causes the WebGL batch to flush, so it can write the texture\r\n * data to the framebuffer being used internally. The batch is flushed at the end,\r\n * after the entries have been iterated. So if you've a bunch of objects to draw,\r\n * try and pass them in an array in one single call, rather than making lots of\r\n * separate calls.\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": 345, "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.\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: For Game Objects that have Post FX Pipelines, the pipeline _cannot_ be\rused when drawn to this texture.\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.\r\rThe `alpha` and `tint` values are only used by Texture Frames.\rGame Objects use their own alpha and tint values when being drawn.\r\rCalling this method causes the WebGL batch to flush, so it can write the texture\rdata to the framebuffer being used internally. The batch is flushed at the end,\rafter the entries have been iterated. So if you've a bunch of objects to draw,\rtry and pass them in an array in one single call, rather than making lots of\rseparate calls.", "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": "T000002R013609", "___s": true }, { "comment": "/**\r\n * Draws the Texture Frame to the Render Texture at the given position.\r\n *\r\n * Textures are referenced by their string-based keys, as stored in the Texture Manager.\r\n *\r\n * ```javascript\r\n * var rt = this.add.renderTexture(0, 0, 800, 600);\r\n * rt.drawFrame(key, frame);\r\n * ```\r\n *\r\n * You can optionally provide a position, alpha and tint value to apply to the frame\r\n * before it is drawn.\r\n *\r\n * Calling this method will cause a batch flush, so if you've got a stack of things to draw\r\n * in a tight loop, try using the `draw` method instead.\r\n *\r\n * If you need to draw a Sprite to this Render Texture, use the `draw` method instead.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#drawFrame\r\n * @since 3.12.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 {number} [alpha=1] - The alpha value. Only used when drawing Texture Frames to this texture.\r\n * @param {number} [tint=0xffffff] - The tint color value. Only used when drawing Texture Frames to this texture. WebGL only.\r\n *\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 407, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Draws the Texture Frame to the Render Texture at the given position.\r\rTextures are referenced by their string-based keys, as stored in the Texture Manager.\r\r```javascript\rvar rt = this.add.renderTexture(0, 0, 800, 600);\rrt.drawFrame(key, frame);\r```\r\rYou can optionally provide a position, alpha and tint value to apply to the frame\rbefore it is drawn.\r\rCalling this method will cause a batch flush, so if you've got a stack of things to draw\rin a tight loop, try using the `draw` method instead.\r\rIf you need to draw a Sprite to this Render Texture, use the `draw` method instead.", "kind": "function", "name": "drawFrame", "since": "3.12.0", "params": [ { "type": { "names": [ "string" ], "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The alpha value. Only used when drawing Texture Frames to this texture.", "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. 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#drawFrame", "scope": "instance", "___id": "T000002R013611", "___s": true }, { "comment": "/**\r\n * Takes the given Texture Frame and draws it to this Render Texture as a fill pattern,\r\n * i.e. in a grid-layout based on the frame dimensions.\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 * Calling this method will cause a batch flush by default. Use the `skipBatch` argument\r\n * to disable this if this call is part of a larger batch draw.\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 {number} [alpha=1] - The alpha to use. Defaults to 1, no alpha.\r\n * @param {number} [tint=0xffffff] - WebGL only. The tint color to use. Leave as undefined, or 0xffffff to have no tint.\r\n * @param {boolean} [skipBatch=false] - Skip beginning and ending a batch with this call. Use if this is part of a bigger batched draw.\r\n *\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Takes the given Texture Frame and draws it to this Render Texture as a fill pattern,\ri.e. in a grid-layout based on the frame dimensions.\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\rCalling this method will cause a batch flush by default. Use the `skipBatch` argument\rto disable this if this call is part of a larger batch draw.", "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The alpha to use. Defaults to 1, no alpha.", "name": "alpha" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "WebGL only. The tint color to use. Leave as undefined, or 0xffffff to have no tint.", "name": "tint" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip beginning and ending a batch with this call. Use if this is part of a bigger batched draw.", "name": "skipBatch" } ], "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": "T000002R013613", "___s": true }, { "comment": "/**\r\n * Use this method if you need to batch draw a large number of Game Objects to\r\n * this Render Texture in a single pass, or on a frequent basis. This is especially\r\n * useful under WebGL, however, if your game is using Canvas only, it will not make\r\n * any speed difference in that situation.\r\n *\r\n * This method starts the beginning of a batched draw, unless one is already open.\r\n *\r\n * Batched drawing is faster than calling `draw` in loop, but you must be careful\r\n * to manage the flow of code and remember to call `endDraw()` when you're finished.\r\n *\r\n * If you don't need to draw large numbers of objects it's much safer and easier\r\n * to use the `draw` method instead.\r\n *\r\n * The flow should be:\r\n *\r\n * ```javascript\r\n * // Call once:\r\n * RenderTexture.beginDraw();\r\n *\r\n * // repeat n times:\r\n * RenderTexture.batchDraw();\r\n * // or\r\n * RenderTexture.batchDrawFrame();\r\n *\r\n * // Call once:\r\n * RenderTexture.endDraw();\r\n * ```\r\n *\r\n * Do not call any methods other than `batchDraw`, `batchDrawFrame`, or `endDraw` once you\r\n * have started a batch. Also, be very careful not to destroy this Render Texture while the\r\n * batch is still open. Doing so will cause a run-time error in the WebGL Renderer.\r\n *\r\n * You can use the `RenderTexture.texture.isDrawing` boolean property to tell if a batch is\r\n * currently open, or not.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#beginDraw\r\n * @since 3.50.0\r\n *\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 481, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Use this method if you need to batch draw a large number of Game Objects to\rthis Render Texture in a single pass, or on a frequent basis. This is especially\ruseful under WebGL, however, if your game is using Canvas only, it will not make\rany speed difference in that situation.\r\rThis method starts the beginning of a batched draw, unless one is already open.\r\rBatched drawing is faster than calling `draw` in loop, but you must be careful\rto manage the flow of code and remember to call `endDraw()` when you're finished.\r\rIf you don't need to draw large numbers of objects it's much safer and easier\rto use the `draw` method instead.\r\rThe flow should be:\r\r```javascript\r// Call once:\rRenderTexture.beginDraw();\r\r// repeat n times:\rRenderTexture.batchDraw();\r// or\rRenderTexture.batchDrawFrame();\r\r// Call once:\rRenderTexture.endDraw();\r```\r\rDo not call any methods other than `batchDraw`, `batchDrawFrame`, or `endDraw` once you\rhave started a batch. Also, be very careful not to destroy this Render Texture while the\rbatch is still open. Doing so will cause a run-time error in the WebGL Renderer.\r\rYou can use the `RenderTexture.texture.isDrawing` boolean property to tell if a batch is\rcurrently open, or not.", "kind": "function", "name": "beginDraw", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Render Texture instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#beginDraw", "scope": "instance", "___id": "T000002R013615", "___s": true }, { "comment": "/**\r\n * Use this method if you have already called `beginDraw` and need to batch\r\n * draw a large number of objects to this Render Texture.\r\n *\r\n * This method batches the drawing of the given objects to this texture,\r\n * without causing a WebGL bind or batch flush for each one.\r\n *\r\n * It is faster than calling `draw`, but you must be careful to manage the\r\n * flow of code and remember to call `endDraw()`. If you don't need to draw large\r\n * numbers of objects it's much safer and easier to use the `draw` method instead.\r\n *\r\n * The flow should be:\r\n *\r\n * ```javascript\r\n * // Call once:\r\n * RenderTexture.beginDraw();\r\n *\r\n * // repeat n times:\r\n * RenderTexture.batchDraw();\r\n * // or\r\n * RenderTexture.batchDrawFrame();\r\n *\r\n * // Call once:\r\n * RenderTexture.endDraw();\r\n * ```\r\n *\r\n * Do not call any methods other than `batchDraw`, `batchDrawFrame`, or `endDraw` once you\r\n * have started a batch. Also, be very careful not to destroy this Render Texture while the\r\n * batch is still open. Doing so will cause a run-time error in the WebGL Renderer.\r\n *\r\n * You can use the `RenderTexture.texture.isDrawing` boolean property to tell if a batch is\r\n * currently open, or not.\r\n *\r\n * This method 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's Display List. Pass in `Scene.children` to draw the whole list.\r\n * * Another Dynamic Texture or Render Texture.\r\n * * A Texture Frame instance.\r\n * * A string. This is used to look-up a texture from the Texture Manager.\r\n *\r\n * Note: You cannot draw a Render Texture to itself.\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 *\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#batchDraw\r\n * @since 3.50.0\r\n *\r\n * @param {any} entries - Any renderable Game Object, or Group, Container, Display List, other Dynamic or 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": 529, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Use this method if you have already called `beginDraw` and need to batch\rdraw a large number of objects to this Render Texture.\r\rThis method batches the drawing of the given objects to this texture,\rwithout causing a WebGL bind or batch flush for each one.\r\rIt is faster than calling `draw`, but you must be careful to manage the\rflow of code and remember to call `endDraw()`. If you don't need to draw large\rnumbers of objects it's much safer and easier to use the `draw` method instead.\r\rThe flow should be:\r\r```javascript\r// Call once:\rRenderTexture.beginDraw();\r\r// repeat n times:\rRenderTexture.batchDraw();\r// or\rRenderTexture.batchDrawFrame();\r\r// Call once:\rRenderTexture.endDraw();\r```\r\rDo not call any methods other than `batchDraw`, `batchDrawFrame`, or `endDraw` once you\rhave started a batch. Also, be very careful not to destroy this Render Texture while the\rbatch is still open. Doing so will cause a run-time error in the WebGL Renderer.\r\rYou can use the `RenderTexture.texture.isDrawing` boolean property to tell if a batch is\rcurrently open, or not.\r\rThis method 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's Display List. Pass in `Scene.children` to draw the whole list.\r* Another Dynamic Texture or Render Texture.\r* A Texture Frame instance.\r* A string. This is used to look-up a texture from the Texture Manager.\r\rNote: You cannot draw a Render Texture to itself.\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.\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": "batchDraw", "since": "3.50.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "Any renderable Game Object, or Group, Container, Display List, other Dynamic or 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#batchDraw", "scope": "instance", "___id": "T000002R013617", "___s": true }, { "comment": "/**\r\n * Use this method if you have already called `beginDraw` and need to batch\r\n * draw a large number of texture frames to this Render Texture.\r\n *\r\n * This method batches the drawing of the given frames to this Render Texture,\r\n * without causing a WebGL bind or batch flush for each one.\r\n *\r\n * It is faster than calling `drawFrame`, but you must be careful to manage the\r\n * flow of code and remember to call `endDraw()`. If you don't need to draw large\r\n * numbers of frames it's much safer and easier to use the `drawFrame` method instead.\r\n *\r\n * The flow should be:\r\n *\r\n * ```javascript\r\n * // Call once:\r\n * RenderTexture.beginDraw();\r\n *\r\n * // repeat n times:\r\n * RenderTexture.batchDraw();\r\n * // or\r\n * RenderTexture.batchDrawFrame();\r\n *\r\n * // Call once:\r\n * RenderTexture.endDraw();\r\n * ```\r\n *\r\n * Do not call any methods other than `batchDraw`, `batchDrawFrame`, or `endDraw` once you\r\n * have started a batch. Also, be very careful not to destroy this Render Texture while the\r\n * batch is still open. Doing so will cause a run-time error in the WebGL Renderer.\r\n *\r\n * You can use the `RenderTexture.texture.isDrawing` boolean property to tell if a batch is\r\n * currently open, or not.\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, alpha and tint value to apply to the frame\r\n * before it is drawn.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#batchDrawFrame\r\n * @since 3.50.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 * @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 {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": 612, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Use this method if you have already called `beginDraw` and need to batch\rdraw a large number of texture frames to this Render Texture.\r\rThis method batches the drawing of the given frames to this Render Texture,\rwithout causing a WebGL bind or batch flush for each one.\r\rIt is faster than calling `drawFrame`, but you must be careful to manage the\rflow of code and remember to call `endDraw()`. If you don't need to draw large\rnumbers of frames it's much safer and easier to use the `drawFrame` method instead.\r\rThe flow should be:\r\r```javascript\r// Call once:\rRenderTexture.beginDraw();\r\r// repeat n times:\rRenderTexture.batchDraw();\r// or\rRenderTexture.batchDrawFrame();\r\r// Call once:\rRenderTexture.endDraw();\r```\r\rDo not call any methods other than `batchDraw`, `batchDrawFrame`, or `endDraw` once you\rhave started a batch. Also, be very careful not to destroy this Render Texture while the\rbatch is still open. Doing so will cause a run-time error in the WebGL Renderer.\r\rYou can use the `RenderTexture.texture.isDrawing` boolean property to tell if a batch is\rcurrently open, or not.\r\rTextures are referenced by their string-based keys, as stored in the Texture Manager.\r\rYou can optionally provide a position, alpha and tint value to apply to the frame\rbefore it is drawn.", "kind": "function", "name": "batchDrawFrame", "since": "3.50.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" }, { "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": [ "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#batchDrawFrame", "scope": "instance", "___id": "T000002R013619", "___s": true }, { "comment": "/**\r\n * Use this method to finish batch drawing to this Render Texture.\r\n *\r\n * Doing so will stop the WebGL Renderer from capturing draws and then blit the\r\n * framebuffer to the Render Target owned by this texture.\r\n *\r\n * Calling this method without first calling `beginDraw` will have no effect.\r\n *\r\n * Batch drawing is faster than calling `draw`, but you must be careful to manage the\r\n * flow of code and remember to call `endDraw()` when you're finished.\r\n *\r\n * If you don't need to draw large numbers of objects it's much safer and easier\r\n * to use the `draw` method instead.\r\n *\r\n * The flow should be:\r\n *\r\n * ```javascript\r\n * // Call once:\r\n * RenderTexture.beginDraw();\r\n *\r\n * // repeat n times:\r\n * RenderTexture.batchDraw();\r\n * // or\r\n * RenderTexture.batchDrawFrame();\r\n *\r\n * // Call once:\r\n * RenderTexture.endDraw();\r\n * ```\r\n *\r\n * Do not call any methods other than `batchDraw`, `batchDrawFrame`, or `endDraw` once you\r\n * have started a batch. Also, be very careful not to destroy this Render Texture while the\r\n * batch is still open. Doing so will cause a run-time error in the WebGL Renderer.\r\n *\r\n * You can use the `RenderTexture.texture.isDrawing` boolean property to tell if a batch is\r\n * currently open, or not.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#endDraw\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [erase=false] - Draws all objects in this batch using a blend mode of ERASE. This has the effect of erasing any filled pixels in the objects being drawn.\r\n *\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 669, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Use this method to finish batch drawing to this Render Texture.\r\rDoing so will stop the WebGL Renderer from capturing draws and then blit the\rframebuffer to the Render Target owned by this texture.\r\rCalling this method without first calling `beginDraw` will have no effect.\r\rBatch drawing is faster than calling `draw`, but you must be careful to manage the\rflow of code and remember to call `endDraw()` when you're finished.\r\rIf you don't need to draw large numbers of objects it's much safer and easier\rto use the `draw` method instead.\r\rThe flow should be:\r\r```javascript\r// Call once:\rRenderTexture.beginDraw();\r\r// repeat n times:\rRenderTexture.batchDraw();\r// or\rRenderTexture.batchDrawFrame();\r\r// Call once:\rRenderTexture.endDraw();\r```\r\rDo not call any methods other than `batchDraw`, `batchDrawFrame`, or `endDraw` once you\rhave started a batch. Also, be very careful not to destroy this Render Texture while the\rbatch is still open. Doing so will cause a run-time error in the WebGL Renderer.\r\rYou can use the `RenderTexture.texture.isDrawing` boolean property to tell if a batch is\rcurrently open, or not.", "kind": "function", "name": "endDraw", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Draws all objects in this batch using a blend mode of ERASE. This has the effect of erasing any filled pixels in the objects being drawn.", "name": "erase" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Render Texture instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#endDraw", "scope": "instance", "___id": "T000002R013621", "___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": 719, "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": "T000002R013623", "___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": 754, "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": "T000002R013625", "___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": 783, "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": "T000002R013627", "___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": 809, "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": "T000002R013629", "___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": "T000002R013637", "___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 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.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 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": [ "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": "T000002R013647", "___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": "T000002R013648", "___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": "T000002R013649", "___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 is stretched along its entire length.\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.\r\n *\r\n * A Ropes origin is always 0.5 x 0.5 and cannot be changed.\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.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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": 15, "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 is stretched along its entire length.\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.\r\rA Ropes origin is always 0.5 x 0.5 and cannot be changed.", "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.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "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": "T000002R013657", "___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": 89, "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": "T000002R013665", "___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, Geom.Point 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": 98, "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, Geom.Point 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": "T000002R013667", "___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": 117, "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": "T000002R013669", "___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": 128, "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": "T000002R013671", "___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": 139, "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": "T000002R013673", "___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": 154, "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": "T000002R013675", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Rope#tintFill\r\n * @type {boolean}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "Rope.js", "lineno": 169, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "name": "tintFill", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.23.0", "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#tintFill", "scope": "instance", "kind": "member", "___id": "T000002R013677", "___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": 181, "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": "T000002R013679", "___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": 191, "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": "T000002R013681", "___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": 244, "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": "T000002R013689", "___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": 267, "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": "T000002R013691", "___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": 305, "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": "T000002R013695", "___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": 328, "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": "T000002R013698", "___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": 347, "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": "T000002R013700", "___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 thoes 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": 364, "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 thoes 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": "T000002R013703", "___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 thoes 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": 393, "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 thoes 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": "T000002R013707", "___s": true }, { "comment": "/**\r\n * Sets the tint fill mode.\r\n *\r\n * Mode 0 (`false`) is an additive tint, the default, which blends the vertices colors with the texture.\r\n * This mode respects the texture alpha.\r\n *\r\n * Mode 1 (`true`) is a fill tint. Unlike an additive tint, a fill-tint literally replaces the pixel colors\r\n * from the texture with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. This mode respects the texture alpha.\r\n *\r\n * See the `setColors` method for details of how to color each of the vertices.\r\n *\r\n * @method Phaser.GameObjects.Rope#setTintFill\r\n * @webglOnly\r\n * @since 3.23.0\r\n *\r\n * @param {boolean} [value=false] - Set to `false` for an Additive tint or `true` fill tint with alpha.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Rope.js", "lineno": 422, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Sets the tint fill mode.\r\rMode 0 (`false`) is an additive tint, the default, which blends the vertices colors with the texture.\rThis mode respects the texture alpha.\r\rMode 1 (`true`) is a fill tint. Unlike an additive tint, a fill-tint literally replaces the pixel colors\rfrom the texture with those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. This mode respects the texture alpha.\r\rSee the `setColors` method for details of how to color each of the vertices.", "kind": "function", "name": "setTintFill", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.23.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Set to `false` for an Additive tint or `true` fill tint with alpha.", "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#setTintFill", "scope": "instance", "___id": "T000002R013711", "___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 value: `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": 451, "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 value: `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": "T000002R013715", "___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": 550, "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": "T000002R013738", "___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": 635, "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": "T000002R013757", "___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": 757, "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": "T000002R013782", "___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": 845, "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": "T000002R013818", "___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": 882, "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": "T000002R013832", "___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": 950, "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": "T000002R013859", "___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": 1002, "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": "T000002R013865", "___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": 1067, "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": "T000002R013892", "___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": 1095, "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": "T000002R013897", "___s": true }, { "comment": "/**\r\n * Creates a new Rope Game Object and returns it.\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\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": "T000002R013911", "___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": "T000002R013923", "___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": "T000002R013975", "___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": "T000002R013976", "___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 into the display list, and manipulate it\r\n * as you would any other Game Object, including scaling, rotating, positioning and adding to Containers. Shaders\r\n * can be masked with either Bitmap or Geometry masks and can also be used as a Bitmap Mask for a Camera or other\r\n * Game Object. They can also be made interactive and used for input events.\r\n *\r\n * It works by taking a reference to a `Phaser.Display.BaseShader` instance, as found in the Shader Cache. These can\r\n * be created dynamically at runtime, or loaded in via the GLSL File Loader:\r\n *\r\n * ```javascript\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 *\r\n * Please see the Phaser 3 Examples GitHub repo for examples of loading and creating shaders dynamically.\r\n *\r\n * Due to the way in which they work, you cannot directly change the alpha or blend mode of a Shader. This should\r\n * be handled via exposed uniforms in the shader code itself.\r\n *\r\n * By default a Shader will be created with a standard set of uniforms. These were added to match those\r\n * found on sites such as ShaderToy or GLSLSandbox, and provide common functionality a shader may need,\r\n * such as the timestamp, resolution or pointer position. You can replace them by specifying your own uniforms\r\n * in the Base Shader.\r\n *\r\n * These Shaders work by halting the current pipeline during rendering, creating a viewport matched to the\r\n * size of this Game Object and then renders a quad using the bound shader. At the end, the pipeline is restored.\r\n *\r\n * Because it blocks the pipeline it means it will interrupt any batching that is currently going on, so you should\r\n * use these Game Objects sparingly. If you need to have a fully batched custom shader, then please look at using\r\n * a custom pipeline instead. However, for background or special masking effects, they are extremely effective.\r\n *\r\n * @class Shader\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @webglOnly\r\n * @since 3.17.0\r\n *\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.Mask\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 {(string|Phaser.Display.BaseShader)} key - The key of the shader to use from the shader cache, or a BaseShader instance.\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 * @param {any} [textureData] - Additional texture data if you want to create shader with none NPOT textures.\r\n */", "meta": { "filename": "Shader.js", "lineno": 16, "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 into the display list, and manipulate it\ras you would any other Game Object, including scaling, rotating, positioning and adding to Containers. Shaders\rcan be masked with either Bitmap or Geometry masks and can also be used as a Bitmap Mask for a Camera or other\rGame Object. They can also be made interactive and used for input events.\r\rIt works by taking a reference to a `Phaser.Display.BaseShader` instance, as found in the Shader Cache. These can\rbe created dynamically at runtime, or loaded in via the GLSL File Loader:\r\r```javascript\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}\r```\r\rPlease see the Phaser 3 Examples GitHub repo for examples of loading and creating shaders dynamically.\r\rDue to the way in which they work, you cannot directly change the alpha or blend mode of a Shader. This should\rbe handled via exposed uniforms in the shader code itself.\r\rBy default a Shader will be created with a standard set of uniforms. These were added to match those\rfound on sites such as ShaderToy or GLSLSandbox, and provide common functionality a shader may need,\rsuch as the timestamp, resolution or pointer position. You can replace them by specifying your own uniforms\rin the Base Shader.\r\rThese Shaders work by halting the current pipeline during rendering, creating a viewport matched to the\rsize of this Game Object and then renders a quad using the bound shader. At the end, the pipeline is restored.\r\rBecause it blocks the pipeline it means it will interrupt any batching that is currently going on, so you should\ruse these Game Objects sparingly. If you need to have a fully batched custom shader, then please look at using\ra custom pipeline instead. However, for background or special masking effects, they are extremely effective.", "kind": "class", "name": "Shader", "augments": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Components.ComputedSize", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.GetBounds", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.ScrollFactor", "Phaser.GameObjects.Components.Transform", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.GameObjects", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "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": [ "string", "Phaser.Display.BaseShader" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Display.BaseShader" } ] } }, "description": "The key of the shader to use from the shader cache, or a BaseShader instance.", "name": "key" }, { "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" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Additional texture data if you want to create shader with none NPOT textures.", "name": "textureData" } ], "scope": "static", "longname": "Phaser.GameObjects.Shader", "___id": "T000002R013985", "___s": true }, { "comment": "/**\r\n * The underlying shader object being used.\r\n * Empty by default and set during a call to the `setShader` method.\r\n *\r\n * @name Phaser.GameObjects.Shader#shader\r\n * @type {Phaser.Display.BaseShader}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 119, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "The underlying shader object being used.\rEmpty by default and set during a call to the `setShader` method.", "name": "shader", "type": { "names": [ "Phaser.Display.BaseShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.BaseShader" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#shader", "scope": "instance", "kind": "member", "___id": "T000002R013996", "___s": true }, { "comment": "/**\r\n * A reference to the current renderer.\r\n * Shaders only work with the WebGL Renderer.\r\n *\r\n * @name Phaser.GameObjects.Shader#renderer\r\n * @type {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "A reference to the current renderer.\rShaders only work with the WebGL Renderer.", "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.17.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#renderer", "scope": "instance", "kind": "member", "___id": "T000002R013999", "___s": true }, { "comment": "/**\r\n * The WebGL context belonging to the renderer.\r\n *\r\n * @name Phaser.GameObjects.Shader#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "The WebGL context belonging to the renderer.", "name": "gl", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#gl", "scope": "instance", "kind": "member", "___id": "T000002R014001", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices this Shader uses.\r\n *\r\n * @name Phaser.GameObjects.Shader#vertexData\r\n * @type {ArrayBuffer}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Raw byte buffer of vertices this Shader uses.", "name": "vertexData", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#vertexData", "scope": "instance", "kind": "member", "___id": "T000002R014003", "___s": true }, { "comment": "/**\r\n * The WebGL vertex buffer object this shader uses.\r\n *\r\n * @name Phaser.GameObjects.Shader#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "The WebGL vertex buffer object this shader uses.", "name": "vertexBuffer", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#vertexBuffer", "scope": "instance", "kind": "member", "___id": "T000002R014005", "___s": true }, { "comment": "/**\r\n * The WebGL shader program this shader uses.\r\n *\r\n * @name Phaser.GameObjects.Shader#program\r\n * @type {WebGLProgram}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 168, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "The WebGL shader program this shader uses.", "name": "program", "type": { "names": [ "WebGLProgram" ], "parsedType": { "type": "NameExpression", "name": "WebGLProgram" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#program", "scope": "instance", "kind": "member", "___id": "T000002R014007", "___s": true }, { "comment": "/**\r\n * Uint8 view to the vertex raw buffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.GameObjects.Shader#bytes\r\n * @type {Uint8Array}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 177, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Uint8 view to the vertex raw buffer. Used for uploading vertex buffer resources to the GPU.", "name": "bytes", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#bytes", "scope": "instance", "kind": "member", "___id": "T000002R014009", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the shaders vertices.\r\n *\r\n * @name Phaser.GameObjects.Shader#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Float32 view of the array buffer containing the shaders vertices.", "name": "vertexViewF32", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#vertexViewF32", "scope": "instance", "kind": "member", "___id": "T000002R014011", "___s": true }, { "comment": "/**\r\n * The view matrix the shader uses during rendering.\r\n *\r\n * @name Phaser.GameObjects.Shader#viewMatrix\r\n * @type {Float32Array}\r\n * @readonly\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "The view matrix the shader uses during rendering.", "name": "viewMatrix", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "readonly": true, "since": "3.17.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#viewMatrix", "scope": "instance", "kind": "member", "___id": "T000002R014019", "___s": true }, { "comment": "/**\r\n * The projection matrix the shader uses during rendering.\r\n *\r\n * @name Phaser.GameObjects.Shader#projectionMatrix\r\n * @type {Float32Array}\r\n * @readonly\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 235, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "The projection matrix the shader uses during rendering.", "name": "projectionMatrix", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "readonly": true, "since": "3.17.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#projectionMatrix", "scope": "instance", "kind": "member", "___id": "T000002R014021", "___s": true }, { "comment": "/**\r\n * The default uniform mappings. These can be added to (or replaced) by specifying your own uniforms when\r\n * creating this shader game object. The uniforms are updated automatically during the render step.\r\n *\r\n * The defaults are:\r\n *\r\n * `resolution` (2f) - Set to the size of this shader.\r\n * `time` (1f) - The elapsed game time, in seconds.\r\n * `mouse` (2f) - If a pointer has been bound (with `setPointer`), this uniform contains its position each frame.\r\n * `date` (4fv) - A vec4 containing the year, month, day and time in seconds.\r\n * `sampleRate` (1f) - Sound sample rate. 44100 by default.\r\n * `iChannel0...3` (sampler2D) - Input channels 0 to 3. `null` by default.\r\n *\r\n * @name Phaser.GameObjects.Shader#uniforms\r\n * @type {any}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "The default uniform mappings. These can be added to (or replaced) by specifying your own uniforms when\rcreating this shader game object. The uniforms are updated automatically during the render step.\r\rThe defaults are:\r\r`resolution` (2f) - Set to the size of this shader.\r`time` (1f) - The elapsed game time, in seconds.\r`mouse` (2f) - If a pointer has been bound (with `setPointer`), this uniform contains its position each frame.\r`date` (4fv) - A vec4 containing the year, month, day and time in seconds.\r`sampleRate` (1f) - Sound sample rate. 44100 by default.\r`iChannel0...3` (sampler2D) - Input channels 0 to 3. `null` by default.", "name": "uniforms", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#uniforms", "scope": "instance", "kind": "member", "___id": "T000002R014023", "___s": true }, { "comment": "/**\r\n * The pointer bound to this shader, if any.\r\n * Set via the chainable `setPointer` method, or by modifying this property directly.\r\n *\r\n * @name Phaser.GameObjects.Shader#pointer\r\n * @type {Phaser.Input.Pointer}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 264, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "The pointer bound to this shader, if any.\rSet via the chainable `setPointer` method, or by modifying this property directly.", "name": "pointer", "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#pointer", "scope": "instance", "kind": "member", "___id": "T000002R014025", "___s": true }, { "comment": "/**\r\n * A reference to the GL Frame Buffer this Shader is drawing to.\r\n * This property is only set if you have called `Shader.setRenderToTexture`.\r\n *\r\n * @name Phaser.GameObjects.Shader#framebuffer\r\n * @type {?WebGLFramebuffer}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 304, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "A reference to the GL Frame Buffer this Shader is drawing to.\rThis property is only set if you have called `Shader.setRenderToTexture`.", "name": "framebuffer", "type": { "names": [ "WebGLFramebuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLFramebuffer", "nullable": true } }, "nullable": true, "since": "3.19.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#framebuffer", "scope": "instance", "kind": "member", "___id": "T000002R014033", "___s": true }, { "comment": "/**\r\n * A reference to the WebGLTexture 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 {?WebGLTexture}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 314, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "A reference to the WebGLTexture this Shader is rendering to.\rThis property is only set if you have called `Shader.setRenderToTexture`.", "name": "glTexture", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.19.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#glTexture", "scope": "instance", "kind": "member", "___id": "T000002R014035", "___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": 324, "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": "T000002R014037", "___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`, 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": 338, "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`, 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": "T000002R014039", "___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.Shader#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": "Shader.js", "lineno": 355, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "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.Shader", "longname": "Phaser.GameObjects.Shader#willRender", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#willRender", "___id": "T000002R014041", "___s": true }, { "comment": "/**\r\n * Changes this Shader so instead of rendering to the display list it renders to a\r\n * WebGL Framebuffer and WebGL Texture instead. This allows you to use the output\r\n * of this shader as an input for another shader, by mapping a sampler2D uniform\r\n * to it.\r\n *\r\n * After calling this method the `Shader.framebuffer` and `Shader.glTexture` properties\r\n * are populated.\r\n *\r\n * Additionally, you can provide a key to this method. Doing so will create a Phaser Texture\r\n * from this Shader 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 * You can access the Phaser Texture that is created via the `Shader.texture` property.\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 * @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 * @param {boolean} [flipY=false] - Does this texture need vertically flipping before rendering? This should usually be set to `true` if being fed from a buffer.\r\n *\r\n * @return {this} This Shader instance.\r\n */", "meta": { "filename": "Shader.js", "lineno": 378, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Changes this Shader so instead of rendering to the display list it renders to a\rWebGL Framebuffer and WebGL Texture instead. This allows you to use the output\rof this shader as an input for another shader, by mapping a sampler2D uniform\rto it.\r\rAfter calling this method the `Shader.framebuffer` and `Shader.glTexture` properties\rare populated.\r\rAdditionally, you can provide a key to this method. Doing so will create a Phaser Texture\rfrom this Shader and 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\rYou can access the Phaser Texture that is created via the `Shader.texture` property.\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.", "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" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this texture need vertically flipping before rendering? This should usually be set to `true` if being fed from a buffer.", "name": "flipY" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shader instance." } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#setRenderToTexture", "scope": "instance", "___id": "T000002R014043", "___s": true }, { "comment": "/**\r\n * Sets the fragment and, optionally, the vertex shader source code that this Shader will use.\r\n * This will immediately delete the active shader program, if set, and then create a new one\r\n * with the given source. Finally, the shader uniforms are initialized.\r\n *\r\n * @method Phaser.GameObjects.Shader#setShader\r\n * @since 3.17.0\r\n *\r\n * @param {(string|Phaser.Display.BaseShader)} key - The key of the shader to use from the shader cache, or a BaseShader instance.\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 * @param {any} [textureData] - Additional texture data.\r\n *\r\n * @return {this} This Shader instance.\r\n */", "meta": { "filename": "Shader.js", "lineno": 461, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Sets the fragment and, optionally, the vertex shader source code that this Shader will use.\rThis will immediately delete the active shader program, if set, and then create a new one\rwith the given source. Finally, the shader uniforms are initialized.", "kind": "function", "name": "setShader", "since": "3.17.0", "params": [ { "type": { "names": [ "string", "Phaser.Display.BaseShader" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Display.BaseShader" } ] } }, "description": "The key of the shader to use from the shader cache, or a BaseShader instance.", "name": "key" }, { "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" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Additional texture data.", "name": "textureData" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shader instance." } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#setShader", "scope": "instance", "___id": "T000002R014056", "___s": true }, { "comment": "/**\r\n * Binds a Phaser Pointer object to this Shader.\r\n *\r\n * The screen position of the pointer will be set in to the shaders `mouse` uniform\r\n * automatically every frame. Call this method with no arguments to unbind the pointer.\r\n *\r\n * @method Phaser.GameObjects.Shader#setPointer\r\n * @since 3.17.0\r\n *\r\n * @param {Phaser.Input.Pointer} [pointer] - The Pointer to bind to this shader.\r\n *\r\n * @return {this} This Shader instance.\r\n */", "meta": { "filename": "Shader.js", "lineno": 552, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Binds a Phaser Pointer object to this Shader.\r\rThe screen position of the pointer will be set in to the shaders `mouse` uniform\rautomatically every frame. Call this method with no arguments to unbind the pointer.", "kind": "function", "name": "setPointer", "since": "3.17.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "optional": true, "description": "The Pointer to bind to this shader.", "name": "pointer" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shader instance." } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#setPointer", "scope": "instance", "___id": "T000002R014110", "___s": true }, { "comment": "/**\r\n * Sets this shader to use an orthographic projection matrix.\r\n * This matrix is stored locally in the `projectionMatrix` property,\r\n * as well as being bound to the `uProjectionMatrix` uniform.\r\n *\r\n * @method Phaser.GameObjects.Shader#projOrtho\r\n * @since 3.17.0\r\n *\r\n * @param {number} left - The left value.\r\n * @param {number} right - The right value.\r\n * @param {number} bottom - The bottom value.\r\n * @param {number} top - The top value.\r\n */", "meta": { "filename": "Shader.js", "lineno": 572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Sets this shader to use an orthographic projection matrix.\rThis matrix is stored locally in the `projectionMatrix` property,\ras well as being bound to the `uProjectionMatrix` uniform.", "kind": "function", "name": "projOrtho", "since": "3.17.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left value.", "name": "left" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The right value.", "name": "right" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom value.", "name": "bottom" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top value.", "name": "top" } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#projOrtho", "scope": "instance", "___id": "T000002R014113", "___s": true }, { "comment": "/**\r\n * Sets a sampler2D uniform on this shader where the source texture is a WebGLTexture.\r\n *\r\n * This allows you to feed the output from one Shader into another:\r\n *\r\n * ```javascript\r\n * let shader1 = this.add.shader(baseShader1, 0, 0, 512, 512).setRenderToTexture();\r\n * let shader2 = this.add.shader(baseShader2, 0, 0, 512, 512).setRenderToTexture('output');\r\n *\r\n * shader1.setSampler2DBuffer('iChannel0', shader2.glTexture, 512, 512);\r\n * shader2.setSampler2DBuffer('iChannel0', shader1.glTexture, 512, 512);\r\n * ```\r\n *\r\n * In the above code, the result of baseShader1 is fed into Shader2 as the `iChannel0` sampler2D uniform.\r\n * The result of baseShader2 is then fed back into shader1 again, creating a feedback loop.\r\n *\r\n * If you wish to use an image from the Texture Manager as a sampler2D input for this shader,\r\n * see the `Shader.setSampler2D` method.\r\n *\r\n * @method Phaser.GameObjects.Shader#setSampler2DBuffer\r\n * @since 3.19.0\r\n *\r\n * @param {string} uniformKey - The key of the sampler2D uniform to be updated, i.e. `iChannel0`.\r\n * @param {WebGLTexture} texture - A WebGLTexture reference.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {number} [textureIndex=0] - The texture index.\r\n * @param {any} [textureData] - Additional texture data.\r\n *\r\n * @return {this} This Shader instance.\r\n */", "meta": { "filename": "Shader.js", "lineno": 652, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Sets a sampler2D uniform on this shader where the source texture is a WebGLTexture.\r\rThis allows you to feed the output from one Shader into another:\r\r```javascript\rlet shader1 = this.add.shader(baseShader1, 0, 0, 512, 512).setRenderToTexture();\rlet shader2 = this.add.shader(baseShader2, 0, 0, 512, 512).setRenderToTexture('output');\r\rshader1.setSampler2DBuffer('iChannel0', shader2.glTexture, 512, 512);\rshader2.setSampler2DBuffer('iChannel0', shader1.glTexture, 512, 512);\r```\r\rIn the above code, the result of baseShader1 is fed into Shader2 as the `iChannel0` sampler2D uniform.\rThe result of baseShader2 is then fed back into shader1 again, creating a feedback loop.\r\rIf you wish to use an image from the Texture Manager as a sampler2D input for this shader,\rsee the `Shader.setSampler2D` method.", "kind": "function", "name": "setSampler2DBuffer", "since": "3.19.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the sampler2D uniform to be updated, i.e. `iChannel0`.", "name": "uniformKey" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "A WebGLTexture reference.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The texture index.", "name": "textureIndex" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Additional texture data.", "name": "textureData" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shader instance." } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#setSampler2DBuffer", "scope": "instance", "___id": "T000002R014146", "___s": true }, { "comment": "/**\r\n * Sets a sampler2D uniform on this shader.\r\n *\r\n * The textureKey given is the key from the Texture Manager cache. You cannot use a single frame\r\n * from a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.\r\n *\r\n * If you wish to use another Shader as a sampler2D input for this shader, see the `Shader.setSampler2DBuffer` method.\r\n *\r\n * @method Phaser.GameObjects.Shader#setSampler2D\r\n * @since 3.17.0\r\n *\r\n * @param {string} uniformKey - The key of the sampler2D uniform to be updated, i.e. `iChannel0`.\r\n * @param {string} textureKey - The key of the texture, as stored in the Texture Manager. Must already be loaded.\r\n * @param {number} [textureIndex=0] - The texture index.\r\n * @param {any} [textureData] - Additional texture data.\r\n *\r\n * @return {this} This Shader instance.\r\n */", "meta": { "filename": "Shader.js", "lineno": 704, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Sets a sampler2D uniform on this shader.\r\rThe textureKey given is the key from the Texture Manager cache. You cannot use a single frame\rfrom a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.\r\rIf you wish to use another Shader as a sampler2D input for this shader, see the `Shader.setSampler2DBuffer` method.", "kind": "function", "name": "setSampler2D", "since": "3.17.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the sampler2D uniform to be updated, i.e. `iChannel0`.", "name": "uniformKey" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the texture, as stored in the Texture Manager. Must already be loaded.", "name": "textureKey" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The texture index.", "name": "textureIndex" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Additional texture data.", "name": "textureData" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shader instance." } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#setSampler2D", "scope": "instance", "___id": "T000002R014156", "___s": true }, { "comment": "/**\r\n * Sets a property of a uniform already present on this shader.\r\n *\r\n * To modify the value of a uniform such as a 1f or 1i use the `value` property directly:\r\n *\r\n * ```javascript\r\n * shader.setUniform('size.value', 16);\r\n * ```\r\n *\r\n * You can use dot notation to access deeper values, for example:\r\n *\r\n * ```javascript\r\n * shader.setUniform('resolution.value.x', 512);\r\n * ```\r\n *\r\n * The change to the uniform will take effect the next time the shader is rendered.\r\n *\r\n * @method Phaser.GameObjects.Shader#setUniform\r\n * @since 3.17.0\r\n *\r\n * @param {string} key - The key of the uniform to modify. Use dots for deep properties, i.e. `resolution.value.x`.\r\n * @param {any} value - The value to set into the uniform.\r\n *\r\n * @return {this} This Shader instance.\r\n */", "meta": { "filename": "Shader.js", "lineno": 768, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Sets a property of a uniform already present on this shader.\r\rTo modify the value of a uniform such as a 1f or 1i use the `value` property directly:\r\r```javascript\rshader.setUniform('size.value', 16);\r```\r\rYou can use dot notation to access deeper values, for example:\r\r```javascript\rshader.setUniform('resolution.value.x', 512);\r```\r\rThe change to the uniform will take effect the next time the shader is rendered.", "kind": "function", "name": "setUniform", "since": "3.17.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the uniform to modify. Use dots for deep properties, i.e. `resolution.value.x`.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The value to set into the uniform.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shader instance." } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#setUniform", "scope": "instance", "___id": "T000002R014171", "___s": true }, { "comment": "/**\r\n * Returns the uniform object for the given key, or `null` if the uniform couldn't be found.\r\n *\r\n * @method Phaser.GameObjects.Shader#getUniform\r\n * @since 3.17.0\r\n *\r\n * @param {string} key - The key of the uniform to return the value for.\r\n *\r\n * @return {any} A reference to the uniform object. This is not a copy, so modifying it will update the original object also.\r\n */", "meta": { "filename": "Shader.js", "lineno": 800, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Returns the uniform object for the given key, or `null` if the uniform couldn't be found.", "kind": "function", "name": "getUniform", "since": "3.17.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the uniform to return the value for.", "name": "key" } ], "returns": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "A reference to the uniform object. This is not a copy, so modifying it will update the original object also." } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#getUniform", "scope": "instance", "___id": "T000002R014173", "___s": true }, { "comment": "/**\r\n * A short-cut method that will directly set the texture being used by the `iChannel0` sampler2D uniform.\r\n *\r\n * The textureKey given is the key from the Texture Manager cache. You cannot use a single frame\r\n * from a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.\r\n *\r\n * @method Phaser.GameObjects.Shader#setChannel0\r\n * @since 3.17.0\r\n *\r\n * @param {string} textureKey - The key of the texture, as stored in the Texture Manager. Must already be loaded.\r\n * @param {any} [textureData] - Additional texture data.\r\n *\r\n * @return {this} This Shader instance.\r\n */", "meta": { "filename": "Shader.js", "lineno": 815, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "A short-cut method that will directly set the texture being used by the `iChannel0` sampler2D uniform.\r\rThe textureKey given is the key from the Texture Manager cache. You cannot use a single frame\rfrom a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.", "kind": "function", "name": "setChannel0", "since": "3.17.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the texture, as stored in the Texture Manager. Must already be loaded.", "name": "textureKey" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Additional texture data.", "name": "textureData" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shader instance." } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#setChannel0", "scope": "instance", "___id": "T000002R014175", "___s": true }, { "comment": "/**\r\n * A short-cut method that will directly set the texture being used by the `iChannel1` sampler2D uniform.\r\n *\r\n * The textureKey given is the key from the Texture Manager cache. You cannot use a single frame\r\n * from a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.\r\n *\r\n * @method Phaser.GameObjects.Shader#setChannel1\r\n * @since 3.17.0\r\n *\r\n * @param {string} textureKey - The key of the texture, as stored in the Texture Manager. Must already be loaded.\r\n * @param {any} [textureData] - Additional texture data.\r\n *\r\n * @return {this} This Shader instance.\r\n */", "meta": { "filename": "Shader.js", "lineno": 834, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "A short-cut method that will directly set the texture being used by the `iChannel1` sampler2D uniform.\r\rThe textureKey given is the key from the Texture Manager cache. You cannot use a single frame\rfrom a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.", "kind": "function", "name": "setChannel1", "since": "3.17.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the texture, as stored in the Texture Manager. Must already be loaded.", "name": "textureKey" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Additional texture data.", "name": "textureData" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shader instance." } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#setChannel1", "scope": "instance", "___id": "T000002R014177", "___s": true }, { "comment": "/**\r\n * A short-cut method that will directly set the texture being used by the `iChannel2` sampler2D uniform.\r\n *\r\n * The textureKey given is the key from the Texture Manager cache. You cannot use a single frame\r\n * from a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.\r\n *\r\n * @method Phaser.GameObjects.Shader#setChannel2\r\n * @since 3.17.0\r\n *\r\n * @param {string} textureKey - The key of the texture, as stored in the Texture Manager. Must already be loaded.\r\n * @param {any} [textureData] - Additional texture data.\r\n *\r\n * @return {this} This Shader instance.\r\n */", "meta": { "filename": "Shader.js", "lineno": 853, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "A short-cut method that will directly set the texture being used by the `iChannel2` sampler2D uniform.\r\rThe textureKey given is the key from the Texture Manager cache. You cannot use a single frame\rfrom a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.", "kind": "function", "name": "setChannel2", "since": "3.17.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the texture, as stored in the Texture Manager. Must already be loaded.", "name": "textureKey" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Additional texture data.", "name": "textureData" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shader instance." } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#setChannel2", "scope": "instance", "___id": "T000002R014179", "___s": true }, { "comment": "/**\r\n * A short-cut method that will directly set the texture being used by the `iChannel3` sampler2D uniform.\r\n *\r\n * The textureKey given is the key from the Texture Manager cache. You cannot use a single frame\r\n * from a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.\r\n *\r\n * @method Phaser.GameObjects.Shader#setChannel3\r\n * @since 3.17.0\r\n *\r\n * @param {string} textureKey - The key of the texture, as stored in the Texture Manager. Must already be loaded.\r\n * @param {any} [textureData] - Additional texture data.\r\n *\r\n * @return {this} This Shader instance.\r\n */", "meta": { "filename": "Shader.js", "lineno": 872, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "A short-cut method that will directly set the texture being used by the `iChannel3` sampler2D uniform.\r\rThe textureKey given is the key from the Texture Manager cache. You cannot use a single frame\rfrom a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.", "kind": "function", "name": "setChannel3", "since": "3.17.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the texture, as stored in the Texture Manager. Must already be loaded.", "name": "textureKey" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Additional texture data.", "name": "textureData" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shader instance." } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#setChannel3", "scope": "instance", "___id": "T000002R014181", "___s": true }, { "comment": "/**\r\n * Called automatically during render.\r\n *\r\n * This method performs matrix ITRS and then stores the resulting value in the `uViewMatrix` uniform.\r\n * It then sets up the vertex buffer and shader, updates and syncs the uniforms ready\r\n * for flush to be called.\r\n *\r\n * @method Phaser.GameObjects.Shader#load\r\n * @since 3.17.0\r\n *\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [matrix2D] - The transform matrix to use during rendering.\r\n */", "meta": { "filename": "Shader.js", "lineno": 1037, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Called automatically during render.\r\rThis method performs matrix ITRS and then stores the resulting value in the `uViewMatrix` uniform.\rIt then sets up the vertex buffer and shader, updates and syncs the uniforms ready\rfor flush to be called.", "kind": "function", "name": "load", "since": "3.17.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "The transform matrix to use during rendering.", "name": "matrix2D" } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#load", "scope": "instance", "___id": "T000002R014213", "___s": true }, { "comment": "/**\r\n * Called automatically during render.\r\n *\r\n * Sets the active shader, loads the vertex buffer and then draws.\r\n *\r\n * @method Phaser.GameObjects.Shader#flush\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 1108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Called automatically during render.\r\rSets the active shader, loads the vertex buffer and then draws.", "kind": "function", "name": "flush", "since": "3.17.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#flush", "scope": "instance", "___id": "T000002R014242", "___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": 1198, "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": "T000002R014264", "___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": "T000002R014278", "___s": true }, { "comment": "/**\r\n * Creates a new Shader Game Object and adds it to the Scene.\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.Display.BaseShader)} key - The key of the shader to use from the shader cache, or a BaseShader instance.\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 * @param {object} [textureData] - Optional additional texture data.\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\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.Display.BaseShader" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Display.BaseShader" } ] } }, "description": "The key of the shader to use from the shader cache, or a BaseShader instance.", "name": "key" }, { "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" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional additional texture data.", "name": "textureData" } ], "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": "T000002R014289", "___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": "T000002R014303", "___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.Display.BaseShader)} key - The key of the shader to use from the shader cache, or a BaseShader instance.\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.Display.BaseShader" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Display.BaseShader" } ] } }, "description": "The key of the shader to use from the shader cache, or a BaseShader instance.", "name": "key" }, { "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": "T000002R014304", "___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": "T000002R014312", "___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": "T000002R014332", "___s": true }, { "comment": "/**\r\n * The radius of the arc.\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.", "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": "T000002R014337", "___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": 177, "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": "T000002R014343", "___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": 200, "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": "T000002R014348", "___s": true }, { "comment": "/**\r\n * The winding order of 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": 223, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\arc", "code": {} }, "description": "The winding order of 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": "T000002R014353", "___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": 246, "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": "T000002R014358", "___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": 264, "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": "T000002R014361", "___s": true }, { "comment": "/**\r\n * Sets the starting angle of the arc, in degrees.\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 *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Arc.js", "lineno": 286, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\arc", "code": {} }, "description": "Sets the starting angle of the arc, in degrees.\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" } ], "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": "T000002R014365", "___s": true }, { "comment": "/**\r\n * Sets the ending angle of the arc, in degrees.\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 *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Arc.js", "lineno": 309, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\arc", "code": {} }, "description": "Sets the ending angle of the arc, in degrees.\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" } ], "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": "T000002R014369", "___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] - 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 *\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": "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" } ], "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": "T000002R014407", "___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 no defined start and end angle, making it render as a complete circle.\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 no defined start and end angle, making it render as a complete circle.\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": "T000002R014408", "___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": "T000002R014434", "___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": "T000002R014446", "___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": "T000002R014451", "___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": "T000002R014484", "___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 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 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 iterations\rthat take place during construction. Increase and decrease the default value for smoother, or more\rjagged, shapes.", "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": "T000002R014510", "___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": "T000002R014523", "___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": "T000002R014528", "___s": true }, { "comment": "/**\r\n * Sets 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 * 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": 136, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\ellipse", "code": {} }, "description": "Sets 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.\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": "T000002R014532", "___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": "T000002R014563", "___s": true }, { "comment": "/**\n * @classdesc\n * The Grid Shape is a Game Object that can be added to a Scene, Group or Container. You can\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\n *\n * This shape supports only fill colors and cannot be stroked.\n *\n * A Grid Shape allows you to display a grid in your game, where you can control the size of the\n * grid as well as the width and height of the grid cells. You can set a fill color for each grid\n * cell as well as an alternate fill color. When the alternate fill color is set then the grid\n * cells will alternate the fill colors as they render, creating a chess-board effect. You can\n * also optionally have an outline fill color. If set, this draws lines between the grid cells\n * in the given color. If you specify an outline color with an alpha of zero, then it will draw\n * the cells spaced out, but without the lines between them.\n *\n * @class Grid\n * @extends Phaser.GameObjects.Shape\n * @memberof Phaser.GameObjects\n * @constructor\n * @since 3.13.0\n *\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.\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\n * @param {number} [width=128] - The width of the grid.\n * @param {number} [height=128] - The height of the grid.\n * @param {number} [cellWidth=32] - The width of one cell in the grid.\n * @param {number} [cellHeight=32] - The height of one cell in the grid.\n * @param {number} [fillColor] - The color the grid cells will be filled with, i.e. 0xff0000 for red.\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.\n * @param {number} [outlineFillColor] - The color of the lines between the grid cells. See the `setOutline` method.\n * @param {number} [outlineFillAlpha] - The alpha of the lines between the grid cells.\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\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only fill colors and cannot be stroked.\n\nA Grid Shape allows you to display a grid in your game, where you can control the size of the\ngrid as well as the width and height of the grid cells. You can set a fill color for each grid\ncell as well as an alternate fill color. When the alternate fill color is set then the grid\ncells will alternate the fill colors as they render, creating a chess-board effect. You can\nalso optionally have an outline fill color. If set, this draws lines between the grid cells\nin the given color. If you specify an outline color with an alpha of zero, then it will draw\nthe cells spaced out, but without the lines between them.", "kind": "class", "name": "Grid", "augments": [ "Phaser.GameObjects.Shape" ], "memberof": "Phaser.GameObjects", "since": "3.13.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "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 `setOutline` method.", "name": "outlineFillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The alpha of the lines between the grid cells.", "name": "outlineFillAlpha" } ], "scope": "static", "longname": "Phaser.GameObjects.Grid", "___id": "T000002R014620", "___s": true }, { "comment": "/**\n * The width of each grid cell.\n * Must be a positive value.\n *\n * @name Phaser.GameObjects.Grid#cellWidth\n * @type {number}\n * @since 3.13.0\n */", "meta": { "filename": "Grid.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "The width of each grid cell.\nMust 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": "T000002R014631", "___s": true }, { "comment": "/**\n * The height of each grid cell.\n * Must be a positive value.\n *\n * @name Phaser.GameObjects.Grid#cellHeight\n * @type {number}\n * @since 3.13.0\n */", "meta": { "filename": "Grid.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "The height of each grid cell.\nMust 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": "T000002R014633", "___s": true }, { "comment": "/**\n * Will the grid render its cells in the `fillColor`?\n *\n * @name Phaser.GameObjects.Grid#showCells\n * @type {boolean}\n * @since 3.13.0\n */", "meta": { "filename": "Grid.js", "lineno": 87, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "Will the grid render its cells in the `fillColor`?", "name": "showCells", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#showCells", "scope": "instance", "kind": "member", "___id": "T000002R014635", "___s": true }, { "comment": "/**\n * The color of the lines between each grid cell.\n *\n * @name Phaser.GameObjects.Grid#outlineFillColor\n * @type {number}\n * @since 3.13.0\n */", "meta": { "filename": "Grid.js", "lineno": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "The color of the lines between each grid cell.", "name": "outlineFillColor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#outlineFillColor", "scope": "instance", "kind": "member", "___id": "T000002R014637", "___s": true }, { "comment": "/**\n * The alpha value for the color of the lines between each grid cell.\n *\n * @name Phaser.GameObjects.Grid#outlineFillAlpha\n * @type {number}\n * @since 3.13.0\n */", "meta": { "filename": "Grid.js", "lineno": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "The alpha value for the color of the lines between each grid cell.", "name": "outlineFillAlpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#outlineFillAlpha", "scope": "instance", "kind": "member", "___id": "T000002R014639", "___s": true }, { "comment": "/**\n * Will the grid display the lines between each cell when it renders?\n *\n * @name Phaser.GameObjects.Grid#showOutline\n * @type {boolean}\n * @since 3.13.0\n */", "meta": { "filename": "Grid.js", "lineno": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "Will the grid display the lines between each cell when it renders?", "name": "showOutline", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#showOutline", "scope": "instance", "kind": "member", "___id": "T000002R014641", "___s": true }, { "comment": "/**\n * Will the grid render the alternating cells in the `altFillColor`?\n *\n * @name Phaser.GameObjects.Grid#showAltCells\n * @type {boolean}\n * @since 3.13.0\n */", "meta": { "filename": "Grid.js", "lineno": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "Will the grid render the alternating cells in the `altFillColor`?", "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": "T000002R014643", "___s": true }, { "comment": "/**\n * The color the alternating grid cells will be filled with, i.e. 0xff0000 for red.\n *\n * @name Phaser.GameObjects.Grid#altFillColor\n * @type {number}\n * @since 3.13.0\n */", "meta": { "filename": "Grid.js", "lineno": 132, "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": "T000002R014645", "___s": true }, { "comment": "/**\n * The alpha the alternating grid cells will be filled with.\n * You can also set the alpha of the overall Shape using its `alpha` property.\n *\n * @name Phaser.GameObjects.Grid#altFillAlpha\n * @type {number}\n * @since 3.13.0\n */", "meta": { "filename": "Grid.js", "lineno": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "The alpha the alternating grid cells will be filled with.\nYou can also set the alpha of the overall Shape using its `alpha` property.", "name": "altFillAlpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#altFillAlpha", "scope": "instance", "kind": "member", "___id": "T000002R014647", "___s": true }, { "comment": "/**\n * Sets the fill color and alpha level the grid cells will use when rendering.\n *\n * If this method is called with no values then the grid cells will not be rendered,\n * however the grid lines and alternating cells may still be.\n *\n * Also see the `setOutlineStyle` and `setAltFillStyle` methods.\n *\n * This call can be chained.\n *\n * @method Phaser.GameObjects.Grid#setFillStyle\n * @since 3.13.0\n *\n * @param {number} [fillColor] - The color the grid cells will be filled with, i.e. 0xff0000 for red.\n * @param {number} [fillAlpha=1] - The alpha the grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\n *\n * @return {this} This Game Object instance.\n */", "meta": { "filename": "Grid.js", "lineno": 164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "Sets the fill color and alpha level the grid cells will use when rendering.\n\nIf this method is called with no values then the grid cells will not be rendered,\nhowever the grid lines and alternating cells may still be.\n\nAlso see the `setOutlineStyle` and `setAltFillStyle` methods.\n\nThis call can be chained.", "kind": "function", "name": "setFillStyle", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "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, "defaultvalue": 1, "description": "The alpha the grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.", "name": "fillAlpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#setFillStyle", "scope": "instance", "overrides": "Phaser.GameObjects.Shape#setFillStyle", "___id": "T000002R014649", "___s": true }, { "comment": "/**\n * Sets the fill color and alpha level that the alternating grid cells will use.\n *\n * If this method is called with no values then alternating grid cells will not be rendered in a different color.\n *\n * Also see the `setOutlineStyle` and `setFillStyle` methods.\n *\n * This call can be chained.\n *\n * @method Phaser.GameObjects.Grid#setAltFillStyle\n * @since 3.13.0\n *\n * @param {number} [fillColor] - The color the alternating grid cells will be filled with, i.e. 0xff0000 for red.\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.\n *\n * @return {this} This Game Object instance.\n */", "meta": { "filename": "Grid.js", "lineno": 200, "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.\n\nIf this method is called with no values then alternating grid cells will not be rendered in a different color.\n\nAlso see the `setOutlineStyle` and `setFillStyle` methods.\n\nThis call can be chained.", "kind": "function", "name": "setAltFillStyle", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "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": "T000002R014656", "___s": true }, { "comment": "/**\n * Sets the fill color and alpha level that the lines between each grid cell will use.\n *\n * If this method is called with no values then the grid lines will not be rendered at all, however\n * the cells themselves may still be if they have colors set.\n *\n * Also see the `setFillStyle` and `setAltFillStyle` methods.\n *\n * This call can be chained.\n *\n * @method Phaser.GameObjects.Grid#setOutlineStyle\n * @since 3.13.0\n *\n * @param {number} [fillColor] - The color the lines between the grid cells will be filled with, i.e. 0xff0000 for red.\n * @param {number} [fillAlpha=1] - The alpha the lines between the grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\n *\n * @return {this} This Game Object instance.\n */", "meta": { "filename": "Grid.js", "lineno": 235, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "Sets the fill color and alpha level that the lines between each grid cell will use.\n\nIf this method is called with no values then the grid lines will not be rendered at all, however\nthe cells themselves may still be if they have colors set.\n\nAlso see the `setFillStyle` and `setAltFillStyle` methods.\n\nThis call can be chained.", "kind": "function", "name": "setOutlineStyle", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the lines between the grid cells will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The alpha the lines between the grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.", "name": "fillAlpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#setOutlineStyle", "scope": "instance", "___id": "T000002R014663", "___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": "T000002R014718", "___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 under-neath, 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 under-neath, 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": "T000002R014794", "___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": "T000002R014806", "___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": "T000002R014808", "___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": "T000002R014810", "___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": "T000002R014812", "___s": true }, { "comment": "/**\r\n * Controls if the top-face of the iso box 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 if the top-face of the iso box 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": "T000002R014814", "___s": true }, { "comment": "/**\r\n * Controls if the left-face of the iso box 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 if the left-face of the iso box 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": "T000002R014816", "___s": true }, { "comment": "/**\r\n * Controls if the right-face of the iso box 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 if the right-face of the iso box 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": "T000002R014818", "___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": "T000002R014821", "___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": "T000002R014824", "___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": "T000002R014832", "___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": "T000002R014851", "___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": "T000002R014912", "___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.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 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.IsoTriangle", "longname": "Phaser.GameObjects.IsoTriangle#projection", "scope": "instance", "kind": "member", "___id": "T000002R014925", "___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": "T000002R014927", "___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": "T000002R014929", "___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": "T000002R014931", "___s": true }, { "comment": "/**\r\n * Controls if the top-face of the iso triangle 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 if the top-face of the iso triangle 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": "T000002R014933", "___s": true }, { "comment": "/**\r\n * Controls if the left-face of the iso triangle 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 if the left-face of the iso triangle 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": "T000002R014935", "___s": true }, { "comment": "/**\r\n * Controls if the right-face of the iso triangle 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 if the right-face of the iso triangle 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": "T000002R014937", "___s": true }, { "comment": "/**\r\n * Sets if the iso triangle will be rendered upside down or not.\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": "Sets if the iso triangle will be rendered upside down or not.", "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": "T000002R014939", "___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": "T000002R014942", "___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 - Sets if the iso triangle will be rendered upside down or not.\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": "Sets if the iso triangle will be rendered upside down or not.", "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": "T000002R014945", "___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": "T000002R014948", "___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": "T000002R014956", "___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 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 * @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 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": "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": "T000002R014976", "___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": "T000002R015045", "___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": 70, "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": "T000002R015058", "___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": 111, "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": "T000002R015064", "___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": 139, "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": "T000002R015070", "___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": "T000002R015083", "___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 * @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.", "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": "T000002R015125", "___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": 80, "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": "T000002R015133", "___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 * 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": 104, "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 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\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": "T000002R015137", "___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": "T000002R015168", "___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": 12, "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": "T000002R015193", "___s": true }, { "comment": "/**\r\n * Sets the internal size of this Rectangle, as used for frame or physics body creation.\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\rectangle", "code": {} }, "description": "Sets the internal size of this Rectangle, as used for frame or physics body creation.\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": "T000002R015202", "___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": "T000002R015227", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Shape Game Object is a base class for the various different shapes, such as the Arc, Star or Polygon.\r\n * You cannot add a Shape directly to your Scene, it is meant as a base for your own custom Shape classes.\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.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "classdesc": "The Shape Game Object is a base class for the various different shapes, such as the Arc, Star or Polygon.\rYou cannot add a Shape directly to your Scene, it is meant as a base for your own custom Shape classes.", "kind": "class", "name": "Shape", "augments": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Components.AlphaSingle", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.GetBounds", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "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": "T000002R015257", "___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": 65, "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": "T000002R015263", "___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": 76, "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": "T000002R015265", "___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": 86, "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": "T000002R015267", "___s": true }, { "comment": "/**\r\n * The fill color used by this Shape.\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": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "The fill color used by this Shape.", "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": "T000002R015269", "___s": true }, { "comment": "/**\r\n * The fill alpha value used by this Shape.\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": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "The fill alpha value used by this Shape.", "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": "T000002R015271", "___s": true }, { "comment": "/**\r\n * The stroke color used by this Shape.\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": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "The stroke color used by this Shape.", "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": "T000002R015273", "___s": true }, { "comment": "/**\r\n * The stroke alpha value used by this Shape.\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": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "The stroke alpha value used by this Shape.", "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": "T000002R015275", "___s": true }, { "comment": "/**\r\n * The stroke line width used by this Shape.\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": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "The stroke line width used by this Shape.", "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": "T000002R015277", "___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": 141, "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": "T000002R015279", "___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": 151, "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": "T000002R015281", "___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": 161, "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": "T000002R015283", "___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": 182, "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": "T000002R015287", "___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": 195, "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": "T000002R015289", "___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": 212, "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": "T000002R015291", "___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": 247, "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": "T000002R015298", "___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": 284, "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": "T000002R015306", "___s": true }, { "comment": "/**\r\n * Sets the display size of this Shape.\r\n *\r\n * Calling this will adjust the scale.\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.\r\n * @param {number} height - The display height of this Shape.\r\n *\r\n * @return {this} This Shape instance.\r\n */", "meta": { "filename": "Shape.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "Sets the display size of this Shape.\r\rCalling this will adjust the scale.", "kind": "function", "name": "setDisplaySize", "since": "3.53.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display width of this Shape.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display height of this Shape.", "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": "T000002R015313", "___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": 353, "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": "T000002R015317", "___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": 368, "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": "T000002R015323", "___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": 393, "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": "T000002R015328", "___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.\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 */", "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.", "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" } ], "scope": "static", "longname": "Phaser.GameObjects.Star", "___id": "T000002R015338", "___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 amount 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 amount 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": "T000002R015354", "___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 amount to set the inner radius to.\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 amount to set the inner radius to.", "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": "T000002R015357", "___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 amount to set the outer radius to.\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 amount to set the outer radius to.", "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": "T000002R015360", "___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": "T000002R015363", "___s": true }, { "comment": "/**\r\n * The inner radius of the Star shape.\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.", "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": "T000002R015368", "___s": true }, { "comment": "/**\r\n * The outer radius of the Star shape.\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.", "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": "T000002R015373", "___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": "T000002R015414", "___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": "T000002R015462", "___s": true }, { "comment": "/**\r\n * Sets the data for the lines that make up this Triangle shape.\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 data for the lines that make up this Triangle shape.", "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": "T000002R015477", "___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": "T000002R015503", "___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.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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": 13, "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.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "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": "T000002R015540", "___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": 92, "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": "T000002R015547", "___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": 125, "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": "T000002R015551", "___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": 140, "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": "T000002R015553", "___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": 205, "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": "T000002R015555", "___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": 270, "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": "T000002R015557", "___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": 300, "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": "T000002R015559", "___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": 327, "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": "T000002R015561", "___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": 359, "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": "T000002R015563", "___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": 377, "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": "T000002R015565", "___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": 400, "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": "T000002R015567", "___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": 423, "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": "T000002R015569", "___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": 447, "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": "T000002R015571", "___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": "T000002R015585", "___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": "T000002R015593", "___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": "T000002R015605", "___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 */", "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" } ], "memberof": "Phaser.Types.GameObjects.Sprite", "longname": "Phaser.Types.GameObjects.Sprite.SpriteConfig", "scope": "static", "___id": "T000002R015606", "___s": true }, { "comment": "/**\r\n * Returns an object containing dimensions of the Text object.\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": "Returns an object containing dimensions of the Text object.", "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": "T000002R015607", "___s": true }, { "comment": "/**\r\n * Calculates the ascent, descent and fontSize of a given font style.\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 of a given font style.", "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": "T000002R015635", "___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 ready 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.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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": 18, "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 ready 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.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "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": "T000002R015697", "___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": 117, "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": "T000002R015704", "___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": "T000002R015706", "___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": "T000002R015708", "___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": "T000002R015711", "___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": "T000002R015713", "___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": "T000002R015715", "___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": "T000002R015719", "___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": "T000002R015725", "___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": "T000002R015727", "___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": "T000002R015729", "___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": "T000002R015731", "___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": 296, "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": "T000002R015740", "___s": true }, { "comment": "/**\r\n * Greedy wrapping algorithm that will wrap words as the line grows longer than its horizontal\r\n * bounds.\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": 328, "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.", "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": "T000002R015746", "___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": 371, "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": "T000002R015751", "___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": 493, "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": "T000002R015781", "___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": 563, "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": "T000002R015803", "___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": 585, "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": "T000002R015807", "___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": 619, "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": "T000002R015812", "___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": 660, "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": "T000002R015820", "___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": 684, "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": "T000002R015822", "___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.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#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": 720, "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.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": "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": "T000002R015824", "___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": 751, "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": "T000002R015826", "___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": 766, "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": "T000002R015828", "___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": 781, "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": "T000002R015830", "___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": 799, "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": "T000002R015832", "___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|any)} 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": 814, "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", "any" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "any" } ] } }, "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": "T000002R015834", "___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} color - The text fill color.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 834, "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "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": "T000002R015836", "___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} 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": 849, "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "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": "T000002R015838", "___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": 865, "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": "T000002R015840", "___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": 885, "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": "T000002R015842", "___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": 901, "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": "T000002R015844", "___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": 916, "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": "T000002R015846", "___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": 931, "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": "T000002R015848", "___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": 946, "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": "T000002R015850", "___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} 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": 961, "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" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "nullable": true, "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": "T000002R015852", "___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": 979, "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": "T000002R015854", "___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": 998, "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": "T000002R015856", "___s": true }, { "comment": "/**\r\n * Set the resolution used by this Text object.\r\n *\r\n * It allows for much clearer text on High DPI devices, at the cost of memory because it uses larger\r\n * internal Canvas textures for the Text.\r\n *\r\n * Therefore, please use with caution, as the more high res 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.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 1017, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the resolution used by this Text object.\r\rIt allows for much clearer text on High DPI devices, at the cost of memory because it uses larger\rinternal Canvas textures for the Text.\r\rTherefore, please use with caution, as the more high res Text you have, the more memory it uses.", "kind": "function", "name": "setResolution", "since": "3.12.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resolution for this Text object to use.", "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": "T000002R015858", "___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": 1037, "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": "T000002R015860", "___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.61.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": 1057, "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.61.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": "T000002R015863", "___s": true }, { "comment": "/**\r\n * Set the text padding.\r\n *\r\n * 'left' can be an object.\r\n *\r\n * If only 'left' and 'top' are given they are treated as 'x' and 'y'.\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": 1083, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the text padding.\r\r'left' can be an object.\r\rIf only 'left' and 'top' are given they are treated as 'x' and 'y'.", "kind": "function", "name": "setPadding", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "Phaser.Types.GameObjects.Text.TextPadding" ], "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": "T000002R015866", "___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": 1149, "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": "T000002R015887", "___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.61.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": 1164, "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.61.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": "T000002R015889", "___s": true }, { "comment": "/**\r\n * Update the displayed text.\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": 1213, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Update the displayed text.", "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": "T000002R015901", "___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": 1442, "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": "T000002R015965", "___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": 1455, "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": "T000002R015967", "___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": 1476, "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": "T000002R015971", "___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": 1507, "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": "T000002R015984", "___s": true }, { "comment": "/**\r\n * Creates a new Text Game Object and returns it.\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\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": "T000002R015994", "___s": true }, { "comment": "/**\r\n * Creates a new Text Game Object and adds it to the Scene.\r\n *\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 * 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 ready 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\rA 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\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 ready 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": "T000002R016006", "___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": "T000002R016046", "___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": "T000002R016049", "___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": "T000002R016051", "___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": "T000002R016053", "___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": "T000002R016055", "___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": "T000002R016057", "___s": true }, { "comment": "/**\r\n * The text fill color.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#color\r\n * @type {string}\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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "'#fff'", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#color", "scope": "instance", "kind": "member", "___id": "T000002R016059", "___s": true }, { "comment": "/**\r\n * The text stroke color.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#stroke\r\n * @type {string}\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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "'#fff'", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#stroke", "scope": "instance", "kind": "member", "___id": "T000002R016061", "___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": "T000002R016063", "___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": "T000002R016065", "___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": "T000002R016067", "___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": "T000002R016069", "___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": "T000002R016071", "___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": "T000002R016073", "___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": "T000002R016075", "___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": "T000002R016077", "___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": "T000002R016079", "___s": true }, { "comment": "/**\r\n * The fixed width of the text.\r\n *\r\n * `0` means no fixed with.\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 with.", "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": "T000002R016081", "___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": "T000002R016083", "___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": "T000002R016085", "___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": "T000002R016087", "___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": "T000002R016089", "___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": "T000002R016091", "___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": "T000002R016093", "___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": "T000002R016095", "___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": "T000002R016097", "___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": "T000002R016099", "___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": "T000002R016101", "___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 is 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 is 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": "T000002R016105", "___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": 456, "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": "T000002R016124", "___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": 470, "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": "T000002R016127", "___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": 491, "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": "T000002R016135", "___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": 518, "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": "T000002R016145", "___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": 540, "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": "T000002R016149", "___s": true }, { "comment": "/**\r\n * Set the font family.\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": 596, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the font family.", "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": "T000002R016166", "___s": true }, { "comment": "/**\r\n * Set the font 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": 618, "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": [ "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": "T000002R016169", "___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": 640, "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": "T000002R016172", "___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": 667, "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": "T000002R016176", "___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": 684, "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": "T000002R016179", "___s": true }, { "comment": "/**\r\n * Set the background color.\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": 715, "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": [ "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": "T000002R016185", "___s": true }, { "comment": "/**\r\n * Set the text fill color.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setFill\r\n * @since 3.0.0\r\n *\r\n * @param {string} color - The text fill color.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 732, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the text fill color.", "kind": "function", "name": "setFill", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "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": "T000002R016188", "___s": true }, { "comment": "/**\r\n * Set the text fill color.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setColor\r\n * @since 3.0.0\r\n *\r\n * @param {string} color - The text fill color.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 749, "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "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": "T000002R016191", "___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": 766, "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": "T000002R016194", "___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} 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": 788, "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "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": "T000002R016197", "___s": true }, { "comment": "/**\r\n * Set the shadow settings.\r\n *\r\n * Calling this method always re-measures 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": 821, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the shadow settings.\r\rCalling this method always re-measures 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": "T000002R016203", "___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": 858, "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": "T000002R016217", "___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": 880, "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": "T000002R016223", "___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": 899, "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": "T000002R016227", "___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": 918, "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": "T000002R016231", "___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": 935, "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": "T000002R016234", "___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} 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": 952, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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": "T000002R016237", "___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": 977, "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": "T000002R016242", "___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": 1003, "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": "T000002R016247", "___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": 1026, "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": "T000002R016251", "___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": 1045, "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": "T000002R016255", "___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": 1064, "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": "T000002R016261", "___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": 1086, "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": "T000002R016267", "___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": "T000002R016281", "___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": "T000002R016282", "___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": "T000002R016283", "___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": "T000002R016284", "___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": "T000002R016285", "___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": "T000002R016286", "___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 'strong'.\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} [color='#fff'] - The color the Text is drawn in. Given as a CSS string color such as `#fff` or `rgb()`.\r\n * @property {string} [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 */", "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 'strong'.", "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'#fff'", "description": "The color the Text is drawn in. Given as a CSS string color such as `#fff` or `rgb()`.", "name": "color" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'#fff'", "description": "The color used to stroke the Text if the `strokeThickness` property is greater than zero.", "name": "stroke" }, { "type": { "names": [ "number" ], "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" } ], "memberof": "Phaser.Types.GameObjects.Text", "longname": "Phaser.Types.GameObjects.Text.TextStyle", "scope": "static", "___id": "T000002R016287", "___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": "T000002R016288", "___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": "T000002R016289", "___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 * An important note about Tile Sprites and NPOT textures: Internally, TileSprite textures use GL_REPEAT to provide\r\n * seamless repeating of the textures. This, combined with the way in which the textures are handled in WebGL, means\r\n * they need to be POT (power-of-two) sizes in order to wrap. If you provide a NPOT (non power-of-two) texture to a\r\n * TileSprite it will generate a POT sized canvas and draw your texture to it, scaled up to the POT size. It's then\r\n * scaled back down again during rendering to the original dimensions. While this works, in that it allows you to use\r\n * any size texture for a Tile Sprite, it does mean that NPOT textures are going to appear anti-aliased when rendered,\r\n * due to the interpolation that took place when it was resized into a POT texture. This is especially visible in\r\n * pixel art graphics. If you notice it and it becomes an issue, the only way to avoid it is to ensure that you\r\n * provide POT textures for Tile Sprites.\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.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.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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 {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": 19, "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\rAn important note about Tile Sprites and NPOT textures: Internally, TileSprite textures use GL_REPEAT to provide\rseamless repeating of the textures. This, combined with the way in which the textures are handled in WebGL, means\rthey need to be POT (power-of-two) sizes in order to wrap. If you provide a NPOT (non power-of-two) texture to a\rTileSprite it will generate a POT sized canvas and draw your texture to it, scaled up to the POT size. It's then\rscaled back down again during rendering to the original dimensions. While this works, in that it allows you to use\rany size texture for a Tile Sprite, it does mean that NPOT textures are going to appear anti-aliased when rendered,\rdue to the interpolation that took place when it was resized into a POT texture. This is especially visible in\rpixel art graphics. If you notice it and it becomes an issue, the only way to avoid it is to ensure that you\rprovide POT textures for Tile Sprites.", "kind": "class", "name": "TileSprite", "augments": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Components.Alpha", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.ComputedSize", "Phaser.GameObjects.Components.Crop", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.Flip", "Phaser.GameObjects.Components.GetBounds", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "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": [ "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": "T000002R016299", "___s": true }, { "comment": "/**\r\n * Whether the Tile Sprite has changed in some way, requiring an 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 * @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": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "Whether the Tile Sprite has changed in some way, requiring an re-render of its tile texture.\r\rSuch changes include the texture frame and scroll position of the Tile Sprite.", "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": "T000002R016319", "___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": 163, "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": "T000002R016321", "___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": 172, "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": "T000002R016323", "___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": 182, "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" } }, "since": "3.12.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#context", "scope": "instance", "kind": "member", "___id": "T000002R016325", "___s": true }, { "comment": "/**\r\n * The Texture this Game Object is using to render with.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#texture\r\n * @type {Phaser.Textures.Texture|Phaser.Textures.CanvasTexture}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 222, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "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.TileSprite", "longname": "Phaser.GameObjects.TileSprite#texture", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Components.Crop#texture", "___id": "T000002R016334", "___s": true }, { "comment": "/**\r\n * The Texture Frame this Game Object is using to render with.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#frame\r\n * @type {Phaser.Textures.Frame}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 231, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "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.TileSprite", "longname": "Phaser.GameObjects.TileSprite#frame", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Components.Crop#frame", "___id": "T000002R016336", "___s": true }, { "comment": "/**\r\n * The next power of two value from the width of the Fill Pattern frame.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#potWidth\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 240, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "The next power of two value from the width of the Fill Pattern frame.", "name": "potWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#potWidth", "scope": "instance", "kind": "member", "___id": "T000002R016338", "___s": true }, { "comment": "/**\r\n * The next power of two value from the height of the Fill Pattern frame.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#potHeight\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 249, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "The next power of two value from the height of the Fill Pattern frame.", "name": "potHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#potHeight", "scope": "instance", "kind": "member", "___id": "T000002R016340", "___s": true }, { "comment": "/**\r\n * The Canvas that the TileSprites 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": 258, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "The Canvas that the TileSprites 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": "T000002R016342", "___s": true }, { "comment": "/**\r\n * The Canvas Context used to render the TileSprites 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": 268, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "The Canvas Context used to render the TileSprites 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": "T000002R016344", "___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 WebGLTexture. In Canvas it's a Canvas Fill Pattern.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#fillPattern\r\n * @type {?(WebGLTexture|CanvasPattern)}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 277, "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 WebGLTexture. In Canvas it's a Canvas Fill Pattern.", "name": "fillPattern", "type": { "names": [ "WebGLTexture", "CanvasPattern" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "WebGLTexture" }, { "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": "T000002R016347", "___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.TileSprite#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": "TileSprite.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "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.TileSprite", "longname": "Phaser.GameObjects.TileSprite#setTexture", "scope": "instance", "___id": "T000002R016349", "___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": 315, "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", "___id": "T000002R016352", "___s": true }, { "comment": "/**\r\n * Sets {@link Phaser.GameObjects.TileSprite#tilePositionX} and {@link Phaser.GameObjects.TileSprite#tilePositionY}.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "Sets {@link Phaser.GameObjects.TileSprite#tilePositionX} and {@link Phaser.GameObjects.TileSprite#tilePositionY}.", "kind": "function", "name": "setTilePosition", "since": "3.3.0", "params": [ { "type": { "names": [ "number" ], "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": "T000002R016362", "___s": true }, { "comment": "/**\r\n * Sets {@link Phaser.GameObjects.TileSprite#tileScaleX} and {@link Phaser.GameObjects.TileSprite#tileScaleY}.\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": 383, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "Sets {@link Phaser.GameObjects.TileSprite#tileScaleX} and {@link Phaser.GameObjects.TileSprite#tileScaleY}.", "kind": "function", "name": "setTileScale", "since": "3.12.0", "params": [ { "type": { "names": [ "number" ], "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": "T000002R016366", "___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": 535, "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": "T000002R016403", "___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": 564, "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": "T000002R016411", "___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": 587, "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": "T000002R016417", "___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": 610, "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": "T000002R016423", "___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": 633, "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": "T000002R016429", "___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": "T000002R016443", "___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": "T000002R016455", "___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": "T000002R016473", "___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": "T000002R016474", "___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": "T000002R016475", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Face\r\n * @since 3.50.0\r\n *\r\n * @property {Phaser.Types.GameObjects.Vertex} vertex1 - The first face vertex.\r\n * @property {Phaser.Types.GameObjects.Vertex} vertex2 - The second face vertex.\r\n * @property {Phaser.Types.GameObjects.Vertex} vertex3 - The third face vertex.\r\n * @property {boolean} isCounterClockwise - Are the vertices counter-clockwise?\r\n */", "meta": { "filename": "Face.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\typedefs", "code": {} }, "kind": "typedef", "name": "Face", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "Phaser.Types.GameObjects.Vertex" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Vertex" } }, "description": "The first face vertex.", "name": "vertex1" }, { "type": { "names": [ "Phaser.Types.GameObjects.Vertex" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Vertex" } }, "description": "The second face vertex.", "name": "vertex2" }, { "type": { "names": [ "Phaser.Types.GameObjects.Vertex" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Vertex" } }, "description": "The third face vertex.", "name": "vertex3" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Are the vertices counter-clockwise?", "name": "isCounterClockwise" } ], "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Face", "scope": "static", "___id": "T000002R016476", "___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": "T000002R016477", "___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} camera - The calculated Camera matrix.\r\n * @property {Phaser.GameObjects.Components.TransformMatrix} sprite - The calculated Sprite (Game Object) matrix.\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 matrix.", "name": "camera" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The calculated Sprite (Game Object) matrix.", "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": "T000002R016478", "___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": "T000002R016479", "___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": "T000002R016480", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Vertex\r\n * @since 3.50.0\r\n *\r\n * @property {number} x - The x coordinate of the vertex.\r\n * @property {number} y - The y coordinate of the vertex.\r\n * @property {number} z - The z coordinate of the vertex.\r\n * @property {number} normalX - The x normal of the vertex.\r\n * @property {number} normalY - The y normal of the vertex.\r\n * @property {number} normalZ - The z normal of the vertex.\r\n * @property {number} u - UV u texture coordinate of the vertex.\r\n * @property {number} v - UV v texture coordinate of the vertex.\r\n * @property {number} alpha - The alpha value of the vertex.\r\n */", "meta": { "filename": "Vertex.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\typedefs", "code": {} }, "kind": "typedef", "name": "Vertex", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the vertex.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the vertex.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The z coordinate of the vertex.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x normal of the vertex.", "name": "normalX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y normal of the vertex.", "name": "normalY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The z normal of the vertex.", "name": "normalZ" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u texture coordinate of the vertex.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v texture coordinate of the vertex.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha value of the vertex.", "name": "alpha" } ], "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Vertex", "scope": "static", "___id": "T000002R016481", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Update List plugin.\r\n *\r\n * Update Lists belong to a Scene and maintain the list Game Objects to be updated every frame.\r\n *\r\n * Some or all of these Game Objects may also be part of the Scene's [Display List]{@link Phaser.GameObjects.DisplayList}, for Rendering.\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 plugin.\r\rUpdate Lists belong to a Scene and maintain the list Game Objects to be updated every frame.\r\rSome or all of these Game Objects may also be part of the Scene's [Display List]{@link Phaser.GameObjects.DisplayList}, for Rendering.", "kind": "class", "name": "UpdateList", "augments": [ "Phaser.Structs.ProcessQueue." ], "memberof": "Phaser.GameObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene that the Update List belongs to.", "name": "scene" } ], "scope": "static", "longname": "Phaser.GameObjects.UpdateList", "___id": "T000002R016486", "___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": "T000002R016491", "___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": "T000002R016493", "___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": "T000002R016504", "___s": true }, { "comment": "/**\r\n * The Scene that owns this plugin is shutting down.\r\n *\r\n * We need to kill and reset all internal properties as well as 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 kill and reset all internal properties as well as stop listening to Scene events.", "kind": "function", "name": "shutdown", "since": "3.0.0", "memberof": "Phaser.GameObjects.UpdateList", "longname": "Phaser.GameObjects.UpdateList#shutdown", "scope": "instance", "___id": "T000002R016510", "___s": true }, { "comment": "/**\r\n * The Scene that owns this plugin is being destroyed.\r\n *\r\n * We need to shutdown and then kill off 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 shutdown and then kill off all external references.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.GameObjects.UpdateList", "longname": "Phaser.GameObjects.UpdateList#destroy", "scope": "instance", "___id": "T000002R016520", "___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": "T000002R016525", "___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": "T000002R016526", "___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 * 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 * Note that due to a bug in IE11 you cannot play a video texture to a Sprite in WebGL. For IE11 force Canvas mode.\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.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.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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} [key] - Optional key of the Video this Game Object will play, as stored in the Video Cache.\r\n */", "meta": { "filename": "Video.js", "lineno": 18, "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\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\rNote that due to a bug in IE11 you cannot play a video texture to a Sprite in WebGL. For IE11 force Canvas mode.\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.Depth", "Phaser.GameObjects.Components.Flip", "Phaser.GameObjects.Components.GetBounds", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "Phaser.GameObjects.Components.ScrollFactor", "Phaser.GameObjects.Components.Size", "Phaser.GameObjects.Components.TextureCrop", "Phaser.GameObjects.Components.Tint", "Phaser.GameObjects.Components.Transform", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.GameObjects", "since": "3.20.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "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": "T000002R016537", "___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": 148, "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": "T000002R016542", "___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": 159, "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": "T000002R016544", "___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": 170, "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": "T000002R016546", "___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": 181, "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": "T000002R016548", "___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. You often need to set this if you wish to use the video texture\r\n * as the input source for a shader. If you find your video is appearing upside down within a shader or\r\n * custom pipeline, flip this property.\r\n *\r\n * @name Phaser.GameObjects.Video#flipY\r\n * @type {boolean}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "Video.js", "lineno": 194, "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. You often need to set this if you wish to use the video texture\ras the input source for a shader. If you find your video is appearing upside down within a shader or\rcustom pipeline, flip this property.", "name": "flipY", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.20.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#flipY", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Components.Flip#flipY", "___id": "T000002R016550", "___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": 216, "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": "T000002R016554", "___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": 227, "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": "T000002R016556", "___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": 236, "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": "T000002R016558", "___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": 245, "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": "T000002R016560", "___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": 272, "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": "T000002R016562", "___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": 282, "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": "T000002R016564", "___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": 303, "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": "T000002R016566", "___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": 312, "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": "T000002R016568", "___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": 402, "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": "T000002R016592", "___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": 451, "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": "T000002R016602", "___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": 463, "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": "T000002R016604", "___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": 541, "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": "T000002R016616", "___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": 576, "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": "T000002R016620", "___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": 612, "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": "T000002R016624", "___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": 627, "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": "T000002R016626", "___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 {string} 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": 666, "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": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "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": "T000002R016631", "___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": 683, "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": "T000002R016633", "___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": 792, "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": "T000002R016650", "___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": 918, "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": "T000002R016674", "___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": 993, "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": "T000002R016686", "___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": 1010, "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": "T000002R016689", "___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": 1027, "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": "T000002R016692", "___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": 1051, "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": "T000002R016697", "___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": 1072, "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": "T000002R016702", "___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": 1122, "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": "T000002R016711", "___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": 1153, "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": "T000002R016714", "___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": 1184, "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": "T000002R016717", "___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}\r\n */", "meta": { "filename": "Video.js", "lineno": 1203, "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" } } } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#snapshot", "scope": "instance", "___id": "T000002R016719", "___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}\r\n */", "meta": { "filename": "Video.js", "lineno": 1226, "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" } } } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#snapshotArea", "scope": "instance", "___id": "T000002R016723", "___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": 1281, "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": "T000002R016735", "___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": 1329, "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": "T000002R016738", "___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": 1370, "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": "T000002R016744", "___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": 1407, "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": "T000002R016750", "___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": 1427, "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": "T000002R016753", "___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": 1441, "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": "T000002R016756", "___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 error Event.\r\n */", "meta": { "filename": "Video.js", "lineno": 1457, "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 error Event.", "name": "event" } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#stalledHandler", "scope": "instance", "___id": "T000002R016758", "___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": 1473, "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": "T000002R016761", "___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": 1521, "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": "T000002R016769", "___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": 1561, "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": "T000002R016774", "___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": 1578, "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": "T000002R016776", "___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": 1655, "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": "T000002R016790", "___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": 1686, "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": "T000002R016794", "___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": 1705, "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": "T000002R016796", "___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": 1731, "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": "T000002R016802", "___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": 1802, "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": "T000002R016815", "___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": 1856, "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": "T000002R016820", "___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": 1873, "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": "T000002R016822", "___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": 1890, "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": "T000002R016824", "___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": 1903, "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": "T000002R016826", "___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": 1927, "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": "T000002R016830", "___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": 1940, "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": "T000002R016832", "___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": 1962, "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": "T000002R016835", "___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": 1975, "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": "T000002R016837", "___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": 2003, "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": "T000002R016841", "___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": 2016, "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": "T000002R016843", "___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 set the\r\n * `flipY` parameter to `true` 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=false] - 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": 2029, "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 set the\r`flipY` parameter to `true` if you find the video renders upside down in your shader.", "kind": "function", "name": "saveTexture", "since": "3.20.0", "params": [ { "type": { "names": [ "string" ], "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": false, "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": "T000002R016845", "___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": 2096, "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": "T000002R016850", "___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": 2138, "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": "T000002R016856", "___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": "T000002R016872", "___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 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 * ### 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 * Note that due to a bug in IE11 you cannot play a video texture to a Sprite in WebGL. For IE11 force Canvas mode.\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 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\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\rNote that due to a bug in IE11 you cannot play a video texture to a Sprite in WebGL. For IE11 force Canvas mode.\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": "T000002R016879", "___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": "T000002R016891", "___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": "T000002R016892", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Zone Game Object.\r\n *\r\n * A Zone is a non-rendering rectangular Game Object that has a position and size.\r\n * It has no texture and never displays, but does live on the display list and\r\n * can be moved, scaled and rotated like any other Game Object.\r\n *\r\n * Its primary use is for creating Drop Zones and Input Hit Areas and it has a couple of helper methods\r\n * specifically for this. It is also useful for object overlap checks, or as a base for your own\r\n * non-displaying Game Objects.\r\n\r\n * The default origin is 0.5, the center of the Zone, the same as with 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 Game Object.\r\rA Zone is a non-rendering rectangular Game Object that has a position and size.\rIt has no texture and never displays, but does live on the display list and\rcan be moved, scaled and rotated like any other Game Object.\r\rIts primary use is for creating Drop Zones and Input Hit Areas and it has a couple of helper methods\rspecifically for this. It is also useful for object overlap checks, or as a base for your own\rnon-displaying Game Objects.\rThe default origin is 0.5, the center of the Zone, the same as with Game Objects.", "kind": "class", "name": "Zone", "augments": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.GetBounds", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.Transform", "Phaser.GameObjects.Components.ScrollFactor", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.GameObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "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": "T000002R016901", "___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": 73, "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": "T000002R016908", "___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": 82, "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": "T000002R016910", "___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": 91, "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": "T000002R016912", "___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": 105, "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": "T000002R016914", "___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": 127, "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": "T000002R016919", "___s": true }, { "comment": "/**\r\n * Sets the size of this Game Object.\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": 149, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone", "code": {} }, "description": "Sets the size of this Game Object.", "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": "T000002R016924", "___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": 181, "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": "T000002R016932", "___s": true }, { "comment": "/**\r\n * Sets this Zone to be a Circular Drop Zone.\r\n * The circle is centered on this Zones `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": 201, "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 Zones `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": "T000002R016936", "___s": true }, { "comment": "/**\r\n * Sets this Zone to be a Rectangle Drop Zone.\r\n * The rectangle is centered on this Zones `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": 217, "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 Zones `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": "T000002R016938", "___s": true }, { "comment": "/**\r\n * Allows you to define your own Geometry shape to be used as a Drop Zone.\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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone", "code": {} }, "description": "Allows you to define your own Geometry shape to be used as a Drop Zone.", "kind": "function", "name": "setDropZone", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "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": "T000002R016940", "___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": "T000002R016954", "___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": "T000002R016961", "___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": "T000002R016962", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Circle object.\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 * @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 object.\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.", "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": "T000002R016971", "___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": 41, "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": "T000002R016977", "___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": 52, "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": "T000002R016979", "___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": 62, "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": "T000002R016981", "___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": 93, "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": "T000002R016987", "___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.Geom.Point} 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.Geom.Point|object)} [out] - An object to store the return values in. If not given a Point object will be created.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} A Point, or point-like object, containing the coordinates of the point around the circle.\r\n */", "meta": { "filename": "Circle.js", "lineno": 109, "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.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An object to store the return values in. If not given a Point object will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A Point, or point-like object, containing the coordinates of the point around the circle." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#getPoint", "scope": "instance", "___id": "T000002R016989", "___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.Geom.Point[]} 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 circle and dividing it by the stepRate.\r\n * @param {(array|Phaser.Geom.Point[])} [output] - An array to insert the points in to. If not provided a new array will be created.\r\n *\r\n * @return {(array|Phaser.Geom.Point[])} An array of Point objects pertaining to the points around the circumference of the circle.\r\n */", "meta": { "filename": "Circle.js", "lineno": 129, "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.Geom.Point[]} O - [output,$return]", "value": "{Phaser.Geom.Point[]} 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 circle and dividing it by the stepRate.", "name": "stepRate" }, { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "description": "An array of Point objects pertaining to the points around the circumference of the circle." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#getPoints", "scope": "instance", "___id": "T000002R016991", "___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.Geom.Point} O - [point,$return]\r\n *\r\n * @param {(Phaser.Geom.Point|object)} [point] - A Point or point-like object to set the random `x` and `y` values in.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} A Point object with the random values set in the `x` and `y` properties.\r\n */", "meta": { "filename": "Circle.js", "lineno": 149, "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.Geom.Point} O - [point,$return]", "value": "{Phaser.Geom.Point} O - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "A Point or point-like object to set the random `x` and `y` values in.", "name": "point" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A Point object with the random values set in the `x` and `y` properties." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#getRandomPoint", "scope": "instance", "___id": "T000002R016993", "___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": 166, "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": "T000002R016995", "___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": 188, "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": "T000002R017001", "___s": true }, { "comment": "/**\r\n * Sets the position of this Circle.\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": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Sets the position of this Circle.", "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": "T000002R017005", "___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": 226, "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": "T000002R017010", "___s": true }, { "comment": "/**\r\n * The radius of the Circle.\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": 239, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "The radius of the Circle.", "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": "T000002R017012", "___s": true }, { "comment": "/**\r\n * The diameter of the Circle.\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": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "The diameter of the Circle.", "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": "T000002R017018", "___s": true }, { "comment": "/**\r\n * The left position of the Circle.\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": 283, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "The left position of the Circle.", "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": "T000002R017024", "___s": true }, { "comment": "/**\r\n * The right position of the Circle.\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": 304, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "The right position of the Circle.", "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": "T000002R017029", "___s": true }, { "comment": "/**\r\n * The top position of the Circle.\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": 325, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "The top position of the Circle.", "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": "T000002R017034", "___s": true }, { "comment": "/**\r\n * The bottom position of the Circle.\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": 346, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "The bottom position of the Circle.", "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": "T000002R017039", "___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": "T000002R017045", "___s": true }, { "comment": "/**\r\n * Returns a Point 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.Geom.Point} 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.Geom.Point|object)} [out] - A Point, or point-like object, to store the results in. If not given a Point will be created.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} A Point 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 Point object containing the coordinates of a point on the circumference of the Circle based on the given angle.", "kind": "function", "name": "CircumferencePoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "A Point, or point-like object, to store the results in. If not given a Point will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A Point object where the `x` and `y` properties are the point on the circumference." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.CircumferencePoint", "scope": "static", "___id": "T000002R017049", "___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": "T000002R017056", "___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": "T000002R017059", "___s": true }, { "comment": "/**\r\n * Check to see if the Circle contains the given Point object.\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.Geom.Point|object)} point - The Point object to check if it's within the Circle or not.\r\n *\r\n * @return {boolean} True if the Point 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 Point object.", "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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The Point object to check if it's within the Circle or not.", "name": "point" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Point coordinates are within the circle, otherwise false." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.ContainsPoint", "scope": "static", "___id": "T000002R017065", "___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": "T000002R017069", "___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": "T000002R017072", "___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": "T000002R017075", "___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 Circles 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 Circles bounds." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.GetBounds", "scope": "static", "___id": "T000002R017079", "___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 * @function Phaser.Geom.Circle.GetPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} 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.Geom.Point|object)} [out] - An object to store the return values in. If not given a Point object will be created.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} A Point, or point-like object, 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 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.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An object to store the return values in. If not given a Point object will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A Point, or point-like object, containing the coordinates of the point around the circle." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.GetPoint", "scope": "static", "___id": "T000002R017091", "___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 * @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 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 circle 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.Geom.Point[]} An array of Point 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 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", "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 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 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": "output" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } }, "description": "An array of Point objects pertaining to the points around the circumference of the circle." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.GetPoints", "scope": "static", "___id": "T000002R017100", "___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": "T000002R017124", "___s": true }, { "comment": "/**\r\n * Offsets the Circle by the values given in the `x` and `y` properties of the Point 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.Geom.Point|object)} point - The Point 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 Point 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The Point object containing the values to offset the Circle by.", "name": "point" } ], "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": "T000002R017129", "___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.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The Circle to get a random point from.\r\n * @param {(Phaser.Geom.Point|object)} [out] - A Point or point-like object to set the random `x` and `y` values in.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} A Point 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.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "A Point or point-like object to set the random `x` and `y` values in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A Point object with the random values set in the `x` and `y` properties." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.Random", "scope": "static", "___id": "T000002R017135", "___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": "T000002R017147", "___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": "T000002R017149", "___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": "T000002R017151", "___s": true }, { "comment": "/**\r\n * A Point Geometry object type.\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.", "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": "T000002R017153", "___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": 45, "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": "T000002R017155", "___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": 54, "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": "T000002R017157", "___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": 63, "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": "T000002R017159", "___s": true }, { "comment": "/**\r\n * Calculates the area of the Ellipse.\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.\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 Ellipse.", "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." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.Area", "scope": "static", "___id": "T000002R017162", "___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 th 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 th Ellipse." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.Circumference", "scope": "static", "___id": "T000002R017165", "___s": true }, { "comment": "/**\r\n * Returns a Point object 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.Geom.Point} 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.Geom.Point|object)} [out] - A Point, or point-like object, to store the results in. If not given a Point will be created.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} A Point 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 Point object containing the coordinates of a point on the circumference of the Ellipse based on the given angle.", "kind": "function", "name": "CircumferencePoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "A Point, or point-like object, to store the results in. If not given a Point will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A Point object where the `x` and `y` properties are the point on the circumference." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.CircumferencePoint", "scope": "static", "___id": "T000002R017172", "___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 a 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 a 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": "T000002R017181", "___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": "T000002R017184", "___s": true }, { "comment": "/**\r\n * Check to see if the Ellipse contains the given Point object.\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.Geom.Point|object)} point - The Point object to check if it's within the Circle or not.\r\n *\r\n * @return {boolean} True if the Point coordinates are within the circle, 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 Point object.", "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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The Point object to check if it's within the Circle or not.", "name": "point" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Point coordinates are within the circle, otherwise false." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.ContainsPoint", "scope": "static", "___id": "T000002R017192", "___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": "T000002R017196", "___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": "T000002R017199", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * An Ellipse object.\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\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": "T000002R017208", "___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": 43, "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": "T000002R017215", "___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": 54, "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": "T000002R017217", "___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": 64, "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": "T000002R017219", "___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": 74, "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": "T000002R017221", "___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": 84, "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": "T000002R017223", "___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": 95, "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": "T000002R017225", "___s": true }, { "comment": "/**\r\n * Returns a Point 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 circle.\r\n *\r\n * @method Phaser.Geom.Ellipse#getPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} 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.Geom.Point|object)} [out] - An object to store the return values in. If not given a Point object will be created.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} A Point, or point-like object, containing the coordinates of the point around the ellipse.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 111, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Returns a Point 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 circle.", "kind": "function", "name": "getPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An object to store the return values in. If not given a Point object will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A Point, or point-like object, containing the coordinates of the point around the ellipse." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#getPoint", "scope": "instance", "___id": "T000002R017227", "___s": true }, { "comment": "/**\r\n * Returns an array of Point 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.Geom.Point[]} 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 {(array|Phaser.Geom.Point[])} [output] - An array to insert the points in to. If not provided a new array will be created.\r\n *\r\n * @return {(array|Phaser.Geom.Point[])} An array of Point objects pertaining to the points around the circumference of the ellipse.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 131, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Returns an array of Point 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.Geom.Point[]} O - [output,$return]", "value": "{Phaser.Geom.Point[]} 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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "description": "An array of Point objects pertaining to the points around the circumference of the ellipse." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#getPoints", "scope": "instance", "___id": "T000002R017229", "___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.Geom.Point} O - [point,$return]\r\n *\r\n * @param {(Phaser.Geom.Point|object)} [point] - A Point or point-like object to set the random `x` and `y` values in.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} A Point object with the random values set in the `x` and `y` properties.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 151, "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.Geom.Point} O - [point,$return]", "value": "{Phaser.Geom.Point} O - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "A Point or point-like object to set the random `x` and `y` values in.", "name": "point" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A Point object with the random values set in the `x` and `y` properties." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#getRandomPoint", "scope": "instance", "___id": "T000002R017231", "___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": 168, "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": "T000002R017233", "___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": 191, "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": "T000002R017239", "___s": true }, { "comment": "/**\r\n * Sets the position of this Ellipse.\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": 208, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Sets the position of this Ellipse.", "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": "T000002R017243", "___s": true }, { "comment": "/**\r\n * Sets the size of this Ellipse.\r\n * Does not change its position.\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": 229, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Sets the size of this Ellipse.\rDoes not change its position.", "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": "T000002R017248", "___s": true }, { "comment": "/**\r\n * Checks to see if the Ellipse is empty: has a width or height equal to zero.\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": 251, "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 equal to zero.", "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": "T000002R017253", "___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": 264, "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": "T000002R017255", "___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": 277, "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": "T000002R017257", "___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": 290, "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": "T000002R017259", "___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": 311, "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": "T000002R017264", "___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": 332, "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": "T000002R017269", "___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": 353, "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": "T000002R017274", "___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": "T000002R017280", "___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": "T000002R017284", "___s": true }, { "comment": "/**\r\n * Returns a Point 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 circle.\r\n *\r\n * @function Phaser.Geom.Ellipse.GetPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} 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 around the ellipse.\r\n * @param {(Phaser.Geom.Point|object)} [out] - An object to store the return values in. If not given a Point object will be created.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} A Point, or point-like 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 Point 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 circle.", "kind": "function", "name": "GetPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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 around the ellipse.", "name": "position" }, { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An object to store the return values in. If not given a Point object will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A Point, or point-like object, containing the coordinates of the point around the ellipse." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.GetPoint", "scope": "static", "___id": "T000002R017296", "___s": true }, { "comment": "/**\r\n * Returns an array of Point 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.Geom.Point[]} 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 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 {(array|Phaser.Geom.Point[])} [out] - An array to insert the points in to. If not provided a new array will be created.\r\n *\r\n * @return {(array|Phaser.Geom.Point[])} An array of Point 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 Point 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.Geom.Point[]} O - [out,$return]", "value": "{Phaser.Geom.Point[]} 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 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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An array to insert the points in to. If not provided a new array will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "description": "An array of Point objects pertaining to the points around the circumference of the ellipse." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.GetPoints", "scope": "static", "___id": "T000002R017305", "___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": "T000002R017329", "___s": true }, { "comment": "/**\r\n * Offsets the Ellipse by the values given in the `x` and `y` properties of the Point 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.Geom.Point|object)} point - The Point 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 Point 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The Point object containing the values to offset the Ellipse by.", "name": "point" } ], "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": "T000002R017334", "___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.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to get a random point from.\r\n * @param {(Phaser.Geom.Point|object)} [out] - A Point or point-like object to set the random `x` and `y` values in.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} A Point 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.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "A Point or point-like object to set the random `x` and `y` values in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A Point object with the random values set in the `x` and `y` properties." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.Random", "scope": "static", "___id": "T000002R017340", "___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": "T000002R017350", "___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": "T000002R017364", "___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": "T000002R017367", "___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 {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": "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": "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.GetCircleToCircle", "scope": "static", "___id": "T000002R017383", "___s": true }, { "comment": "/**\r\n * Checks for intersection between a circle and a rectangle,\r\n * and returns the intersection points as a Point object 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,\rand returns the intersection points as a Point object 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": "T000002R017414", "___s": true }, { "comment": "/**\r\n * Checks for intersection between the line segment and circle,\r\n * and returns the intersection points as a Point 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 {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": "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 Point 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": "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.GetLineToCircle", "scope": "static", "___id": "T000002R017424", "___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 intersection distance, which can be used to find\r\n * 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 containing the intersection results, or `null`.\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 intersection distance, which can be used to find\rthe 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 containing the intersection results, or `null`." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.GetLineToLine", "scope": "static", "___id": "T000002R017455", "___s": true }, { "comment": "/**\r\n * Checks for the closest point of intersection between a line segment and an array of points, where each pair\r\n * of points are converted to line segments for the intersection tests.\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.Geom.Point[]} 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 pair\rof points are converted to line segments for the intersection tests.\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.Geom.Point", "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": "T000002R017487", "___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": "T000002R017502", "___s": true }, { "comment": "/**\r\n * Checks for intersection between the Line and a Rectangle shape,\r\n * and returns the intersection points as a Point object 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|object)} rect - The 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": "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 Point object 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", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The Rectangle to check for intersection.", "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.GetLineToRectangle", "scope": "static", "___id": "T000002R017513", "___s": true }, { "comment": "/**\r\n * Projects rays out from the given point to each line segment 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 intersection.\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 line segment 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 intersection.\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": "T000002R017533", "___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 wil 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 wil 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": "T000002R017545", "___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": "T000002R017555", "___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": "T000002R017565", "___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": "T000002R017574", "___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 {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": "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": "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.GetTriangleToLine", "scope": "static", "___id": "T000002R017584", "___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": "T000002R017596", "___s": true }, { "comment": "/**\n * @namespace Phaser.Geom.Intersects\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": "T000002R017603", "___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.Geom.Point|any)} [nearest] - An optional Point-like 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.Geom.Point", "any" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "any" } ] } }, "optional": true, "description": "An optional Point-like object. If given the closest point on the Line where the circle intersects will be stored in this object.", "name": "nearest" } ], "returns": [ { "type": { "names": [ "boolean" ], "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": "T000002R017635", "___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": "T000002R017656", "___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 * The 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\rThe for 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": "T000002R017672", "___s": true }, { "comment": "/**\r\n * Checks if the 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.Geom.Point|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 the 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.Geom.Point", "any" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "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": "T000002R017688", "___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.Geom.Point} 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.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "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": "T000002R017702", "___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": "T000002R017709", "___s": true }, { "comment": "/**\r\n * Checks for intersection between Rectangle shape and Triangle shape.\r\n *\r\n * @function Phaser.Geom.Intersects.RectangleToTriangle\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 *\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 Rectangle shape and Triangle shape.", "kind": "function", "name": "RectangleToTriangle", "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" } ], "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": "T000002R017716", "___s": true }, { "comment": "/**\r\n * Check if rectangle intersects with 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 object\r\n * @param {number} left - The x coordinate of the left of the Rectangle.\r\n * @param {number} right - The x coordinate of the right of the Rectangle.\r\n * @param {number} top - The y coordinate of the top of the Rectangle.\r\n * @param {number} bottom - The y coordinate of the bottom of the Rectangle.\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": "Check if rectangle intersects with 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 object", "name": "rect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the left of the Rectangle.", "name": "left" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the right of the Rectangle.", "name": "right" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the top of the Rectangle.", "name": "top" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the bottom of the Rectangle.", "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": "T000002R017728", "___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": "T000002R017734", "___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": "T000002R017738", "___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": "T000002R017744", "___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": "T000002R017757", "___s": true }, { "comment": "/**\r\n * Using Bresenham's line algorithm this will return an array of all coordinates on this 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] - The optional step rate for the points on the line.\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 this 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": "The optional step rate for the points on the line.", "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": "T000002R017760", "___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": "T000002R017784", "___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": "T000002R017794", "___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": "T000002R017797", "___s": true }, { "comment": "/**\r\n * Compare two lines for strict equality.\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} Whether the two lines are equal.\r\n */", "meta": { "filename": "Equals.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Compare two lines for strict equality.", "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": "Whether the two lines are equal." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.Equals", "scope": "static", "___id": "T000002R017800", "___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 points 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 * @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 points 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.", "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": "T000002R017804", "___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.Geom.Point[]} 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 noisey eases.\r\n * @param {number[]} [easeParams] - An optional array of ease parameters to go with the ease.\r\n *\r\n * @return {Phaser.Geom.Point[]} An array of Geom.Points 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.Geom.Point[]} O - [out,$return]", "value": "{Phaser.Geom.Point[]} 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 noisey 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.Geom.Point", "type": "NameExpression" } ] } }, "description": "An array of Geom.Points containing the coordinates of the points on the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.GetEasedPoints", "scope": "static", "___id": "T000002R017818", "___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.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to get the midpoint of.\r\n * @param {(Phaser.Geom.Point|object)} [out] - An optional point object to store the midpoint in.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} 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.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An optional point object to store the midpoint in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The midpoint of the Line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.GetMidPoint", "scope": "static", "___id": "T000002R017842", "___s": true }, { "comment": "/**\r\n * Get the nearest point on a line perpendicular to the given point.\r\n *\r\n * @function Phaser.Geom.Line.GetNearestPoint\r\n * @since 3.16.0\r\n *\r\n * @generic {Phaser.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to get the nearest point on.\r\n * @param {(Phaser.Geom.Point|object)} point - The point to get the nearest point to.\r\n * @param {(Phaser.Geom.Point|object)} [out] - An optional point, or point-like object, to store the coordinates of the nearest point on the line.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} 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": "Get the nearest point on a line perpendicular to the given point.", "kind": "function", "name": "GetNearestPoint", "since": "3.16.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The point to get the nearest point to.", "name": "point" }, { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An optional point, or point-like object, to store the coordinates of the nearest point on the line.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The nearest point on the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.GetNearestPoint", "scope": "static", "___id": "T000002R017849", "___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.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to calculate the normal of.\r\n * @param {(Phaser.Geom.Point|object)} [out] - An optional point object to store the normal in.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} 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.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An optional point object to store the normal in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The normal of the Line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.GetNormal", "scope": "static", "___id": "T000002R017864", "___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.Geom.Point} 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.Geom.Point|object)} [out] - An optional point, or point-like object, to store the coordinates of the point on the line.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} 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.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An optional point, or point-like object, to store the coordinates of the point on the line.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The point on the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.GetPoint", "scope": "static", "___id": "T000002R017872", "___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 * @function Phaser.Geom.Line.GetPoints\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point[]} 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 implied and should be set to `0`.\r\n * @param {(array|Phaser.Geom.Point[])} [out] - An optional array of Points, or point-like objects, to store the coordinates of the points on the line.\r\n *\r\n * @return {(array|Phaser.Geom.Point[])} An array of Points, or point-like 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 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.Geom.Point[]} O - [out,$return]", "value": "{Phaser.Geom.Point[]} 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 implied and should be set to `0`.", "name": "stepRate" }, { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An optional array of Points, or point-like objects, to store the coordinates of the points on the line.", "name": "out" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "description": "An array of Points, or point-like objects, containing the coordinates of the points on the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.GetPoints", "scope": "static", "___id": "T000002R017880", "___s": true }, { "comment": "/**\r\n * Get the shortest distance from a Line to the given Point.\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 distance from the line to the point, or `false`.\r\n */", "meta": { "filename": "GetShortestDistance.js", "lineno": 8, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Get the shortest distance from a Line to the given Point.", "kind": "function", "name": "GetShortestDistance", "since": "3.16.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "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 distance from the line to the point, or `false`." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.GetShortestDistance", "scope": "static", "___id": "T000002R017893", "___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": "T000002R017902", "___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": "T000002R017936", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Defines a Line segment, a part of a line between two endpoints.\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 lines starting point.\r\n * @param {number} [y1=0] - The y coordinate of the lines starting point.\r\n * @param {number} [x2=0] - The x coordinate of the lines ending point.\r\n * @param {number} [y2=0] - The y coordinate of the lines 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 part of a line between two endpoints.", "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 lines starting point.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the lines starting point.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of the lines ending point.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the lines ending point.", "name": "y2" } ], "scope": "static", "longname": "Phaser.Geom.Line", "___id": "T000002R017945", "___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": 39, "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": "T000002R017952", "___s": true }, { "comment": "/**\r\n * The x coordinate of the lines 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": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The x coordinate of the lines 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": "T000002R017954", "___s": true }, { "comment": "/**\r\n * The y coordinate of the lines 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": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The y coordinate of the lines 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": "T000002R017956", "___s": true }, { "comment": "/**\r\n * The x coordinate of the lines 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": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The x coordinate of the lines 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": "T000002R017958", "___s": true }, { "comment": "/**\r\n * The y coordinate of the lines 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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The y coordinate of the lines 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": "T000002R017960", "___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.Geom.Point} 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.Geom.Point|object)} [output] - An optional point, or point-like object, to store the coordinates of the point on the line.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} A Point, or point-like object, containing the coordinates of the point on the line.\r\n */", "meta": { "filename": "Line.js", "lineno": 87, "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.Geom.Point} O - [output,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An optional point, or point-like object, to store the coordinates of the point on the line.", "name": "output" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A Point, or point-like object, containing the coordinates of the point on the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#getPoint", "scope": "instance", "___id": "T000002R017962", "___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.Geom.Point[]} 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 {(array|Phaser.Geom.Point[])} [output] - An optional array of Points, or point-like objects, to store the coordinates of the points on the line.\r\n *\r\n * @return {(array|Phaser.Geom.Point[])} An array of Points, or point-like objects, containing the coordinates of the points on the line.\r\n */", "meta": { "filename": "Line.js", "lineno": 105, "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.Geom.Point[]} O - [output,$return]", "value": "{Phaser.Geom.Point[]} 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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An optional array of Points, or point-like objects, to store the coordinates of the points on the line.", "name": "output" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "description": "An array of Points, or point-like objects, containing the coordinates of the points on the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#getPoints", "scope": "instance", "___id": "T000002R017964", "___s": true }, { "comment": "/**\r\n * Get a random Point on the Line.\r\n *\r\n * @method Phaser.Geom.Line#getRandomPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} O - [point,$return]\r\n *\r\n * @param {(Phaser.Geom.Point|object)} [point] - An instance of a Point to be modified.\r\n *\r\n * @return {Phaser.Geom.Point} A random Point on the Line.\r\n */", "meta": { "filename": "Line.js", "lineno": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Get a random Point on the Line.", "kind": "function", "name": "getRandomPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [point,$return]", "value": "{Phaser.Geom.Point} O - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An instance of a Point to be modified.", "name": "point" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "A random Point on the Line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#getRandomPoint", "scope": "instance", "___id": "T000002R017966", "___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 lines starting point.\r\n * @param {number} [y1=0] - The y coordinate of the lines starting point.\r\n * @param {number} [x2=0] - The x coordinate of the lines ending point.\r\n * @param {number} [y2=0] - The y coordinate of the lines ending point.\r\n *\r\n * @return {this} This Line object.\r\n */", "meta": { "filename": "Line.js", "lineno": 146, "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 lines starting point.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the lines starting point.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of the lines ending point.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the lines 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": "T000002R017968", "___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": 175, "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": "T000002R017978", "___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": 196, "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": "T000002R017981", "___s": true }, { "comment": "/**\r\n * The left position of the Line.\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": 217, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The left position of the Line.", "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": "T000002R017984", "___s": true }, { "comment": "/**\r\n * The right position of the Line.\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": 245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The right position of the Line.", "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": "T000002R017990", "___s": true }, { "comment": "/**\r\n * The top position of the Line.\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": 273, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The top position of the Line.", "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": "T000002R017996", "___s": true }, { "comment": "/**\r\n * The bottom position of the Line.\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": 301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The bottom position of the Line.", "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": "T000002R018002", "___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": "T000002R018012", "___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": "T000002R018018", "___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": "T000002R018023", "___s": true }, { "comment": "/**\r\n * Offset a line by the given amount.\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 offset line.\r\n */", "meta": { "filename": "Offset.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Offset a line by the given amount.", "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 offset line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.Offset", "scope": "static", "___id": "T000002R018026", "___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": "T000002R018033", "___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.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Line} line - The Line to calculate the random Point on.\r\n * @param {(Phaser.Geom.Point|object)} [out] - An instance of a Point to be modified.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} A random Point on the Line.\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.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An instance of a Point to be modified.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A random Point on the Line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.Random", "scope": "static", "___id": "T000002R018037", "___s": true }, { "comment": "/**\r\n * Calculate the reflected angle between two lines.\r\n *\r\n * This is the outgoing angle based on the angle of Line 1 and the normalAngle of Line 2.\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 first line.\r\n * @param {Phaser.Geom.Line} lineB - The second line.\r\n *\r\n * @return {number} The reflected angle between each line.\r\n */", "meta": { "filename": "ReflectAngle.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Calculate the reflected angle between two lines.\r\rThis is the outgoing angle based on the angle of Line 1 and the normalAngle of Line 2.", "kind": "function", "name": "ReflectAngle", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The first line.", "name": "lineA" }, { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The second line.", "name": "lineB" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The reflected angle between each line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.ReflectAngle", "scope": "static", "___id": "T000002R018046", "___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": "T000002R018050", "___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.Geom.Point|object)} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "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": "T000002R018056", "___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": "T000002R018059", "___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": "T000002R018072", "___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": "T000002R018079", "___s": true }, { "comment": "/**\r\n * Calculate the width of the given line.\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.\r\n */", "meta": { "filename": "Width.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Calculate the width of the given line.", "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." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.Width", "scope": "static", "___id": "T000002R018082", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Face Geometry Object.\r\n *\r\n * A Face is used by the Mesh Game Object. A Mesh consists of one, or more, faces that are\r\n * used to render the Mesh Game Objects in WebGL.\r\n *\r\n * A Face consists of 3 Vertex instances, for the 3 corners of the face and methods to help\r\n * you modify and test them.\r\n *\r\n * @class Face\r\n * @memberof Phaser.Geom.Mesh\r\n * @constructor\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Geom.Mesh.Vertex} vertex1 - The first vertex of the Face.\r\n * @param {Phaser.Geom.Mesh.Vertex} vertex2 - The second vertex of the Face.\r\n * @param {Phaser.Geom.Mesh.Vertex} vertex3 - The third vertex of the Face.\r\n */", "meta": { "filename": "Face.js", "lineno": 33, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "classdesc": "A Face Geometry Object.\r\rA Face is used by the Mesh Game Object. A Mesh consists of one, or more, faces that are\rused to render the Mesh Game Objects in WebGL.\r\rA Face consists of 3 Vertex instances, for the 3 corners of the face and methods to help\ryou modify and test them.", "kind": "class", "name": "Face", "memberof": "Phaser.Geom.Mesh", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Geom.Mesh.Vertex" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Vertex" } }, "description": "The first vertex of the Face.", "name": "vertex1" }, { "type": { "names": [ "Phaser.Geom.Mesh.Vertex" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Vertex" } }, "description": "The second vertex of the Face.", "name": "vertex2" }, { "type": { "names": [ "Phaser.Geom.Mesh.Vertex" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Vertex" } }, "description": "The third vertex of the Face.", "name": "vertex3" } ], "scope": "static", "longname": "Phaser.Geom.Mesh.Face", "___id": "T000002R018092", "___s": true }, { "comment": "/**\r\n * The first vertex in this Face.\r\n *\r\n * @name Phaser.Geom.Mesh.Face#vertex1\r\n * @type {Phaser.Geom.Mesh.Vertex}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Face.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The first vertex in this Face.", "name": "vertex1", "type": { "names": [ "Phaser.Geom.Mesh.Vertex" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Vertex" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#vertex1", "scope": "instance", "kind": "member", "___id": "T000002R018095", "___s": true }, { "comment": "/**\r\n * The second vertex in this Face.\r\n *\r\n * @name Phaser.Geom.Mesh.Face#vertex2\r\n * @type {Phaser.Geom.Mesh.Vertex}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Face.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The second vertex in this Face.", "name": "vertex2", "type": { "names": [ "Phaser.Geom.Mesh.Vertex" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Vertex" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#vertex2", "scope": "instance", "kind": "member", "___id": "T000002R018097", "___s": true }, { "comment": "/**\r\n * The third vertex in this Face.\r\n *\r\n * @name Phaser.Geom.Mesh.Face#vertex3\r\n * @type {Phaser.Geom.Mesh.Vertex}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Face.js", "lineno": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The third vertex in this Face.", "name": "vertex3", "type": { "names": [ "Phaser.Geom.Mesh.Vertex" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Vertex" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#vertex3", "scope": "instance", "kind": "member", "___id": "T000002R018099", "___s": true }, { "comment": "/**\r\n * The bounds of this Face.\r\n *\r\n * Be sure to call the `Face.updateBounds` method _before_ using this property.\r\n *\r\n * @name Phaser.Geom.Mesh.Face#bounds\r\n * @type {Phaser.Geom.Rectangle}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Face.js", "lineno": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The bounds of this Face.\r\rBe sure to call the `Face.updateBounds` method _before_ using this property.", "name": "bounds", "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#bounds", "scope": "instance", "kind": "member", "___id": "T000002R018101", "___s": true }, { "comment": "/**\r\n * Calculates and returns the in-center position of this Face.\r\n *\r\n * @method Phaser.Geom.Mesh.Face#getInCenter\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [local=true] Return the in center from the un-transformed vertex positions (`true`), or transformed? (`false`)\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 containing the in center position of this Face.\r\n */", "meta": { "filename": "Face.js", "lineno": 107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Calculates and returns the in-center position of this Face.", "kind": "function", "name": "getInCenter", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Return the in center from the un-transformed vertex positions (`true`), or transformed? (`false`)", "name": "local" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 containing the in center position of this Face." } ], "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#getInCenter", "scope": "instance", "___id": "T000002R018105", "___s": true }, { "comment": "/**\r\n * Checks if the given coordinates are within this Face.\r\n *\r\n * You can optionally provide a transform matrix. If given, the Face vertices\r\n * will be transformed first, before being checked against the coordinates.\r\n *\r\n * @method Phaser.Geom.Mesh.Face#contains\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The horizontal position to check.\r\n * @param {number} y - The vertical position to check.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [calcMatrix] - Optional transform matrix to apply to the vertices before comparison.\r\n *\r\n * @return {boolean} `true` if the coordinates lay within this Face, otherwise `false`.\r\n */", "meta": { "filename": "Face.js", "lineno": 169, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Checks if the given coordinates are within this Face.\r\rYou can optionally provide a transform matrix. If given, the Face vertices\rwill be transformed first, before being checked against the coordinates.", "kind": "function", "name": "contains", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position to check.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position to check.", "name": "y" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "Optional transform matrix to apply to the vertices before comparison.", "name": "calcMatrix" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the coordinates lay within this Face, otherwise `false`." } ], "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#contains", "scope": "instance", "___id": "T000002R018133", "___s": true }, { "comment": "/**\r\n * Checks if the vertices in this Face are orientated counter-clockwise, or not.\r\n *\r\n * It checks the transformed position of the vertices, not the local one.\r\n *\r\n * @method Phaser.Geom.Mesh.Face#isCounterClockwise\r\n * @since 3.50.0\r\n *\r\n * @param {number} z - The z-axis value to test against. Typically the `Mesh.modelPosition.z`.\r\n *\r\n * @return {boolean} `true` if the vertices in this Face run counter-clockwise, otherwise `false`.\r\n */", "meta": { "filename": "Face.js", "lineno": 242, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Checks if the vertices in this Face are orientated counter-clockwise, or not.\r\rIt checks the transformed position of the vertices, not the local one.", "kind": "function", "name": "isCounterClockwise", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The z-axis value to test against. Typically the `Mesh.modelPosition.z`.", "name": "z" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertices in this Face run counter-clockwise, otherwise `false`." } ], "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#isCounterClockwise", "scope": "instance", "___id": "T000002R018171", "___s": true }, { "comment": "/**\r\n * Loads the data from this Vertex into the given Typed Arrays.\r\n *\r\n * @method Phaser.Geom.Mesh.Face#load\r\n * @since 3.50.0\r\n *\r\n * @param {Float32Array} F32 - A Float32 Array to insert the position, UV and unit data in to.\r\n * @param {Uint32Array} U32 - A Uint32 Array to insert the color and alpha data in to.\r\n * @param {number} offset - The index of the array to insert this Vertex to.\r\n * @param {number} textureUnit - The texture unit currently in use.\r\n * @param {number} tintEffect - The tint effect to use.\r\n *\r\n * @return {number} The new vertex index array offset.\r\n */", "meta": { "filename": "Face.js", "lineno": 265, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Loads the data from this Vertex into the given Typed Arrays.", "kind": "function", "name": "load", "since": "3.50.0", "params": [ { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "A Float32 Array to insert the position, UV and unit data in to.", "name": "F32" }, { "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "description": "A Uint32 Array to insert the color and alpha data in to.", "name": "U32" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the array to insert this Vertex to.", "name": "offset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit currently in use.", "name": "textureUnit" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint effect to use.", "name": "tintEffect" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new vertex index array offset." } ], "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#load", "scope": "instance", "___id": "T000002R018177", "___s": true }, { "comment": "/**\r\n * Transforms all Face vertices by the given matrix, storing the results in their `vx`, `vy` and `vz` properties.\r\n *\r\n * @method Phaser.Geom.Mesh.Face#transformCoordinatesLocal\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} transformMatrix - The transform matrix to apply to this vertex.\r\n * @param {number} width - The width of the parent Mesh.\r\n * @param {number} height - The height of the parent Mesh.\r\n * @param {number} cameraZ - The z position of the MeshCamera.\r\n *\r\n * @return {this} This Face instance.\r\n */", "meta": { "filename": "Face.js", "lineno": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Transforms all Face vertices by the given matrix, storing the results in their `vx`, `vy` and `vz` properties.", "kind": "function", "name": "transformCoordinatesLocal", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The transform matrix to apply to this vertex.", "name": "transformMatrix" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the parent Mesh.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the parent Mesh.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The z position of the MeshCamera.", "name": "cameraZ" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Face instance." } ], "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#transformCoordinatesLocal", "scope": "instance", "___id": "T000002R018182", "___s": true }, { "comment": "/**\r\n * Updates the bounds of this Face, based on the translated values of the vertices.\r\n *\r\n * Call this method prior to accessing the `Face.bounds` property.\r\n *\r\n * @method Phaser.Geom.Mesh.Face#updateBounds\r\n * @since 3.50.0\r\n *\r\n * @return {this} This Face instance.\r\n */", "meta": { "filename": "Face.js", "lineno": 310, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Updates the bounds of this Face, based on the translated values of the vertices.\r\rCall this method prior to accessing the `Face.bounds` property.", "kind": "function", "name": "updateBounds", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Face instance." } ], "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#updateBounds", "scope": "instance", "___id": "T000002R018184", "___s": true }, { "comment": "/**\r\n * Checks if this Face is within the view of the given Camera.\r\n *\r\n * This method is called in the `MeshWebGLRenderer` function. It performs the following tasks:\r\n *\r\n * First, the `Vertex.update` method is called on each of the vertices. This populates them\r\n * with the new translated values, updating their `tx`, `ty` and `ta` properties.\r\n *\r\n * Then it tests to see if this face is visible due to the alpha values, if not, it returns.\r\n *\r\n * After this, if `hideCCW` is set, it calls `isCounterClockwise` and returns if not.\r\n *\r\n * Finally, it will update the `Face.bounds` based on the newly translated vertex values\r\n * and return the results of an intersection test between the bounds and the camera world view\r\n * rectangle.\r\n *\r\n * @method Phaser.Geom.Mesh.Face#isInView\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to check against.\r\n * @param {boolean} hideCCW - Test the counter-clockwise orientation of the verts?\r\n * @param {number} z - The Cameras z position, used in the CCW test.\r\n * @param {number} alpha - The alpha of the parent object.\r\n * @param {number} a - The parent transform matrix data a component.\r\n * @param {number} b - The parent transform matrix data b component.\r\n * @param {number} c - The parent transform matrix data c component.\r\n * @param {number} d - The parent transform matrix data d component.\r\n * @param {number} e - The parent transform matrix data e component.\r\n * @param {number} f - The parent transform matrix data f component.\r\n * @param {boolean} roundPixels - Round the vertex position or not?\r\n *\r\n * @return {boolean} `true` if this Face can be seen by the Camera.\r\n */", "meta": { "filename": "Face.js", "lineno": 336, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Checks if this Face is within the view of the given Camera.\r\rThis method is called in the `MeshWebGLRenderer` function. It performs the following tasks:\r\rFirst, the `Vertex.update` method is called on each of the vertices. This populates them\rwith the new translated values, updating their `tx`, `ty` and `ta` properties.\r\rThen it tests to see if this face is visible due to the alpha values, if not, it returns.\r\rAfter this, if `hideCCW` is set, it calls `isCounterClockwise` and returns if not.\r\rFinally, it will update the `Face.bounds` based on the newly translated vertex values\rand return the results of an intersection test between the bounds and the camera world view\rrectangle.", "kind": "function", "name": "isInView", "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.", "name": "camera" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Test the counter-clockwise orientation of the verts?", "name": "hideCCW" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Cameras z position, used in the CCW test.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha of the parent object.", "name": "alpha" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data a component.", "name": "a" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data b component.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data c component.", "name": "c" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data d component.", "name": "d" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data e component.", "name": "e" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data f component.", "name": "f" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Round the vertex position or not?", "name": "roundPixels" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Face can be seen by the Camera." } ], "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#isInView", "scope": "instance", "___id": "T000002R018194", "___s": true }, { "comment": "/**\r\n * Translates the original UV positions of each vertex by the given amounts.\r\n *\r\n * The original properties `Vertex.u` and `Vertex.v`\r\n * remain unchanged, only the translated properties\r\n * `Vertex.tu` and `Vertex.tv`, as used in rendering,\r\n * are updated.\r\n *\r\n * @method Phaser.Geom.Mesh.Face#scrollUV\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - The amount to scroll the UV u coordinate by.\r\n * @param {number} y - The amount to scroll the UV v coordinate by.\r\n *\r\n * @return {this} This Face instance.\r\n */", "meta": { "filename": "Face.js", "lineno": 408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Translates the original UV positions of each vertex by the given amounts.\r\rThe original properties `Vertex.u` and `Vertex.v`\rremain unchanged, only the translated properties\r`Vertex.tu` and `Vertex.tv`, as used in rendering,\rare updated.", "kind": "function", "name": "scrollUV", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to scroll the UV u coordinate by.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to scroll the UV v coordinate by.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Face instance." } ], "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#scrollUV", "scope": "instance", "___id": "T000002R018206", "___s": true }, { "comment": "/**\r\n * Scales the original UV values of each vertex by the given amounts.\r\n *\r\n * The original properties `Vertex.u` and `Vertex.v`\r\n * remain unchanged, only the translated properties\r\n * `Vertex.tu` and `Vertex.tv`, as used in rendering,\r\n * are updated.\r\n *\r\n * @method Phaser.Geom.Mesh.Face#scaleUV\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - The amount to scale the UV u coordinate by.\r\n * @param {number} y - The amount to scale the UV v coordinate by.\r\n *\r\n * @return {this} This Face instance.\r\n */", "meta": { "filename": "Face.js", "lineno": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Scales the original UV values of each vertex by the given amounts.\r\rThe original properties `Vertex.u` and `Vertex.v`\rremain unchanged, only the translated properties\r`Vertex.tu` and `Vertex.tv`, as used in rendering,\rare updated.", "kind": "function", "name": "scaleUV", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to scale the UV u coordinate by.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to scale the UV v coordinate by.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Face instance." } ], "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#scaleUV", "scope": "instance", "___id": "T000002R018208", "___s": true }, { "comment": "/**\r\n * Sets the color value for each Vertex in this Face.\r\n *\r\n * @method Phaser.Geom.Mesh.Face#setColor\r\n * @since 3.60.0\r\n *\r\n * @param {number} color - The color value for each vertex.\r\n *\r\n * @return {this} This Face instance.\r\n */", "meta": { "filename": "Face.js", "lineno": 458, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Sets the color value for each Vertex in this Face.", "kind": "function", "name": "setColor", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The color value for each vertex.", "name": "color" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Face instance." } ], "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#setColor", "scope": "instance", "___id": "T000002R018210", "___s": true }, { "comment": "/**\r\n * Calls the `Vertex.update` method on each of the vertices. This populates them\r\n * with the new translated values, updating their `tx`, `ty` and `ta` properties.\r\n *\r\n * @method Phaser.Geom.Mesh.Face#update\r\n * @since 3.60.0\r\n *\r\n * @param {number} alpha - The alpha of the parent object.\r\n * @param {number} a - The parent transform matrix data a component.\r\n * @param {number} b - The parent transform matrix data b component.\r\n * @param {number} c - The parent transform matrix data c component.\r\n * @param {number} d - The parent transform matrix data d component.\r\n * @param {number} e - The parent transform matrix data e component.\r\n * @param {number} f - The parent transform matrix data f component.\r\n * @param {boolean} roundPixels - Round the vertex position or not?\r\n *\r\n * @return {this} This Face instance.\r\n */", "meta": { "filename": "Face.js", "lineno": 477, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Calls the `Vertex.update` method on each of the vertices. This populates them\rwith the new translated values, updating their `tx`, `ty` and `ta` properties.", "kind": "function", "name": "update", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha of the parent object.", "name": "alpha" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data a component.", "name": "a" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data b component.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data c component.", "name": "c" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data d component.", "name": "d" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data e component.", "name": "e" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data f component.", "name": "f" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Round the vertex position or not?", "name": "roundPixels" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Face instance." } ], "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#update", "scope": "instance", "___id": "T000002R018215", "___s": true }, { "comment": "/**\r\n * Translates the vertices of this Face by the given amounts.\r\n *\r\n * The actual vertex positions are adjusted, not their transformed position.\r\n *\r\n * Therefore, this updates the vertex data directly.\r\n *\r\n * @method Phaser.Geom.Mesh.Face#translate\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The amount to horizontally translate by.\r\n * @param {number} [y=0] - The amount to vertically translate by.\r\n *\r\n * @return {this} This Face instance.\r\n */", "meta": { "filename": "Face.js", "lineno": 504, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Translates the vertices of this Face by the given amounts.\r\rThe actual vertex positions are adjusted, not their transformed position.\r\rTherefore, this updates the vertex data directly.", "kind": "function", "name": "translate", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to horizontally translate by.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to vertically translate by.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Face instance." } ], "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#translate", "scope": "instance", "___id": "T000002R018217", "___s": true }, { "comment": "/**\r\n * The x coordinate of this Face, based on the in center position of the Face.\r\n *\r\n * @name Phaser.Geom.Mesh.Face#x\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Face.js", "lineno": 539, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The x coordinate of this Face, based on the in center position of the Face.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#x", "scope": "instance", "kind": "member", "___id": "T000002R018229", "___s": true }, { "comment": "/**\r\n * The y coordinate of this Face, based on the in center position of the Face.\r\n *\r\n * @name Phaser.Geom.Mesh.Face#y\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Face.js", "lineno": 562, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The y coordinate of this Face, based on the in center position of the Face.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#y", "scope": "instance", "kind": "member", "___id": "T000002R018234", "___s": true }, { "comment": "/**\r\n * Set the alpha value of this Face.\r\n *\r\n * Each vertex is given the same value. If you need to adjust the alpha on a per-vertex basis\r\n * then use the `Vertex.alpha` property instead.\r\n *\r\n * When getting the alpha of this Face, it will return an average of the alpha\r\n * component of all three vertices.\r\n *\r\n * @name Phaser.Geom.Mesh.Face#alpha\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Face.js", "lineno": 585, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Set the alpha value of this Face.\r\rEach vertex is given the same value. If you need to adjust the alpha on a per-vertex basis\rthen use the `Vertex.alpha` property instead.\r\rWhen getting the alpha of this Face, it will return an average of the alpha\rcomponent of all three vertices.", "name": "alpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#alpha", "scope": "instance", "kind": "member", "___id": "T000002R018239", "___s": true }, { "comment": "/**\r\n * The depth of this Face, which is an average of the z component of all three vertices.\r\n *\r\n * The depth is calculated based on the transformed z value, not the local one.\r\n *\r\n * @name Phaser.Geom.Mesh.Face#depth\r\n * @type {number}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Face.js", "lineno": 618, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The depth of this Face, which is an average of the z component of all three vertices.\r\rThe depth is calculated based on the transformed z value, not the local one.", "name": "depth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#depth", "scope": "instance", "kind": "member", "___id": "T000002R018249", "___s": true }, { "comment": "/**\r\n * Destroys this Face and nulls the references to the vertices.\r\n *\r\n * @method Phaser.Geom.Mesh.Face#destroy\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Face.js", "lineno": 641, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Destroys this Face and nulls the references to the vertices.", "kind": "function", "name": "destroy", "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Face", "longname": "Phaser.Geom.Mesh.Face#destroy", "scope": "instance", "___id": "T000002R018255", "___s": true }, { "comment": "/**\r\n * Creates a grid of vertices based on the given configuration object and optionally adds it to a Mesh.\r\n *\r\n * The size of the grid is given in pixels. An example configuration may be:\r\n *\r\n * `{ width: 256, height: 256, widthSegments: 2, heightSegments: 2, tile: true }`\r\n *\r\n * This will create a grid 256 x 256 pixels in size, split into 2 x 2 segments, with\r\n * the texture tiling across the cells.\r\n *\r\n * You can split the grid into segments both vertically and horizontally. This will\r\n * generate two faces per grid segment as a result.\r\n *\r\n * The `tile` parameter allows you to control if the tile will repeat across the grid\r\n * segments, or be displayed in full.\r\n *\r\n * If adding this grid to a Mesh you can offset the grid via the `x` and `y` properties.\r\n *\r\n * UV coordinates are generated based on the given texture and frame in the config. For\r\n * example, no frame is given, the UVs will be in the range 0 to 1. If a frame is given,\r\n * such as from a texture atlas, the UVs will be generated within the range of that frame.\r\n *\r\n * @function Phaser.Geom.Mesh.GenerateGridVerts\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Geom.Mesh.GenerateGridConfig} config - A Grid configuration object.\r\n *\r\n * @return {Phaser.Types.Geom.Mesh.GenerateGridVertsResult} A Grid Result object, containing the generated vertices and indicies.\r\n */", "meta": { "filename": "GenerateGridVerts.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Creates a grid of vertices based on the given configuration object and optionally adds it to a Mesh.\r\rThe size of the grid is given in pixels. An example configuration may be:\r\r`{ width: 256, height: 256, widthSegments: 2, heightSegments: 2, tile: true }`\r\rThis will create a grid 256 x 256 pixels in size, split into 2 x 2 segments, with\rthe texture tiling across the cells.\r\rYou can split the grid into segments both vertically and horizontally. This will\rgenerate two faces per grid segment as a result.\r\rThe `tile` parameter allows you to control if the tile will repeat across the grid\rsegments, or be displayed in full.\r\rIf adding this grid to a Mesh you can offset the grid via the `x` and `y` properties.\r\rUV coordinates are generated based on the given texture and frame in the config. For\rexample, no frame is given, the UVs will be in the range 0 to 1. If a frame is given,\rsuch as from a texture atlas, the UVs will be generated within the range of that frame.", "kind": "function", "name": "GenerateGridVerts", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Types.Geom.Mesh.GenerateGridConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Geom.Mesh.GenerateGridConfig" } }, "description": "A Grid configuration object.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Geom.Mesh.GenerateGridVertsResult" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Geom.Mesh.GenerateGridVertsResult" } }, "description": "A Grid Result object, containing the generated vertices and indicies." } ], "memberof": "Phaser.Geom.Mesh", "longname": "Phaser.Geom.Mesh.GenerateGridVerts", "scope": "static", "___id": "T000002R018269", "___s": true }, { "comment": "/**\r\n * This method will return an object containing Face and Vertex instances, generated\r\n * from the parsed triangulated OBJ Model data given to this function.\r\n *\r\n * The obj data should have been parsed in advance via the ParseObj function:\r\n *\r\n * ```javascript\r\n * var data = Phaser.Geom.Mesh.ParseObj(rawData, flipUV);\r\n *\r\n * var results = GenerateObjVerts(data);\r\n * ```\r\n *\r\n * Alternatively, you can parse obj files loaded via the OBJFile loader:\r\n *\r\n * ```javascript\r\n * preload ()\r\n * {\r\n * this.load.obj('alien', 'assets/3d/alien.obj);\r\n * }\r\n *\r\n * var results = GenerateObjVerts(this.cache.obj.get('alien));\r\n * ```\r\n *\r\n * Make sure your 3D package has triangulated the model data prior to exporting it.\r\n *\r\n * You can use the data returned by this function to populate the vertices of a Mesh Game Object.\r\n *\r\n * You may add multiple models to a single Mesh, although they will act as one when\r\n * moved or rotated. You can scale the model data, should it be too small (or large) to visualize.\r\n * You can also offset the model via the `x`, `y` and `z` parameters.\r\n *\r\n * @function Phaser.Geom.Mesh.GenerateObjVerts\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Geom.Mesh.OBJData} data - The parsed OBJ model data.\r\n * @param {Phaser.GameObjects.Mesh} [mesh] - An optional Mesh Game Object. If given, the generated Faces will be automatically added to this Mesh. Set to `null` to skip.\r\n * @param {number} [scale=1] - An amount to scale the model data by. Use this if the model has exported too small, or large, to see.\r\n * @param {number} [x=0] - Translate the model x position by this amount.\r\n * @param {number} [y=0] - Translate the model y position by this amount.\r\n * @param {number} [z=0] - Translate the model z position by this amount.\r\n * @param {number} [rotateX=0] - Rotate the model on the x axis by this amount, in radians.\r\n * @param {number} [rotateY=0] - Rotate the model on the y axis by this amount, in radians.\r\n * @param {number} [rotateZ=0] - Rotate the model on the z axis by this amount, in radians.\r\n * @param {boolean} [zIsUp=true] - Is the z axis up (true), or is y axis up (false)?\r\n *\r\n * @return {Phaser.Types.Geom.Mesh.GenerateVertsResult} The parsed Face and Vertex objects.\r\n */", "meta": { "filename": "GenerateObjVerts.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "This method will return an object containing Face and Vertex instances, generated\rfrom the parsed triangulated OBJ Model data given to this function.\r\rThe obj data should have been parsed in advance via the ParseObj function:\r\r```javascript\rvar data = Phaser.Geom.Mesh.ParseObj(rawData, flipUV);\r\rvar results = GenerateObjVerts(data);\r```\r\rAlternatively, you can parse obj files loaded via the OBJFile loader:\r\r```javascript\rpreload ()\r{\r this.load.obj('alien', 'assets/3d/alien.obj);\r}\r\rvar results = GenerateObjVerts(this.cache.obj.get('alien));\r```\r\rMake sure your 3D package has triangulated the model data prior to exporting it.\r\rYou can use the data returned by this function to populate the vertices of a Mesh Game Object.\r\rYou may add multiple models to a single Mesh, although they will act as one when\rmoved or rotated. You can scale the model data, should it be too small (or large) to visualize.\rYou can also offset the model via the `x`, `y` and `z` parameters.", "kind": "function", "name": "GenerateObjVerts", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Types.Geom.Mesh.OBJData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Geom.Mesh.OBJData" } }, "description": "The parsed OBJ model data.", "name": "data" }, { "type": { "names": [ "Phaser.GameObjects.Mesh" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Mesh" } }, "optional": true, "description": "An optional Mesh Game Object. If given, the generated Faces will be automatically added to this Mesh. Set to `null` to skip.", "name": "mesh" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "An amount to scale the model data by. Use this if the model has exported too small, or large, to see.", "name": "scale" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Translate the model x position by this amount.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Translate the model y position by this amount.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Translate the model z position by this amount.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Rotate the model on the x axis by this amount, in radians.", "name": "rotateX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Rotate the model on the y axis by this amount, in radians.", "name": "rotateY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Rotate the model on the z axis by this amount, in radians.", "name": "rotateZ" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Is the z axis up (true), or is y axis up (false)?", "name": "zIsUp" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Geom.Mesh.GenerateVertsResult" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Geom.Mesh.GenerateVertsResult" } }, "description": "The parsed Face and Vertex objects." } ], "memberof": "Phaser.Geom.Mesh", "longname": "Phaser.Geom.Mesh.GenerateObjVerts", "scope": "static", "___id": "T000002R018361", "___s": true }, { "comment": "/**\r\n * Generates a set of Face and Vertex objects by parsing the given data.\r\n *\r\n * This method will take vertex data in one of two formats, based on the `containsZ` parameter.\r\n *\r\n * If your vertex data are `x`, `y` pairs, then `containsZ` should be `false` (this is the default)\r\n *\r\n * If your vertex data is groups of `x`, `y` and `z` values, then the `containsZ` parameter must be true.\r\n *\r\n * The `uvs` parameter is a numeric array consisting of `u` and `v` pairs.\r\n *\r\n * The `normals` parameter is a numeric array consisting of `x`, `y` vertex normal values and, if `containsZ` is true, `z` values as well.\r\n *\r\n * The `indicies` parameter is an optional array that, if given, is an indexed list of vertices to be added.\r\n *\r\n * The `colors` parameter is an optional array, or single value, that if given sets the color of each vertex created.\r\n *\r\n * The `alphas` parameter is an optional array, or single value, that if given sets the alpha of each vertex created.\r\n *\r\n * When providing indexed data it is assumed that _all_ of the arrays are indexed, not just the vertices.\r\n *\r\n * The following example will create a 256 x 256 sized quad using an index array:\r\n *\r\n * ```javascript\r\n * const vertices = [\r\n * -128, 128,\r\n * 128, 128,\r\n * -128, -128,\r\n * 128, -128\r\n * ];\r\n *\r\n * const uvs = [\r\n * 0, 1,\r\n * 1, 1,\r\n * 0, 0,\r\n * 1, 0\r\n * ];\r\n *\r\n * const indices = [ 0, 2, 1, 2, 3, 1 ];\r\n *\r\n * GenerateVerts(vertices, uvs, indicies);\r\n * ```\r\n *\r\n * If the data is not indexed, it's assumed that the arrays all contain sequential data.\r\n *\r\n * @function Phaser.Geom.Mesh.GenerateVerts\r\n * @since 3.50.0\r\n *\r\n * @param {number[]} vertices - The vertices array. Either `xy` pairs, or `xyz` if the `containsZ` parameter is `true`.\r\n * @param {number[]} uvs - The UVs pairs array.\r\n * @param {number[]} [indicies] - Optional vertex indicies array. If you don't have one, pass `null` or an empty array.\r\n * @param {boolean} [containsZ=false] - Does the vertices data include a `z` component?\r\n * @param {number[]} [normals] - Optional vertex normals array. If you don't have one, pass `null` or an empty array.\r\n * @param {number|number[]} [colors=0xffffff] - An array of colors, one per vertex, or a single color value applied to all vertices.\r\n * @param {number|number[]} [alphas=1] - An array of alpha values, one per vertex, or a single alpha value applied to all vertices.\r\n * @param {boolean} [flipUV=false] - Flip the UV coordinates?\r\n *\r\n * @return {Phaser.Types.Geom.Mesh.GenerateVertsResult} The parsed Face and Vertex objects.\r\n */", "meta": { "filename": "GenerateVerts.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Generates a set of Face and Vertex objects by parsing the given data.\r\rThis method will take vertex data in one of two formats, based on the `containsZ` parameter.\r\rIf your vertex data are `x`, `y` pairs, then `containsZ` should be `false` (this is the default)\r\rIf your vertex data is groups of `x`, `y` and `z` values, then the `containsZ` parameter must be true.\r\rThe `uvs` parameter is a numeric array consisting of `u` and `v` pairs.\r\rThe `normals` parameter is a numeric array consisting of `x`, `y` vertex normal values and, if `containsZ` is true, `z` values as well.\r\rThe `indicies` parameter is an optional array that, if given, is an indexed list of vertices to be added.\r\rThe `colors` parameter is an optional array, or single value, that if given sets the color of each vertex created.\r\rThe `alphas` parameter is an optional array, or single value, that if given sets the alpha of each vertex created.\r\rWhen providing indexed data it is assumed that _all_ of the arrays are indexed, not just the vertices.\r\rThe following example will create a 256 x 256 sized quad using an index array:\r\r```javascript\rconst vertices = [\r -128, 128,\r 128, 128,\r -128, -128,\r 128, -128\r];\r\rconst uvs = [\r 0, 1,\r 1, 1,\r 0, 0,\r 1, 0\r];\r\rconst indices = [ 0, 2, 1, 2, 3, 1 ];\r\rGenerateVerts(vertices, uvs, indicies);\r```\r\rIf the data is not indexed, it's assumed that the arrays all contain sequential data.", "kind": "function", "name": "GenerateVerts", "since": "3.50.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The vertices array. Either `xy` pairs, or `xyz` if the `containsZ` parameter is `true`.", "name": "vertices" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The UVs pairs array.", "name": "uvs" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "Optional vertex indicies array. If you don't have one, pass `null` or an empty array.", "name": "indicies" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does the vertices data include a `z` component?", "name": "containsZ" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "Optional vertex normals array. If you don't have one, pass `null` or an empty array.", "name": "normals" }, { "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": "0xffffff", "description": "An array of colors, one per vertex, or a single color value applied to all vertices.", "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, "defaultvalue": 1, "description": "An array of alpha values, one per vertex, or a single alpha value applied to all vertices.", "name": "alphas" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Flip the UV coordinates?", "name": "flipUV" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Geom.Mesh.GenerateVertsResult" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Geom.Mesh.GenerateVertsResult" } }, "description": "The parsed Face and Vertex objects." } ], "memberof": "Phaser.Geom.Mesh", "longname": "Phaser.Geom.Mesh.GenerateVerts", "scope": "static", "___id": "T000002R018410", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Geom.Mesh\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "kind": "namespace", "name": "Mesh", "memberof": "Phaser.Geom", "longname": "Phaser.Geom.Mesh", "scope": "static", "___id": "T000002R018475", "___s": true }, { "comment": "/**\n * Parses a Wavefront OBJ File, extracting the models from it and returning them in an array.\n *\n * The model data *must* be triangulated for a Mesh Game Object to be able to render it.\n *\n * @function Phaser.Geom.Mesh.ParseObj\n * @since 3.50.0\n *\n * @param {string} data - The OBJ File data as a raw string.\n * @param {boolean} [flipUV=true] - Flip the UV coordinates?\n *\n * @return {Phaser.Types.Geom.Mesh.OBJData} The parsed model and material data.\n */", "meta": { "filename": "ParseObj.js", "lineno": 226, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Parses a Wavefront OBJ File, extracting the models from it and returning them in an array.\n\nThe model data *must* be triangulated for a Mesh Game Object to be able to render it.", "kind": "function", "name": "ParseObj", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The OBJ File data as a raw string.", "name": "data" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the UV coordinates?", "name": "flipUV" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Geom.Mesh.OBJData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Geom.Mesh.OBJData" } }, "description": "The parsed model and material data." } ], "memberof": "Phaser.Geom.Mesh", "longname": "Phaser.Geom.Mesh.ParseObj", "scope": "static", "___id": "T000002R018563", "___s": true }, { "comment": "/**\r\n * Takes a Wavefront Material file and extracts the diffuse reflectivity of the named\r\n * materials, converts them to integer color values and returns them.\r\n *\r\n * This is used internally by the `addOBJ` and `addModel` methods, but is exposed for\r\n * public consumption as well.\r\n *\r\n * Note this only works with diffuse values, specified in the `Kd r g b` format, where\r\n * `g` and `b` are optional, but `r` is required. It does not support spectral rfl files,\r\n * or any other material statement (such as `Ka` or `Ks`)\r\n *\r\n * @method Phaser.Geom.Mesh.ParseObjMaterial\r\n * @since 3.50.0\r\n *\r\n * @param {string} mtl - The OBJ MTL file as a raw string, i.e. loaded via `this.load.text`.\r\n *\r\n * @return {object} The parsed material colors, where each property of the object matches the material name.\r\n */", "meta": { "filename": "ParseObjMaterial.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Takes a Wavefront Material file and extracts the diffuse reflectivity of the named\rmaterials, converts them to integer color values and returns them.\r\rThis is used internally by the `addOBJ` and `addModel` methods, but is exposed for\rpublic consumption as well.\r\rNote this only works with diffuse values, specified in the `Kd r g b` format, where\r`g` and `b` are optional, but `r` is required. It does not support spectral rfl files,\ror any other material statement (such as `Ka` or `Ks`)", "kind": "function", "name": "ParseObjMaterial", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The OBJ MTL file as a raw string, i.e. loaded via `this.load.text`.", "name": "mtl" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The parsed material colors, where each property of the object matches the material name." } ], "memberof": "Phaser.Geom.Mesh", "longname": "Phaser.Geom.Mesh.ParseObjMaterial", "scope": "static", "___id": "T000002R018579", "___s": true }, { "comment": "/**\r\n * Rotates the vertices of a Face to the given angle.\r\n *\r\n * The actual vertex positions are adjusted, not their transformed positions.\r\n *\r\n * Therefore, this updates the vertex data directly.\r\n *\r\n * @function Phaser.Geom.Mesh.RotateFace\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Geom.Mesh.Face} face - The Face to rotate.\r\n * @param {number} angle - The angle to rotate to, in radians.\r\n * @param {number} [cx] - An optional center of rotation. If not given, the Face in-center is used.\r\n * @param {number} [cy] - An optional center of rotation. If not given, the Face in-center is used.\r\n */", "meta": { "filename": "RotateFace.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Rotates the vertices of a Face to the given angle.\r\rThe actual vertex positions are adjusted, not their transformed positions.\r\rTherefore, this updates the vertex data directly.", "kind": "function", "name": "RotateFace", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Geom.Mesh.Face" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Face" } }, "description": "The Face to rotate.", "name": "face" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle to rotate to, in radians.", "name": "angle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "An optional center of rotation. If not given, the Face in-center is used.", "name": "cx" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "An optional center of rotation. If not given, the Face in-center is used.", "name": "cy" } ], "memberof": "Phaser.Geom.Mesh", "longname": "Phaser.Geom.Mesh.RotateFace", "scope": "static", "___id": "T000002R018593", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Geom.Mesh.GenerateGridConfig\r\n * @since 3.50.0\r\n *\r\n * @property {(string|Phaser.Textures.Texture)} texture - The texture to be used for this Grid. Must be a Texture instance. Can also be a string but only if the `mesh` property is set.\r\n * @property {(string|number)} [frame] - The name or index of the frame within the Texture.\r\n * @property {Phaser.GameObjects.Mesh} [mesh] - If specified, the vertices of the generated grid will be added to this Mesh Game Object.\r\n * @property {number} [width=1] - The width of the grid in 3D units. If you wish to get a pixel accurate grid based on a texture, you can use an Ortho Mesh or the `isOrtho` parameter.\r\n * @property {number} [height=width] - The height of the grid in 3D units.\r\n * @property {number} [widthSegments=1] - The number of segments to split the grid horizontally in to.\r\n * @property {number} [heightSegments=widthSegments] - The number of segments to split the grid vertically in to.\r\n * @property {number} [x=0] - Offset the grid x position by this amount.\r\n * @property {number} [y=0] - Offset the grid y position by this amount.\r\n * @property {number|number[]} [colors=0xffffff] - An array of colors, one per vertex, or a single color value applied to all vertices.\r\n * @property {number|number[]} [alphas=1] - An array of alpha values, one per vertex, or a single alpha value applied to all vertices.\r\n * @property {boolean} [tile=false] - Should the texture tile (repeat) across the grid segments, or display as a single texture?\r\n * @property {boolean} [isOrtho=false] - If set and using a texture with an ortho Mesh, the `width` and `height` parameters will be calculated based on the frame size for you.\r\n * @property {boolean} [flipY=false] - If set and using a texture, vertically flipping render result.\r\n */", "meta": { "filename": "GenerateGridConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh\\typedefs", "code": {} }, "kind": "typedef", "name": "GenerateGridConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The texture to be used for this Grid. Must be a Texture instance. Can also be a string but only if the `mesh` property is set.", "name": "texture" }, { "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": [ "Phaser.GameObjects.Mesh" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Mesh" } }, "optional": true, "description": "If specified, the vertices of the generated grid will be added to this Mesh Game Object.", "name": "mesh" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The width of the grid in 3D units. If you wish to get a pixel accurate grid based on a texture, you can use an Ortho Mesh or the `isOrtho` parameter.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "width", "description": "The height of the grid in 3D units.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The number of segments to split the grid horizontally in to.", "name": "widthSegments" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "widthSegments", "description": "The number of segments to split the grid vertically in to.", "name": "heightSegments" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Offset the grid x position by this amount.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Offset the grid y position by this amount.", "name": "y" }, { "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": "0xffffff", "description": "An array of colors, one per vertex, or a single color value applied to all vertices.", "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, "defaultvalue": 1, "description": "An array of alpha values, one per vertex, or a single alpha value applied to all vertices.", "name": "alphas" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the texture tile (repeat) across the grid segments, or display as a single texture?", "name": "tile" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If set and using a texture with an ortho Mesh, the `width` and `height` parameters will be calculated based on the frame size for you.", "name": "isOrtho" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If set and using a texture, vertically flipping render result.", "name": "flipY" } ], "memberof": "Phaser.Types.Geom.Mesh", "longname": "Phaser.Types.Geom.Mesh.GenerateGridConfig", "scope": "static", "___id": "T000002R018612", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Geom.Mesh.GenerateGridVertsResult\r\n * @since 3.50.0\r\n *\r\n * @property {number[]} verts - An array of vertex values in x, y pairs.\r\n * @property {number[]} indices - An array of vertex indexes. This array will be empty if the `tile` parameter was `true`.\r\n * @property {number[]} uvs - An array of UV values, two per vertex.\r\n * @property {number|number[]} [colors=0xffffff] - An array of colors, one per vertex, or a single color value applied to all vertices.\r\n * @property {number|number[]} [alphas=1] - An array of alpha values, one per vertex, or a single alpha value applied to all vertices.\r\n */", "meta": { "filename": "GenerateGridVertsResult.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh\\typedefs", "code": {} }, "kind": "typedef", "name": "GenerateGridVertsResult", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "An array of vertex values in x, y pairs.", "name": "verts" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "An array of vertex indexes. This array will be empty if the `tile` parameter was `true`.", "name": "indices" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "An array of UV values, two per vertex.", "name": "uvs" }, { "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": "0xffffff", "description": "An array of colors, one per vertex, or a single color value applied to all vertices.", "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, "defaultvalue": 1, "description": "An array of alpha values, one per vertex, or a single alpha value applied to all vertices.", "name": "alphas" } ], "memberof": "Phaser.Types.Geom.Mesh", "longname": "Phaser.Types.Geom.Mesh.GenerateGridVertsResult", "scope": "static", "___id": "T000002R018613", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Geom.Mesh.GenerateVertsResult\r\n * @since 3.50.0\r\n *\r\n * @property {Phaser.Geom.Mesh.Face[]} faces - An array of Face objects generated from the OBJ Data.\r\n * @property {Phaser.Geom.Mesh.Vertex[]} vertices - An array of Vertex objects generated from the OBJ Data.\r\n */", "meta": { "filename": "GenerateVertsResult.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh\\typedefs", "code": {} }, "kind": "typedef", "name": "GenerateVertsResult", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Mesh.Face", "type": "NameExpression" } ] } }, "description": "An array of Face objects generated from the OBJ Data.", "name": "faces" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Mesh.Vertex", "type": "NameExpression" } ] } }, "description": "An array of Vertex objects generated from the OBJ Data.", "name": "vertices" } ], "memberof": "Phaser.Types.Geom.Mesh", "longname": "Phaser.Types.Geom.Mesh.GenerateVertsResult", "scope": "static", "___id": "T000002R018614", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Geom.Mesh\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh\\typedefs", "code": {} }, "kind": "namespace", "name": "Mesh", "memberof": "Phaser.Types.Geom", "longname": "Phaser.Types.Geom.Mesh", "scope": "static", "___id": "T000002R018615", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Geom.Mesh.OBJData\r\n * @since 3.50.0\r\n *\r\n * @property {string[]} materialLibraries - An array of material library filenames found in the OBJ file.\r\n * @property {object} materials - If the obj was loaded with an mtl file, the parsed material names are stored in this object.\r\n * @property {Phaser.Types.Geom.Mesh.OBJModel[]} models - An array of parsed models extracted from the OBJ file.\r\n */", "meta": { "filename": "OBJData.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh\\typedefs", "code": {} }, "kind": "typedef", "name": "OBJData", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "An array of material library filenames found in the OBJ file.", "name": "materialLibraries" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "If the obj was loaded with an mtl file, the parsed material names are stored in this object.", "name": "materials" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Geom.Mesh.OBJModel", "type": "NameExpression" } ] } }, "description": "An array of parsed models extracted from the OBJ file.", "name": "models" } ], "memberof": "Phaser.Types.Geom.Mesh", "longname": "Phaser.Types.Geom.Mesh.OBJData", "scope": "static", "___id": "T000002R018616", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Geom.Mesh.OBJFace\r\n * @since 3.50.0\r\n *\r\n * @property {string} group - The name of the Group this Face is in.\r\n * @property {string} material - The name of the material this Face uses.\r\n * @property {Phaser.Types.Geom.Mesh.OBJFaceVertice[]} vertices - An array of vertices in this Face.\r\n */", "meta": { "filename": "OBJFace.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh\\typedefs", "code": {} }, "kind": "typedef", "name": "OBJFace", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the Group this Face is in.", "name": "group" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the material this Face uses.", "name": "material" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Geom.Mesh.OBJFaceVertice", "type": "NameExpression" } ] } }, "description": "An array of vertices in this Face.", "name": "vertices" } ], "memberof": "Phaser.Types.Geom.Mesh", "longname": "Phaser.Types.Geom.Mesh.OBJFace", "scope": "static", "___id": "T000002R018617", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Geom.Mesh.OBJFaceVertice\r\n * @since 3.50.0\r\n *\r\n * @property {number} textureCoordsIndex - The index in the `textureCoords` array that this vertex uses.\r\n * @property {number} vertexIndex - The index in the `vertices` array that this vertex uses.\r\n * @property {number} vertexNormalIndex - The index in the `vertexNormals` array that this vertex uses.\r\n */", "meta": { "filename": "OBJFaceVertice.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh\\typedefs", "code": {} }, "kind": "typedef", "name": "OBJFaceVertice", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index in the `textureCoords` array that this vertex uses.", "name": "textureCoordsIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index in the `vertices` array that this vertex uses.", "name": "vertexIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index in the `vertexNormals` array that this vertex uses.", "name": "vertexNormalIndex" } ], "memberof": "Phaser.Types.Geom.Mesh", "longname": "Phaser.Types.Geom.Mesh.OBJFaceVertice", "scope": "static", "___id": "T000002R018618", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Geom.Mesh.OBJModel\r\n * @since 3.50.0\r\n *\r\n * @property {Phaser.Types.Geom.Mesh.OBJFace[]} faces - An array of Faces.\r\n * @property {string} name - The name of the model.\r\n * @property {Phaser.Types.Geom.Mesh.UV[]} textureCoords - An array of texture coordinates.\r\n * @property {Phaser.Types.Math.Vector3Like[]} vertexNormals - An array of vertex normals.\r\n * @property {Phaser.Types.Math.Vector3Like[]} vertices - An array of vertices in the model.\r\n */", "meta": { "filename": "OBJModel.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh\\typedefs", "code": {} }, "kind": "typedef", "name": "OBJModel", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Geom.Mesh.OBJFace", "type": "NameExpression" } ] } }, "description": "An array of Faces.", "name": "faces" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the model.", "name": "name" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Geom.Mesh.UV", "type": "NameExpression" } ] } }, "description": "An array of texture coordinates.", "name": "textureCoords" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector3Like", "type": "NameExpression" } ] } }, "description": "An array of vertex normals.", "name": "vertexNormals" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector3Like", "type": "NameExpression" } ] } }, "description": "An array of vertices in the model.", "name": "vertices" } ], "memberof": "Phaser.Types.Geom.Mesh", "longname": "Phaser.Types.Geom.Mesh.OBJModel", "scope": "static", "___id": "T000002R018619", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Geom.Mesh.UV\r\n * @since 3.50.0\r\n *\r\n * @property {number} u - The u component.\r\n * @property {number} v - The v component.\r\n * @property {number} w - The w component.\r\n */", "meta": { "filename": "UV.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh\\typedefs", "code": {} }, "kind": "typedef", "name": "UV", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The u component.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The v component.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The w component.", "name": "w" } ], "memberof": "Phaser.Types.Geom.Mesh", "longname": "Phaser.Types.Geom.Mesh.UV", "scope": "static", "___id": "T000002R018620", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Vertex Geometry Object.\r\n *\r\n * This class consists of all the information required for a single vertex within a Face Geometry Object.\r\n *\r\n * Faces, and thus Vertex objects, are used by the Mesh Game Object in order to render objects in WebGL.\r\n *\r\n * @class Vertex\r\n * @memberof Phaser.Geom.Mesh\r\n * @constructor\r\n * @extends Phaser.Math.Vector3\r\n * @since 3.50.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} z - The z 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 * @param {number} [color=0xffffff] - The color value of the vertex.\r\n * @param {number} [alpha=1] - The alpha value of the vertex.\r\n * @param {number} [nx=0] - The x normal value of the vertex.\r\n * @param {number} [ny=0] - The y normal value of the vertex.\r\n * @param {number} [nz=0] - The z normal value of the vertex.\r\n */", "meta": { "filename": "Vertex.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "classdesc": "A Vertex Geometry Object.\r\rThis class consists of all the information required for a single vertex within a Face Geometry Object.\r\rFaces, and thus Vertex objects, are used by the Mesh Game Object in order to render objects in WebGL.", "kind": "class", "name": "Vertex", "memberof": "Phaser.Geom.Mesh", "augments": [ "Phaser.Math.Vector3" ], "since": "3.50.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 z position of the vertex.", "name": "z" }, { "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" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color value of the vertex.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The alpha value of the vertex.", "name": "alpha" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x normal value of the vertex.", "name": "nx" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y normal value of the vertex.", "name": "ny" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z normal value of the vertex.", "name": "nz" } ], "scope": "static", "longname": "Phaser.Geom.Mesh.Vertex", "___id": "T000002R018624", "___s": true }, { "comment": "/**\r\n * The projected x coordinate of this vertex.\r\n *\r\n * @name Phaser.Geom.Mesh.Vertex#vx\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Vertex.js", "lineno": 52, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The projected x coordinate of this vertex.", "name": "vx", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#vx", "scope": "instance", "kind": "member", "___id": "T000002R018633", "___s": true }, { "comment": "/**\r\n * The projected y coordinate of this vertex.\r\n *\r\n * @name Phaser.Geom.Mesh.Vertex#vy\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Vertex.js", "lineno": 61, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The projected y coordinate of this vertex.", "name": "vy", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#vy", "scope": "instance", "kind": "member", "___id": "T000002R018635", "___s": true }, { "comment": "/**\r\n * The projected z coordinate of this vertex.\r\n *\r\n * @name Phaser.Geom.Mesh.Vertex#vz\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Vertex.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The projected z coordinate of this vertex.", "name": "vz", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#vz", "scope": "instance", "kind": "member", "___id": "T000002R018637", "___s": true }, { "comment": "/**\r\n * The normalized projected x coordinate of this vertex.\r\n *\r\n * @name Phaser.Geom.Mesh.Vertex#nx\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Vertex.js", "lineno": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The normalized projected x coordinate of this vertex.", "name": "nx", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#nx", "scope": "instance", "kind": "member", "___id": "T000002R018639", "___s": true }, { "comment": "/**\r\n * The normalized projected y coordinate of this vertex.\r\n *\r\n * @name Phaser.Geom.Mesh.Vertex#ny\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Vertex.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The normalized projected y coordinate of this vertex.", "name": "ny", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#ny", "scope": "instance", "kind": "member", "___id": "T000002R018641", "___s": true }, { "comment": "/**\r\n * The normalized projected z coordinate of this vertex.\r\n *\r\n * @name Phaser.Geom.Mesh.Vertex#nz\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Vertex.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The normalized projected z coordinate of this vertex.", "name": "nz", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#nz", "scope": "instance", "kind": "member", "___id": "T000002R018643", "___s": true }, { "comment": "/**\r\n * UV u coordinate of this vertex.\r\n *\r\n * @name Phaser.Geom.Mesh.Vertex#u\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Vertex.js", "lineno": 106, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "UV u coordinate of this vertex.", "name": "u", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#u", "scope": "instance", "kind": "member", "___id": "T000002R018645", "___s": true }, { "comment": "/**\r\n * UV v coordinate of this vertex.\r\n *\r\n * @name Phaser.Geom.Mesh.Vertex#v\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Vertex.js", "lineno": 115, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "UV v coordinate of this vertex.", "name": "v", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#v", "scope": "instance", "kind": "member", "___id": "T000002R018647", "___s": true }, { "comment": "/**\r\n * The color value of this vertex.\r\n *\r\n * @name Phaser.Geom.Mesh.Vertex#color\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Vertex.js", "lineno": 124, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The color value of this vertex.", "name": "color", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#color", "scope": "instance", "kind": "member", "___id": "T000002R018649", "___s": true }, { "comment": "/**\r\n * The alpha value of this vertex.\r\n *\r\n * @name Phaser.Geom.Mesh.Vertex#alpha\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Vertex.js", "lineno": 133, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The alpha value of this vertex.", "name": "alpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#alpha", "scope": "instance", "kind": "member", "___id": "T000002R018651", "___s": true }, { "comment": "/**\r\n * The translated x coordinate of this vertex.\r\n *\r\n * @name Phaser.Geom.Mesh.Vertex#tx\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Vertex.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The translated x coordinate of this vertex.", "name": "tx", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#tx", "scope": "instance", "kind": "member", "___id": "T000002R018653", "___s": true }, { "comment": "/**\r\n * The translated y coordinate of this vertex.\r\n *\r\n * @name Phaser.Geom.Mesh.Vertex#ty\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Vertex.js", "lineno": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The translated y coordinate of this vertex.", "name": "ty", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#ty", "scope": "instance", "kind": "member", "___id": "T000002R018655", "___s": true }, { "comment": "/**\r\n * The translated alpha value of this vertex.\r\n *\r\n * @name Phaser.Geom.Mesh.Vertex#ta\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Vertex.js", "lineno": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The translated alpha value of this vertex.", "name": "ta", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#ta", "scope": "instance", "kind": "member", "___id": "T000002R018657", "___s": true }, { "comment": "/**\r\n * The translated uv u coordinate of this vertex.\r\n *\r\n * @name Phaser.Geom.Mesh.Vertex#tu\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Vertex.js", "lineno": 169, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The translated uv u coordinate of this vertex.", "name": "tu", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#tu", "scope": "instance", "kind": "member", "___id": "T000002R018659", "___s": true }, { "comment": "/**\r\n * The translated uv v coordinate of this vertex.\r\n *\r\n * @name Phaser.Geom.Mesh.Vertex#tv\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Vertex.js", "lineno": 178, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "The translated uv v coordinate of this vertex.", "name": "tv", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#tv", "scope": "instance", "kind": "member", "___id": "T000002R018661", "___s": true }, { "comment": "/**\r\n * Sets the U and V properties.\r\n *\r\n * Also resets the translated uv properties, undoing any scale\r\n * or shift they may have had.\r\n *\r\n * @method Phaser.Geom.Mesh.Vertex#setUVs\r\n * @since 3.50.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": "Vertex.js", "lineno": 188, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Sets the U and V properties.\r\rAlso resets the translated uv properties, undoing any scale\ror shift they may have had.", "kind": "function", "name": "setUVs", "since": "3.50.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.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#setUVs", "scope": "instance", "___id": "T000002R018663", "___s": true }, { "comment": "/**\r\n * Translates the original UV positions by the given amounts.\r\n *\r\n * The original properties `Vertex.u` and `Vertex.v`\r\n * remain unchanged, only the translated properties\r\n * `Vertex.tu` and `Vertex.tv`, as used in rendering,\r\n * are updated.\r\n *\r\n * @method Phaser.Geom.Mesh.Vertex#scrollUV\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - The amount to scroll the UV u coordinate by.\r\n * @param {number} y - The amount to scroll the UV v coordinate by.\r\n *\r\n * @return {this} This Vertex.\r\n */", "meta": { "filename": "Vertex.js", "lineno": 213, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Translates the original UV positions by the given amounts.\r\rThe original properties `Vertex.u` and `Vertex.v`\rremain unchanged, only the translated properties\r`Vertex.tu` and `Vertex.tv`, as used in rendering,\rare updated.", "kind": "function", "name": "scrollUV", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to scroll the UV u coordinate by.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to scroll the UV v coordinate by.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Vertex." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#scrollUV", "scope": "instance", "___id": "T000002R018669", "___s": true }, { "comment": "/**\r\n * Scales the original UV values by the given amounts.\r\n *\r\n * The original properties `Vertex.u` and `Vertex.v`\r\n * remain unchanged, only the translated properties\r\n * `Vertex.tu` and `Vertex.tv`, as used in rendering,\r\n * are updated.\r\n *\r\n * @method Phaser.Geom.Mesh.Vertex#scaleUV\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - The amount to scale the UV u coordinate by.\r\n * @param {number} y - The amount to scale the UV v coordinate by.\r\n *\r\n * @return {this} This Vertex.\r\n */", "meta": { "filename": "Vertex.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Scales the original UV values by the given amounts.\r\rThe original properties `Vertex.u` and `Vertex.v`\rremain unchanged, only the translated properties\r`Vertex.tu` and `Vertex.tv`, as used in rendering,\rare updated.", "kind": "function", "name": "scaleUV", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to scale the UV u coordinate by.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to scale the UV v coordinate by.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Vertex." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#scaleUV", "scope": "instance", "___id": "T000002R018673", "___s": true }, { "comment": "/**\r\n * Transforms this vertex by the given matrix, storing the results in `vx`, `vy` and `vz`.\r\n *\r\n * @method Phaser.Geom.Mesh.Vertex#transformCoordinatesLocal\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} transformMatrix - The transform matrix to apply to this vertex.\r\n * @param {number} width - The width of the parent Mesh.\r\n * @param {number} height - The height of the parent Mesh.\r\n * @param {number} cameraZ - The z position of the MeshCamera.\r\n */", "meta": { "filename": "Vertex.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Transforms this vertex by the given matrix, storing the results in `vx`, `vy` and `vz`.", "kind": "function", "name": "transformCoordinatesLocal", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The transform matrix to apply to this vertex.", "name": "transformMatrix" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the parent Mesh.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the parent Mesh.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The z position of the MeshCamera.", "name": "cameraZ" } ], "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#transformCoordinatesLocal", "scope": "instance", "___id": "T000002R018677", "___s": true }, { "comment": "/**\r\n * Resizes this Vertex by setting the x and y coordinates, then transforms this vertex\r\n * by an identity matrix and dimensions, storing the results in `vx`, `vy` and `vz`.\r\n *\r\n * @method Phaser.Geom.Mesh.Vertex#resize\r\n * @since 3.60.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 Mesh.\r\n * @param {number} height - The height of the parent Mesh.\r\n * @param {number} originX - The originX of the parent Mesh.\r\n * @param {number} originY - The originY of the parent Mesh.\r\n *\r\n * @return {this} This Vertex.\r\n */", "meta": { "filename": "Vertex.js", "lineno": 298, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Resizes this Vertex by setting the x and y coordinates, then transforms this vertex\rby an identity matrix and dimensions, storing the results in `vx`, `vy` and `vz`.", "kind": "function", "name": "resize", "since": "3.60.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 Mesh.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the parent Mesh.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The originX of the parent Mesh.", "name": "originX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The originY of the parent Mesh.", "name": "originY" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Vertex." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#resize", "scope": "instance", "___id": "T000002R018691", "___s": true }, { "comment": "/**\r\n * Updates this Vertex based on the given transform.\r\n *\r\n * @method Phaser.Geom.Mesh.Vertex#update\r\n * @since 3.50.0\r\n *\r\n * @param {number} a - The parent transform matrix data a component.\r\n * @param {number} b - The parent transform matrix data b component.\r\n * @param {number} c - The parent transform matrix data c component.\r\n * @param {number} d - The parent transform matrix data d component.\r\n * @param {number} e - The parent transform matrix data e component.\r\n * @param {number} f - The parent transform matrix data f component.\r\n * @param {boolean} roundPixels - Round the vertex position or not?\r\n * @param {number} alpha - The alpha of the parent object.\r\n *\r\n * @return {this} This Vertex.\r\n */", "meta": { "filename": "Vertex.js", "lineno": 344, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Updates this Vertex based on the given transform.", "kind": "function", "name": "update", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data a component.", "name": "a" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data b component.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data c component.", "name": "c" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data d component.", "name": "d" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data e component.", "name": "e" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The parent transform matrix data f component.", "name": "f" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Round the vertex position or not?", "name": "roundPixels" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha of the parent object.", "name": "alpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Vertex." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#update", "scope": "instance", "___id": "T000002R018702", "___s": true }, { "comment": "/**\r\n * Loads the data from this Vertex into the given Typed Arrays.\r\n *\r\n * @method Phaser.Geom.Mesh.Vertex#load\r\n * @since 3.50.0\r\n *\r\n * @param {Float32Array} F32 - A Float32 Array to insert the position, UV and unit data in to.\r\n * @param {Uint32Array} U32 - A Uint32 Array to insert the color and alpha data in to.\r\n * @param {number} offset - The index of the array to insert this Vertex to.\r\n * @param {number} textureUnit - The texture unit currently in use.\r\n * @param {number} tintEffect - The tint effect to use.\r\n *\r\n * @return {number} The new array offset.\r\n */", "meta": { "filename": "Vertex.js", "lineno": 379, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\mesh", "code": {} }, "description": "Loads the data from this Vertex into the given Typed Arrays.", "kind": "function", "name": "load", "since": "3.50.0", "params": [ { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "A Float32 Array to insert the position, UV and unit data in to.", "name": "F32" }, { "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "description": "A Uint32 Array to insert the color and alpha data in to.", "name": "U32" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the array to insert this Vertex to.", "name": "offset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit currently in use.", "name": "textureUnit" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint effect to use.", "name": "tintEffect" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new array offset." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "longname": "Phaser.Geom.Mesh.Vertex#load", "scope": "instance", "___id": "T000002R018711", "___s": true }, { "comment": "/**\r\n * Apply `Math.ceil()` to each coordinate of the given Point.\r\n *\r\n * @function Phaser.Geom.Point.Ceil\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} O - [point,$return]\r\n *\r\n * @param {Phaser.Geom.Point} point - The Point to ceil.\r\n *\r\n * @return {Phaser.Geom.Point} The Point with `Math.ceil()` applied to its coordinates.\r\n */", "meta": { "filename": "Ceil.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "Apply `Math.ceil()` to each coordinate of the given Point.", "kind": "function", "name": "Ceil", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [point,$return]", "value": "{Phaser.Geom.Point} O - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The Point to ceil.", "name": "point" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The Point with `Math.ceil()` applied to its coordinates." } ], "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point.Ceil", "scope": "static", "___id": "T000002R018721", "___s": true }, { "comment": "/**\r\n * Clone the given Point.\r\n *\r\n * @function Phaser.Geom.Point.Clone\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Point} source - The source Point to clone.\r\n *\r\n * @return {Phaser.Geom.Point} The cloned Point.\r\n */", "meta": { "filename": "Clone.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "Clone the given Point.", "kind": "function", "name": "Clone", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The source Point to clone.", "name": "source" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The cloned Point." } ], "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point.Clone", "scope": "static", "___id": "T000002R018725", "___s": true }, { "comment": "/**\r\n * Copy the values of one Point to a destination Point.\r\n *\r\n * @function Phaser.Geom.Point.CopyFrom\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} O - [dest,$return]\r\n *\r\n * @param {Phaser.Geom.Point} source - The source Point to copy the values from.\r\n * @param {Phaser.Geom.Point} dest - The destination Point to copy the values to.\r\n *\r\n * @return {Phaser.Geom.Point} The destination Point.\r\n */", "meta": { "filename": "CopyFrom.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "Copy the values of one Point to a destination Point.", "kind": "function", "name": "CopyFrom", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [dest,$return]", "value": "{Phaser.Geom.Point} O - [dest,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The source Point to copy the values from.", "name": "source" }, { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The destination Point to copy the values to.", "name": "dest" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The destination Point." } ], "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point.CopyFrom", "scope": "static", "___id": "T000002R018728", "___s": true }, { "comment": "/**\r\n * A comparison of two `Point` objects to see if they are equal.\r\n *\r\n * @function Phaser.Geom.Point.Equals\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Point} point - The original `Point` to compare against.\r\n * @param {Phaser.Geom.Point} toCompare - The second `Point` to compare.\r\n *\r\n * @return {boolean} Returns true if the both `Point` objects are equal.\r\n */", "meta": { "filename": "Equals.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "A comparison of two `Point` objects to see if they are equal.", "kind": "function", "name": "Equals", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The original `Point` to compare against.", "name": "point" }, { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The second `Point` to compare.", "name": "toCompare" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns true if the both `Point` objects are equal." } ], "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point.Equals", "scope": "static", "___id": "T000002R018731", "___s": true }, { "comment": "/**\r\n * Apply `Math.ceil()` to each coordinate of the given Point.\r\n *\r\n * @function Phaser.Geom.Point.Floor\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} O - [point,$return]\r\n *\r\n * @param {Phaser.Geom.Point} point - The Point to floor.\r\n *\r\n * @return {Phaser.Geom.Point} The Point with `Math.floor()` applied to its coordinates.\r\n */", "meta": { "filename": "Floor.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "Apply `Math.ceil()` to each coordinate of the given Point.", "kind": "function", "name": "Floor", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [point,$return]", "value": "{Phaser.Geom.Point} O - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The Point to floor.", "name": "point" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The Point with `Math.floor()` applied to its coordinates." } ], "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point.Floor", "scope": "static", "___id": "T000002R018734", "___s": true }, { "comment": "/**\r\n * Get the centroid or geometric center of a plane figure (the arithmetic mean position of all the points in the figure).\r\n * Informally, it is the point at which a cutout of the shape could be perfectly balanced on the tip of a pin.\r\n *\r\n * @function Phaser.Geom.Point.GetCentroid\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like[]} points - An array of Vector2Like objects to get the geometric center of.\r\n * @param {Phaser.Geom.Point} [out] - A Point object to store the output coordinates in. If not given, a new Point instance is created.\r\n *\r\n * @return {Phaser.Geom.Point} A Point object representing the geometric center of the given points.\r\n */", "meta": { "filename": "GetCentroid.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "Get the centroid or geometric center of a plane figure (the arithmetic mean position of all the points in the figure).\rInformally, it is the point at which a cutout of the shape could be perfectly balanced on the tip of a pin.", "kind": "function", "name": "GetCentroid", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "description": "An array of Vector2Like objects to get the geometric center of.", "name": "points" }, { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "optional": true, "description": "A Point object to store the output coordinates in. If not given, a new Point instance is created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "A Point object representing the geometric center of the given points." } ], "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point.GetCentroid", "scope": "static", "___id": "T000002R018738", "___s": true }, { "comment": "/**\r\n * Calculate the magnitude of the point, which equivalent to the length of the line from the origin to this point.\r\n *\r\n * @function Phaser.Geom.Point.GetMagnitude\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Point} point - The point to calculate the magnitude for\r\n *\r\n * @return {number} The resulting magnitude\r\n */", "meta": { "filename": "GetMagnitude.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "Calculate the magnitude of the point, which equivalent to the length of the line from the origin to this point.", "kind": "function", "name": "GetMagnitude", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The point to calculate the magnitude for", "name": "point" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resulting magnitude" } ], "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point.GetMagnitude", "scope": "static", "___id": "T000002R018750", "___s": true }, { "comment": "/**\r\n * Calculates the square of magnitude of given point.(Can be used for fast magnitude calculation of point)\r\n *\r\n * @function Phaser.Geom.Point.GetMagnitudeSq\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Point} point - Returns square of the magnitude/length of given point.\r\n *\r\n * @return {number} Returns square of the magnitude of given point.\r\n */", "meta": { "filename": "GetMagnitudeSq.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "Calculates the square of magnitude of given point.(Can be used for fast magnitude calculation of point)", "kind": "function", "name": "GetMagnitudeSq", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "Returns square of the magnitude/length of given point.", "name": "point" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Returns square of the magnitude of given point." } ], "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point.GetMagnitudeSq", "scope": "static", "___id": "T000002R018753", "___s": true }, { "comment": "/**\r\n * Calculates the Axis Aligned Bounding Box (or aabb) from an array of points.\r\n *\r\n * @function Phaser.Geom.Point.GetRectangleFromPoints\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [out,$return]\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like[]} points - An array of Vector2Like objects to get the AABB from.\r\n * @param {Phaser.Geom.Rectangle} [out] - A Rectangle object to store the results in. If not given, a new Rectangle instance is created.\r\n *\r\n * @return {Phaser.Geom.Rectangle} A Rectangle object holding the AABB values for the given points.\r\n */", "meta": { "filename": "GetRectangleFromPoints.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "Calculates the Axis Aligned Bounding Box (or aabb) from an array of points.", "kind": "function", "name": "GetRectangleFromPoints", "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": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "description": "An array of Vector2Like objects to get the AABB from.", "name": "points" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "optional": true, "description": "A Rectangle object to store the results in. If not given, a new Rectangle instance is created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "A Rectangle object holding the AABB values for the given points." } ], "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point.GetRectangleFromPoints", "scope": "static", "___id": "T000002R018757", "___s": true }, { "comment": "/**\r\n * Returns the linear interpolation point between the two given points, based on `t`.\r\n *\r\n * @function Phaser.Geom.Point.Interpolate\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Point} pointA - The starting `Point` for the interpolation.\r\n * @param {Phaser.Geom.Point} pointB - The target `Point` for the interpolation.\r\n * @param {number} [t=0] - The amount to interpolate between the two points. Generally, a value between 0 (returns the starting `Point`) and 1 (returns the target `Point`). If omitted, 0 is used.\r\n * @param {(Phaser.Geom.Point|object)} [out] - An optional `Point` object whose `x` and `y` values will be set to the result of the interpolation (can also be any object with `x` and `y` properties). If omitted, a new `Point` created and returned.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} Either the object from the `out` argument with the properties `x` and `y` set to the result of the interpolation or a newly created `Point` object.\r\n */", "meta": { "filename": "Interpolate.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "Returns the linear interpolation point between the two given points, based on `t`.", "kind": "function", "name": "Interpolate", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The starting `Point` for the interpolation.", "name": "pointA" }, { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The target `Point` for the interpolation.", "name": "pointB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to interpolate between the two points. Generally, a value between 0 (returns the starting `Point`) and 1 (returns the target `Point`). If omitted, 0 is used.", "name": "t" }, { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An optional `Point` object whose `x` and `y` values will be set to the result of the interpolation (can also be any object with `x` and `y` properties). If omitted, a new `Point` created and returned.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "Either the object from the `out` argument with the properties `x` and `y` set to the result of the interpolation or a newly created `Point` object." } ], "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point.Interpolate", "scope": "static", "___id": "T000002R018793", "___s": true }, { "comment": "/**\r\n * Swaps the X and the Y coordinate of a point.\r\n *\r\n * @function Phaser.Geom.Point.Invert\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} O - [point,$return]\r\n *\r\n * @param {Phaser.Geom.Point} point - The Point to modify.\r\n *\r\n * @return {Phaser.Geom.Point} The modified `point`.\r\n */", "meta": { "filename": "Invert.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "Swaps the X and the Y coordinate of a point.", "kind": "function", "name": "Invert", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [point,$return]", "value": "{Phaser.Geom.Point} O - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The Point to modify.", "name": "point" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The modified `point`." } ], "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point.Invert", "scope": "static", "___id": "T000002R018800", "___s": true }, { "comment": "/**\r\n * Inverts a Point's coordinates.\r\n *\r\n * @function Phaser.Geom.Point.Negative\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Point} point - The Point to invert.\r\n * @param {Phaser.Geom.Point} [out] - The Point to return the inverted coordinates in.\r\n *\r\n * @return {Phaser.Geom.Point} The modified `out` Point, or a new Point if none was provided.\r\n */", "meta": { "filename": "Negative.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "Inverts a Point's coordinates.", "kind": "function", "name": "Negative", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The Point to invert.", "name": "point" }, { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "optional": true, "description": "The Point to return the inverted coordinates in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The modified `out` Point, or a new Point if none was provided." } ], "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point.Negative", "scope": "static", "___id": "T000002R018804", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Defines a Point in 2D space, with an x and y component.\r\n *\r\n * @class Point\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 this Point.\r\n * @param {number} [y=x] - The y coordinate of this Point.\r\n */", "meta": { "filename": "Point.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "classdesc": "Defines a Point in 2D space, with an x and y component.", "kind": "class", "name": "Point", "memberof": "Phaser.Geom", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of this Point.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The y coordinate of this Point.", "name": "y" } ], "scope": "static", "longname": "Phaser.Geom.Point", "___id": "T000002R018810", "___s": true }, { "comment": "/**\r\n * The geometry constant type of this object: `GEOM_CONST.POINT`.\r\n * Used for fast type comparisons.\r\n *\r\n * @name Phaser.Geom.Point#type\r\n * @type {number}\r\n * @readonly\r\n * @since 3.19.0\r\n */", "meta": { "filename": "Point.js", "lineno": 31, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "The geometry constant type of this object: `GEOM_CONST.POINT`.\rUsed for fast type comparisons.", "name": "type", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.19.0", "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point#type", "scope": "instance", "kind": "member", "___id": "T000002R018815", "___s": true }, { "comment": "/**\r\n * The x coordinate of this Point.\r\n *\r\n * @name Phaser.Geom.Point#x\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Point.js", "lineno": 42, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "The x coordinate of this Point.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point#x", "scope": "instance", "kind": "member", "___id": "T000002R018817", "___s": true }, { "comment": "/**\r\n * The y coordinate of this Point.\r\n *\r\n * @name Phaser.Geom.Point#y\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Point.js", "lineno": 52, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "The y coordinate of this Point.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point#y", "scope": "instance", "kind": "member", "___id": "T000002R018819", "___s": true }, { "comment": "/**\r\n * Set the x and y coordinates of the point to the given values.\r\n *\r\n * @method Phaser.Geom.Point#setTo\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The x coordinate of this Point.\r\n * @param {number} [y=x] - The y coordinate of this Point.\r\n *\r\n * @return {this} This Point object.\r\n */", "meta": { "filename": "Point.js", "lineno": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "Set the x and y coordinates of the point to the given values.", "kind": "function", "name": "setTo", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of this Point.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The y coordinate of this Point.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Point object." } ], "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point#setTo", "scope": "instance", "___id": "T000002R018821", "___s": true }, { "comment": "/**\r\n * Calculates the vector projection of `pointA` onto the nonzero `pointB`. This is the\r\n * orthogonal projection of `pointA` onto a straight line parallel to `pointB`.\r\n *\r\n * @function Phaser.Geom.Point.Project\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Point} pointA - Point A, to be projected onto Point B.\r\n * @param {Phaser.Geom.Point} pointB - Point B, to have Point A projected upon it.\r\n * @param {Phaser.Geom.Point} [out] - The Point object to store the position in. If not given, a new Point instance is created.\r\n *\r\n * @return {Phaser.Geom.Point} A Point object holding the coordinates of the vector projection of `pointA` onto `pointB`.\r\n */", "meta": { "filename": "Project.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "Calculates the vector projection of `pointA` onto the nonzero `pointB`. This is the\rorthogonal projection of `pointA` onto a straight line parallel to `pointB`.", "kind": "function", "name": "Project", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "Point A, to be projected onto Point B.", "name": "pointA" }, { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "Point B, to have Point A projected upon it.", "name": "pointB" }, { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "optional": true, "description": "The Point object to store the position in. If not given, a new Point instance is created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "A Point object holding the coordinates of the vector projection of `pointA` onto `pointB`." } ], "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point.Project", "scope": "static", "___id": "T000002R018830", "___s": true }, { "comment": "/**\r\n * Calculates the vector projection of `pointA` onto the nonzero `pointB`. This is the\r\n * orthogonal projection of `pointA` onto a straight line paralle to `pointB`.\r\n *\r\n * @function Phaser.Geom.Point.ProjectUnit\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Point} pointA - Point A, to be projected onto Point B. Must be a normalized point with a magnitude of 1.\r\n * @param {Phaser.Geom.Point} pointB - Point B, to have Point A projected upon it.\r\n * @param {Phaser.Geom.Point} [out] - The Point object to store the position in. If not given, a new Point instance is created.\r\n *\r\n * @return {Phaser.Geom.Point} A unit Point object holding the coordinates of the vector projection of `pointA` onto `pointB`.\r\n */", "meta": { "filename": "ProjectUnit.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "Calculates the vector projection of `pointA` onto the nonzero `pointB`. This is the\rorthogonal projection of `pointA` onto a straight line paralle to `pointB`.", "kind": "function", "name": "ProjectUnit", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "Point A, to be projected onto Point B. Must be a normalized point with a magnitude of 1.", "name": "pointA" }, { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "Point B, to have Point A projected upon it.", "name": "pointB" }, { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "optional": true, "description": "The Point object to store the position in. If not given, a new Point instance is created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "A unit Point object holding the coordinates of the vector projection of `pointA` onto `pointB`." } ], "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point.ProjectUnit", "scope": "static", "___id": "T000002R018839", "___s": true }, { "comment": "/**\r\n * Changes the magnitude (length) of a two-dimensional vector without changing its direction.\r\n *\r\n * @function Phaser.Geom.Point.SetMagnitude\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} O - [point,$return]\r\n *\r\n * @param {Phaser.Geom.Point} point - The Point to treat as the end point of the vector.\r\n * @param {number} magnitude - The new magnitude of the vector.\r\n *\r\n * @return {Phaser.Geom.Point} The modified Point.\r\n */", "meta": { "filename": "SetMagnitude.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\point", "code": {} }, "description": "Changes the magnitude (length) of a two-dimensional vector without changing its direction.", "kind": "function", "name": "SetMagnitude", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [point,$return]", "value": "{Phaser.Geom.Point} O - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The Point to treat as the end point of the vector.", "name": "point" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new magnitude of the vector.", "name": "magnitude" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The modified Point." } ], "memberof": "Phaser.Geom.Point", "longname": "Phaser.Geom.Point.SetMagnitude", "scope": "static", "___id": "T000002R018847", "___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": "T000002R018856", "___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": "T000002R018859", "___s": true }, { "comment": "/**\r\n * Checks the given Point again 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.Geom.Point} point - The 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 again 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.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The Point to check if it's within the Polygon.", "name": "point" } ], "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": "T000002R018872", "___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 coordinate, 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 coordinate, 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": "T000002R018875", "___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": "T000002R019174", "___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": "T000002R019193", "___s": true }, { "comment": "/**\r\n * Returns an array of Point 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 falsey 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.Geom.Point[]} An array of Point 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 Point 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 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 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.Geom.Point", "type": "NameExpression" } ] } }, "description": "An array of Point objects pertaining to the points around the perimeter of the Polygon." } ], "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon.GetPoints", "scope": "static", "___id": "T000002R019201", "___s": true }, { "comment": "/**\r\n * Returns the perimeter of the given Polygon.\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.", "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": "T000002R019234", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Polygon object\r\n *\r\n * The polygon is a closed shape consists of a series of connected straight lines defined by 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 consists of a series of connected straight lines defined by 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": "T000002R019248", "___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": "T000002R019251", "___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": "T000002R019253", "___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.Geom.Point[]}\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.Geom.Point", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon#points", "scope": "instance", "kind": "member", "___id": "T000002R019255", "___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": "T000002R019257", "___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": "T000002R019259", "___s": true }, { "comment": "/**\r\n * Calculates the area of the Polygon. This is available in the property Polygon.area\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. This is available in the property Polygon.area", "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": "T000002R019275", "___s": true }, { "comment": "/**\r\n * Returns an array of Point 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.Geom.Point[]} 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 perimeter of the Polygon and dividing it by the stepRate.\r\n * @param {(array|Phaser.Geom.Point[])} [output] - An array to insert the points in to. If not provided a new array will be created.\r\n *\r\n * @return {(array|Phaser.Geom.Point[])} An array of Point 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 Point 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.Geom.Point[]} O - [output,$return]", "value": "{Phaser.Geom.Point[]} 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 perimeter of the Polygon and dividing it by the stepRate.", "name": "stepRate" }, { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "description": "An array of Point objects pertaining to the points around the perimeter of the Polygon." } ], "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon#getPoints", "scope": "instance", "___id": "T000002R019289", "___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": "T000002R019292", "___s": true }, { "comment": "/**\n * Takes a Polygon object and simplifies the points by running them through a combination of\n * Douglas-Peucker and Radial Distance algorithms. Simplification dramatically reduces the number of\n * points in a polygon while retaining its shape, giving a huge performance boost when processing\n * it and also reducing visual noise.\n *\n * @function Phaser.Geom.Polygon.Simplify\n * @since 3.50.0\n *\n * @generic {Phaser.Geom.Polygon} O - [polygon,$return]\n *\n * @param {Phaser.Geom.Polygon} polygon - The polygon to be simplified. The polygon will be modified in-place and returned.\n * @param {number} [tolerance=1] - Affects the amount of simplification (in the same metric as the point coordinates).\n * @param {boolean} [highestQuality=false] - Excludes distance-based preprocessing step which leads to highest quality simplification but runs ~10-20 times slower.\n *\n * @return {Phaser.Geom.Polygon} The input polygon.\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\nDouglas-Peucker and Radial Distance algorithms. Simplification dramatically reduces the number of\npoints in a polygon while retaining its shape, giving a huge performance boost when processing\nit 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": "T000002R019328", "___s": true }, { "comment": "/**\r\n * Takes a Polygon object and applies Chaikin's smoothing algorithm on its points.\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.", "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": "T000002R019339", "___s": true }, { "comment": "/**\n * Tranlates the points of the given Polygon.\n *\n * @function Phaser.Geom.Polygon.Translate\n * @since 3.50.0\n *\n * @generic {Phaser.Geom.Polygon} O - [polygon,$return]\n *\n * @param {Phaser.Geom.Polygon} polygon - The Polygon to modify.\n * @param {number} x - The amount to horizontally translate the points by.\n * @param {number} y - The amount to vertically translate the points by.\n *\n * @return {Phaser.Geom.Polygon} The modified Polygon.\n */", "meta": { "filename": "Translate.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "description": "Tranlates 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": "T000002R019354", "___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": "T000002R019361", "___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": "T000002R019364", "___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": "T000002R019369", "___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": "T000002R019376", "___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": "T000002R019382", "___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": "T000002R019385", "___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.Geom.Point} point - The point object to be checked. Can be a Phaser Point object or any object with x and y values.\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.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The point object to be checked. Can be a Phaser Point object or any object with x and y values.", "name": "point" } ], "returns": [ { "type": { "names": [ "boolean" ], "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": "T000002R019389", "___s": true }, { "comment": "/**\r\n * Tests if one rectangle fully contains another.\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 first rectangle.\r\n * @param {Phaser.Geom.Rectangle} rectB - The second rectangle.\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.", "kind": "function", "name": "ContainsRect", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The first rectangle.", "name": "rectA" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The second rectangle.", "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": "T000002R019392", "___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": "T000002R019395", "___s": true }, { "comment": "/**\r\n * Create an array of points for each corner of a Rectangle\r\n * If an array is specified, each point object will be added to the end of the array, otherwise a new array will be created.\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": "Create an array of points for each corner of a Rectangle\rIf an array is specified, each point object will be added to the end of the array, otherwise a new array will be created.", "kind": "function", "name": "Decompose", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "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": "T000002R019398", "___s": true }, { "comment": "/**\r\n * Compares the `x`, `y`, `width` and `height` properties of two rectangles.\r\n *\r\n * @function Phaser.Geom.Rectangle.Equals\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - Rectangle A\r\n * @param {Phaser.Geom.Rectangle} toCompare - Rectangle B\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.", "kind": "function", "name": "Equals", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "Rectangle A", "name": "rect" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "Rectangle B", "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": "T000002R019410", "___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": "T000002R019414", "___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": "T000002R019419", "___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": "T000002R019423", "___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": "T000002R019428", "___s": true }, { "comment": "/**\r\n * Constructs 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 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": "T000002R019437", "___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": "T000002R019463", "___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": "T000002R019467", "___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.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to get the center of.\r\n * @param {(Phaser.Geom.Point|object)} [out] - Optional point-like object to update with the center coordinates.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} The modified `out` object, or a new Point 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.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "Optional point-like object to update with the center coordinates.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The modified `out` object, or a new Point if none was provided." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.GetCenter", "scope": "static", "___id": "T000002R019471", "___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.Geom.Point} 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.Geom.Point|object)} [out] - An object to update with the `x` and `y` coordinates of the point.\r\n *\r\n * @return {Phaser.Geom.Point} The updated `output` object, or a new Point if no `output` 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.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An object to update with the `x` and `y` coordinates of the point.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The updated `output` object, or a new Point if no `output` object was given." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.GetPoint", "scope": "static", "___id": "T000002R019479", "___s": true }, { "comment": "/**\r\n * Return an array of 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.Geom.Point[]} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rectangle - The Rectangle object to get the points from.\r\n * @param {number} step - Step between points. Used to calculate the number of points to return when quantity is falsey. Ignored if quantity is positive.\r\n * @param {number} quantity - The number of evenly spaced points from the rectangles perimeter to return. If falsey, step param will be used to calculate the number of points.\r\n * @param {(array|Phaser.Geom.Point[])} [out] - An optional array to store the points in.\r\n *\r\n * @return {(array|Phaser.Geom.Point[])} An array of 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 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.Geom.Point[]} O - [out,$return]", "value": "{Phaser.Geom.Point[]} 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": "Step between points. Used to calculate the number of points to return when quantity is falsey. Ignored if quantity is positive.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of evenly spaced points from the rectangles perimeter to return. If falsey, step param will be used to calculate the number of points.", "name": "quantity" }, { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An optional array to store the points in.", "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.Point", "type": "NameExpression" } ] } ] } }, "description": "An array of Points from the perimeter of the rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.GetPoints", "scope": "static", "___id": "T000002R019497", "___s": true }, { "comment": "/**\r\n * Returns the size of the Rectangle, expressed as a Point 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.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to get the size from.\r\n * @param {(Phaser.Geom.Point|object)} [out] - The Point object to store the size in. If not given, a new Point instance is created.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} A Point 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 Point 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.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "The Point object to store the size in. If not given, a new Point instance is created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A Point 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": "T000002R019505", "___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": "T000002R019552", "___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": "T000002R019559", "___s": true }, { "comment": "/**\r\n * Returns an array of points from the perimeter of the Rectangle, where each point is spaced out based\r\n * on either the `step` value, or the `quantity`.\r\n *\r\n * @function Phaser.Geom.Rectangle.MarchingAnts\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point[]} 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 {(array|Phaser.Geom.Point[])} [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 {(array|Phaser.Geom.Point[])} 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 points from the perimeter of the Rectangle, where each point is spaced out based\ron either the `step` value, or the `quantity`.", "kind": "function", "name": "MarchingAnts", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point[]} O - [out,$return]", "value": "{Phaser.Geom.Point[]} 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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "description": "An array containing the perimeter points from the Rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.MarchingAnts", "scope": "static", "___id": "T000002R019569", "___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.Geom.Point[]} points - An array of Points (or any object with public `x` and `y` properties) 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.Geom.Point", "type": "NameExpression" } ] } }, "description": "An array of Points (or any object with public `x` and `y` properties) which should be merged with the Rectangle.", "name": "points" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The modified Rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.MergePoints", "scope": "static", "___id": "T000002R019594", "___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": "T000002R019610", "___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": "T000002R019621", "___s": true }, { "comment": "/**\r\n * Nudges (translates) the top left corner of a Rectangle by a given offset.\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": "Nudges (translates) the top left corner of a Rectangle by a given offset.", "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": "T000002R019632", "___s": true }, { "comment": "/**\r\n * Nudges (translates) the top-left corner of a Rectangle by the coordinates of a point (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.Geom.Point|Phaser.Math.Vector2)} point - The 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": "Nudges (translates) the top-left corner of a Rectangle by the coordinates of a point (translation vector).", "kind": "function", "name": "OffsetPoint", "since": "3.0.0", "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.Geom.Point", "Phaser.Math.Vector2" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "Phaser.Math.Vector2" } ] } }, "description": "The point whose coordinates should be used as an offset.", "name": "point" } ], "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": "T000002R019637", "___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": "T000002R019642", "___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": "T000002R019645", "___s": true }, { "comment": "/**\r\n * Returns a Point from the perimeter of a Rectangle based on the given angle.\r\n *\r\n * @function Phaser.Geom.Rectangle.PerimeterPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} 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.Geom.Point} [out] - The Point object to store the position in. If not given, a new Point instance is created.\r\n *\r\n * @return {Phaser.Geom.Point} A Point object holding the coordinates of the Rectangle 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.", "kind": "function", "name": "PerimeterPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "optional": true, "description": "The Point object to store the position in. If not given, a new Point instance is created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "A Point object holding the coordinates of the Rectangle perimeter." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.PerimeterPoint", "scope": "static", "___id": "T000002R019650", "___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.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to return a point from.\r\n * @param {Phaser.Geom.Point} out - The object to update with the point's coordinates.\r\n *\r\n * @return {Phaser.Geom.Point} 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.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The object to update with the point's coordinates.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The modified `out` object, or a new Point if none was provided." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.Random", "scope": "static", "___id": "T000002R019664", "___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.\r\n *\r\n * @function Phaser.Geom.Rectangle.RandomOutside\r\n * @since 3.10.0\r\n *\r\n * @generic {Phaser.Geom.Point} 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.Geom.Point} [out] - A Point, or Point-like object to store the result in. If not specified, a new Point will be created.\r\n *\r\n * @return {Phaser.Geom.Point} A Point 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.", "kind": "function", "name": "RandomOutside", "since": "3.10.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "optional": true, "description": "A Point, or Point-like object to store the result in. If not specified, a new Point will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "A Point object containing the random values in its `x` and `y` properties." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.RandomOutside", "scope": "static", "___id": "T000002R019673", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Encapsulates a 2D rectangle defined by its corner point in the top-left and its extends in x (width) and y (height)\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": "Encapsulates a 2D rectangle defined by its corner point in the top-left and its extends in x (width) and y (height)", "kind": "class", "name": "Rectangle", "memberof": "Phaser.Geom", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "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": "T000002R019692", "___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": 40, "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": "T000002R019699", "___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": 51, "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": "T000002R019701", "___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": 61, "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": "T000002R019703", "___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": 71, "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": "T000002R019705", "___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": 81, "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": "T000002R019707", "___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": 92, "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": "T000002R019709", "___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.Geom.Point} O - [output,$return]\r\n *\r\n * @param {number} position - The normalized distance into the Rectangle's perimeter to return.\r\n * @param {(Phaser.Geom.Point|object)} [output] - An object to update with the `x` and `y` coordinates of the point.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} The updated `output` object, or a new Point if no `output` object was given.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 108, "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.Geom.Point} O - [output,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An object to update with the `x` and `y` coordinates of the point.", "name": "output" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The updated `output` object, or a new Point if no `output` object was given." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#getPoint", "scope": "instance", "___id": "T000002R019711", "___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.Geom.Point[]} 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 {(array|Phaser.Geom.Point[])} [output] - An array to which to append the points.\r\n *\r\n * @return {(array|Phaser.Geom.Point[])} The modified `output` array, or a new array if none was provided.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 130, "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.Geom.Point[]} O - [output,$return]", "value": "{Phaser.Geom.Point[]} 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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An array to which to append the points.", "name": "output" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "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": "T000002R019713", "___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.Geom.Point} O - [point,$return]\r\n *\r\n * @param {Phaser.Geom.Point} [point] - The object in which to store the `x` and `y` coordinates of the point.\r\n *\r\n * @return {Phaser.Geom.Point} The updated `point`, or a new Point if none was provided.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 149, "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.Geom.Point} O - [point,$return]", "value": "{Phaser.Geom.Point} O - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "optional": true, "description": "The object in which to store the `x` and `y` coordinates of the point.", "name": "point" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The updated `point`, or a new Point if none was provided." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#getRandomPoint", "scope": "instance", "___id": "T000002R019715", "___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": 166, "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": "T000002R019717", "___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": 189, "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": "T000002R019723", "___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": 202, "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": "T000002R019725", "___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": 223, "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": "T000002R019730", "___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. A Rectangle object is empty if its width or height is less than or equal to 0.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 244, "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. A Rectangle object is empty if its width or height is less than or equal to 0." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#isEmpty", "scope": "instance", "___id": "T000002R019735", "___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": 257, "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": "T000002R019737", "___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": 278, "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": "T000002R019740", "___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": 299, "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": "T000002R019743", "___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": 320, "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": "T000002R019746", "___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": 341, "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": "T000002R019749", "___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": 372, "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": "T000002R019756", "___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": 401, "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": "T000002R019762", "___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": 432, "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": "T000002R019769", "___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": 461, "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": "T000002R019775", "___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": 482, "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": "T000002R019780", "___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": "T000002R019786", "___s": true }, { "comment": "/**\r\n * Scales the width and height of this Rectangle by the given amounts.\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 amount by which to scale the rectangle vertically. If this is not specified, the rectangle will be scaled by the factor `x` in both directions.\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 this Rectangle by the given amounts.", "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 amount by which to scale the rectangle vertically. If this is not specified, the rectangle will be scaled by the factor `x` in both directions.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "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": "T000002R019789", "___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": "T000002R019796", "___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": "T000002R019804", "___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} The Triangle object of the given size.\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": "The Triangle object of the given size." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.BuildEquilateral", "scope": "static", "___id": "T000002R019814", "___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": "T000002R019826", "___s": true }, { "comment": "/**\r\n * Builds a right triangle, i.e. one which has a 90-degree angle and two acute angles.\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.\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.", "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.", "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": "T000002R019855", "___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": "T000002R019867", "___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": "T000002R019868", "___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.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to use.\r\n * @param {(Phaser.Geom.Point|object)} [out] - An object to store the coordinates in.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} The `out` object with modified `x` and `y` properties, or a new Point if none was provided.\r\n */", "meta": { "filename": "Centroid.js", "lineno": 13, "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.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An object to store the coordinates in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The `out` object with modified `x` and `y` properties, or a new Point if none was provided." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.Centroid", "scope": "static", "___id": "T000002R019876", "___s": true }, { "comment": "/**\r\n * Computes the circumcentre of a triangle. The circumcentre is the centre of\r\n * the circumcircle, the smallest circle which encloses the triangle. It is also\r\n * the common intersection point of the perpendicular bisectors of the sides of\r\n * the triangle, and is the only point which has equal distance to all three\r\n * vertices of the triangle.\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": 30, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Computes the circumcentre of a triangle. The circumcentre is the centre of\rthe circumcircle, the smallest circle which encloses the triangle. It is also\rthe common intersection point of the perpendicular bisectors of the sides of\rthe triangle, and is the only point which has equal distance to all three\rvertices of the triangle.", "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": "T000002R019885", "___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 * @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": 11, "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.", "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": "T000002R019901", "___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": "T000002R019933", "___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": "T000002R019936", "___s": true }, { "comment": "/**\r\n * Filters an array of point-like objects to only those contained within a triangle.\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.Geom.Point[]} points - An array of point-like objects (objects that have an `x` and `y` property)\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.Geom.Point[]} 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": 13, "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.\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.Geom.Point", "type": "NameExpression" } ] } }, "description": "An array of point-like objects (objects that have an `x` and `y` property)", "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.Geom.Point", "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": "T000002R019954", "___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.Geom.Point|Phaser.Math.Vector2|any)} point - The point to test, or any point-like object with public `x` and `y` properties.\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.Geom.Point", "Phaser.Math.Vector2", "any" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "any" } ] } }, "description": "The point to test, or any point-like object with public `x` and `y` properties.", "name": "point" } ], "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": "T000002R019986", "___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": "T000002R019989", "___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": "T000002R019992", "___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": "T000002R020002", "___s": true }, { "comment": "/**\r\n * Returns a Point from around the perimeter of a Triangle.\r\n *\r\n * @function Phaser.Geom.Triangle.GetPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} 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 - The position along the perimeter of the triangle. A value between 0 and 1.\r\n * @param {(Phaser.Geom.Point|object)} [out] - An option Point, or Point-like object to store the value in. If not given a new Point will be created.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} A Point object containing the given position from the perimeter of the triangle.\r\n */", "meta": { "filename": "GetPoint.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Returns a Point from around the perimeter of a Triangle.", "kind": "function", "name": "GetPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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": "The position along the perimeter of the triangle. A value between 0 and 1.", "name": "position" }, { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An option Point, or Point-like object to store the value in. If not given a new Point will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A Point object containing the given position from the perimeter of the triangle." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.GetPoint", "scope": "static", "___id": "T000002R020007", "___s": true }, { "comment": "/**\r\n * Returns an array of evenly spaced points on the perimeter of a Triangle.\r\n *\r\n * @function Phaser.Geom.Triangle.GetPoints\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} 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 between each returned point.\r\n * @param {(array|Phaser.Geom.Point[])} [out] - An array to which the points should be appended.\r\n *\r\n * @return {(array|Phaser.Geom.Point[])} 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.", "kind": "function", "name": "GetPoints", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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 between each returned point.", "name": "stepRate" }, { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An array to which the points should be appended.", "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.Point", "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": "T000002R020035", "___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.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to find the incenter of.\r\n * @param {Phaser.Geom.Point} [out] - An optional Point in which to store the coordinates.\r\n *\r\n * @return {Phaser.Geom.Point} Point (x, y) of the center pixel of the triangle.\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.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "optional": true, "description": "An optional Point in which to store the coordinates.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "Point (x, y) of the center pixel of the triangle." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.InCenter", "scope": "static", "___id": "T000002R020067", "___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": "T000002R020109", "___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": "T000002R020119", "___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.Geom.Point} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to get a random point from.\r\n * @param {Phaser.Geom.Point} [out] - The Point object to store the position in. If not given, a new Point instance is created.\r\n *\r\n * @return {Phaser.Geom.Point} A 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.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "optional": true, "description": "The Point object to store the position in. If not given, a new Point instance is created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "A Point object holding the coordinates of a random position within the Triangle." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.Random", "scope": "static", "___id": "T000002R020126", "___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": "T000002R020142", "___s": true }, { "comment": "/**\r\n * Rotates a Triangle at a certain angle about a given Point or object with public `x` and `y` properties.\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.Geom.Point} point - 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": "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 Point or object with public `x` and `y` properties.", "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.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The Point to rotate the Triangle about.", "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": "T000002R020147", "___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": "T000002R020150", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A triangle is a plane created by connecting three points.\r\n * The first two arguments specify the first point, the middle two arguments\r\n * specify the second point, and the last two arguments specify the third point.\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 plane created by connecting three points.\rThe first two arguments specify the first point, the middle two arguments\rspecify the second point, and the last two arguments specify the third point.", "kind": "class", "name": "Triangle", "memberof": "Phaser.Geom", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "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": "T000002R020174", "___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": 46, "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": "T000002R020183", "___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": 57, "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": "T000002R020185", "___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": 67, "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": "T000002R020187", "___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": 77, "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": "T000002R020189", "___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": 87, "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": "T000002R020191", "___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": 97, "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": "T000002R020193", "___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": 107, "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": "T000002R020195", "___s": true }, { "comment": "/**\r\n * Checks whether a given points 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": 118, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Checks whether a given points 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": "T000002R020197", "___s": true }, { "comment": "/**\r\n * Returns a specific point on the triangle.\r\n *\r\n * @method Phaser.Geom.Triangle#getPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} 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.Geom.Point|object)} [output] - Optional Point, or point-like object, that the calculated point will be written to.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} Calculated `Point` that represents the requested position. It is the same as `output` when this parameter has been given.\r\n */", "meta": { "filename": "Triangle.js", "lineno": 134, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Returns a specific point on the triangle.", "kind": "function", "name": "getPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [output,$return]", "value": "{Phaser.Geom.Point} 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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "Optional Point, or point-like object, that the calculated point will be written to.", "name": "output" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "Calculated `Point` that represents the requested position. It is the same as `output` when this parameter has been given." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#getPoint", "scope": "instance", "___id": "T000002R020199", "___s": true }, { "comment": "/**\r\n * Calculates a list of evenly distributed points on the triangle. It is either possible to pass an amount of points to be generated (`quantity`) or the distance between two points (`stepRate`).\r\n *\r\n * @method Phaser.Geom.Triangle#getPoints\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point[]} 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 {(array|Phaser.Geom.Point[])} [output] - Optional Array for writing the calculated points into. Otherwise a new array will be created.\r\n *\r\n * @return {(array|Phaser.Geom.Point[])} Returns a list of calculated `Point` instances or the filled array passed as parameter `output`.\r\n */", "meta": { "filename": "Triangle.js", "lineno": 152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Calculates a list of evenly distributed points on the triangle. It is either possible to pass an amount of points to be generated (`quantity`) or the distance between two points (`stepRate`).", "kind": "function", "name": "getPoints", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point[]} O - [output,$return]", "value": "{Phaser.Geom.Point[]} 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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "Optional Array for writing the calculated points into. Otherwise a new array will be created.", "name": "output" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "description": "Returns a list of calculated `Point` instances or the filled array passed as parameter `output`." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#getPoints", "scope": "instance", "___id": "T000002R020201", "___s": true }, { "comment": "/**\r\n * Returns a random point along the triangle.\r\n *\r\n * @method Phaser.Geom.Triangle#getRandomPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Point} O - [point,$return]\r\n *\r\n * @param {Phaser.Geom.Point} [point] - Optional `Point` that should be modified. Otherwise a new one will be created.\r\n *\r\n * @return {Phaser.Geom.Point} Random `Point`. When parameter `point` has been provided it will be returned.\r\n */", "meta": { "filename": "Triangle.js", "lineno": 171, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Returns a random point along the triangle.", "kind": "function", "name": "getRandomPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [point,$return]", "value": "{Phaser.Geom.Point} O - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "optional": true, "description": "Optional `Point` that should be modified. Otherwise a new one will be created.", "name": "point" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "Random `Point`. When parameter `point` has been provided it will be returned." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#getRandomPoint", "scope": "instance", "___id": "T000002R020203", "___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": 188, "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": "T000002R020205", "___s": true }, { "comment": "/**\r\n * Returns a Line object that corresponds to Line A of this Triangle.\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": 224, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Returns a Line object that corresponds to Line A of this Triangle.", "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": "T000002R020219", "___s": true }, { "comment": "/**\r\n * Returns a Line object that corresponds to Line B of this Triangle.\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": 245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Returns a Line object that corresponds to Line B of this Triangle.", "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": "T000002R020222", "___s": true }, { "comment": "/**\r\n * Returns a Line object that corresponds to Line C of this Triangle.\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": 266, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Returns a Line object that corresponds to Line C of this Triangle.", "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": "T000002R020225", "___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": 287, "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": "T000002R020228", "___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": 325, "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": "T000002R020239", "___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": 363, "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": "T000002R020250", "___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": 401, "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": "T000002R020261", "___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": "T000002R020273", "___s": true }, { "comment": "/**\r\n * The mouse pointer is being held 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 is being held 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": "T000002R020275", "___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": "T000002R020277", "___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": "T000002R020279", "___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": "T000002R020281", "___s": true }, { "comment": "/**\r\n * A touch pointer has been started.\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 started.", "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": "T000002R020283", "___s": true }, { "comment": "/**\r\n * A touch pointer has been started.\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 been started.", "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": "T000002R020285", "___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": "T000002R020287", "___s": true }, { "comment": "/**\r\n * A touch pointer has been 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 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": "T000002R020289", "___s": true }, { "comment": "/**\r\n * The mouse wheel changes.\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 changes.", "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": "T000002R020291", "___s": true }, { "comment": "/**\r\n * Creates a new Interactive Object.\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\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": "T000002R020294", "___s": true }, { "comment": "/**\r\n * Creates a new Pixel Perfect Handler function.\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 should be above to be included 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\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 should be above to be included 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": "T000002R020317", "___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": "T000002R020321", "___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": "T000002R020323", "___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 */", "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" } ], "memberof": "Phaser.Input.Events", "longname": "Phaser.Input.Events#event:DRAG_END", "scope": "instance", "___id": "T000002R020325", "___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": "T000002R020327", "___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": "T000002R020329", "___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": "T000002R020331", "___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": "T000002R020333", "___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": "T000002R020335", "___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": "T000002R020337", "___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": "T000002R020339", "___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 */", "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" } ], "memberof": "Phaser.Input.Events", "longname": "Phaser.Input.Events#event:GAMEOBJECT_DRAG_END", "scope": "instance", "___id": "T000002R020341", "___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": "T000002R020343", "___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": "T000002R020345", "___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": "T000002R020347", "___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": "T000002R020349", "___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": "T000002R020351", "___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": "T000002R020353", "___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": "T000002R020355", "___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 an 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 an 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": "T000002R020357", "___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": "T000002R020359", "___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": "T000002R020361", "___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": "T000002R020363", "___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 an 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 an 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": "T000002R020365", "___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": "T000002R020367", "___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": "T000002R020369", "___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": "T000002R020371", "___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": "T000002R020373", "___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": "T000002R020375", "___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": "T000002R020377", "___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 of 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 of 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": "T000002R020379", "___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": "T000002R020381", "___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": "T000002R020429", "___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": "T000002R020431", "___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": "T000002R020433", "___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": "T000002R020435", "___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": "T000002R020437", "___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": "T000002R020439", "___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": "T000002R020441", "___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 an 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 an 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": "T000002R020443", "___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": "T000002R020445", "___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": "T000002R020447", "___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": "T000002R020449", "___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": "T000002R020451", "___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": "T000002R020453", "___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": "T000002R020455", "___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": "T000002R020457", "___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": "T000002R020459", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Contains information about a specific Gamepad Axis.\r\n * Axis 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": "Contains information about a specific Gamepad Axis.\rAxis objects are created automatically by the Gamepad as they are needed.", "kind": "class", "name": "Axis", "memberof": "Phaser.Input.Gamepad", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Gamepad.Gamepad" ], "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": "T000002R020462", "___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": 28, "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": "T000002R020465", "___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": 37, "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": "T000002R020467", "___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": 46, "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": "T000002R020469", "___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": 55, "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": "T000002R020471", "___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": 66, "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": "T000002R020473", "___s": true }, { "comment": "/**\r\n * Applies the `threshold` value to the axis and returns it.\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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Applies the `threshold` value to the axis and returns it.", "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": "T000002R020478", "___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": 105, "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": "T000002R020480", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Contains information about a specific button on a Gamepad.\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 */", "meta": { "filename": "Button.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "classdesc": "Contains information about a specific button on a Gamepad.\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" } ], "scope": "static", "longname": "Phaser.Input.Gamepad.Button", "___id": "T000002R020487", "___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": 29, "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": "T000002R020490", "___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": 38, "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": "T000002R020492", "___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": 47, "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": "T000002R020494", "___s": true }, { "comment": "/**\r\n * Between 0 and 1.\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": 56, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Between 0 and 1.", "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": "T000002R020496", "___s": true }, { "comment": "/**\r\n * Can be set for analogue buttons to enable a 'pressure' threshold,\r\n * before a button is considered as being 'pressed'.\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": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Can be set for analogue buttons to enable a 'pressure' threshold,\rbefore a button is considered as being 'pressed'.", "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": "T000002R020498", "___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": 77, "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": "T000002R020500", "___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": 126, "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": "T000002R020509", "___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": "T000002R020514", "___s": true }, { "comment": "/**\r\n * Tatar SNES USB Controller Gamepad Configuration.\r\n * USB Gamepad (STANDARD GAMEPAD Vendor: 0079 Product: 0011)\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": "Tatar SNES USB Controller Gamepad Configuration.\rUSB Gamepad (STANDARD GAMEPAD Vendor: 0079 Product: 0011)", "name": "SNES_USB", "kind": "namespace", "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs", "longname": "Phaser.Input.Gamepad.Configs.SNES_USB", "scope": "static", "___id": "T000002R020519", "___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": 17, "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": "T000002R020521", "___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": 27, "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": "T000002R020523", "___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": 37, "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": "T000002R020525", "___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": 47, "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": "T000002R020527", "___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": 57, "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": "T000002R020529", "___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": 67, "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": "T000002R020531", "___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": 77, "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": "T000002R020533", "___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": 87, "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": "T000002R020535", "___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": 97, "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": "T000002R020537", "___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": 107, "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": "T000002R020539", "___s": true }, { "comment": "/**\r\n * Left bumper\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": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Left bumper", "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": "T000002R020541", "___s": true }, { "comment": "/**\r\n * Right bumper\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": 127, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Right bumper", "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": "T000002R020543", "___s": true }, { "comment": "/**\r\n * PlayStation DualShock 4 Gamepad Configuration.\r\n * Sony PlayStation DualShock 4 (v2) wireless controller\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": "PlayStation DualShock 4 Gamepad Configuration.\rSony PlayStation DualShock 4 (v2) wireless controller", "name": "DUALSHOCK_4", "kind": "namespace", "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "scope": "static", "___id": "T000002R020545", "___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": 17, "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": "T000002R020547", "___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": 27, "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": "T000002R020549", "___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": 37, "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": "T000002R020551", "___s": true }, { "comment": "/**\r\n * D-Pad up\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": 47, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "D-Pad up", "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": "T000002R020553", "___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": 57, "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": "T000002R020555", "___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": 67, "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": "T000002R020557", "___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": 77, "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": "T000002R020559", "___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": 87, "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": "T000002R020561", "___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": 97, "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": "T000002R020563", "___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": 107, "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": "T000002R020565", "___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": 117, "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": "T000002R020567", "___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": 127, "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": "T000002R020569", "___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": 137, "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": "T000002R020571", "___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": 147, "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": "T000002R020573", "___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": 157, "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": "T000002R020575", "___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": 167, "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": "T000002R020577", "___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": 177, "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": "T000002R020579", "___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": 187, "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": "T000002R020581", "___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": 197, "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": "T000002R020583", "___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": 207, "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": "T000002R020585", "___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": 217, "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": "T000002R020587", "___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": 227, "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": "T000002R020589", "___s": true }, { "comment": "/**\r\n * XBox 360 Gamepad Configuration.\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": "XBox 360 Gamepad Configuration.", "name": "XBOX_360", "kind": "namespace", "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360", "scope": "static", "___id": "T000002R020591", "___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": 16, "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": "T000002R020593", "___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": 26, "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": "T000002R020595", "___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": 36, "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": "T000002R020597", "___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": 46, "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": "T000002R020599", "___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": 56, "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": "T000002R020601", "___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": 66, "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": "T000002R020603", "___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": 76, "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": "T000002R020605", "___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": 86, "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": "T000002R020607", "___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": 96, "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": "T000002R020609", "___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": 106, "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": "T000002R020611", "___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": 116, "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": "T000002R020613", "___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": 126, "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": "T000002R020615", "___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": 136, "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": "T000002R020617", "___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": 146, "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": "T000002R020619", "___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": 156, "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": "T000002R020621", "___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": 166, "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": "T000002R020623", "___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": 176, "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": "T000002R020625", "___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": 186, "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": "T000002R020627", "___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": 196, "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": "T000002R020629", "___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": 206, "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": "T000002R020631", "___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": 216, "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": "T000002R020633", "___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": "T000002R020635", "___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": "T000002R020637", "___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": "T000002R020639", "___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": "T000002R020641", "___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. Once 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. Once 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": "T000002R020643", "___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. Once 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. Once 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": "T000002R020645", "___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": "T000002R020647", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Gamepad.\r\n *\r\n * These are created, updated and managed by the Gamepad Plugin.\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": "A single Gamepad.\r\rThese are created, updated and managed by the Gamepad Plugin.", "kind": "class", "name": "Gamepad", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Input.Gamepad", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Gamepad.GamepadPlugin" ], "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": "T000002R020660", "___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": 38, "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": "T000002R020664", "___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": 47, "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": "T000002R020666", "___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": 56, "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": "T000002R020668", "___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": 71, "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": "T000002R020670", "___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": 89, "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": "T000002R020674", "___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": 105, "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": "T000002R020678", "___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": 114, "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": "T000002R020680", "___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": 291, "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": "T000002R020719", "___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": 304, "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": "T000002R020721", "___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": 328, "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": "T000002R020725", "___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 0 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 0 and 1.\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 341, "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 0 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 0 and 1." } ], "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#getAxisValue", "scope": "instance", "___id": "T000002R020727", "___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": 358, "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": "T000002R020729", "___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": 375, "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": "T000002R020733", "___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 an analogue button, or a float between 0 and 1\r\n * for a pressure-sensitive digital 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": 388, "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 an analogue button, or a float between 0 and 1\rfor a pressure-sensitive digital button, such as the shoulder buttons on a Dual Shock.", "kind": "function", "name": "getButtonValue", "since": "3.10.0", "params": [ { "type": { "names": [ "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": "T000002R020735", "___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": 407, "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": "T000002R020737", "___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": 475, "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": "T000002R020750", "___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": 504, "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": "T000002R020759", "___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": 521, "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": "T000002R020762", "___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": 537, "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": "T000002R020765", "___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": 555, "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": "T000002R020768", "___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": 573, "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": "T000002R020771", "___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": 591, "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": "T000002R020774", "___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": 609, "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": "T000002R020777", "___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": 628, "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": "T000002R020780", "___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": 647, "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": "T000002R020783", "___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": 666, "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": "T000002R020786", "___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": 685, "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": "T000002R020789", "___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": 705, "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": "T000002R020792", "___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": 725, "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": "T000002R020795", "___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": 745, "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": "T000002R020798", "___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 KeyboardPlugin 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 KeyboardPlugin belongs to.", "name": "sceneInputPlugin" } ], "scope": "static", "longname": "Phaser.Input.Gamepad.GamepadPlugin", "___id": "T000002R020809", "___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": "T000002R020813", "___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": "T000002R020815", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Input Plugin that created this Keyboard 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 Keyboard 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": "T000002R020817", "___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": "T000002R020819", "___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": "T000002R020821", "___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": "T000002R020823", "___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": "T000002R020846", "___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": 307, "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": "T000002R020857", "___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": 397, "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": "T000002R020877", "___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": 421, "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": "T000002R020882", "___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": 532, "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": "T000002R020903", "___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 gamepadconnect, 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": 548, "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 gamepadconnect, 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": "T000002R020906", "___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 gamepadconnect, 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": 568, "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 gamepadconnect, 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": "T000002R020909", "___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 gamepadconnect, 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": 588, "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 gamepadconnect, 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": "T000002R020912", "___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 gamepadconnect, 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": 608, "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 gamepadconnect, 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": "T000002R020915", "___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 create 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": 630, "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 create 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": "T000002R020918", "___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": "T000002R020920", "___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": "T000002R020928", "___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": "T000002R020929", "___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": "T000002R020932", "___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": "T000002R020958", "___s": true }, { "comment": "/**\r\n * The Game instance that owns the Input Manager.\r\n * A Game only maintains on 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 on 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": "T000002R020961", "___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": "T000002R020963", "___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": "T000002R020965", "___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": "T000002R020967", "___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": "T000002R020969", "___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": "T000002R020971", "___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": "T000002R020973", "___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": "T000002R020975", "___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": "T000002R020977", "___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": "T000002R020979", "___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": "T000002R020981", "___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": "T000002R020983", "___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": "T000002R020985", "___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": 194, "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": "T000002R020991", "___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": 205, "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": "T000002R020993", "___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": 219, "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": "T000002R020995", "___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": 232, "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": "T000002R020997", "___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": 307, "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": "T000002R021013", "___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": 395, "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": "T000002R021033", "___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": 470, "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": "T000002R021043", "___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": 517, "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": "T000002R021052", "___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": 872, "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": "T000002R021122", "___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": 951, "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": "T000002R021142", "___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 Game Objects hit area, otherwise `false`.\r\n */", "meta": { "filename": "InputManager.js", "lineno": 988, "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 Game Objects hit area, otherwise `false`." } ], "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#pointWithinInteractiveObject", "scope": "instance", "___id": "T000002R021149", "___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": 1021, "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": "T000002R021155", "___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": 1061, "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": "T000002R021168", "___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": "T000002R021197", "___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": "T000002R021201", "___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": "T000002R021203", "___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": "T000002R021205", "___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": "T000002R021207", "___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": "T000002R021211", "___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": "T000002R021213", "___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": "T000002R021215", "___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": "T000002R021217", "___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": "T000002R021219", "___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": "T000002R021221", "___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": "T000002R021233", "___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": "T000002R021235", "___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.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 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.InputPlugin", "longname": "Phaser.Input.InputPlugin#isActive", "scope": "instance", "___id": "T000002R021306", "___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": 541, "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": "T000002R021308", "___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": 763, "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": "T000002R021354", "___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 *\r\n * @return {this} This Input Plugin.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 812, "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" } ], "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": "T000002R021365", "___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": 870, "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": "T000002R021378", "___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": 920, "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": "T000002R021383", "___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": 1045, "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": "T000002R021405", "___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": 1069, "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": "T000002R021407", "___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": 2042, "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": "T000002R021587", "___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": 2087, "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": "T000002R021595", "___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 * @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|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 *\r\n * @return {this} This InputPlugin object.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2129, "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`.", "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", "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" } ], "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": "T000002R021599", "___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": 2233, "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": "T000002R021629", "___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": 2257, "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": "T000002R021633", "___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 an ellipse hit area.\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": 2282, "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 an ellipse hit area.", "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": "T000002R021637", "___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": 2340, "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": "T000002R021651", "___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": 2365, "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": "T000002R021655", "___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": 2392, "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": "T000002R021659", "___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": 2530, "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": "T000002R021698", "___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": 2560, "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": "T000002R021703", "___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": 2580, "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": "T000002R021705", "___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": 2596, "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": "T000002R021707", "___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": 2615, "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": "T000002R021711", "___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": 2634, "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": "T000002R021714", "___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": 2654, "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": "T000002R021717", "___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": 2684, "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": "T000002R021722", "___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": 2776, "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": "T000002R021732", "___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": 2794, "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": "T000002R021735", "___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": 2817, "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": "T000002R021737", "___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": 2936, "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": "T000002R021762", "___s": true }, { "comment": "/**\r\n * The x coordinates 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": 2982, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The x coordinates 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": "T000002R021773", "___s": true }, { "comment": "/**\r\n * The y coordinates 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": 3000, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The y coordinates 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": "T000002R021776", "___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": 3018, "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": "T000002R021779", "___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": 3035, "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": "T000002R021782", "___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": 3054, "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": "T000002R021785", "___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#pointer1\r\n * @type {Phaser.Input.Pointer}\r\n * @readonly\r\n * @since 3.10.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3071, "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": "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": "T000002R021788", "___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": 3089, "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": "T000002R021791", "___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": 3107, "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": "T000002R021794", "___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": 3125, "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": "T000002R021797", "___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": 3143, "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": "T000002R021800", "___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": 3161, "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": "T000002R021803", "___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": 3179, "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": "T000002R021806", "___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": 3197, "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": "T000002R021809", "___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": 3215, "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": "T000002R021812", "___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": 3233, "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": "T000002R021815", "___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": "T000002R021821", "___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 plugins object (i.e. InputPlugin)\r\n * Plugin is the object to instantiate to create the plugin\r\n * Mapping is what the plugin is injected into the Scene.Systems as (i.e. 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 plugins object (i.e. InputPlugin)\rPlugin is the object to instantiate to create the plugin\rMapping is what the plugin is injected into the Scene.Systems as (i.e. input)", "kind": "function", "name": "register", "scope": "static", "since": "3.10.0", "params": [ { "type": { "names": [ "string" ], "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": "T000002R021823", "___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": "T000002R021830", "___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": "T000002R021832", "___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": "T000002R021843", "___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": "T000002R021856", "___s": true }, { "comment": "/**\r\n * A reference to the Keyboard Manager\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 Manager", "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": "T000002R021860", "___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": "T000002R021862", "___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": "T000002R021864", "___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": "T000002R021868", "___s": true }, { "comment": "/**\r\n * The current index of the key being waited for in the 'keys' string.\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 'keys' string.", "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": "T000002R021870", "___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": "T000002R021872", "___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": "T000002R021874", "___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": "T000002R021876", "___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": "T000002R021878", "___s": true }, { "comment": "/**\r\n * If they press the wrong key do we reset the combo?\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCombo#resetOnWrongKey\r\n * @type {boolean}\r\n * @default 0\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 they press the wrong key do we reset the combo?", "name": "resetOnWrongKey", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCombo", "longname": "Phaser.Input.Keyboard.KeyCombo#resetOnWrongKey", "scope": "instance", "kind": "member", "___id": "T000002R021880", "___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": "T000002R021882", "___s": true }, { "comment": "/**\r\n * If previously matched and they press the first key of the combo again, will it 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 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" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCombo", "longname": "Phaser.Input.Keyboard.KeyCombo#resetOnMatch", "scope": "instance", "kind": "member", "___id": "T000002R021884", "___s": true }, { "comment": "/**\r\n * If the combo matches, will it delete 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, will it delete 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": "T000002R021886", "___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": "T000002R021893", "___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": "T000002R021896", "___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": "T000002R021926", "___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": "T000002R021928", "___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": "T000002R021930", "___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": "T000002R021932", "___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": "T000002R021934", "___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": "T000002R021943", "___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": "T000002R021945", "___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": "T000002R021947", "___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": "T000002R021949", "___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": "T000002R021970", "___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": "T000002R021973", "___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": "T000002R021977", "___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": "T000002R021979", "___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": "T000002R021981", "___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": "T000002R021983", "___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.00\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.00", "memberof": "Phaser.Input.Keyboard.KeyboardManager", "longname": "Phaser.Input.Keyboard.KeyboardManager#onKeyDown", "scope": "instance", "kind": "member", "___id": "T000002R021985", "___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.00\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.00", "memberof": "Phaser.Input.Keyboard.KeyboardManager", "longname": "Phaser.Input.Keyboard.KeyboardManager#onKeyUp", "scope": "instance", "kind": "member", "___id": "T000002R021987", "___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": "T000002R021995", "___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": "T000002R022004", "___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 event for specific keys so it doesn't bubble up to the 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 event for specific keys so it doesn't bubble up to the 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": "T000002R022011", "___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": "T000002R022020", "___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": "T000002R022029", "___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": "T000002R022033", "___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": "T000002R022053", "___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": "T000002R022057", "___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": "T000002R022059", "___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": "T000002R022061", "___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": "T000002R022063", "___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": "T000002R022065", "___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": "T000002R022067", "___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": "T000002R022069", "___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": "T000002R022071", "___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": "T000002R022086", "___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": "T000002R022088", "___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": "T000002R022090", "___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": "T000002R022092", "___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": "T000002R022094", "___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": "T000002R022097", "___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": "T000002R022100", "___s": true }, { "comment": "/**\r\n * Creates and returns an object containing 4 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 4 hotkeys for Up, Down, Left and Right, and also Space Bar and shift.", "kind": "function", "name": "createCursorKeys", "since": "3.10.0", "returns": [ { "type": { "names": [ "Phaser.Types.Input.Keyboard.CursorKeys" ], "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": "T000002R022102", "___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": "T000002R022110", "___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": "T000002R022121", "___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": "T000002R022131", "___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 owened 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 owened 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": "T000002R022144", "___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": "T000002R022152", "___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": "T000002R022154", "___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": "T000002R022179", "___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": "T000002R022200", "___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": "T000002R022202", "___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": "T000002R022207", "___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": "T000002R022211", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A generic Key object which can be passed to the Process functions (and so on)\r\n * keycode must be an integer\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": "A generic Key object which can be passed to the Process functions (and so on)\rkeycode must be an integer", "kind": "class", "name": "Key", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Input.Keyboard", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Keyboard.KeyboardPlugin" ], "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": "T000002R022218", "___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": 35, "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": "T000002R022222", "___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": 44, "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": "T000002R022224", "___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": 53, "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": "T000002R022226", "___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": 62, "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": "T000002R022228", "___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": 72, "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": "T000002R022230", "___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": 82, "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": "T000002R022232", "___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": 92, "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": "T000002R022234", "___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": 102, "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": "T000002R022236", "___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": 112, "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": "T000002R022238", "___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": 122, "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": "T000002R022240", "___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": 133, "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": "T000002R022242", "___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": 143, "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": "T000002R022244", "___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": 153, "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": "T000002R022246", "___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": 165, "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": "T000002R022248", "___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": 175, "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": "T000002R022250", "___s": true }, { "comment": "/**\r\n * If a key is held down this holds down 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": 188, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "If a key is held down this holds down 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": "T000002R022252", "___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": 231, "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": "T000002R022260", "___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": 249, "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": "T000002R022263", "___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": 293, "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": "T000002R022277", "___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": 325, "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": "T000002R022288", "___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": 354, "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": "T000002R022303", "___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": 379, "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": "T000002R022305", "___s": true }, { "comment": "/**\r\n * Keyboard Codes.\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": "Keyboard Codes.", "kind": "namespace", "name": "KeyCodes", "memberof": "Phaser.Input.Keyboard", "since": "3.0.0", "longname": "Phaser.Input.Keyboard.KeyCodes", "scope": "static", "___id": "T000002R022310", "___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": 17, "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": "T000002R022312", "___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": 26, "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": "T000002R022314", "___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": 35, "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": "T000002R022316", "___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": 44, "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": "T000002R022318", "___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": 53, "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": "T000002R022320", "___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": 62, "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": "T000002R022322", "___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": 71, "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": "T000002R022324", "___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": 80, "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": "T000002R022326", "___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": 89, "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": "T000002R022328", "___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": 98, "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": "T000002R022330", "___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": 107, "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": "T000002R022332", "___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": 116, "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": "T000002R022334", "___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": 125, "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": "T000002R022336", "___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": 134, "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": "T000002R022338", "___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": 143, "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": "T000002R022340", "___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": 152, "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": "T000002R022342", "___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": 161, "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": "T000002R022344", "___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": 170, "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": "T000002R022346", "___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": 179, "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": "T000002R022348", "___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": 188, "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": "T000002R022350", "___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": 197, "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": "T000002R022352", "___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": 206, "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": "T000002R022354", "___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": 215, "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": "T000002R022356", "___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": 224, "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": "T000002R022358", "___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": 233, "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": "T000002R022360", "___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": 242, "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": "T000002R022362", "___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": 251, "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": "T000002R022364", "___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": 260, "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": "T000002R022366", "___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": 269, "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": "T000002R022368", "___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": 278, "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": "T000002R022370", "___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": 287, "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": "T000002R022372", "___s": true }, { "comment": "/**\r\n * The NUMPAD_ZERO 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": 296, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The NUMPAD_ZERO 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": "T000002R022374", "___s": true }, { "comment": "/**\r\n * The NUMPAD_ONE 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": 305, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The NUMPAD_ONE 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": "T000002R022376", "___s": true }, { "comment": "/**\r\n * The NUMPAD_TWO 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": 314, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The NUMPAD_TWO 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": "T000002R022378", "___s": true }, { "comment": "/**\r\n * The NUMPAD_THREE 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": 323, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The NUMPAD_THREE 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": "T000002R022380", "___s": true }, { "comment": "/**\r\n * The NUMPAD_FOUR 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": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The NUMPAD_FOUR 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": "T000002R022382", "___s": true }, { "comment": "/**\r\n * The NUMPAD_FIVE 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": 341, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The NUMPAD_FIVE 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": "T000002R022384", "___s": true }, { "comment": "/**\r\n * The NUMPAD_SIX 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": 350, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The NUMPAD_SIX 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": "T000002R022386", "___s": true }, { "comment": "/**\r\n * The NUMPAD_SEVEN 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": 359, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The NUMPAD_SEVEN 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": "T000002R022388", "___s": true }, { "comment": "/**\r\n * The NUMPAD_EIGHT 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": 368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The NUMPAD_EIGHT 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": "T000002R022390", "___s": true }, { "comment": "/**\r\n * The NUMPAD_NINE 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": 377, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The NUMPAD_NINE 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": "T000002R022392", "___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": 386, "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": "T000002R022394", "___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": 395, "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": "T000002R022396", "___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": 404, "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": "T000002R022398", "___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": 413, "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": "T000002R022400", "___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": 422, "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": "T000002R022402", "___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": 431, "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": "T000002R022404", "___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": 440, "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": "T000002R022406", "___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": 449, "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": "T000002R022408", "___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": 458, "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": "T000002R022410", "___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": 467, "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": "T000002R022412", "___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": 476, "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": "T000002R022414", "___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": 485, "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": "T000002R022416", "___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": 494, "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": "T000002R022418", "___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": 503, "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": "T000002R022420", "___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": 512, "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": "T000002R022422", "___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": 521, "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": "T000002R022424", "___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": 530, "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": "T000002R022426", "___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": 539, "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": "T000002R022428", "___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": 548, "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": "T000002R022430", "___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": 557, "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": "T000002R022432", "___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": 566, "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": "T000002R022434", "___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": 575, "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": "T000002R022436", "___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": 584, "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": "T000002R022438", "___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": 593, "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": "T000002R022440", "___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": 602, "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": "T000002R022442", "___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": 611, "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": "T000002R022444", "___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": 620, "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": "T000002R022446", "___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": 629, "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": "T000002R022448", "___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": 638, "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": "T000002R022450", "___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": 647, "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": "T000002R022452", "___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": 656, "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": "T000002R022454", "___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": 665, "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": "T000002R022456", "___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": 674, "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": "T000002R022458", "___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": 683, "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": "T000002R022460", "___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": 692, "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": "T000002R022462", "___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": 701, "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": "T000002R022464", "___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": 710, "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": "T000002R022466", "___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": 719, "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": "T000002R022468", "___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": 728, "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": "T000002R022470", "___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": 737, "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": "T000002R022472", "___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": 746, "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": "T000002R022474", "___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": 755, "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": "T000002R022476", "___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": 764, "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": "T000002R022478", "___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": 773, "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": "T000002R022480", "___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": 782, "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": "T000002R022482", "___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": 791, "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": "T000002R022484", "___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": 800, "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": "T000002R022486", "___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": 809, "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": "T000002R022488", "___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": 818, "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": "T000002R022490", "___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": 827, "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": "T000002R022492", "___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": 836, "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": "T000002R022494", "___s": true }, { "comment": "/**\r\n * The SEMICOLON_FIREFOX key.\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": 845, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The SEMICOLON_FIREFOX key.", "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": "T000002R022496", "___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": 854, "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": "T000002R022498", "___s": true }, { "comment": "/**\r\n * The COMMA_FIREFOX_WINDOWS 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": 863, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The COMMA_FIREFOX_WINDOWS 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": "T000002R022500", "___s": true }, { "comment": "/**\r\n * The COMMA_FIREFOX 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": 872, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The COMMA_FIREFOX 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": "T000002R022502", "___s": true }, { "comment": "/**\r\n * The BRACKET_RIGHT_FIREFOX key.\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": 881, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The BRACKET_RIGHT_FIREFOX key.", "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": "T000002R022504", "___s": true }, { "comment": "/**\r\n * The BRACKET_LEFT_FIREFOX key.\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": 890, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The BRACKET_LEFT_FIREFOX key.", "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": "T000002R022506", "___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": "T000002R022514", "___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": "T000002R022519", "___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": "T000002R022520", "___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": "T000002R022521", "___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": "T000002R022522", "___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": "T000002R022523", "___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": "T000002R022530", "___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": "T000002R022533", "___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": "T000002R022535", "___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": "T000002R022537", "___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": "T000002R022539", "___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 true\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": "true", "since": "3.50.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#preventDefaultWheel", "scope": "instance", "kind": "member", "___id": "T000002R022541", "___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": "T000002R022543", "___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": "T000002R022545", "___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": "T000002R022547", "___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": "T000002R022549", "___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": "T000002R022551", "___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": "T000002R022553", "___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": "T000002R022555", "___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": "T000002R022557", "___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": "T000002R022559", "___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": "T000002R022561", "___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": "T000002R022563", "___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": "T000002R022565", "___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": "T000002R022567", "___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": "T000002R022581", "___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": "T000002R022583", "___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 enters a 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 enters a 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": "T000002R022587", "___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": "T000002R022590", "___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": 510, "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": "T000002R022613", "___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": 543, "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": "T000002R022617", "___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": "T000002R022630", "___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": "T000002R022633", "___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": "T000002R022635", "___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": "T000002R022637", "___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": "T000002R022639", "___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": "T000002R022641", "___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": "T000002R022643", "___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": "T000002R022645", "___s": true }, { "comment": "/**\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": "0: 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": "T000002R022647", "___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": 143, "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": "T000002R022649", "___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": 153, "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": "T000002R022651", "___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": 177, "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": "T000002R022655", "___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": 192, "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": "T000002R022657", "___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 buttons 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": 207, "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 buttons 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": "T000002R022659", "___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": 225, "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": "T000002R022661", "___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": 245, "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": "T000002R022663", "___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": 261, "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": "T000002R022665", "___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": 274, "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": "T000002R022667", "___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": 287, "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": "T000002R022669", "___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": 297, "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": "T000002R022671", "___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": 307, "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": "T000002R022673", "___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": 317, "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": "T000002R022675", "___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": 327, "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": "T000002R022677", "___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": 337, "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": "T000002R022679", "___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": 347, "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": "T000002R022681", "___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": 357, "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": "T000002R022683", "___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": 367, "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": "T000002R022685", "___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": 377, "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": "T000002R022687", "___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": 387, "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": "T000002R022689", "___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": 399, "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": "T000002R022691", "___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": 409, "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": "T000002R022693", "___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": 419, "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": "T000002R022695", "___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": 428, "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": "T000002R022697", "___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": 438, "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": "T000002R022699", "___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": 448, "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": "T000002R022701", "___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": 464, "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": "T000002R022703", "___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": 474, "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": "T000002R022705", "___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": 485, "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": "T000002R022707", "___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": 496, "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": "T000002R022709", "___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": 521, "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": "T000002R022714", "___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": 878, "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": "T000002R022819", "___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": 891, "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": "T000002R022821", "___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": 904, "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": "T000002R022823", "___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": 917, "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": "T000002R022825", "___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": 930, "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": "T000002R022827", "___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": 943, "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": "T000002R022829", "___s": true }, { "comment": "/**\r\n * Checks to see if the left button was just released 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 left button was just released.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 956, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Checks to see if the left button was just released on this Pointer.", "kind": "function", "name": "leftButtonReleased", "since": "3.18.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the left button was just released." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#leftButtonReleased", "scope": "instance", "___id": "T000002R022831", "___s": true }, { "comment": "/**\r\n * Checks to see if the right button was just released 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 right button was just released.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 969, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Checks to see if the right button was just released on this Pointer.", "kind": "function", "name": "rightButtonReleased", "since": "3.18.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the right button was just released." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#rightButtonReleased", "scope": "instance", "___id": "T000002R022833", "___s": true }, { "comment": "/**\r\n * Checks to see if the middle button was just released 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 middle button was just released.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 982, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Checks to see if the middle button was just released on this Pointer.", "kind": "function", "name": "middleButtonReleased", "since": "3.18.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the middle button was just released." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#middleButtonReleased", "scope": "instance", "___id": "T000002R022835", "___s": true }, { "comment": "/**\r\n * Checks to see if the back button was just released 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 back button was just released.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 995, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Checks to see if the back button was just released on this Pointer.", "kind": "function", "name": "backButtonReleased", "since": "3.18.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the back button was just released." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#backButtonReleased", "scope": "instance", "___id": "T000002R022837", "___s": true }, { "comment": "/**\r\n * Checks to see if the forward button was just released 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 forward button was just released.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 1008, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Checks to see if the forward button was just released on this Pointer.", "kind": "function", "name": "forwardButtonReleased", "since": "3.18.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the forward button was just released." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#forwardButtonReleased", "scope": "instance", "___id": "T000002R022839", "___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": 1021, "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": "T000002R022841", "___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` and `downY` values and the current 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": 1048, "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` and `downY` values and the current 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": "T000002R022843", "___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 `downX` and `downY` values and the current 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": 1072, "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 `downX` and `downY` values and the current 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": "T000002R022845", "___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": 1096, "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": "T000002R022847", "___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": 1120, "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": "T000002R022849", "___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": 1149, "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": "T000002R022851", "___s": true }, { "comment": "/**\r\n * Fully reset this Pointer back to its unitialized state.\r\n *\r\n * @method Phaser.Input.Pointer#reset\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 1200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Fully reset this Pointer back to its unitialized state.", "kind": "function", "name": "reset", "since": "3.60.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#reset", "scope": "instance", "___id": "T000002R022864", "___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": 1245, "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": "T000002R022894", "___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": 1258, "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": "T000002R022899", "___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": 1281, "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": "T000002R022904", "___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": 1304, "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": "T000002R022909", "___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": "T000002R022913", "___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": "T000002R022919", "___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": "T000002R022922", "___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": "T000002R022924", "___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": "T000002R022926", "___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": "T000002R022928", "___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": "T000002R022930", "___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": "T000002R022932", "___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": "T000002R022934", "___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": "T000002R022936", "___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": "T000002R022938", "___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": "T000002R022940", "___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": "T000002R022942", "___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": "T000002R022944", "___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 prevent defaulting 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 prevent defaulting 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": "T000002R022954", "___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": "T000002R022956", "___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": "T000002R022977", "___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": "T000002R022981", "___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": "T000002R022987", "___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": "T000002R022988", "___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": "T000002R022989", "___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` the 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.\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` the 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.", "name": "alphaTolerance" } ], "memberof": "Phaser.Types.Input", "longname": "Phaser.Types.Input.InputConfiguration", "scope": "static", "___id": "T000002R022990", "___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": "T000002R022991", "___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": "T000002R022992", "___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": "T000002R022994", "___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": "T000002R022996", "___s": true }, { "comment": "/**\r\n * The Loader is processing files is 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 is 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": "T000002R022998", "___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": "T000002R023000", "___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": "T000002R023002", "___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": "T000002R023004", "___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": "T000002R023006", "___s": true }, { "comment": "/**\r\n * File has been started to load 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 been started to load 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": "T000002R023008", "___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": "T000002R023010", "___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": "T000002R023012", "___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": "T000002R023014", "___s": true }, { "comment": "/**\r\n * The File has errored somehow 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 has errored somehow 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": "T000002R023016", "___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": "T000002R023018", "___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": "T000002R023020", "___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": "T000002R023022", "___s": true }, { "comment": "/**\r\n * File is pending being destroyed.\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 being destroyed.", "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": "T000002R023024", "___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": "T000002R023027", "___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": "T000002R023029", "___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": "T000002R023031", "___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": "T000002R023033", "___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": "T000002R023035", "___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": "T000002R023037", "___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 which errored during load.\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 which errored during load.", "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": "T000002R023039", "___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": "T000002R023041", "___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": "T000002R023053", "___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": "T000002R023055", "___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": "T000002R023057", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The base File class used by all File Types that the Loader can support.\r\n * You shouldn't create an instance of a File directly, but should extend it with your own class, setting a custom type and processing methods.\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.\rYou shouldn't create an instance of a File directly, but should extend it with your own class, setting a custom type and processing methods.", "kind": "class", "name": "File", "memberof": "Phaser.Loader", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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": "T000002R023067", "___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": 35, "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": "T000002R023070", "___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": 44, "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": "T000002R023072", "___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": 53, "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": "T000002R023074", "___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": 67, "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": "T000002R023076", "___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": 99, "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": "T000002R023083", "___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": 112, "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": "T000002R023085", "___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": 122, "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": "T000002R023087", "___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": 136, "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": "T000002R023090", "___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": 145, "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": "T000002R023092", "___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": 154, "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": "T000002R023094", "___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": 165, "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": "T000002R023096", "___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": 176, "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": "T000002R023098", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.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": "T000002R023100", "___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": 197, "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": "T000002R023102", "___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": 206, "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": "T000002R023104", "___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": 215, "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": "T000002R023106", "___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": 225, "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": "T000002R023108", "___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": 237, "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": "T000002R023110", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Resets the XHRLoader instance this file is using.", "kind": "function", "name": "resetXHR", "since": "3.0.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#resetXHR", "scope": "instance", "___id": "T000002R023114", "___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": 268, "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": "T000002R023119", "___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": 307, "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": "T000002R023124", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "kind": "function", "name": "onError", "since": "3.0.0", "params": [ { "type": { "names": [ "XMLHttpRequest" ], "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 error.", "name": "event" } ], "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#onError", "scope": "instance", "___id": "T000002R023131", "___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": 356, "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": "T000002R023133", "___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": 378, "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": "T000002R023138", "___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": 392, "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": "T000002R023141", "___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": 411, "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": "T000002R023144", "___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": 433, "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": "T000002R023147", "___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": 448, "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": "T000002R023149", "___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": 463, "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": "T000002R023151", "___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": 492, "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": "T000002R023157", "___s": true }, { "comment": "/**\r\n * Static method for creating object URL using URL API and setting it as image 'src' attribute.\r\n * If URL API is not supported (usually on old browsers) it falls back to creating 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": 510, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Static method for creating object URL using URL API and setting it as image 'src' attribute.\rIf URL API is not supported (usually on old browsers) it falls back to creating Base64 encoded url using FileReader.", "kind": "function", "name": "createObjectURL", "scope": "static", "since": "3.7.0", "params": [ { "type": { "names": [ "HTMLImageElement" ], "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": "T000002R023165", "___s": true }, { "comment": "/**\r\n * Static method for releasing an existing object URL which was previously created\r\n * by calling {@link 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": 544, "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 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": "T000002R023172", "___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": "T000002R023179", "___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": "T000002R023184", "___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": "T000002R023186", "___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 Managers `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 Managers `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": "T000002R023188", "___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 * https://www.codeandweb.com/texturepacker/tutorials/how-to-create-sprite-sheets-for-phaser3?source=photonstorm\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 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\rhttps://www.codeandweb.com/texturepacker/tutorials/how-to-create-sprite-sheets-for-phaser3?source=photonstorm", "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": "T000002R023198", "___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": 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.AsepriteFile", "longname": "Phaser.Loader.FileTypes.AsepriteFile#addToCache", "scope": "instance", "___id": "T000002R023219", "___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, i.e.:\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.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": 111, "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, i.e.:\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.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": "T000002R023225", "___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 * https://www.codeandweb.com/texturepacker/tutorials/how-to-create-sprite-sheets-for-phaser3?source=photonstorm\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\rhttps://www.codeandweb.com/texturepacker/tutorials/how-to-create-sprite-sheets-for-phaser3?source=photonstorm", "kind": "class", "name": "AtlasJSONFile", "augments": [ "Phaser.Loader.MultiFile" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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": "T000002R023238", "___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": "T000002R023259", "___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": "T000002R023265", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single XML based Texture Atlas File suitable for loading by the Loader.\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": "A single XML based Texture Atlas File suitable for loading by the Loader.\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": "T000002R023278", "___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.AtlasXMLFile#addToCache\r\n * @since 3.7.0\r\n */", "meta": { "filename": "AtlasXMLFile.js", "lineno": 85, "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.AtlasXMLFile", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#addToCache", "scope": "instance", "___id": "T000002R023299", "___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": 107, "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": "T000002R023305", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Audio File suitable for loading by the Loader.\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.\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": "T000002R023318", "___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.AudioFile#onProcess\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AudioFile.js", "lineno": 67, "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.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "longname": "Phaser.Loader.FileTypes.AudioFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R023336", "___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": 172, "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": "T000002R023359", "___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": "T000002R023375", "___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": "T000002R023394", "___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": "T000002R023401", "___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 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 * 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 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\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": "T000002R023406", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Binary File suitable for loading by the Loader.\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\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": "T000002R023420", "___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.BinaryFile#onProcess\r\n * @since 3.7.0\r\n */", "meta": { "filename": "BinaryFile.js", "lineno": 69, "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.BinaryFile", "longname": "Phaser.Loader.FileTypes.BinaryFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R023441", "___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": 89, "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": "T000002R023446", "___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": "T000002R023457", "___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": "T000002R023478", "___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 atlas has finished loading you can use 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```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 atlas has finished loading you can use 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": "T000002R023488", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Compressed Texture File suitable for loading by the Loader.\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": 21, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A Compressed Texture File suitable for loading by the Loader.\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": "T000002R023507", "___s": true }, { "comment": "/**\r\n * Called by each File when it finishes loading.\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": 96, "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.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": "T000002R023530", "___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.CompressedTextureFile#addToCache\r\n * @since 3.60.0\r\n */", "meta": { "filename": "CompressedTextureFile.js", "lineno": 185, "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.60.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#addToCache", "scope": "instance", "___id": "T000002R023549", "___s": true }, { "comment": "/**\r\n * Adds all of the multi-file entties to their target caches upon successful loading and processing.\r\n *\r\n * @method Phaser.Loader.FileTypes.CompressedTextureFile#addMultiToCache\r\n * @since 3.60.0\r\n */", "meta": { "filename": "CompressedTextureFile.js", "lineno": 233, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds all of the multi-file entties to their target caches upon successful loading and processing.", "kind": "function", "name": "addMultiToCache", "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#addMultiToCache", "scope": "instance", "___id": "T000002R023562", "___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', atlasURL: `${path}/textures.json` },\r\n * 'PVRTC': { type: 'PVR', atlasURL: `${path}/textures-pvrtc-4bpp-rgba.json` },\r\n * 'S3TC': { type: 'PVR', atlasURL: `${path}/textures-dxt5.json` },\r\n * 'IMG': { atlasURL: `${path}/textures.json` }\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 * Mali Texture Compression Tool (https://developer.arm.com/tools-and-software/graphics-and-gaming/mali-texture-compression-tool)\r\n * ASTC Encoder (https://github.com/ARM-software/astc-encoder)\r\n *\r\n * ASTCs must have a Channel Type of Unsigned Normalized Bytes (UNorm) and a Linear RGB Color Space.\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 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 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": 313, "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', atlasURL: `${path}/textures.json` },\r 'PVRTC': { type: 'PVR', atlasURL: `${path}/textures-pvrtc-4bpp-rgba.json` },\r 'S3TC': { type: 'PVR', atlasURL: `${path}/textures-dxt5.json` },\r 'IMG': { atlasURL: `${path}/textures.json` }\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.\rMali Texture Compression Tool (https://developer.arm.com/tools-and-software/graphics-and-gaming/mali-texture-compression-tool)\rASTC Encoder (https://github.com/ARM-software/astc-encoder)\r\rASTCs must have a Channel Type of Unsigned Normalized Bytes (UNorm) and a Linear RGB Color Space.\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 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 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": "T000002R023584", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single CSS File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#css 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#css.\r\n *\r\n * @class CSSFile\r\n * @extends Phaser.Loader.File\r\n * @memberof Phaser.Loader.FileTypes\r\n * @constructor\r\n * @since 3.17.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.CSSFileConfig)} 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 `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "CSSFile.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single CSS File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#css method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#css.", "kind": "class", "name": "CSSFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.17.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.CSSFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CSSFileConfig" } ] } }, "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 `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".", "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" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.CSSFile", "___id": "T000002R023622", "___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.CSSFile#onProcess\r\n * @since 3.17.0\r\n */", "meta": { "filename": "CSSFile.js", "lineno": 66, "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.17.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "longname": "Phaser.Loader.FileTypes.CSSFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R023640", "___s": true }, { "comment": "/**\r\n * Adds a CSS file, or array of CSS 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.css('headers', 'styles/headers.css');\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 and not already in-use by another file in the Loader.\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.css({\r\n * key: 'headers',\r\n * url: 'styles/headers.css'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.CSSFileConfig` for more details.\r\n *\r\n * Once the file has finished loading it will automatically be converted into a style DOM element\r\n * via `document.createElement('style')`. It will have its `defer` property set to false and then the\r\n * resulting element will be appended to `document.head`. The CSS styles are then applied to the current document.\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.css\". It will always add `.css` 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 CSS 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#css\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.17.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.CSSFileConfig|Phaser.Types.Loader.FileTypes.CSSFileConfig[])} 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 `.css`, i.e. if `key` was \"alien\" then the URL will be \"alien.css\".\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": "CSSFile.js", "lineno": 88, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a CSS file, or array of CSS 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.css('headers', 'styles/headers.css');\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 and not already in-use by another file in the Loader.\r\rInstead of passing arguments you can pass a configuration object, such as:\r\r```javascript\rthis.load.css({\r key: 'headers',\r url: 'styles/headers.css'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.CSSFileConfig` for more details.\r\rOnce the file has finished loading it will automatically be converted into a style DOM element\rvia `document.createElement('style')`. It will have its `defer` property set to false and then the\rresulting element will be appended to `document.head`. The CSS styles are then applied to the current document.\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.css\". It will always add `.css` 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 CSS File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "css", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.17.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.CSSFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CSSFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.CSSFileConfig", "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 `.css`, i.e. if `key` was \"alien\" then the URL will be \"alien.css\".", "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#css", "scope": "instance", "___id": "T000002R023646", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single GLSL File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#glsl 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#glsl.\r\n *\r\n * @class GLSLFile\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.GLSLFileConfig)} 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 `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".\r\n * @param {string} [shaderType='fragment'] - The type of shader. Either `fragment` for a fragment shader, or `vertex` for a vertex shader. This is ignored if you load a shader bundle.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "GLSLFile.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single GLSL File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#glsl method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#glsl.", "kind": "class", "name": "GLSLFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.GLSLFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.GLSLFileConfig" } ] } }, "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 `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'fragment'", "description": "The type of shader. Either `fragment` for a fragment shader, or `vertex` for a vertex shader. This is ignored if you load a shader bundle.", "name": "shaderType" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "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.GLSLFile", "___id": "T000002R023656", "___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.GLSLFile#onProcess\r\n * @since 3.7.0\r\n */", "meta": { "filename": "GLSLFile.js", "lineno": 76, "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.GLSLFile", "longname": "Phaser.Loader.FileTypes.GLSLFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R023678", "___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.GLSLFile#addToCache\r\n * @since 3.17.0\r\n */", "meta": { "filename": "GLSLFile.js", "lineno": 92, "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.17.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "longname": "Phaser.Loader.FileTypes.GLSLFile#addToCache", "scope": "instance", "overrides": "Phaser.Loader.File#addToCache", "___id": "T000002R023682", "___s": true }, { "comment": "/**\r\n * Returns the name of the shader from the header block.\r\n *\r\n * @method Phaser.Loader.FileTypes.GLSLFile#getShaderName\r\n * @since 3.17.0\r\n *\r\n * @param {string[]} headerSource - The header data.\r\n *\r\n * @return {string} The shader name.\r\n */", "meta": { "filename": "GLSLFile.js", "lineno": 155, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Returns the name of the shader from the header block.", "kind": "function", "name": "getShaderName", "since": "3.17.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "The header data.", "name": "headerSource" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The shader name." } ], "memberof": "Phaser.Loader.FileTypes.GLSLFile", "longname": "Phaser.Loader.FileTypes.GLSLFile#getShaderName", "scope": "instance", "___id": "T000002R023695", "___s": true }, { "comment": "/**\r\n * Returns the type of the shader from the header block.\r\n *\r\n * @method Phaser.Loader.FileTypes.GLSLFile#getShaderType\r\n * @since 3.17.0\r\n *\r\n * @param {string[]} headerSource - The header data.\r\n *\r\n * @return {string} The shader type. Either 'fragment' or 'vertex'.\r\n */", "meta": { "filename": "GLSLFile.js", "lineno": 180, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Returns the type of the shader from the header block.", "kind": "function", "name": "getShaderType", "since": "3.17.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "The header data.", "name": "headerSource" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The shader type. Either 'fragment' or 'vertex'." } ], "memberof": "Phaser.Loader.FileTypes.GLSLFile", "longname": "Phaser.Loader.FileTypes.GLSLFile#getShaderType", "scope": "instance", "___id": "T000002R023699", "___s": true }, { "comment": "/**\r\n * Returns the shader uniforms from the header block.\r\n *\r\n * @method Phaser.Loader.FileTypes.GLSLFile#getShaderUniforms\r\n * @since 3.17.0\r\n *\r\n * @param {string[]} headerSource - The header data.\r\n *\r\n * @return {any} The shader uniforms object.\r\n */", "meta": { "filename": "GLSLFile.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Returns the shader uniforms from the header block.", "kind": "function", "name": "getShaderUniforms", "since": "3.17.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "The header data.", "name": "headerSource" } ], "returns": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The shader uniforms object." } ], "memberof": "Phaser.Loader.FileTypes.GLSLFile", "longname": "Phaser.Loader.FileTypes.GLSLFile#getShaderUniforms", "scope": "instance", "___id": "T000002R023703", "___s": true }, { "comment": "/**\r\n * Adds a GLSL file, or array of GLSL files, to the current load queue.\r\n * In Phaser 3 GLSL files are just plain Text files at the current moment in time.\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.glsl('plasma', 'shaders/Plasma.glsl');\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 Shader 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 Shader 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 Shader 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.glsl({\r\n * key: 'plasma',\r\n * shaderType: 'fragment',\r\n * url: 'shaders/Plasma.glsl'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.GLSLFileConfig` 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.glsl('plasma', 'shaders/Plasma.glsl');\r\n * // and later in your game ...\r\n * var data = this.cache.shader.get('plasma');\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 `FX.` and the key was `Plasma` the final key will be `FX.Plasma` and\r\n * this is what you would use to retrieve the text from the Shader 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 \"plasma\"\r\n * and no URL is given then the Loader will set the URL to be \"plasma.glsl\". It will always add `.glsl` 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 GLSL 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#glsl\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.GLSLFileConfig|Phaser.Types.Loader.FileTypes.GLSLFileConfig[])} 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 `.glsl`, i.e. if `key` was \"alien\" then the URL will be \"alien.glsl\".\r\n * @param {string} [shaderType='fragment'] - The type of shader. Either `fragment` for a fragment shader, or `vertex` for a vertex shader. This is ignored if you load a shader bundle.\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": "GLSLFile.js", "lineno": 315, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a GLSL file, or array of GLSL files, to the current load queue.\rIn Phaser 3 GLSL files are just plain Text files at the current moment in time.\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.glsl('plasma', 'shaders/Plasma.glsl');\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 Shader Cache upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the Shader 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 Shader 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.glsl({\r key: 'plasma',\r shaderType: 'fragment',\r url: 'shaders/Plasma.glsl'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.GLSLFileConfig` 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.glsl('plasma', 'shaders/Plasma.glsl');\r// and later in your game ...\rvar data = this.cache.shader.get('plasma');\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 `FX.` and the key was `Plasma` the final key will be `FX.Plasma` and\rthis is what you would use to retrieve the text from the Shader 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 \"plasma\"\rand no URL is given then the Loader will set the URL to be \"plasma.glsl\". It will always add `.glsl` 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 GLSL File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "glsl", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.GLSLFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.GLSLFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.GLSLFileConfig", "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 `.glsl`, i.e. if `key` was \"alien\" then the URL will be \"alien.glsl\".", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'fragment'", "description": "The type of shader. Either `fragment` for a fragment shader, or `vertex` for a vertex shader. This is ignored if you load a shader bundle.", "name": "shaderType" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "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#glsl", "scope": "instance", "___id": "T000002R023732", "___s": true }, { "comment": "/**\n * @classdesc\n * A single Audio File suitable for loading by the Loader.\n *\n * These are created when you use the Phaser.Loader.LoaderPlugin#audio method and are not typically created directly.\n *\n * For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#audio.\n *\n * @class HTML5AudioFile\n * @extends Phaser.Loader.File\n * @memberof Phaser.Loader.FileTypes\n * @constructor\n * @since 3.0.0\n *\n * @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader that is responsible for this file.\n * @param {(string|Phaser.Types.Loader.FileTypes.AudioFileConfig)} key - The key to use for this file, or a file configuration object.\n * @param {string} [urlConfig] - The absolute or relative URL to load this file from.\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\n */", "meta": { "filename": "HTML5AudioFile.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Audio File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#audio method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#audio.", "kind": "class", "name": "HTML5AudioFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load this file from.", "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" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile", "___id": "T000002R023741", "___s": true }, { "comment": "/**\n * Called when the file finishes loading.\n *\n * @method Phaser.Loader.FileTypes.HTML5AudioFile#onLoad\n * @since 3.0.0\n */", "meta": { "filename": "HTML5AudioFile.js", "lineno": 67, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Called when the file finishes loading.", "kind": "function", "name": "onLoad", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#onLoad", "scope": "instance", "overrides": "Phaser.Loader.File#onLoad", "___id": "T000002R023759", "___s": true }, { "comment": "/**\n * Called if the file errors while loading.\n *\n * @method Phaser.Loader.FileTypes.HTML5AudioFile#onError\n * @since 3.0.0\n */", "meta": { "filename": "HTML5AudioFile.js", "lineno": 85, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Called if the file errors while loading.", "kind": "function", "name": "onError", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#onError", "scope": "instance", "overrides": "Phaser.Loader.File#onError", "___id": "T000002R023762", "___s": true }, { "comment": "/**\n * Called during the file load progress. Is sent a DOM ProgressEvent.\n *\n * @method Phaser.Loader.FileTypes.HTML5AudioFile#onProgress\n * @fires Phaser.Loader.Events#FILE_PROGRESS\n * @since 3.0.0\n */", "meta": { "filename": "HTML5AudioFile.js", "lineno": 104, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "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", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#onProgress", "scope": "instance", "overrides": "Phaser.Loader.File#onProgress", "___id": "T000002R023768", "___s": true }, { "comment": "/**\n * Called by the Loader, starts the actual file downloading.\n * During the load the methods onLoad, onError and onProgress are called, based on the XHR events.\n * You shouldn't normally call this method directly, it's meant to be invoked by the Loader.\n *\n * @method Phaser.Loader.FileTypes.HTML5AudioFile#load\n * @since 3.0.0\n */", "meta": { "filename": "HTML5AudioFile.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.", "kind": "function", "name": "load", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#load", "scope": "instance", "overrides": "Phaser.Loader.File#load", "___id": "T000002R023774", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single HTML File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#html 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#html.\r\n *\r\n * @class HTMLFile\r\n * @extends Phaser.Loader.File\r\n * @memberof Phaser.Loader.FileTypes\r\n * @constructor\r\n * @since 3.12.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.HTMLFileConfig)} 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 `.html`, i.e. if `key` was \"alien\" then the URL will be \"alien.html\".\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "HTMLFile.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single HTML File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#html method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#html.", "kind": "class", "name": "HTMLFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.12.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.HTMLFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.HTMLFileConfig" } ] } }, "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 `.html`, i.e. if `key` was \"alien\" then the URL will be \"alien.html\".", "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" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.HTMLFile", "___id": "T000002R023801", "___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.HTMLFile#onProcess\r\n * @since 3.7.0\r\n */", "meta": { "filename": "HTMLFile.js", "lineno": 66, "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.HTMLFile", "longname": "Phaser.Loader.FileTypes.HTMLFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R023819", "___s": true }, { "comment": "/**\r\n * Adds an HTML file, or array of HTML 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.html('story', 'files/LoginForm.html');\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 HTML 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 HTML 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 HTML 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.html({\r\n * key: 'login',\r\n * url: 'files/LoginForm.html'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.HTMLFileConfig` 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.html('login', 'files/LoginForm.html');\r\n * // and later in your game ...\r\n * var data = this.cache.html.get('login');\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 `Story` the final key will be `LEVEL1.Story` and\r\n * this is what you would use to retrieve the html from the HTML 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 \"story\"\r\n * and no URL is given then the Loader will set the URL to be \"story.html\". It will always add `.html` 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 HTML 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#html\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.12.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.HTMLFileConfig|Phaser.Types.Loader.FileTypes.HTMLFileConfig[])} 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 `.html`, i.e. if `key` was \"alien\" then the URL will be \"alien.html\".\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": "HTMLFile.js", "lineno": 84, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds an HTML file, or array of HTML 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.html('story', 'files/LoginForm.html');\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 HTML Cache upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the HTML 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 HTML 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.html({\r key: 'login',\r url: 'files/LoginForm.html'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.HTMLFileConfig` 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.html('login', 'files/LoginForm.html');\r// and later in your game ...\rvar data = this.cache.html.get('login');\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 `Story` the final key will be `LEVEL1.Story` and\rthis is what you would use to retrieve the html from the HTML 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 \"story\"\rand no URL is given then the Loader will set the URL to be \"story.html\". It will always add `.html` 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 HTML File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "html", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.12.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.HTMLFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.HTMLFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.HTMLFileConfig", "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 `.html`, i.e. if `key` was \"alien\" then the URL will be \"alien.html\".", "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#html", "scope": "instance", "___id": "T000002R023823", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single HTML File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#htmlTexture 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#htmlTexture.\r\n *\r\n * @class HTMLTextureFile\r\n * @extends Phaser.Loader.File\r\n * @memberof Phaser.Loader.FileTypes\r\n * @constructor\r\n * @since 3.12.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.HTMLTextureFileConfig)} 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 `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".\r\n * @param {number} [width] - The width of the texture the HTML will be rendered to.\r\n * @param {number} [height] - The height of the texture the HTML will be rendered to.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "HTMLTextureFile.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single HTML File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#htmlTexture method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#htmlTexture.", "kind": "class", "name": "HTMLTextureFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.12.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.HTMLTextureFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig" } ] } }, "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 `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".", "name": "url" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the texture the HTML will be rendered to.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the texture the HTML will be rendered to.", "name": "height" }, { "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.HTMLTextureFile", "___id": "T000002R023832", "___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.HTMLTextureFile#onProcess\r\n * @since 3.7.0\r\n */", "meta": { "filename": "HTMLTextureFile.js", "lineno": 77, "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.HTMLTextureFile", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R023857", "___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.HTMLTextureFile#addToCache\r\n * @since 3.7.0\r\n */", "meta": { "filename": "HTMLTextureFile.js", "lineno": 138, "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.HTMLTextureFile", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#addToCache", "scope": "instance", "overrides": "Phaser.Loader.File#addToCache", "___id": "T000002R023872", "___s": true }, { "comment": "/**\r\n * Adds an HTML File, or array of HTML Files, to the current load queue. When the files are loaded they\r\n * will be rendered to textures and stored in the Texture Manager.\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.htmlTexture('instructions', 'content/intro.html', 256, 512);\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 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.htmlTexture({\r\n * key: 'instructions',\r\n * url: 'content/intro.html',\r\n * width: 256,\r\n * height: 512\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig` for more details.\r\n *\r\n * Once the file has finished loading you can use it as a texture for a Game Object by referencing its key:\r\n *\r\n * ```javascript\r\n * this.load.htmlTexture('instructions', 'content/intro.html', 256, 512);\r\n * // and later in your game ...\r\n * this.add.image(x, y, 'instructions');\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 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.html\". It will always add `.html` 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 * The width and height are the size of the texture to which the HTML will be rendered. It's not possible to determine these\r\n * automatically, so you will need to provide them, either as arguments or in the file config object.\r\n * When the HTML file has loaded a new SVG element is created with a size and viewbox set to the width and height given.\r\n * The SVG file has a body tag added to it, with the HTML file contents included. It then calls `window.Blob` on the SVG,\r\n * and if successful is added to the Texture Manager, otherwise it fails processing. The overall quality of the rendered\r\n * HTML depends on your browser, and some of them may not even support the svg / blob process used. Be aware that there are\r\n * limitations on what HTML can be inside an SVG. You can find out more details in this\r\n * [Mozilla MDN entry](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API/Drawing_DOM_objects_into_a_canvas).\r\n *\r\n * Note: The ability to load this type of file will only be available if the HTMLTextureFile 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#htmlTexture\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.12.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig|Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig[])} 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 `.html`, i.e. if `key` was \"alien\" then the URL will be \"alien.html\".\r\n * @param {number} [width=512] - The width of the texture the HTML will be rendered to.\r\n * @param {number} [height=512] - The height of the texture the HTML will be rendered to.\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": "HTMLTextureFile.js", "lineno": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds an HTML File, or array of HTML Files, to the current load queue. When the files are loaded they\rwill be rendered to textures and stored in the Texture Manager.\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.htmlTexture('instructions', 'content/intro.html', 256, 512);\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 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.htmlTexture({\r key: 'instructions',\r url: 'content/intro.html',\r width: 256,\r height: 512\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig` for more details.\r\rOnce the file has finished loading you can use it as a texture for a Game Object by referencing its key:\r\r```javascript\rthis.load.htmlTexture('instructions', 'content/intro.html', 256, 512);\r// and later in your game ...\rthis.add.image(x, y, 'instructions');\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 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.html\". It will always add `.html` 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\rThe width and height are the size of the texture to which the HTML will be rendered. It's not possible to determine these\rautomatically, so you will need to provide them, either as arguments or in the file config object.\rWhen the HTML file has loaded a new SVG element is created with a size and viewbox set to the width and height given.\rThe SVG file has a body tag added to it, with the HTML file contents included. It then calls `window.Blob` on the SVG,\rand if successful is added to the Texture Manager, otherwise it fails processing. The overall quality of the rendered\rHTML depends on your browser, and some of them may not even support the svg / blob process used. Be aware that there are\rlimitations on what HTML can be inside an SVG. You can find out more details in this\r[Mozilla MDN entry](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API/Drawing_DOM_objects_into_a_canvas).\r\rNote: The ability to load this type of file will only be available if the HTMLTextureFile File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "htmlTexture", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.12.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig", "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 `.html`, i.e. if `key` was \"alien\" then the URL will be \"alien.html\".", "name": "url" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 512, "description": "The width of the texture the HTML will be rendered to.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 512, "description": "The height of the texture the HTML will be rendered to.", "name": "height" }, { "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#htmlTexture", "scope": "instance", "___id": "T000002R023874", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Image File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#image 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#image.\r\n *\r\n * @class ImageFile\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.ImageFileConfig)} key - The key to use for this file, or a file configuration object.\r\n * @param {string|string[]} [url] - The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n * @param {Phaser.Types.Loader.FileTypes.ImageFrameConfig} [frameConfig] - The frame configuration object. Only provided for, and used by, Sprite Sheets.\r\n */", "meta": { "filename": "ImageFile.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Image File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#image method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#image.", "kind": "class", "name": "ImageFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.ImageFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.ImageFileConfig" } ] } }, "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 this file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".", "name": "url" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.ImageFrameConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.ImageFrameConfig" } }, "optional": true, "description": "The frame configuration object. Only provided for, and used by, Sprite Sheets.", "name": "frameConfig" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.ImageFile", "___id": "T000002R023884", "___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.ImageFile#onProcess\r\n * @since 3.7.0\r\n */", "meta": { "filename": "ImageFile.js", "lineno": 98, "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.ImageFile", "longname": "Phaser.Loader.FileTypes.ImageFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R023913", "___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.ImageFile#addToCache\r\n * @since 3.7.0\r\n */", "meta": { "filename": "ImageFile.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.", "kind": "function", "name": "addToCache", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "longname": "Phaser.Loader.FileTypes.ImageFile#addToCache", "scope": "instance", "overrides": "Phaser.Loader.File#addToCache", "___id": "T000002R023936", "___s": true }, { "comment": "/**\r\n * Adds an Image, or array of Images, 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.image('logo', 'images/phaserLogo.png');\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 * Phaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\r\n * If you try to load an animated gif only the first frame will be rendered. Browsers do not natively support playback\r\n * of animated gifs to Canvas elements.\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.image({\r\n * key: 'logo',\r\n * url: 'images/AtariLogo.png'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.ImageFileConfig` for more details.\r\n *\r\n * Once the file has finished loading you can use it as a texture for a Game Object by referencing its key:\r\n *\r\n * ```javascript\r\n * this.load.image('logo', 'images/AtariLogo.png');\r\n * // and later in your game ...\r\n * this.add.image(x, y, 'logo');\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 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.image('logo', [ 'images/AtariLogo.png', 'images/AtariLogo-n.png' ]);\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.image({\r\n * key: 'logo',\r\n * url: 'images/AtariLogo.png',\r\n * normalMap: 'images/AtariLogo-n.png'\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 * In Phaser 3.60 a new property was added that allows you to control how images are loaded. By default, images are loaded via XHR as Blobs.\r\n * However, you can set `loader.imageLoadType: \"HTMLImageElement\"` in the Game Configuration and instead, the Loader will load all images\r\n * via the Image tag instead.\r\n *\r\n * Note: The ability to load this type of file will only be available if the Image 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#image\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.ImageFileConfig|Phaser.Types.Loader.FileTypes.ImageFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.\r\n * @param {string|string[]} [url] - The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".\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": "ImageFile.js", "lineno": 238, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds an Image, or array of Images, 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.image('logo', 'images/phaserLogo.png');\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\rPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\rIf you try to load an animated gif only the first frame will be rendered. Browsers do not natively support playback\rof animated gifs to Canvas elements.\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.image({\r key: 'logo',\r url: 'images/AtariLogo.png'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.ImageFileConfig` for more details.\r\rOnce the file has finished loading you can use it as a texture for a Game Object by referencing its key:\r\r```javascript\rthis.load.image('logo', 'images/AtariLogo.png');\r// and later in your game ...\rthis.add.image(x, y, 'logo');\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 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.image('logo', [ 'images/AtariLogo.png', 'images/AtariLogo-n.png' ]);\r```\r\rOr, if you are using a config object use the `normalMap` property:\r\r```javascript\rthis.load.image({\r key: 'logo',\r url: 'images/AtariLogo.png',\r normalMap: 'images/AtariLogo-n.png'\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\rIn Phaser 3.60 a new property was added that allows you to control how images are loaded. By default, images are loaded via XHR as Blobs.\rHowever, you can set `loader.imageLoadType: \"HTMLImageElement\"` in the Game Configuration and instead, the Loader will load all images\rvia the Image tag instead.\r\rNote: The ability to load this type of file will only be available if the Image File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "image", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.ImageFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.ImageFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.ImageFileConfig", "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 this file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".", "name": "url" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "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#image", "scope": "instance", "___id": "T000002R023939", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Loader.FileTypes\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "kind": "namespace", "name": "FileTypes", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.FileTypes", "scope": "static", "___id": "T000002R023942", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single JSON File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#json 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#json.\r\n *\r\n * @class JSONFile\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 {(object|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\". Or, can be a fully formed JSON Object.\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": "JSONFile.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single JSON File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#json method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#json.", "kind": "class", "name": "JSONFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "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\". Or, can be a fully formed JSON Object.", "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.JSONFile", "___id": "T000002R023984", "___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.JSONFile#onProcess\r\n * @since 3.7.0\r\n */", "meta": { "filename": "JSONFile.js", "lineno": 88, "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.JSONFile", "longname": "Phaser.Loader.FileTypes.JSONFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R024007", "___s": true }, { "comment": "/**\r\n * Adds a JSON file, or array of 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.json('wavedata', 'files/AlienWaveData.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 * 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.json({\r\n * key: 'wavedata',\r\n * url: 'files/AlienWaveData.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 you can access it from its Cache using its key:\r\n *\r\n * ```javascript\r\n * this.load.json('wavedata', 'files/AlienWaveData.json');\r\n * // and later in your game ...\r\n * var data = this.cache.json.get('wavedata');\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 you only wanted to store the `boss` data in the Cache, 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#json\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 {(object|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\". Or, can be a fully formed JSON Object.\r\n * @param {string} [dataKey] - When the JSON file loads only this property will be stored in the Cache.\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": "JSONFile.js", "lineno": 129, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a JSON file, or array of 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.json('wavedata', 'files/AlienWaveData.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\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.json({\r key: 'wavedata',\r url: 'files/AlienWaveData.json'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.JSONFileConfig` 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.json('wavedata', 'files/AlienWaveData.json');\r// and later in your game ...\rvar data = this.cache.json.get('wavedata');\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 you only wanted to store the `boss` data in the Cache, 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": "json", "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": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "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\". Or, can be a fully formed JSON Object.", "name": "url" }, { "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" }, { "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#json", "scope": "instance", "___id": "T000002R024014", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Multi Texture Atlas File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#multiatlas 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#multiatlas.\r\n *\r\n * @class MultiAtlasFile\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.MultiAtlasFileConfig)} key - The key of the file. Must be unique within both the Loader and the Texture Manager. Or a config object.\r\n * @param {string} [atlasURL] - The absolute or relative URL to load the multi atlas json file from.\r\n * @param {string} [path] - Optional path to use when loading the textures defined in the atlas data.\r\n * @param {string} [baseURL] - Optional Base URL to use when loading the textures defined in the atlas data.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [atlasXhrSettings] - Extra XHR Settings specifically for the atlas json file.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - Extra XHR Settings specifically for the texture files.\r\n */", "meta": { "filename": "MultiAtlasFile.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Multi Texture Atlas File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#multiatlas method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#multiatlas.", "kind": "class", "name": "MultiAtlasFile", "augments": [ "Phaser.Loader.MultiFile" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.7.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.MultiAtlasFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig" } ] } }, "description": "The key of the file. Must be unique within both the Loader and the Texture Manager. Or a config object.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the multi atlas json file from.", "name": "atlasURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional path to use when loading the textures defined in the atlas data.", "name": "path" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional Base URL to use when loading the textures defined in the atlas data.", "name": "baseURL" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the atlas json file.", "name": "atlasXhrSettings" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the texture files.", "name": "textureXhrSettings" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile", "___id": "T000002R024024", "___s": true }, { "comment": "/**\r\n * Called by each File when it finishes loading.\r\n *\r\n * @method Phaser.Loader.FileTypes.MultiAtlasFile#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": "MultiAtlasFile.js", "lineno": 75, "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.MultiAtlasFile", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#onFileComplete", "scope": "instance", "overrides": "Phaser.Loader.MultiFile#onFileComplete", "___id": "T000002R024040", "___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.MultiAtlasFile#addToCache\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiAtlasFile.js", "lineno": 148, "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.MultiAtlasFile", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#addToCache", "scope": "instance", "___id": "T000002R024059", "___s": true }, { "comment": "/**\r\n * Adds a Multi Texture Atlas, or array of multi 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.multiatlas('level1', 'images/Level1.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 as exported from the application Texture Packer,\r\n * version 4.6.3 or above, where you have made sure to use the Phaser 3 Export option.\r\n *\r\n * The way it works internally is that you provide a URL to the JSON file. Phaser then loads this JSON, parses it and\r\n * extracts which texture files it also needs to load to complete the process. If the JSON also defines normal maps,\r\n * Phaser will load those as well.\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.multiatlas({\r\n * key: 'level1',\r\n * atlasURL: 'images/Level1.json'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig` 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.multiatlas('level1', 'images/Level1.json');\r\n * // and later in your game ...\r\n * this.add.image(x, y, 'level1', '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 * Note: The ability to load this type of file will only be available if the Multi Atlas 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#multiatlas\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.7.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig|Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.\r\n * @param {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\".\r\n * @param {string} [path] - Optional path to use when loading the textures defined in the atlas data.\r\n * @param {string} [baseURL] - Optional Base URL to use when loading the textures defined in the atlas data.\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": "MultiAtlasFile.js", "lineno": 212, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a Multi Texture Atlas, or array of multi 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.multiatlas('level1', 'images/Level1.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 as exported from the application Texture Packer,\rversion 4.6.3 or above, where you have made sure to use the Phaser 3 Export option.\r\rThe way it works internally is that you provide a URL to the JSON file. Phaser then loads this JSON, parses it and\rextracts which texture files it also needs to load to complete the process. If the JSON also defines normal maps,\rPhaser will load those as well.\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.multiatlas({\r key: 'level1',\r atlasURL: 'images/Level1.json'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig` 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.multiatlas('level1', 'images/Level1.json');\r// and later in your game ...\rthis.add.image(x, y, 'level1', '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\rNote: The ability to load this type of file will only be available if the Multi Atlas File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "multiatlas", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.7.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig", "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 the texture atlas json data file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".", "name": "atlasURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional path to use when loading the textures defined in the atlas data.", "name": "path" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional Base URL to use when loading the textures defined in the atlas data.", "name": "baseURL" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "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#multiatlas", "scope": "instance", "___id": "T000002R024074", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Multi Script File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#scripts 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#scripts.\r\n *\r\n * @class MultiScriptFile\r\n * @extends Phaser.Loader.MultiFile\r\n * @memberof Phaser.Loader.FileTypes\r\n * @constructor\r\n * @since 3.17.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.MultiScriptFileConfig)} key - The key to use for this file, or a file configuration object.\r\n * @param {string[]} [url] - An array of absolute or relative URLs to load the script files from. They are processed in the order given in the array.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - An XHR Settings configuration object for the script files. Used in replacement of the Loaders default XHR Settings.\r\n */", "meta": { "filename": "MultiScriptFile.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A Multi Script File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#scripts method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#scripts.", "kind": "class", "name": "MultiScriptFile", "augments": [ "Phaser.Loader.MultiFile" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.17.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.MultiScriptFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.MultiScriptFileConfig" } ] } }, "description": "The key to use for this file, or a file configuration object.", "name": "key" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of absolute or relative URLs to load the script files from. They are processed in the order given in the array.", "name": "url" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "An XHR Settings configuration object for the script files. Used in replacement of the Loaders default XHR Settings.", "name": "xhrSettings" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.MultiScriptFile", "___id": "T000002R024086", "___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.MultiScriptFile#addToCache\r\n * @since 3.17.0\r\n */", "meta": { "filename": "MultiScriptFile.js", "lineno": 80, "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.17.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#addToCache", "scope": "instance", "___id": "T000002R024105", "___s": true }, { "comment": "/**\r\n * Adds an array of Script files to the current load queue.\r\n *\r\n * The difference between this and the `ScriptFile` file type is that you give an array of scripts to this method,\r\n * and the scripts are then processed _exactly_ in that order. This allows you to load a bunch of scripts that\r\n * may have dependencies on each other without worrying about the async nature of traditional script loading.\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.scripts('PostProcess', [\r\n * 'libs/shaders/CopyShader.js',\r\n * 'libs/postprocessing/EffectComposer.js',\r\n * 'libs/postprocessing/RenderPass.js',\r\n * 'libs/postprocessing/MaskPass.js',\r\n * 'libs/postprocessing/ShaderPass.js',\r\n * 'libs/postprocessing/AfterimagePass.js'\r\n * ]);\r\n * }\r\n * ```\r\n *\r\n * In the code above the script files will all be loaded in parallel but only processed (i.e. invoked) in the exact\r\n * order given in the array.\r\n *\r\n * The files are **not** loaded right away. They are 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 files are queued\r\n * it means you cannot use the files immediately after calling this method, but must wait for the files 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 and not already in-use by another file in the Loader.\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.scripts({\r\n * key: 'PostProcess',\r\n * url: [\r\n * 'libs/shaders/CopyShader.js',\r\n * 'libs/postprocessing/EffectComposer.js',\r\n * 'libs/postprocessing/RenderPass.js',\r\n * 'libs/postprocessing/MaskPass.js',\r\n * 'libs/postprocessing/ShaderPass.js',\r\n * 'libs/postprocessing/AfterimagePass.js'\r\n * ]\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.MultiScriptFileConfig` for more details.\r\n *\r\n * Once all the files have finished loading they will automatically be converted into a script element\r\n * via `document.createElement('script')`. They will have their language set to JavaScript, `defer` set to\r\n * false and then the resulting element will be appended to `document.head`. Any code then in the\r\n * script will be executed. This is done in the exact order the files are specified in the url array.\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 * Note: The ability to load this type of file will only be available if the MultiScript 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#scripts\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.17.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.MultiScriptFileConfig|Phaser.Types.Loader.FileTypes.MultiScriptFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.\r\n * @param {string[]} [url] - An array of absolute or relative URLs to load the script files from. They are processed in the order given in the array.\r\n * @param {string} [extension='js'] - The default file extension to use if no url is provided.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for these files.\r\n *\r\n * @return {this} The Loader instance.\r\n */", "meta": { "filename": "MultiScriptFile.js", "lineno": 109, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds an array of Script files to the current load queue.\r\rThe difference between this and the `ScriptFile` file type is that you give an array of scripts to this method,\rand the scripts are then processed _exactly_ in that order. This allows you to load a bunch of scripts that\rmay have dependencies on each other without worrying about the async nature of traditional script loading.\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.scripts('PostProcess', [\r 'libs/shaders/CopyShader.js',\r 'libs/postprocessing/EffectComposer.js',\r 'libs/postprocessing/RenderPass.js',\r 'libs/postprocessing/MaskPass.js',\r 'libs/postprocessing/ShaderPass.js',\r 'libs/postprocessing/AfterimagePass.js'\r ]);\r}\r```\r\rIn the code above the script files will all be loaded in parallel but only processed (i.e. invoked) in the exact\rorder given in the array.\r\rThe files are **not** loaded right away. They are 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 files are queued\rit means you cannot use the files immediately after calling this method, but must wait for the files 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 and not already in-use by another file in the Loader.\r\rInstead of passing arguments you can pass a configuration object, such as:\r\r```javascript\rthis.load.scripts({\r key: 'PostProcess',\r url: [\r 'libs/shaders/CopyShader.js',\r 'libs/postprocessing/EffectComposer.js',\r 'libs/postprocessing/RenderPass.js',\r 'libs/postprocessing/MaskPass.js',\r 'libs/postprocessing/ShaderPass.js',\r 'libs/postprocessing/AfterimagePass.js'\r ]\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.MultiScriptFileConfig` for more details.\r\rOnce all the files have finished loading they will automatically be converted into a script element\rvia `document.createElement('script')`. They will have their language set to JavaScript, `defer` set to\rfalse and then the resulting element will be appended to `document.head`. Any code then in the\rscript will be executed. This is done in the exact order the files are specified in the url array.\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\rNote: The ability to load this type of file will only be available if the MultiScript File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "scripts", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.17.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.MultiScriptFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.MultiScriptFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.MultiScriptFileConfig", "type": "NameExpression" } ] } ] } }, "description": "The key to use for this file, or a file configuration object, or array of them.", "name": "key" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of absolute or relative URLs to load the script files from. They are processed in the order given in the array.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'js'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for these files.", "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#scripts", "scope": "instance", "___id": "T000002R024115", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Wavefront OBJ File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#obj 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#obj.\r\n *\r\n * @class OBJFile\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.OBJFileConfig)} key - The key to use for this file, or a file configuration object.\r\n * @param {string} [objURL] - The absolute or relative URL to load the obj file from. If undefined or `null` it will be set to `.obj`, i.e. if `key` was \"alien\" then the URL will be \"alien.obj\".\r\n * @param {string} [matURL] - The absolute or relative URL to load the material file from. If undefined or `null` it will be set to `.mat`, i.e. if `key` was \"alien\" then the URL will be \"alien.mat\".\r\n * @param {boolean} [flipUV] - Flip the UV coordinates stored in the model data?\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for these files.\r\n */", "meta": { "filename": "OBJFile.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Wavefront OBJ File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#obj method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#obj.", "kind": "class", "name": "OBJFile", "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.OBJFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.OBJFileConfig" } ] } }, "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 the obj file from. If undefined or `null` it will be set to `.obj`, i.e. if `key` was \"alien\" then the URL will be \"alien.obj\".", "name": "objURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the material file from. If undefined or `null` it will be set to `.mat`, i.e. if `key` was \"alien\" then the URL will be \"alien.mat\".", "name": "matURL" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Flip the UV coordinates stored in the model data?", "name": "flipUV" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for these files.", "name": "xhrSettings" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.OBJFile", "___id": "T000002R024129", "___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.OBJFile#addToCache\r\n * @since 3.50.0\r\n */", "meta": { "filename": "OBJFile.js", "lineno": 112, "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.50.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "longname": "Phaser.Loader.FileTypes.OBJFile#addToCache", "scope": "instance", "___id": "T000002R024171", "___s": true }, { "comment": "/**\r\n * Adds a Wavefront OBJ file, or array of OBJ files, to the current load queue.\r\n *\r\n * Note: You should ensure your 3D package has triangulated the OBJ file prior to export.\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.obj('ufo', 'files/spaceship.obj');\r\n * }\r\n * ```\r\n *\r\n * You can optionally also load a Wavefront Material file as well, by providing the 3rd parameter:\r\n *\r\n * ```javascript\r\n * function preload ()\r\n * {\r\n * this.load.obj('ufo', 'files/spaceship.obj', 'files/spaceship.mtl');\r\n * }\r\n * ```\r\n *\r\n * If given, the material will be parsed and stored along with the obj data in the cache.\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 OBJ 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 OBJ 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 OBJ 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.obj({\r\n * key: 'ufo',\r\n * url: 'files/spaceship.obj',\r\n * matURL: 'files/spaceship.mtl',\r\n * flipUV: true\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.OBJFileConfig` 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.obj('ufo', 'files/spaceship.obj');\r\n * // and later in your game ...\r\n * var data = this.cache.obj.get('ufo');\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 `Story` the final key will be `LEVEL1.Story` and\r\n * this is what you would use to retrieve the obj from the OBJ 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 \"story\"\r\n * and no URL is given then the Loader will set the URL to be \"story.obj\". It will always add `.obj` 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 OBJ 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#obj\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.50.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.OBJFileConfig|Phaser.Types.Loader.FileTypes.OBJFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.\r\n * @param {string} [objURL] - The absolute or relative URL to load the obj file from. If undefined or `null` it will be set to `.obj`, i.e. if `key` was \"alien\" then the URL will be \"alien.obj\".\r\n * @param {string} [matURL] - Optional absolute or relative URL to load the obj material file from.\r\n * @param {boolean} [flipUV] - Flip the UV coordinates stored in the model 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": "OBJFile.js", "lineno": 140, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a Wavefront OBJ file, or array of OBJ files, to the current load queue.\r\rNote: You should ensure your 3D package has triangulated the OBJ file prior to export.\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.obj('ufo', 'files/spaceship.obj');\r}\r```\r\rYou can optionally also load a Wavefront Material file as well, by providing the 3rd parameter:\r\r```javascript\rfunction preload ()\r{\r this.load.obj('ufo', 'files/spaceship.obj', 'files/spaceship.mtl');\r}\r```\r\rIf given, the material will be parsed and stored along with the obj data in the cache.\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 OBJ Cache upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the OBJ 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 OBJ 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.obj({\r key: 'ufo',\r url: 'files/spaceship.obj',\r matURL: 'files/spaceship.mtl',\r flipUV: true\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.OBJFileConfig` 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.obj('ufo', 'files/spaceship.obj');\r// and later in your game ...\rvar data = this.cache.obj.get('ufo');\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 `Story` the final key will be `LEVEL1.Story` and\rthis is what you would use to retrieve the obj from the OBJ 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 \"story\"\rand no URL is given then the Loader will set the URL to be \"story.obj\". It will always add `.obj` 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 OBJ File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "obj", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.50.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.OBJFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.OBJFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.OBJFileConfig", "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 the obj file from. If undefined or `null` it will be set to `.obj`, i.e. if `key` was \"alien\" then the URL will be \"alien.obj\".", "name": "objURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional absolute or relative URL to load the obj material file from.", "name": "matURL" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Flip the UV coordinates stored in the model data?", "name": "flipUV" }, { "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#obj", "scope": "instance", "___id": "T000002R024178", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single JSON Pack File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#pack 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#pack.\r\n *\r\n * @class PackFile\r\n * @extends Phaser.Loader.File\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.PackFileConfig)} key - The key to use for this file, or a file configuration object.\r\n * @param {(string|any)} [url] - The absolute or relative URL to load this file from or a ready formed JSON object. 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": "PackFile.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single JSON Pack File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#pack method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#pack.", "kind": "class", "name": "PackFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.7.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.PackFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.PackFileConfig" } ] } }, "description": "The key to use for this file, or a file configuration object.", "name": "key" }, { "type": { "names": [ "string", "any" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "any" } ] } }, "optional": true, "description": "The absolute or relative URL to load this file from or a ready formed JSON object. 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.PackFile", "___id": "T000002R024188", "___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.PackFile#onProcess\r\n * @since 3.7.0\r\n */", "meta": { "filename": "PackFile.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.PackFile", "longname": "Phaser.Loader.FileTypes.PackFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R024193", "___s": true }, { "comment": "/**\r\n * Adds a JSON File Pack, or array of packs, 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.pack('level1', 'data/Level1Files.json');\r\n * }\r\n * ```\r\n *\r\n * A File Pack is a JSON file (or object) that contains details about other files that should be added into the Loader.\r\n * Here is a small example:\r\n *\r\n * ```json\r\n * {\r\n * \"test1\": {\r\n * \"files\": [\r\n * {\r\n * \"type\": \"image\",\r\n * \"key\": \"taikodrummaster\",\r\n * \"url\": \"assets/pics/taikodrummaster.jpg\"\r\n * },\r\n * {\r\n * \"type\": \"image\",\r\n * \"key\": \"sukasuka-chtholly\",\r\n * \"url\": \"assets/pics/sukasuka-chtholly.png\"\r\n * }\r\n * ]\r\n * },\r\n * \"meta\": {\r\n * \"generated\": \"1401380327373\",\r\n * \"app\": \"Phaser 3 Asset Packer\",\r\n * \"url\": \"https://phaser.io\",\r\n * \"version\": \"1.0\",\r\n * \"copyright\": \"Photon Storm Ltd. 2018\"\r\n * }\r\n * }\r\n * ```\r\n *\r\n * The pack can be split into sections. In the example above you'll see a section called `test1`. You can tell\r\n * the `load.pack` method to parse only a particular section of a pack. The pack is stored in the JSON Cache,\r\n * so you can pass it to the Loader to process additional sections as needed in your game, or you can just load\r\n * them all at once without specifying anything.\r\n *\r\n * The pack file can contain an entry for any type of file that Phaser can load. The object structures exactly\r\n * match that of the file type configs, and all properties available within the file type configs can be used\r\n * in the pack file too. An entry's `type` is the name of the Loader method that will load it, e.g., 'image'.\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.pack({\r\n * key: 'level1',\r\n * url: 'data/Level1Files.json'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.PackFileConfig` for more details.\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 you only wanted to store the `boss` data in the Cache, 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 Pack 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#pack\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.7.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.PackFileConfig|Phaser.Types.Loader.FileTypes.PackFileConfig[])} 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 JSON file loads only this property will be stored in the Cache.\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": "PackFile.js", "lineno": 81, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a JSON File Pack, or array of packs, 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.pack('level1', 'data/Level1Files.json');\r}\r```\r\rA File Pack is a JSON file (or object) that contains details about other files that should be added into the Loader.\rHere is a small example:\r\r```json\r{\r \"test1\": {\r \"files\": [\r {\r \"type\": \"image\",\r \"key\": \"taikodrummaster\",\r \"url\": \"assets/pics/taikodrummaster.jpg\"\r },\r {\r \"type\": \"image\",\r \"key\": \"sukasuka-chtholly\",\r \"url\": \"assets/pics/sukasuka-chtholly.png\"\r }\r ]\r },\r \"meta\": {\r \"generated\": \"1401380327373\",\r \"app\": \"Phaser 3 Asset Packer\",\r \"url\": \"https://phaser.io\",\r \"version\": \"1.0\",\r \"copyright\": \"Photon Storm Ltd. 2018\"\r }\r}\r```\r\rThe pack can be split into sections. In the example above you'll see a section called `test1`. You can tell\rthe `load.pack` method to parse only a particular section of a pack. The pack is stored in the JSON Cache,\rso you can pass it to the Loader to process additional sections as needed in your game, or you can just load\rthem all at once without specifying anything.\r\rThe pack file can contain an entry for any type of file that Phaser can load. The object structures exactly\rmatch that of the file type configs, and all properties available within the file type configs can be used\rin the pack file too. An entry's `type` is the name of the Loader method that will load it, e.g., 'image'.\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.pack({\r key: 'level1',\r url: 'data/Level1Files.json'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.PackFileConfig` for more details.\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 you only wanted to store the `boss` data in the Cache, 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 Pack File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "pack", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.7.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.PackFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.PackFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.PackFileConfig", "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 JSON file loads only this property will be stored in the Cache.", "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#pack", "scope": "instance", "___id": "T000002R024200", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Plugin Script File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#plugin 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#plugin.\r\n *\r\n * @class PluginFile\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.PluginFileConfig)} 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 `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".\r\n * @param {boolean} [start=false] - Automatically start the plugin after loading?\r\n * @param {string} [mapping] - If this plugin is to be injected into the Scene, this is the property key used.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "PluginFile.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Plugin Script File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#plugin method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#plugin.", "kind": "class", "name": "PluginFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.PluginFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.PluginFileConfig" } ] } }, "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 `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".", "name": "url" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Automatically start the plugin after loading?", "name": "start" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If this plugin is to be injected into the Scene, this is the property key used.", "name": "mapping" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "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.PluginFile", "___id": "T000002R024209", "___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.PluginFile#onProcess\r\n * @since 3.7.0\r\n */", "meta": { "filename": "PluginFile.js", "lineno": 82, "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.PluginFile", "longname": "Phaser.Loader.FileTypes.PluginFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R024234", "___s": true }, { "comment": "/**\r\n * Adds a Plugin Script file, or array of plugin 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.plugin('modplayer', 'plugins/ModPlayer.js');\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 and not already in-use by another file in the Loader.\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.plugin({\r\n * key: 'modplayer',\r\n * url: 'plugins/ModPlayer.js'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.PluginFileConfig` for more details.\r\n *\r\n * Once the file has finished loading it will automatically be converted into a script element\r\n * via `document.createElement('script')`. It will have its language set to JavaScript, `defer` set to\r\n * false and then the resulting element will be appended to `document.head`. Any code then in the\r\n * script will be executed. It will then be passed to the Phaser PluginCache.register method.\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.js\". It will always add `.js` 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 Plugin 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#plugin\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.PluginFileConfig|Phaser.Types.Loader.FileTypes.PluginFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.\r\n * @param {(string|function)} [url] - The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\". Or, a plugin function.\r\n * @param {boolean} [start] - Automatically start the plugin after loading?\r\n * @param {string} [mapping] - If this plugin is to be injected into the Scene, this is the property key used.\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": "PluginFile.js", "lineno": 129, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a Plugin Script file, or array of plugin 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.plugin('modplayer', 'plugins/ModPlayer.js');\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 and not already in-use by another file in the Loader.\r\rInstead of passing arguments you can pass a configuration object, such as:\r\r```javascript\rthis.load.plugin({\r key: 'modplayer',\r url: 'plugins/ModPlayer.js'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.PluginFileConfig` for more details.\r\rOnce the file has finished loading it will automatically be converted into a script element\rvia `document.createElement('script')`. It will have its language set to JavaScript, `defer` set to\rfalse and then the resulting element will be appended to `document.head`. Any code then in the\rscript will be executed. It will then be passed to the Phaser PluginCache.register method.\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.js\". It will always add `.js` 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 Plugin File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "plugin", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.PluginFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.PluginFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.PluginFileConfig", "type": "NameExpression" } ] } ] } }, "description": "The key to use for this file, or a file configuration object, or array of them.", "name": "key" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "description": "The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\". Or, a plugin function.", "name": "url" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Automatically start the plugin after loading?", "name": "start" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If this plugin is to be injected into the Scene, this is the property key used.", "name": "mapping" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "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#plugin", "scope": "instance", "___id": "T000002R024249", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * An external Scene JavaScript File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#sceneFile 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#sceneFile.\r\n *\r\n * @class SceneFile\r\n * @extends Phaser.Loader.File\r\n * @memberof Phaser.Loader.FileTypes\r\n * @constructor\r\n * @since 3.16.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.SceneFileConfig)} 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 `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "SceneFile.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "An external Scene JavaScript File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#sceneFile method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#sceneFile.", "kind": "class", "name": "SceneFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.16.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.SceneFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.SceneFileConfig" } ] } }, "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 `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".", "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" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.SceneFile", "___id": "T000002R024258", "___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.SceneFile#onProcess\r\n * @since 3.16.0\r\n */", "meta": { "filename": "SceneFile.js", "lineno": 65, "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.16.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "longname": "Phaser.Loader.FileTypes.SceneFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R024275", "___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.SceneFile#addToCache\r\n * @since 3.16.0\r\n */", "meta": { "filename": "SceneFile.js", "lineno": 81, "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.16.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "longname": "Phaser.Loader.FileTypes.SceneFile#addToCache", "scope": "instance", "overrides": "Phaser.Loader.File#addToCache", "___id": "T000002R024279", "___s": true }, { "comment": "/**\r\n * Adds an external Scene file, or array of Scene 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.sceneFile('Level1', 'src/Level1.js');\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 Scene Manager upon a successful load.\r\n *\r\n * For a Scene File it's vitally important that the key matches the class name in the JavaScript file.\r\n *\r\n * For example here is the source file:\r\n *\r\n * ```javascript\r\n * class ExternalScene extends Phaser.Scene {\r\n *\r\n * constructor ()\r\n * {\r\n * super('myScene');\r\n * }\r\n *\r\n * }\r\n * ```\r\n *\r\n * Because the class is called `ExternalScene` that is the exact same key you must use when loading it:\r\n *\r\n * ```javascript\r\n * function preload ()\r\n * {\r\n * this.load.sceneFile('ExternalScene', 'src/yourScene.js');\r\n * }\r\n * ```\r\n *\r\n * The key that is used within the Scene Manager can either be set to the same, or you can override it in the Scene\r\n * constructor, as we've done in the example above, where the Scene key was changed to `myScene`.\r\n *\r\n * The key should be unique both in terms of files being loaded and Scenes already present in the Scene 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 Scene 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.sceneFile({\r\n * key: 'Level1',\r\n * url: 'src/Level1.js'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.SceneFileConfig` for more details.\r\n *\r\n * Once the file has finished loading it will be added to the Scene Manager.\r\n *\r\n * ```javascript\r\n * this.load.sceneFile('Level1', 'src/Level1.js');\r\n * // and later in your game ...\r\n * this.scene.start('Level1');\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 `WORLD1.` and the key was `Story` the final key will be `WORLD1.Story` and\r\n * this is what you would use to retrieve the text from the Scene 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 \"story\"\r\n * and no URL is given then the Loader will set the URL to be \"story.js\". It will always add `.js` 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 Scene 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#sceneFile\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.16.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.SceneFileConfig|Phaser.Types.Loader.FileTypes.SceneFileConfig[])} 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 `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".\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": "SceneFile.js", "lineno": 101, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds an external Scene file, or array of Scene 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.sceneFile('Level1', 'src/Level1.js');\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 Scene Manager upon a successful load.\r\rFor a Scene File it's vitally important that the key matches the class name in the JavaScript file.\r\rFor example here is the source file:\r\r```javascript\rclass ExternalScene extends Phaser.Scene {\r\r constructor ()\r {\r super('myScene');\r }\r\r}\r```\r\rBecause the class is called `ExternalScene` that is the exact same key you must use when loading it:\r\r```javascript\rfunction preload ()\r{\r this.load.sceneFile('ExternalScene', 'src/yourScene.js');\r}\r```\r\rThe key that is used within the Scene Manager can either be set to the same, or you can override it in the Scene\rconstructor, as we've done in the example above, where the Scene key was changed to `myScene`.\r\rThe key should be unique both in terms of files being loaded and Scenes already present in the Scene 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 Scene 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.sceneFile({\r key: 'Level1',\r url: 'src/Level1.js'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.SceneFileConfig` for more details.\r\rOnce the file has finished loading it will be added to the Scene Manager.\r\r```javascript\rthis.load.sceneFile('Level1', 'src/Level1.js');\r// and later in your game ...\rthis.scene.start('Level1');\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 `WORLD1.` and the key was `Story` the final key will be `WORLD1.Story` and\rthis is what you would use to retrieve the text from the Scene 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 \"story\"\rand no URL is given then the Loader will set the URL to be \"story.js\". It will always add `.js` 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 Scene File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "sceneFile", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.16.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.SceneFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.SceneFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.SceneFileConfig", "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 `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".", "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#sceneFile", "scope": "instance", "___id": "T000002R024284", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Scene Plugin Script File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#scenePlugin 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#scenePlugin.\r\n *\r\n * @class ScenePluginFile\r\n * @extends Phaser.Loader.File\r\n * @memberof Phaser.Loader.FileTypes\r\n * @constructor\r\n * @since 3.8.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.ScenePluginFileConfig)} 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 `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".\r\n * @param {string} [systemKey] - If this plugin is to be added to Scene.Systems, this is the property key for it.\r\n * @param {string} [sceneKey] - If this plugin is to be added to the Scene, this is the property key for it.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "ScenePluginFile.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Scene Plugin Script File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#scenePlugin method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#scenePlugin.", "kind": "class", "name": "ScenePluginFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.8.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.ScenePluginFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.ScenePluginFileConfig" } ] } }, "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 `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If this plugin is to be added to Scene.Systems, this is the property key for it.", "name": "systemKey" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If this plugin is to be added to the Scene, this is the property key for it.", "name": "sceneKey" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "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.ScenePluginFile", "___id": "T000002R024293", "___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.ScenePluginFile#onProcess\r\n * @since 3.8.0\r\n */", "meta": { "filename": "ScenePluginFile.js", "lineno": 82, "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.8.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R024318", "___s": true }, { "comment": "/**\r\n * Adds a Scene Plugin Script file, or array of plugin 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.scenePlugin('ModPlayer', 'plugins/ModPlayer.js', 'modPlayer', 'mods');\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 and not already in-use by another file in the Loader.\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.scenePlugin({\r\n * key: 'modplayer',\r\n * url: 'plugins/ModPlayer.js'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.ScenePluginFileConfig` for more details.\r\n *\r\n * Once the file has finished loading it will automatically be converted into a script element\r\n * via `document.createElement('script')`. It will have its language set to JavaScript, `defer` set to\r\n * false and then the resulting element will be appended to `document.head`. Any code then in the\r\n * script will be executed. It will then be passed to the Phaser PluginCache.register method.\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.js\". It will always add `.js` 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 Script 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#scenePlugin\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.8.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.ScenePluginFileConfig|Phaser.Types.Loader.FileTypes.ScenePluginFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.\r\n * @param {(string|function)} [url] - The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\". Or, set to a plugin function.\r\n * @param {string} [systemKey] - If this plugin is to be added to Scene.Systems, this is the property key for it.\r\n * @param {string} [sceneKey] - If this plugin is to be added to the Scene, this is the property key for it.\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": "ScenePluginFile.js", "lineno": 123, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a Scene Plugin Script file, or array of plugin 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.scenePlugin('ModPlayer', 'plugins/ModPlayer.js', 'modPlayer', 'mods');\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 and not already in-use by another file in the Loader.\r\rInstead of passing arguments you can pass a configuration object, such as:\r\r```javascript\rthis.load.scenePlugin({\r key: 'modplayer',\r url: 'plugins/ModPlayer.js'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.ScenePluginFileConfig` for more details.\r\rOnce the file has finished loading it will automatically be converted into a script element\rvia `document.createElement('script')`. It will have its language set to JavaScript, `defer` set to\rfalse and then the resulting element will be appended to `document.head`. Any code then in the\rscript will be executed. It will then be passed to the Phaser PluginCache.register method.\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.js\". It will always add `.js` 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 Script File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "scenePlugin", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.8.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.ScenePluginFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.ScenePluginFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.ScenePluginFileConfig", "type": "NameExpression" } ] } ] } }, "description": "The key to use for this file, or a file configuration object, or array of them.", "name": "key" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "description": "The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\". Or, set to a plugin function.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If this plugin is to be added to Scene.Systems, this is the property key for it.", "name": "systemKey" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If this plugin is to be added to the Scene, this is the property key for it.", "name": "sceneKey" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "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#scenePlugin", "scope": "instance", "___id": "T000002R024331", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Script File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#script 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#script.\r\n *\r\n * @class ScriptFile\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.ScriptFileConfig)} 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 `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".\r\n * @param {string} [type='script'] - The script type. Should be either 'script' for classic JavaScript, or 'module' if the file contains an exported module.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "ScriptFile.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Script File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#script method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#script.", "kind": "class", "name": "ScriptFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.ScriptFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.ScriptFileConfig" } ] } }, "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 `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'script'", "description": "The script type. Should be either 'script' for classic JavaScript, or 'module' if the file contains an exported module.", "name": "type" }, { "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.ScriptFile", "___id": "T000002R024340", "___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.ScriptFile#onProcess\r\n * @since 3.7.0\r\n */", "meta": { "filename": "ScriptFile.js", "lineno": 72, "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.ScriptFile", "longname": "Phaser.Loader.FileTypes.ScriptFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R024360", "___s": true }, { "comment": "/**\r\n * Adds a Script file, or array of Script 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.script('aliens', 'lib/aliens.js');\r\n * }\r\n * ```\r\n *\r\n * If the script file contains a module, then you should specify that using the 'type' parameter:\r\n *\r\n * ```javascript\r\n * function preload ()\r\n * {\r\n * this.load.script('aliens', 'lib/aliens.js', 'module');\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 and not already in-use by another file in the Loader.\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.script({\r\n * key: 'aliens',\r\n * url: 'lib/aliens.js',\r\n * type: 'script' // or 'module'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.ScriptFileConfig` for more details.\r\n *\r\n * Once the file has finished loading it will automatically be converted into a script element\r\n * via `document.createElement('script')`. It will have its language set to JavaScript, `defer` set to\r\n * false and then the resulting element will be appended to `document.head`. Any code then in the\r\n * script will be executed.\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.js\". It will always add `.js` 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 Script 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#script\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.ScriptFileConfig|Phaser.Types.Loader.FileTypes.ScriptFileConfig[])} 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 `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".\r\n * @param {string} [type='script'] - The script type. Should be either 'script' for classic JavaScript, or 'module' if the file contains an exported module.\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": "ScriptFile.js", "lineno": 96, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a Script file, or array of Script 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.script('aliens', 'lib/aliens.js');\r}\r```\r\rIf the script file contains a module, then you should specify that using the 'type' parameter:\r\r```javascript\rfunction preload ()\r{\r this.load.script('aliens', 'lib/aliens.js', 'module');\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 and not already in-use by another file in the Loader.\r\rInstead of passing arguments you can pass a configuration object, such as:\r\r```javascript\rthis.load.script({\r key: 'aliens',\r url: 'lib/aliens.js',\r type: 'script' // or 'module'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.ScriptFileConfig` for more details.\r\rOnce the file has finished loading it will automatically be converted into a script element\rvia `document.createElement('script')`. It will have its language set to JavaScript, `defer` set to\rfalse and then the resulting element will be appended to `document.head`. Any code then in the\rscript will be executed.\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.js\". It will always add `.js` 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 Script File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "script", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.ScriptFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.ScriptFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.ScriptFileConfig", "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 `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'script'", "description": "The script type. Should be either 'script' for classic JavaScript, or 'module' if the file contains an exported module.", "name": "type" }, { "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#script", "scope": "instance", "___id": "T000002R024368", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Sprite Sheet Image File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#spritesheet 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#spritesheet.\r\n *\r\n * @class SpriteSheetFile\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.SpriteSheetFileConfig)} key - The key to use for this file, or a file configuration object.\r\n * @param {string|string[]} [url] - The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".\r\n * @param {Phaser.Types.Loader.FileTypes.ImageFrameConfig} [frameConfig] - The frame configuration object.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "SpriteSheetFile.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Sprite Sheet Image File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#spritesheet method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#spritesheet.", "kind": "class", "name": "SpriteSheetFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.SpriteSheetFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig" } ] } }, "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 this file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".", "name": "url" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.ImageFrameConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.ImageFrameConfig" } }, "optional": true, "description": "The frame configuration object.", "name": "frameConfig" }, { "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.SpriteSheetFile", "___id": "T000002R024375", "___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.SpriteSheetFile#addToCache\r\n * @since 3.7.0\r\n */", "meta": { "filename": "SpriteSheetFile.js", "lineno": 45, "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.SpriteSheetFile", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#addToCache", "scope": "instance", "overrides": "Phaser.Loader.File#addToCache", "___id": "T000002R024380", "___s": true }, { "comment": "/**\r\n * Adds a Sprite Sheet Image, or array of Sprite Sheet Images, to the current load queue.\r\n *\r\n * The term 'Sprite Sheet' in Phaser means a fixed-size sheet. Where every frame in the sheet is the exact same size,\r\n * and you reference those frames using numbers, not frame names. This is not the same thing as a Texture Atlas, where\r\n * the frames are packed in a way where they take up the least amount of space, and are referenced by their names,\r\n * not numbers. Some articles and software use the term 'Sprite Sheet' to mean Texture Atlas, so please be aware of\r\n * what sort of file you're actually trying to load.\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.spritesheet('bot', 'images/robot.png', { frameWidth: 32, frameHeight: 38 });\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 * Phaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\r\n * If you try to load an animated gif only the first frame will be rendered. Browsers do not natively support playback\r\n * of animated gifs to Canvas elements.\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.spritesheet({\r\n * key: 'bot',\r\n * url: 'images/robot.png',\r\n * frameConfig: {\r\n * frameWidth: 32,\r\n * frameHeight: 38,\r\n * startFrame: 0,\r\n * endFrame: 8\r\n * }\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig` for more details.\r\n *\r\n * Once the file has finished loading you can use it as a texture for a Game Object by referencing its key:\r\n *\r\n * ```javascript\r\n * this.load.spritesheet('bot', 'images/robot.png', { frameWidth: 32, frameHeight: 38 });\r\n * // and later in your game ...\r\n * this.add.image(x, y, 'bot', 0);\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 `PLAYER.` and the key was `Running` the final key will be `PLAYER.Running` 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.spritesheet('logo', [ 'images/AtariLogo.png', 'images/AtariLogo-n.png' ], { frameWidth: 256, frameHeight: 80 });\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.spritesheet({\r\n * key: 'logo',\r\n * url: 'images/AtariLogo.png',\r\n * normalMap: 'images/AtariLogo-n.png',\r\n * frameConfig: {\r\n * frameWidth: 256,\r\n * frameHeight: 80\r\n * }\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 Sprite Sheet 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#spritesheet\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig|Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig[])} 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 `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".\r\n * @param {Phaser.Types.Loader.FileTypes.ImageFrameConfig} [frameConfig] - The frame configuration object. At a minimum it should have a `frameWidth` property.\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": "SpriteSheetFile.js", "lineno": 87, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a Sprite Sheet Image, or array of Sprite Sheet Images, to the current load queue.\r\rThe term 'Sprite Sheet' in Phaser means a fixed-size sheet. Where every frame in the sheet is the exact same size,\rand you reference those frames using numbers, not frame names. This is not the same thing as a Texture Atlas, where\rthe frames are packed in a way where they take up the least amount of space, and are referenced by their names,\rnot numbers. Some articles and software use the term 'Sprite Sheet' to mean Texture Atlas, so please be aware of\rwhat sort of file you're actually trying to load.\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.spritesheet('bot', 'images/robot.png', { frameWidth: 32, frameHeight: 38 });\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\rPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\rIf you try to load an animated gif only the first frame will be rendered. Browsers do not natively support playback\rof animated gifs to Canvas elements.\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.spritesheet({\r key: 'bot',\r url: 'images/robot.png',\r frameConfig: {\r frameWidth: 32,\r frameHeight: 38,\r startFrame: 0,\r endFrame: 8\r }\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig` for more details.\r\rOnce the file has finished loading you can use it as a texture for a Game Object by referencing its key:\r\r```javascript\rthis.load.spritesheet('bot', 'images/robot.png', { frameWidth: 32, frameHeight: 38 });\r// and later in your game ...\rthis.add.image(x, y, 'bot', 0);\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 `PLAYER.` and the key was `Running` the final key will be `PLAYER.Running` 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.spritesheet('logo', [ 'images/AtariLogo.png', 'images/AtariLogo-n.png' ], { frameWidth: 256, frameHeight: 80 });\r```\r\rOr, if you are using a config object use the `normalMap` property:\r\r```javascript\rthis.load.spritesheet({\r key: 'logo',\r url: 'images/AtariLogo.png',\r normalMap: 'images/AtariLogo-n.png',\r frameConfig: {\r frameWidth: 256,\r frameHeight: 80\r }\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 Sprite Sheet File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "spritesheet", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig", "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 `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".", "name": "url" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.ImageFrameConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.ImageFrameConfig" } }, "optional": true, "description": "The frame configuration object. At a minimum it should have a `frameWidth` property.", "name": "frameConfig" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "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#spritesheet", "scope": "instance", "___id": "T000002R024383", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single SVG File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#svg 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#svg.\r\n *\r\n * @class SVGFile\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.SVGFileConfig)} 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 `.svg`, i.e. if `key` was \"alien\" then the URL will be \"alien.svg\".\r\n * @param {Phaser.Types.Loader.FileTypes.SVGSizeConfig} [svgConfig] - The svg size configuration object.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "SVGFile.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single SVG File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#svg method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#svg.", "kind": "class", "name": "SVGFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.SVGFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.SVGFileConfig" } ] } }, "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 `.svg`, i.e. if `key` was \"alien\" then the URL will be \"alien.svg\".", "name": "url" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.SVGSizeConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.SVGSizeConfig" } }, "optional": true, "description": "The svg size configuration object.", "name": "svgConfig" }, { "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.SVGFile", "___id": "T000002R024392", "___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.SVGFile#onProcess\r\n * @since 3.7.0\r\n */", "meta": { "filename": "SVGFile.js", "lineno": 73, "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.SVGFile", "longname": "Phaser.Loader.FileTypes.SVGFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R024415", "___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.SVGFile#addToCache\r\n * @since 3.7.0\r\n */", "meta": { "filename": "SVGFile.js", "lineno": 182, "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.SVGFile", "longname": "Phaser.Loader.FileTypes.SVGFile#addToCache", "scope": "instance", "overrides": "Phaser.Loader.File#addToCache", "___id": "T000002R024446", "___s": true }, { "comment": "/**\r\n * Adds an SVG File, or array of SVG Files, to the current load queue. When the files are loaded they\r\n * will be rendered to bitmap textures and stored in the Texture Manager.\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.svg('morty', 'images/Morty.svg');\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 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.svg({\r\n * key: 'morty',\r\n * url: 'images/Morty.svg'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.SVGFileConfig` for more details.\r\n *\r\n * Once the file has finished loading you can use it as a texture for a Game Object by referencing its key:\r\n *\r\n * ```javascript\r\n * this.load.svg('morty', 'images/Morty.svg');\r\n * // and later in your game ...\r\n * this.add.image(x, y, 'morty');\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 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.html\". It will always add `.html` 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 optionally pass an SVG Resize Configuration object when you load an SVG file. By default the SVG will be rendered to a texture\r\n * at the same size defined in the SVG file attributes. However, this isn't always desirable. You may wish to resize the SVG (either down\r\n * or up) to improve texture clarity, or reduce texture memory consumption. You can either specify an exact width and height to resize\r\n * the SVG to:\r\n *\r\n * ```javascript\r\n * function preload ()\r\n * {\r\n * this.load.svg('morty', 'images/Morty.svg', { width: 300, height: 600 });\r\n * }\r\n * ```\r\n *\r\n * Or when using a configuration object:\r\n *\r\n * ```javascript\r\n * this.load.svg({\r\n * key: 'morty',\r\n * url: 'images/Morty.svg',\r\n * svgConfig: {\r\n * width: 300,\r\n * height: 600\r\n * }\r\n * });\r\n * ```\r\n *\r\n * Alternatively, you can just provide a scale factor instead:\r\n *\r\n * ```javascript\r\n * function preload ()\r\n * {\r\n * this.load.svg('morty', 'images/Morty.svg', { scale: 2.5 });\r\n * }\r\n * ```\r\n *\r\n * Or when using a configuration object:\r\n *\r\n * ```javascript\r\n * this.load.svg({\r\n * key: 'morty',\r\n * url: 'images/Morty.svg',\r\n * svgConfig: {\r\n * scale: 2.5\r\n * }\r\n * });\r\n * ```\r\n *\r\n * If scale, width and height values are all given, the scale has priority and the width and height values are ignored.\r\n *\r\n * Note: The ability to load this type of file will only be available if the SVG 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#svg\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.SVGFileConfig|Phaser.Types.Loader.FileTypes.SVGFileConfig[])} 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 `.svg`, i.e. if `key` was \"alien\" then the URL will be \"alien.svg\".\r\n * @param {Phaser.Types.Loader.FileTypes.SVGSizeConfig} [svgConfig] - The svg size configuration object.\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": "SVGFile.js", "lineno": 195, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds an SVG File, or array of SVG Files, to the current load queue. When the files are loaded they\rwill be rendered to bitmap textures and stored in the Texture Manager.\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.svg('morty', 'images/Morty.svg');\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 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.svg({\r key: 'morty',\r url: 'images/Morty.svg'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.SVGFileConfig` for more details.\r\rOnce the file has finished loading you can use it as a texture for a Game Object by referencing its key:\r\r```javascript\rthis.load.svg('morty', 'images/Morty.svg');\r// and later in your game ...\rthis.add.image(x, y, 'morty');\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 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.html\". It will always add `.html` 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 optionally pass an SVG Resize Configuration object when you load an SVG file. By default the SVG will be rendered to a texture\rat the same size defined in the SVG file attributes. However, this isn't always desirable. You may wish to resize the SVG (either down\ror up) to improve texture clarity, or reduce texture memory consumption. You can either specify an exact width and height to resize\rthe SVG to:\r\r```javascript\rfunction preload ()\r{\r this.load.svg('morty', 'images/Morty.svg', { width: 300, height: 600 });\r}\r```\r\rOr when using a configuration object:\r\r```javascript\rthis.load.svg({\r key: 'morty',\r url: 'images/Morty.svg',\r svgConfig: {\r width: 300,\r height: 600\r }\r});\r```\r\rAlternatively, you can just provide a scale factor instead:\r\r```javascript\rfunction preload ()\r{\r this.load.svg('morty', 'images/Morty.svg', { scale: 2.5 });\r}\r```\r\rOr when using a configuration object:\r\r```javascript\rthis.load.svg({\r key: 'morty',\r url: 'images/Morty.svg',\r svgConfig: {\r scale: 2.5\r }\r});\r```\r\rIf scale, width and height values are all given, the scale has priority and the width and height values are ignored.\r\rNote: The ability to load this type of file will only be available if the SVG File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "svg", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.SVGFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.SVGFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.SVGFileConfig", "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 `.svg`, i.e. if `key` was \"alien\" then the URL will be \"alien.svg\".", "name": "url" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.SVGSizeConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.SVGSizeConfig" } }, "optional": true, "description": "The svg size configuration object.", "name": "svgConfig" }, { "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#svg", "scope": "instance", "___id": "T000002R024448", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Text File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#text 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#text.\r\n *\r\n * @class TextFile\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.TextFileConfig)} 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 `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "TextFile.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Text File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#text method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#text.", "kind": "class", "name": "TextFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.TextFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.TextFileConfig" } ] } }, "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 `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".", "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" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.TextFile", "___id": "T000002R024457", "___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.TextFile#onProcess\r\n * @since 3.7.0\r\n */", "meta": { "filename": "TextFile.js", "lineno": 70, "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.TextFile", "longname": "Phaser.Loader.FileTypes.TextFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R024479", "___s": true }, { "comment": "/**\r\n * Adds a Text file, or array of Text 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.text('story', 'files/IntroStory.txt');\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 Text 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 Text 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 Text 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.text({\r\n * key: 'story',\r\n * url: 'files/IntroStory.txt'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.TextFileConfig` 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.text('story', 'files/IntroStory.txt');\r\n * // and later in your game ...\r\n * var data = this.cache.text.get('story');\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 `Story` the final key will be `LEVEL1.Story` and\r\n * this is what you would use to retrieve the text from the Text 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 \"story\"\r\n * and no URL is given then the Loader will set the URL to be \"story.txt\". It will always add `.txt` 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 Text 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#text\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.TextFileConfig|Phaser.Types.Loader.FileTypes.TextFileConfig[])} 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 `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".\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": "TextFile.js", "lineno": 88, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a Text file, or array of Text 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.text('story', 'files/IntroStory.txt');\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 Text Cache upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the Text 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 Text 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.text({\r key: 'story',\r url: 'files/IntroStory.txt'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.TextFileConfig` 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.text('story', 'files/IntroStory.txt');\r// and later in your game ...\rvar data = this.cache.text.get('story');\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 `Story` the final key will be `LEVEL1.Story` and\rthis is what you would use to retrieve the text from the Text 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 \"story\"\rand no URL is given then the Loader will set the URL to be \"story.txt\". It will always add `.txt` 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 Text File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "text", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.TextFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.TextFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.TextFileConfig", "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 `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".", "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#text", "scope": "instance", "___id": "T000002R024483", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Tilemap CSV File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#tilemapCSV 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#tilemapCSV.\r\n *\r\n * @class TilemapCSVFile\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.TilemapCSVFileConfig)} 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 `.csv`, i.e. if `key` was \"alien\" then the URL will be \"alien.csv\".\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "TilemapCSVFile.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Tilemap CSV File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#tilemapCSV method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#tilemapCSV.", "kind": "class", "name": "TilemapCSVFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.TilemapCSVFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig" } ] } }, "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 `.csv`, i.e. if `key` was \"alien\" then the URL will be \"alien.csv\".", "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" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile", "___id": "T000002R024493", "___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.TilemapCSVFile#onProcess\r\n * @since 3.7.0\r\n */", "meta": { "filename": "TilemapCSVFile.js", "lineno": 69, "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.TilemapCSVFile", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R024512", "___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.TilemapCSVFile#addToCache\r\n * @since 3.7.0\r\n */", "meta": { "filename": "TilemapCSVFile.js", "lineno": 85, "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.TilemapCSVFile", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#addToCache", "scope": "instance", "overrides": "Phaser.Loader.File#addToCache", "___id": "T000002R024516", "___s": true }, { "comment": "/**\r\n * Adds a CSV Tilemap file, or array of CSV 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.tilemapCSV('level1', 'maps/Level1.csv');\r\n * }\r\n * ```\r\n *\r\n * Tilemap CSV data can be created in a text editor, or a 3rd party app that exports as CSV.\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 Tilemap 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 Tilemap 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 Text 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.tilemapCSV({\r\n * key: 'level1',\r\n * url: 'maps/Level1.csv'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig` 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.tilemapCSV('level1', 'maps/Level1.csv');\r\n * // and later in your game ...\r\n * var map = this.make.tilemap({ key: 'level1' });\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 `Story` the final key will be `LEVEL1.Story` and\r\n * this is what you would use to retrieve the text from the Tilemap 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 \"level\"\r\n * and no URL is given then the Loader will set the URL to be \"level.csv\". It will always add `.csv` 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 Tilemap CSV 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#tilemapCSV\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig|Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig[])} 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 `.csv`, i.e. if `key` was \"alien\" then the URL will be \"alien.csv\".\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": "TilemapCSVFile.js", "lineno": 100, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a CSV Tilemap file, or array of CSV 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.tilemapCSV('level1', 'maps/Level1.csv');\r}\r```\r\rTilemap CSV data can be created in a text editor, or a 3rd party app that exports as CSV.\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 Tilemap Cache upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the Tilemap 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 Text 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.tilemapCSV({\r key: 'level1',\r url: 'maps/Level1.csv'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig` 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.tilemapCSV('level1', 'maps/Level1.csv');\r// and later in your game ...\rvar map = this.make.tilemap({ key: 'level1' });\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 `Story` the final key will be `LEVEL1.Story` and\rthis is what you would use to retrieve the text from the Tilemap 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 \"level\"\rand no URL is given then the Loader will set the URL to be \"level.csv\". It will always add `.csv` 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 Tilemap CSV File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "tilemapCSV", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig", "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 `.csv`, i.e. if `key` was \"alien\" then the URL will be \"alien.csv\".", "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#tilemapCSV", "scope": "instance", "___id": "T000002R024521", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Impact.js Tilemap JSON File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#tilemapImpact 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#tilemapImpact.\r\n *\r\n * @class TilemapImpactFile\r\n * @extends Phaser.Loader.File\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.TilemapImpactFileConfig)} 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 */", "meta": { "filename": "TilemapImpactFile.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Impact.js Tilemap JSON File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#tilemapImpact method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#tilemapImpact.", "kind": "class", "name": "TilemapImpactFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.7.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.TilemapImpactFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig" } ] } }, "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" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile", "___id": "T000002R024528", "___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.TilemapImpactFile#addToCache\r\n * @since 3.7.0\r\n */", "meta": { "filename": "TilemapImpactFile.js", "lineno": 46, "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.TilemapImpactFile", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#addToCache", "scope": "instance", "overrides": "Phaser.Loader.File#addToCache", "___id": "T000002R024534", "___s": true }, { "comment": "/**\r\n * Adds an Impact.js Tilemap file, or array of map 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.tilemapImpact('level1', 'maps/Level1.json');\r\n * }\r\n * ```\r\n *\r\n * Impact Tilemap data is created the Impact.js Map Editor called Weltmeister.\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 Tilemap 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 Tilemap 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 Text 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.tilemapImpact({\r\n * key: 'level1',\r\n * url: 'maps/Level1.json'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig` 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.tilemapImpact('level1', 'maps/Level1.json');\r\n * // and later in your game ...\r\n * var map = this.make.tilemap({ key: 'level1' });\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 `Story` the final key will be `LEVEL1.Story` and\r\n * this is what you would use to retrieve the text from the Tilemap 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 \"level\"\r\n * and no URL is given then the Loader will set the URL to be \"level.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 * Note: The ability to load this type of file will only be available if the Tilemap Impact 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#tilemapImpact\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.7.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig|Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig[])} 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 {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": "TilemapImpactFile.js", "lineno": 61, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds an Impact.js Tilemap file, or array of map 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.tilemapImpact('level1', 'maps/Level1.json');\r}\r```\r\rImpact Tilemap data is created the Impact.js Map Editor called Weltmeister.\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 Tilemap Cache upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the Tilemap 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 Text 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.tilemapImpact({\r key: 'level1',\r url: 'maps/Level1.json'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig` 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.tilemapImpact('level1', 'maps/Level1.json');\r// and later in your game ...\rvar map = this.make.tilemap({ key: 'level1' });\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 `Story` the final key will be `LEVEL1.Story` and\rthis is what you would use to retrieve the text from the Tilemap 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 \"level\"\rand no URL is given then the Loader will set the URL to be \"level.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\rNote: The ability to load this type of file will only be available if the Tilemap Impact File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "tilemapImpact", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.7.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig", "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": [ "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#tilemapImpact", "scope": "instance", "___id": "T000002R024539", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Tiled Tilemap JSON File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#tilemapTiledJSON 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#tilemapTiledJSON.\r\n *\r\n * @class TilemapJSONFile\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.TilemapJSONFileConfig)} key - The key to use for this file, or a file configuration object.\r\n * @param {object|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\". Or, a well formed JSON object.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "TilemapJSONFile.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Tiled Tilemap JSON File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#tilemapTiledJSON method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#tilemapTiledJSON.", "kind": "class", "name": "TilemapJSONFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.TilemapJSONFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig" } ] } }, "description": "The key to use for this file, or a file configuration object.", "name": "key" }, { "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 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\". Or, a well formed JSON object.", "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" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile", "___id": "T000002R024546", "___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.TilemapJSONFile#addToCache\r\n * @since 3.7.0\r\n */", "meta": { "filename": "TilemapJSONFile.js", "lineno": 46, "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.TilemapJSONFile", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#addToCache", "scope": "instance", "overrides": "Phaser.Loader.File#addToCache", "___id": "T000002R024552", "___s": true }, { "comment": "/**\r\n * Adds a Tiled JSON Tilemap file, or array of map 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.tilemapTiledJSON('level1', 'maps/Level1.json');\r\n * }\r\n * ```\r\n *\r\n * The Tilemap data is created using the Tiled Map Editor and selecting JSON as the export format.\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 Tilemap 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 Tilemap 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 Text 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.tilemapTiledJSON({\r\n * key: 'level1',\r\n * url: 'maps/Level1.json'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig` 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.tilemapTiledJSON('level1', 'maps/Level1.json');\r\n * // and later in your game ...\r\n * var map = this.make.tilemap({ key: 'level1' });\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 `Story` the final key will be `LEVEL1.Story` and\r\n * this is what you would use to retrieve the text from the Tilemap 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 \"level\"\r\n * and no URL is given then the Loader will set the URL to be \"level.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 * Note: The ability to load this type of file will only be available if the Tilemap 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#tilemapTiledJSON\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig|Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.\r\n * @param {object|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\". Or, a well formed JSON object.\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": "TilemapJSONFile.js", "lineno": 61, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a Tiled JSON Tilemap file, or array of map 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.tilemapTiledJSON('level1', 'maps/Level1.json');\r}\r```\r\rThe Tilemap data is created using the Tiled Map Editor and selecting JSON as the export format.\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 Tilemap Cache upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the Tilemap 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 Text 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.tilemapTiledJSON({\r key: 'level1',\r url: 'maps/Level1.json'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig` 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.tilemapTiledJSON('level1', 'maps/Level1.json');\r// and later in your game ...\rvar map = this.make.tilemap({ key: 'level1' });\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 `Story` the final key will be `LEVEL1.Story` and\rthis is what you would use to retrieve the text from the Tilemap 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 \"level\"\rand no URL is given then the Loader will set the URL to be \"level.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\rNote: The ability to load this type of file will only be available if the Tilemap 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": "tilemapTiledJSON", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig", "type": "NameExpression" } ] } ] } }, "description": "The key to use for this file, or a file configuration object, or array of them.", "name": "key" }, { "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 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\". Or, a well formed JSON object.", "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#tilemapTiledJSON", "scope": "instance", "___id": "T000002R024557", "___s": true }, { "comment": "/**\n * @typedef {object} Phaser.Types.Loader.FileTypes.AsepriteFileConfig\n *\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Texture Manager.\n * @property {string} [textureURL] - The absolute or relative URL to load the texture image file from.\n * @property {string} [textureExtension='png'] - The default file extension to use for the image texture if no url is provided.\n * @property {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - Extra XHR Settings specifically for the texture image file.\n * @property {object|string} [atlasURL] - The absolute or relative URL to load the atlas json file from. Or, a well formed JSON object to use instead.\n * @property {string} [atlasExtension='json'] - The default file extension to use for the atlas json if no url is provided.\n * @property {Phaser.Types.Loader.XHRSettingsObject} [atlasXhrSettings] - Extra XHR Settings specifically for the atlas json file.\n */", "meta": { "filename": "AsepriteFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "AsepriteFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Texture Manager.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the texture image file from.", "name": "textureURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'png'", "description": "The default file extension to use for the image texture if no url is provided.", "name": "textureExtension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the texture image file.", "name": "textureXhrSettings" }, { "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 atlas json file from. Or, a well formed JSON object to use instead.", "name": "atlasURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'json'", "description": "The default file extension to use for the atlas json if no url is provided.", "name": "atlasExtension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the atlas json file.", "name": "atlasXhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.AsepriteFileConfig", "scope": "static", "___id": "T000002R024560", "___s": true }, { "comment": "/**\n * @typedef {object} Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig\n *\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Texture Manager.\n * @property {string} [textureURL] - The absolute or relative URL to load the texture image file from.\n * @property {string} [textureExtension='png'] - The default file extension to use for the image texture if no url is provided.\n * @property {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - Extra XHR Settings specifically for the texture image file.\n * @property {string} [normalMap] - The filename of an associated normal map. It uses the same path and url to load as the texture image.\n * @property {object|string} [atlasURL] - The absolute or relative URL to load the atlas json file from. Or, a well formed JSON object to use instead.\n * @property {string} [atlasExtension='json'] - The default file extension to use for the atlas json if no url is provided.\n * @property {Phaser.Types.Loader.XHRSettingsObject} [atlasXhrSettings] - Extra XHR Settings specifically for the atlas json file.\n */", "meta": { "filename": "AtlasJSONFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "AtlasJSONFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Texture Manager.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the texture image file from.", "name": "textureURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'png'", "description": "The default file extension to use for the image texture if no url is provided.", "name": "textureExtension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the texture image file.", "name": "textureXhrSettings" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The filename of an associated normal map. It uses the same path and url to load as the texture image.", "name": "normalMap" }, { "type": { "names": [ "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 atlas json file from. Or, a well formed JSON object to use instead.", "name": "atlasURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'json'", "description": "The default file extension to use for the atlas json if no url is provided.", "name": "atlasExtension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the atlas json file.", "name": "atlasXhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig", "scope": "static", "___id": "T000002R024561", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Texture Manager.\r\n * @property {string} [textureURL] - The absolute or relative URL to load the texture image file from.\r\n * @property {string} [textureExtension='png'] - The default file extension to use for the image texture if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - Extra XHR Settings specifically for the texture image file.\r\n * @property {string} [normalMap] - The filename of an associated normal map. It uses the same path and url to load as the texture image.\r\n * @property {string} [atlasURL] - The absolute or relative URL to load the atlas xml file from.\r\n * @property {string} [atlasExtension='xml'] - The default file extension to use for the atlas xml if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [atlasXhrSettings] - Extra XHR Settings specifically for the atlas xml file.\r\n */", "meta": { "filename": "AtlasXMLFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "AtlasXMLFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Texture Manager.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the texture image file from.", "name": "textureURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'png'", "description": "The default file extension to use for the image texture if no url is provided.", "name": "textureExtension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the texture image file.", "name": "textureXhrSettings" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The filename of an associated normal map. It uses the same path and url to load as the texture image.", "name": "normalMap" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the atlas xml file from.", "name": "atlasURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'xml'", "description": "The default file extension to use for the atlas xml if no url is provided.", "name": "atlasExtension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the atlas xml file.", "name": "atlasXhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig", "scope": "static", "___id": "T000002R024562", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.AudioFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within the Loader and Audio Cache.\r\n * @property {(string|string[]|Phaser.Types.Loader.FileTypes.AudioFileURLConfig|Phaser.Types.Loader.FileTypes.AudioFileURLConfig[])} [url] - The absolute or relative URLs to load the audio files from.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n * @property {AudioContext} [context] - The optional AudioContext this file will use to process itself.\r\n */", "meta": { "filename": "AudioFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "AudioFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within the Loader and Audio Cache.", "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 URLs to load the audio files from.", "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": [ "AudioContext" ], "parsedType": { "type": "NameExpression", "name": "AudioContext" } }, "optional": true, "description": "The optional AudioContext this file will use to process itself.", "name": "context" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.AudioFileConfig", "scope": "static", "___id": "T000002R024563", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.AudioFileURLConfig\r\n *\r\n * @property {string} type - The audio file format. See property names in {@link Phaser.Device.Audio}.\r\n * @property {string} url - The absolute or relative URL of the audio file.\r\n */", "meta": { "filename": "AudioFileURLConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "AudioFileURLConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The audio file format. See property names in {@link Phaser.Device.Audio}.", "name": "type" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The absolute or relative URL of the audio file.", "name": "url" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.AudioFileURLConfig", "scope": "static", "___id": "T000002R024564", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Audio Cache.\r\n * @property {string} jsonURL - The absolute or relative URL to load the json file from. Or a well formed JSON object to use instead.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [jsonXhrSettings] - Extra XHR Settings specifically for the json file.\r\n * @property {{(string|string[])}} [audioURL] - The absolute or relative URL to load the audio file from.\r\n * @property {any} [audioConfig] - The audio configuration options.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [audioXhrSettings] - Extra XHR Settings specifically for the audio file.\r\n */", "meta": { "filename": "AudioSpriteFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "AudioSpriteFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Audio Cache.", "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": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the json file.", "name": "jsonXhrSettings" }, { "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.", "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": "Extra XHR Settings specifically for the audio file.", "name": "audioXhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig", "scope": "static", "___id": "T000002R024565", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.BinaryFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Binary Cache.\r\n * @property {string} [url] - The absolute or relative URL to load the file from.\r\n * @property {string} [extension='bin'] - The default file extension to use if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n * @property {any} [dataType] - Optional type to cast the binary file to once loaded. For example, `Uint8Array`.\r\n */", "meta": { "filename": "BinaryFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "BinaryFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Binary Cache.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the file from.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'bin'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "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" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.BinaryFileConfig", "scope": "static", "___id": "T000002R024566", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.BitmapFontFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Texture Manager.\r\n * @property {string} [textureURL] - The absolute or relative URL to load the texture image file from.\r\n * @property {string} [textureExtension='png'] - The default file extension to use for the image texture if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - Extra XHR Settings specifically for the texture image file.\r\n * @property {string} [normalMap] - The filename of an associated normal map. It uses the same path and url to load as the texture image.\r\n * @property {string} [fontDataURL] - The absolute or relative URL to load the font data xml file from.\r\n * @property {string} [fontDataExtension='xml'] - The default file extension to use for the font data xml if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [fontDataXhrSettings] - Extra XHR Settings specifically for the font data xml file.\r\n */", "meta": { "filename": "BitmapFontFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "BitmapFontFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Texture Manager.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the texture image file from.", "name": "textureURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'png'", "description": "The default file extension to use for the image texture if no url is provided.", "name": "textureExtension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the texture image file.", "name": "textureXhrSettings" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The filename of an associated normal map. It uses the same path and url to load as the texture image.", "name": "normalMap" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the font data xml file from.", "name": "fontDataURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'xml'", "description": "The default file extension to use for the font data xml if no url is provided.", "name": "fontDataExtension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the font data xml file.", "name": "fontDataXhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.BitmapFontFileConfig", "scope": "static", "___id": "T000002R024567", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry\r\n *\r\n * @property {string} [format] - The texture compression base format that the browser must support in order to load this file. Can be any of: 'ETC', 'ETC1', 'ATC', 'ASTC', 'BPTC', 'RGTC', 'PVRTC', 'S3TC', 'S3TCSRGB' or the fallback format of 'IMG'.\r\n * @property {string} [type] - The container format, either PVR or KTX. If not given it will try to extract it from the textureURL extension.\r\n * @property {string} [textureURL] - The URL of the compressed texture file to load.\r\n * @property {string} [atlasURL] - Optional URL of a texture atlas JSON data file. If not given, the texture will be loaded as a single image.\r\n * @property {string} [multiAtlasURL] - Optional URL of a multi-texture atlas JSON data file as created by Texture Packer Pro.\r\n * @property {string} [multiPath] - Optional path to use when loading the textures defined in the multi atlas data.\r\n * @property {string} [multiBaseURL] - Optional Base URL to use when loading the textures defined in the multi atlas data.\r\n */", "meta": { "filename": "CompressedTextureFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "CompressedTextureFileEntry", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The texture compression base format that the browser must support in order to load this file. Can be any of: 'ETC', 'ETC1', 'ATC', 'ASTC', 'BPTC', 'RGTC', 'PVRTC', 'S3TC', 'S3TCSRGB' or the fallback format of 'IMG'.", "name": "format" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The container format, either PVR or KTX. If not given it will try to extract it from the textureURL extension.", "name": "type" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The URL of the compressed texture file to load.", "name": "textureURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional URL of a texture atlas JSON data file. If not given, the texture will be loaded as a single image.", "name": "atlasURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional URL of a multi-texture atlas JSON data file as created by Texture Packer Pro.", "name": "multiAtlasURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional path to use when loading the textures defined in the multi atlas data.", "name": "multiPath" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional Base URL to use when loading the textures defined in the multi atlas data.", "name": "multiBaseURL" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "scope": "static", "___id": "T000002R024568", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.CompressedTextureFileConfig\r\n *\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [ETC] - The string, or file entry object, for an ETC format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [ETC1] - The string, or file entry object, for an ETC1 format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [ATC] - The string, or file entry object, for an ATC format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [ASTC] - The string, or file entry object, for an ASTC format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [BPTC] - The string, or file entry object, for an BPTC format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [RGTC] - The string, or file entry object, for an RGTC format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [PVRTC] - The string, or file entry object, for an PVRTC format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [S3TC] - The string, or file entry object, for an S3TC format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [S3TCRGB] - The string, or file entry object, for an S3TCRGB format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [IMG] - The string, or file entry object, for the fallback image file.\r\n */", "meta": { "filename": "CompressedTextureFileConfig.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "CompressedTextureFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an ETC format texture.", "name": "ETC" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an ETC1 format texture.", "name": "ETC1" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an ATC format texture.", "name": "ATC" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an ASTC format texture.", "name": "ASTC" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an BPTC format texture.", "name": "BPTC" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an RGTC format texture.", "name": "RGTC" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an PVRTC format texture.", "name": "PVRTC" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an S3TC format texture.", "name": "S3TC" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an S3TCRGB format texture.", "name": "S3TCRGB" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for the fallback image file.", "name": "IMG" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.CompressedTextureFileConfig", "scope": "static", "___id": "T000002R024569", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.CSSFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within the Loader.\r\n * @property {string} [url] - The absolute or relative URL to load the file from.\r\n * @property {string} [extension='css'] - The default file extension to use if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "CSSFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "CSSFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within the Loader.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the file from.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'css'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "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" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.CSSFileConfig", "scope": "static", "___id": "T000002R024570", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.GLSLFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Text Cache.\r\n * @property {string} [url] - The absolute or relative URL to load the file from.\r\n * @property {string} [shaderType='fragment'] - The type of shader. Either `fragment` for a fragment shader, or `vertex` for a vertex shader. This is ignored if you load a shader bundle.\r\n * @property {string} [extension='glsl'] - The default file extension to use if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "GLSLFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "GLSLFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Text Cache.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the file from.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'fragment'", "description": "The type of shader. Either `fragment` for a fragment shader, or `vertex` for a vertex shader. This is ignored if you load a shader bundle.", "name": "shaderType" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'glsl'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.GLSLFileConfig", "scope": "static", "___id": "T000002R024571", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.HTMLFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Text Cache.\r\n * @property {string} [url] - The absolute or relative URL to load the file from.\r\n * @property {string} [extension='html'] - The default file extension to use if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "HTMLFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "HTMLFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Text Cache.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the file from.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'html'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.HTMLFileConfig", "scope": "static", "___id": "T000002R024572", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Texture Manager.\r\n * @property {string} [url] - The absolute or relative URL to load the file from.\r\n * @property {string} [extension='html'] - The default file extension to use if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n * @property {number} [width=512] - The width of the texture the HTML will be rendered to.\r\n * @property {number} [height=512] - The height of the texture the HTML will be rendered to.\r\n */", "meta": { "filename": "HTMLTextureFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "HTMLTextureFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Texture Manager.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the file from.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'html'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 512, "description": "The width of the texture the HTML will be rendered to.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 512, "description": "The height of the texture the HTML will be rendered to.", "name": "height" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig", "scope": "static", "___id": "T000002R024573", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.ImageFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Texture Manager.\r\n * @property {string} [url] - The absolute or relative URL to load the file from.\r\n * @property {string} [extension='png'] - The default file extension to use if no url is provided.\r\n * @property {string} [normalMap] - The filename of an associated normal map. It uses the same path and url to load as the image.\r\n * @property {Phaser.Types.Loader.FileTypes.ImageFrameConfig} [frameConfig] - The frame configuration object. Only provided for, and used by, Sprite Sheets.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "ImageFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "ImageFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Texture Manager.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the file from.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'png'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The filename of an associated normal map. It uses the same path and url to load as the image.", "name": "normalMap" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.ImageFrameConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.ImageFrameConfig" } }, "optional": true, "description": "The frame configuration object. Only provided for, and used by, Sprite Sheets.", "name": "frameConfig" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.ImageFileConfig", "scope": "static", "___id": "T000002R024574", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.ImageFrameConfig\r\n *\r\n * @property {number} frameWidth - The width of the frame in pixels.\r\n * @property {number} [frameHeight] - The height of the frame in pixels. Uses the `frameWidth` value if not provided.\r\n * @property {number} [startFrame=0] - The first frame to start parsing from.\r\n * @property {number} [endFrame] - The frame to stop parsing at. If not provided it will calculate the value based on the image and frame dimensions.\r\n * @property {number} [margin=0] - The margin in the image. This is the space around the edge of the frames.\r\n * @property {number} [spacing=0] - The spacing between each frame in the image.\r\n */", "meta": { "filename": "ImageFrameConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "ImageFrameConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the frame in pixels.", "name": "frameWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the frame in pixels. Uses the `frameWidth` value if not provided.", "name": "frameHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The first frame to start parsing from.", "name": "startFrame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The frame to stop parsing at. If not provided it will calculate the value based on the image and frame dimensions.", "name": "endFrame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The margin in the image. This is the space around the edge of the frames.", "name": "margin" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The spacing between each frame in the image.", "name": "spacing" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.ImageFrameConfig", "scope": "static", "___id": "T000002R024575", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Loader.FileTypes\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "namespace", "name": "FileTypes", "memberof": "Phaser.Types.Loader", "longname": "Phaser.Types.Loader.FileTypes", "scope": "static", "___id": "T000002R024576", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.JSONFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the JSON Cache.\r\n * @property {string|any} [url] - The absolute or relative URL to load the file from. Or can be a ready formed JSON object, in which case it will be directly added to the Cache.\r\n * @property {string} [extension='json'] - The default file extension to use if no url is provided.\r\n * @property {string} [dataKey] - If specified instead of the whole JSON file being parsed and added to the Cache, only the section corresponding to this property key will be added. If the property you want to extract is nested, use periods to divide it.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "JSONFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "JSONFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the JSON Cache.", "name": "key" }, { "type": { "names": [ "string", "any" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "any" } ] } }, "optional": true, "description": "The absolute or relative URL to load the file from. Or can be a ready formed JSON object, in which case it will be directly added to the Cache.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'json'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If specified instead of the whole JSON file being parsed and added to the Cache, only the section corresponding to this property key will be added. If the property you want to extract is nested, use periods to divide it.", "name": "dataKey" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.JSONFileConfig", "scope": "static", "___id": "T000002R024577", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Texture Manager.\r\n * @property {string} [atlasURL] - The absolute or relative URL to load the multi atlas json file from. Or, a well formed JSON object.\r\n * @property {string} [url] - An alias for 'atlasURL'. If given, it overrides anything set in 'atlasURL'.\r\n * @property {string} [atlasExtension='json'] - The default file extension to use for the atlas json if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [atlasXhrSettings] - Extra XHR Settings specifically for the atlas json file.\r\n * @property {string} [path] - Optional path to use when loading the textures defined in the atlas data.\r\n * @property {string} [baseURL] - Optional Base URL to use when loading the textures defined in the atlas data.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - Extra XHR Settings specifically for the texture files.\r\n */", "meta": { "filename": "MultiAtlasFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "MultiAtlasFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Texture Manager.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the multi atlas json file from. Or, a well formed JSON object.", "name": "atlasURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "An alias for 'atlasURL'. If given, it overrides anything set in 'atlasURL'.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'json'", "description": "The default file extension to use for the atlas json if no url is provided.", "name": "atlasExtension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the atlas json file.", "name": "atlasXhrSettings" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional path to use when loading the textures defined in the atlas data.", "name": "path" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional Base URL to use when loading the textures defined in the atlas data.", "name": "baseURL" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the texture files.", "name": "textureXhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig", "scope": "static", "___id": "T000002R024578", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.MultiScriptFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within the Loader.\r\n * @property {string[]} [url] - An array of absolute or relative URLs to load the script files from. They are processed in the order given in the array.\r\n * @property {string} [extension='js'] - The default file extension to use if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for these files.\r\n */", "meta": { "filename": "MultiScriptFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "MultiScriptFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within the Loader.", "name": "key" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of absolute or relative URLs to load the script files from. They are processed in the order given in the array.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'js'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for these files.", "name": "xhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.MultiScriptFileConfig", "scope": "static", "___id": "T000002R024579", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.OBJFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the OBJ Cache.\r\n * @property {string} [url] - The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.obj`, i.e. if `key` was \"alien\" then the URL will be \"alien.obj\".\r\n * @property {string} [extension='obj'] - The default file extension to use if no url is provided.\r\n * @property {boolean} [flipUV] - Flip the UV coordinates stored in the model data?\r\n * @property {string} [matURL] - An optional absolute or relative URL to the object material file from. If undefined or `null`, no material file will be loaded.\r\n * @property {string} [matExtension='mat'] - The default material file extension to use if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "OBJFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "OBJFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the OBJ Cache.", "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 `.obj`, i.e. if `key` was \"alien\" then the URL will be \"alien.obj\".", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'obj'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Flip the UV coordinates stored in the model data?", "name": "flipUV" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "An optional absolute or relative URL to the object material file from. If undefined or `null`, no material file will be loaded.", "name": "matURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'mat'", "description": "The default material file extension to use if no url is provided.", "name": "matExtension" }, { "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" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.OBJFileConfig", "scope": "static", "___id": "T000002R024580", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.PackFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the JSON Cache.\r\n * @property {string|any} [url] - The absolute or relative URL to load the file from. Or can be a ready formed JSON object, in which case it will be directly processed.\r\n * @property {string} [extension='json'] - The default file extension to use if no url is provided.\r\n * @property {string} [dataKey] - If specified instead of the whole JSON file being parsed, only the section corresponding to this property key will be added. If the property you want to extract is nested, use periods to divide it.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "PackFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "PackFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the JSON Cache.", "name": "key" }, { "type": { "names": [ "string", "any" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "any" } ] } }, "optional": true, "description": "The absolute or relative URL to load the file from. Or can be a ready formed JSON object, in which case it will be directly processed.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'json'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If specified instead of the whole JSON file being parsed, only the section corresponding to this property key will be added. If the property you want to extract is nested, use periods to divide it.", "name": "dataKey" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.PackFileConfig", "scope": "static", "___id": "T000002R024581", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.PackFileSection\r\n *\r\n * @property {Phaser.Types.Loader.FileConfig[]} files - The files to load. See {@link Phaser.Types.Loader.FileTypes}.\r\n * @property {string} [baseURL] - A URL used to resolve paths in `files`. Example: 'http://labs.phaser.io/assets/'.\r\n * @property {string} [defaultType] - The default {@link Phaser.Types.Loader.FileConfig} `type`.\r\n * @property {string} [path] - A URL path used to resolve relative paths in `files`. Example: 'images/sprites/'.\r\n * @property {string} [prefix] - An optional prefix that is automatically prepended to each file key.\r\n *\r\n * @example\r\n * var packFileSection = {\r\n * \"prefix\": \"TEST2.\",\r\n * \"path\": \"assets/pics\",\r\n * \"defaultType\": \"image\",\r\n * \"files\": [\r\n * {\r\n * \"key\": \"donuts\",\r\n * \"extension\": \"jpg\"\r\n * },\r\n * {\r\n * \"key\": \"ayu\"\r\n * }\r\n * ]\r\n * }\r\n * // Result:\r\n * // --------------------------------------------\r\n * // assets/pics/ayu.png -> image TEST2.ayu\r\n * // assets/pics/donuts.jpg -> image TEST2.donuts\r\n */", "meta": { "filename": "PackFileSection.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "PackFileSection", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileConfig", "type": "NameExpression" } ] } }, "description": "The files to load. See {@link Phaser.Types.Loader.FileTypes}.", "name": "files" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "A URL used to resolve paths in `files`. Example: 'http://labs.phaser.io/assets/'.", "name": "baseURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The default {@link Phaser.Types.Loader.FileConfig} `type`.", "name": "defaultType" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "A URL path used to resolve relative paths in `files`. Example: 'images/sprites/'.", "name": "path" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "An optional prefix that is automatically prepended to each file key.", "name": "prefix" } ], "examples": [ "var packFileSection = {\r \"prefix\": \"TEST2.\",\r \"path\": \"assets/pics\",\r \"defaultType\": \"image\",\r \"files\": [\r {\r \"key\": \"donuts\",\r \"extension\": \"jpg\"\r },\r {\r \"key\": \"ayu\"\r }\r ]\r }\r// Result:\r// --------------------------------------------\r// assets/pics/ayu.png -> image TEST2.ayu\r// assets/pics/donuts.jpg -> image TEST2.donuts" ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.PackFileSection", "scope": "static", "___id": "T000002R024582", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.PluginFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within the Loader.\r\n * @property {string} [url] - The absolute or relative URL to load the file from.\r\n * @property {string} [extension='js'] - The default file extension to use if no url is provided.\r\n * @property {boolean} [start=false] - Automatically start the plugin after loading?\r\n * @property {string} [mapping] - If this plugin is to be injected into the Scene, this is the property key used.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "PluginFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "PluginFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within the Loader.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the file from.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'js'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Automatically start the plugin after loading?", "name": "start" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If this plugin is to be injected into the Scene, this is the property key used.", "name": "mapping" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.PluginFileConfig", "scope": "static", "___id": "T000002R024583", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.SceneFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Text Cache.\r\n * @property {string} [url] - The absolute or relative URL to load the file from.\r\n * @property {string} [extension='js'] - The default file extension to use if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "SceneFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "SceneFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Text Cache.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the file from.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'js'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.SceneFileConfig", "scope": "static", "___id": "T000002R024584", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.ScenePluginFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within the Loader.\r\n * @property {(string|function)} [url] - The absolute or relative URL to load the file from. Or, a Scene Plugin.\r\n * @property {string} [extension='js'] - The default file extension to use if no url is provided.\r\n * @property {string} [systemKey] - If this plugin is to be added to Scene.Systems, this is the property key for it.\r\n * @property {string} [sceneKey] - If this plugin is to be added to the Scene, this is the property key for it.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "ScenePluginFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "ScenePluginFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within the Loader.", "name": "key" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "description": "The absolute or relative URL to load the file from. Or, a Scene Plugin.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'js'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If this plugin is to be added to Scene.Systems, this is the property key for it.", "name": "systemKey" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If this plugin is to be added to the Scene, this is the property key for it.", "name": "sceneKey" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.ScenePluginFileConfig", "scope": "static", "___id": "T000002R024585", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.ScriptFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within the Loader.\r\n * @property {string} [url] - The absolute or relative URL to load the file from.\r\n * @property {string} [extension='js'] - The default file extension to use if no url is provided.\r\n * @property {string} [type='script'] - The script type. Should be either 'script' for classic JavaScript, or 'module' if the file contains an exported module.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "ScriptFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "ScriptFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within the Loader.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the file from.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'js'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'script'", "description": "The script type. Should be either 'script' for classic JavaScript, or 'module' if the file contains an exported module.", "name": "type" }, { "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" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.ScriptFileConfig", "scope": "static", "___id": "T000002R024586", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Texture Manager.\r\n * @property {string} [url] - The absolute or relative URL to load the file from.\r\n * @property {string} [extension='png'] - The default file extension to use if no url is provided.\r\n * @property {string} [normalMap] - The filename of an associated normal map. It uses the same path and url to load as the image.\r\n * @property {Phaser.Types.Loader.FileTypes.ImageFrameConfig} [frameConfig] - The frame configuration object.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "SpriteSheetFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "SpriteSheetFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Texture Manager.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the file from.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'png'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The filename of an associated normal map. It uses the same path and url to load as the image.", "name": "normalMap" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.ImageFrameConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.ImageFrameConfig" } }, "optional": true, "description": "The frame configuration object.", "name": "frameConfig" }, { "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" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig", "scope": "static", "___id": "T000002R024587", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.SVGFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Texture Manager.\r\n * @property {string} [url] - The absolute or relative URL to load the file from.\r\n * @property {string} [extension='svg'] - The default file extension to use if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n * @property {Phaser.Types.Loader.FileTypes.SVGSizeConfig} [svgConfig] - The svg size configuration object.\r\n */", "meta": { "filename": "SVGFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "SVGFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Texture Manager.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the file from.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'svg'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.SVGSizeConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.SVGSizeConfig" } }, "optional": true, "description": "The svg size configuration object.", "name": "svgConfig" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.SVGFileConfig", "scope": "static", "___id": "T000002R024588", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.SVGSizeConfig\r\n *\r\n * @property {number} [width] - An optional width. The SVG will be resized to this size before being rendered to a texture.\r\n * @property {number} [height] - An optional height. The SVG will be resized to this size before being rendered to a texture.\r\n * @property {number} [scale] - An optional scale. If given it overrides the width / height properties. The SVG is scaled by the scale factor before being rendered to a texture.\r\n */", "meta": { "filename": "SVGSizeConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "SVGSizeConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "An optional width. The SVG will be resized to this size before being rendered to a texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "An optional height. The SVG will be resized to this size before being rendered to a texture.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "An optional scale. If given it overrides the width / height properties. The SVG is scaled by the scale factor before being rendered to a texture.", "name": "scale" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.SVGSizeConfig", "scope": "static", "___id": "T000002R024589", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.TextFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Text Cache.\r\n * @property {string} [url] - The absolute or relative URL to load the file from.\r\n * @property {string} [extension='txt'] - The default file extension to use if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "TextFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "TextFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Text Cache.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the file from.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'txt'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.TextFileConfig", "scope": "static", "___id": "T000002R024590", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Tilemap Cache.\r\n * @property {string} [url] - The absolute or relative URL to load the file from.\r\n * @property {string} [extension='csv'] - The default file extension to use if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "TilemapCSVFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "TilemapCSVFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Tilemap Cache.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the file from.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'csv'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig", "scope": "static", "___id": "T000002R024591", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Tilemap Cache.\r\n * @property {string} [url] - The absolute or relative URL to load the file from.\r\n * @property {string} [extension='json'] - The default file extension to use if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "TilemapImpactFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "TilemapImpactFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Tilemap Cache.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the file from.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'json'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig", "scope": "static", "___id": "T000002R024592", "___s": true }, { "comment": "/**\n * @typedef {object} Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig\n *\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Tilemap Cache.\n * @property {object|string} [url] - The absolute or relative URL to load the file from. Or, a well formed JSON object.\n * @property {string} [extension='json'] - The default file extension to use if no url is provided.\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\n */", "meta": { "filename": "TilemapJSONFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "TilemapJSONFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Tilemap Cache.", "name": "key" }, { "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 file from. Or, a well formed JSON object.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'json'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig", "scope": "static", "___id": "T000002R024593", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Texture Manager.\r\n * @property {string} [textureURL] - The absolute or relative URL to load the texture image file from.\r\n * @property {string} [textureExtension='png'] - The default file extension to use for the image texture if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - Extra XHR Settings specifically for the texture image file.\r\n * @property {string} [normalMap] - The filename of an associated normal map. It uses the same path and url to load as the texture image.\r\n * @property {string} [atlasURL] - The absolute or relative URL to load the atlas data file from.\r\n * @property {string} [atlasExtension='txt'] - The default file extension to use for the atlas data if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [atlasXhrSettings] - Extra XHR Settings specifically for the atlas data file.\r\n */", "meta": { "filename": "UnityAtlasFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "UnityAtlasFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Texture Manager.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the texture image file from.", "name": "textureURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'png'", "description": "The default file extension to use for the image texture if no url is provided.", "name": "textureExtension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the texture image file.", "name": "textureXhrSettings" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The filename of an associated normal map. It uses the same path and url to load as the texture image.", "name": "normalMap" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the atlas data file from.", "name": "atlasURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'txt'", "description": "The default file extension to use for the atlas data if no url is provided.", "name": "atlasExtension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the atlas data file.", "name": "atlasXhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig", "scope": "static", "___id": "T000002R024594", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.VideoFileConfig\r\n *\r\n * @property {(string|Phaser.Types.Loader.FileTypes.VideoFileConfig)} key - The key to use for this file, or a file configuration object.\r\n * @property {(string|string[]|Phaser.Types.Loader.FileTypes.VideoFileURLConfig|Phaser.Types.Loader.FileTypes.VideoFileURLConfig[])} [url] - The absolute or relative URLs to load the video files from.\r\n * @property {boolean} [noAudio] - Does the video have an audio track? If not you can enable auto-playing on it.\r\n */", "meta": { "filename": "VideoFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "VideoFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.VideoFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.VideoFileConfig" } ] } }, "description": "The key to use for this file, or a file configuration object.", "name": "key" }, { "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 URLs to load the video files from.", "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" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.VideoFileConfig", "scope": "static", "___id": "T000002R024595", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.VideoFileURLConfig\r\n *\r\n * @property {string} type - The video file format. See property names in {@link Phaser.Device.Video}.\r\n * @property {string} url - The absolute or relative URL of the video file.\r\n */", "meta": { "filename": "VideoFileURLConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "VideoFileURLConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The video file format. See property names in {@link Phaser.Device.Video}.", "name": "type" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The absolute or relative URL of the video file.", "name": "url" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.VideoFileURLConfig", "scope": "static", "___id": "T000002R024596", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileTypes.XMLFileConfig\r\n *\r\n * @property {string} key - The key of the file. Must be unique within both the Loader and the Text Cache.\r\n * @property {string} [url] - The absolute or relative URL to load the file from.\r\n * @property {string} [extension='xml'] - The default file extension to use if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "XMLFileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes\\typedefs", "code": {} }, "kind": "typedef", "name": "XMLFileConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file. Must be unique within both the Loader and the Text Cache.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the file from.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'xml'", "description": "The default file extension to use if no url is provided.", "name": "extension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" } ], "memberof": "Phaser.Types.Loader.FileTypes", "longname": "Phaser.Types.Loader.FileTypes.XMLFileConfig", "scope": "static", "___id": "T000002R024597", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single text file based Unity Texture Atlas File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#unityAtlas 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#unityAtlas.\r\n *\r\n * @class UnityAtlasFile\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.UnityAtlasFileConfig)} 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 data file from. If undefined or `null` it will be set to `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".\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 data file. Used in replacement of the Loaders default XHR Settings.\r\n */", "meta": { "filename": "UnityAtlasFile.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single text file based Unity Texture Atlas File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#unityAtlas method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#unityAtlas.", "kind": "class", "name": "UnityAtlasFile", "augments": [ "Phaser.Loader.MultiFile" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.UnityAtlasFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig" } ] } }, "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 data file from. If undefined or `null` it will be set to `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".", "name": "atlasURL" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "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 data file. Used in replacement of the Loaders default XHR Settings.", "name": "atlasXhrSettings" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile", "___id": "T000002R024605", "___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.UnityAtlasFile#addToCache\r\n * @since 3.7.0\r\n */", "meta": { "filename": "UnityAtlasFile.js", "lineno": 85, "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.UnityAtlasFile", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#addToCache", "scope": "instance", "___id": "T000002R024626", "___s": true }, { "comment": "/**\r\n * Adds a Unity YAML 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.unityAtlas('mainmenu', 'images/MainMenu.png', 'images/MainMenu.txt');\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 YAML formatted text file as exported from Unity.\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.unityAtlas({\r\n * key: 'mainmenu',\r\n * textureURL: 'images/MainMenu.png',\r\n * atlasURL: 'images/MainMenu.txt'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig` 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.unityAtlas('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.unityAtlas('mainmenu', [ 'images/MainMenu.png', 'images/MainMenu-n.png' ], 'images/MainMenu.txt');\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.unityAtlas({\r\n * key: 'mainmenu',\r\n * textureURL: 'images/MainMenu.png',\r\n * normalMap: 'images/MainMenu-n.png',\r\n * atlasURL: 'images/MainMenu.txt'\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 Unity Atlas 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#unityAtlas\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig|Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig[])} 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 data file from. If undefined or `null` it will be set to `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".\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 data file. Used in replacement of the Loaders default XHR Settings.\r\n *\r\n * @return {this} The Loader instance.\r\n */", "meta": { "filename": "UnityAtlasFile.js", "lineno": 107, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a Unity YAML 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.unityAtlas('mainmenu', 'images/MainMenu.png', 'images/MainMenu.txt');\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 YAML formatted text file as exported from Unity.\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.unityAtlas({\r key: 'mainmenu',\r textureURL: 'images/MainMenu.png',\r atlasURL: 'images/MainMenu.txt'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig` 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.unityAtlas('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.unityAtlas('mainmenu', [ 'images/MainMenu.png', 'images/MainMenu-n.png' ], 'images/MainMenu.txt');\r```\r\rOr, if you are using a config object use the `normalMap` property:\r\r```javascript\rthis.load.unityAtlas({\r key: 'mainmenu',\r textureURL: 'images/MainMenu.png',\r normalMap: 'images/MainMenu-n.png',\r atlasURL: 'images/MainMenu.txt'\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 Unity Atlas File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "unityAtlas", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig", "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 data file from. If undefined or `null` it will be set to `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".", "name": "atlasURL" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "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 data 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#unityAtlas", "scope": "instance", "___id": "T000002R024632", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Video File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#video 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#video.\r\n *\r\n * @class VideoFile\r\n * @extends Phaser.Loader.File\r\n * @memberof Phaser.Loader.FileTypes\r\n * @constructor\r\n * @since 3.20.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.VideoFileConfig)} key - The key to use for this file, or a file configuration object.\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 */", "meta": { "filename": "VideoFile.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Video File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#video method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#video.", "kind": "class", "name": "VideoFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.20.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.VideoFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.VideoFileConfig" } ] } }, "description": "The key to use for this file, or a file configuration object.", "name": "key" }, { "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" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.VideoFile", "___id": "T000002R024645", "___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.VideoFile#onProcess\r\n * @since 3.20.0\r\n */", "meta": { "filename": "VideoFile.js", "lineno": 74, "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.20.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "longname": "Phaser.Loader.FileTypes.VideoFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R024663", "___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.FileTypes.VideoFile#load\r\n * @since 3.20.0\r\n */", "meta": { "filename": "VideoFile.js", "lineno": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "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.20.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "longname": "Phaser.Loader.FileTypes.VideoFile#load", "scope": "instance", "overrides": "Phaser.Loader.File#load", "___id": "T000002R024669", "___s": true }, { "comment": "/**\r\n * Adds a Video file, or array of video 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.video('intro', [ 'video/level1.mp4', 'video/level1.webm', 'video/level1.mov' ]);\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 Video 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 Video 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 Video 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.video({\r\n * key: 'intro',\r\n * url: [ 'video/level1.mp4', 'video/level1.webm', 'video/level1.mov' ],\r\n * noAudio: true\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.VideoFileConfig` 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 video file types you should usually provide your video files in a variety of formats.\r\n * mp4, mov and webm are the most common. If you provide an array of URLs then the Loader will determine which _one_ file to load based on\r\n * browser support, starting with the first in the array and progressing to the end.\r\n *\r\n * Unlike most asset-types, videos do not _need_ to be preloaded. You can create a Video Game Object and then call its `loadURL` method,\r\n * to load a video at run-time, rather than in advance.\r\n *\r\n * Note: The ability to load this type of file will only be available if the Video 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#video\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.20.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.VideoFileConfig|Phaser.Types.Loader.FileTypes.VideoFileConfig[])} 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.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 *\r\n * @return {this} The Loader instance.\r\n */", "meta": { "filename": "VideoFile.js", "lineno": 113, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a Video file, or array of video 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.video('intro', [ 'video/level1.mp4', 'video/level1.webm', 'video/level1.mov' ]);\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 Video Cache upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the Video 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 Video 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.video({\r key: 'intro',\r url: [ 'video/level1.mp4', 'video/level1.webm', 'video/level1.mov' ],\r noAudio: true\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.VideoFileConfig` 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 video file types you should usually provide your video files in a variety of formats.\rmp4, mov and webm are the most common. If you provide an array of URLs then the Loader will determine which _one_ file to load based on\rbrowser support, starting with the first in the array and progressing to the end.\r\rUnlike most asset-types, videos do not _need_ to be preloaded. You can create a Video Game Object and then call its `loadURL` method,\rto load a video at run-time, rather than in advance.\r\rNote: The ability to load this type of file will only be available if the Video File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "video", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.20.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.VideoFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.VideoFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.VideoFileConfig", "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.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" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Loader instance." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#video", "scope": "instance", "___id": "T000002R024673", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single XML File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#xml 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#xml.\r\n *\r\n * @class XMLFile\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.XMLFileConfig)} 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 `.xml`, i.e. if `key` was \"alien\" then the URL will be \"alien.xml\".\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "XMLFile.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single XML File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#xml method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#xml.", "kind": "class", "name": "XMLFile", "augments": [ "Phaser.Loader.File" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "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.XMLFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.XMLFileConfig" } ] } }, "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 `.xml`, i.e. if `key` was \"alien\" then the URL will be \"alien.xml\".", "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" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.XMLFile", "___id": "T000002R024683", "___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.XMLFile#onProcess\r\n * @since 3.7.0\r\n */", "meta": { "filename": "XMLFile.js", "lineno": 67, "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.XMLFile", "longname": "Phaser.Loader.FileTypes.XMLFile#onProcess", "scope": "instance", "overrides": "Phaser.Loader.File#onProcess", "___id": "T000002R024701", "___s": true }, { "comment": "/**\r\n * Adds an XML file, or array of XML 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.xml('wavedata', 'files/AlienWaveData.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 * The key must be a unique String. It is used to add the file to the global XML 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 XML 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 XML 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.xml({\r\n * key: 'wavedata',\r\n * url: 'files/AlienWaveData.xml'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.XMLFileConfig` 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.xml('wavedata', 'files/AlienWaveData.xml');\r\n * // and later in your game ...\r\n * var data = this.cache.xml.get('wavedata');\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 XML 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.xml\". It will always add `.xml` 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 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#xml\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.XMLFileConfig|Phaser.Types.Loader.FileTypes.XMLFileConfig[])} 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 `.xml`, i.e. if `key` was \"alien\" then the URL will be \"alien.xml\".\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": "XMLFile.js", "lineno": 92, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds an XML file, or array of XML 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.xml('wavedata', 'files/AlienWaveData.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\rThe key must be a unique String. It is used to add the file to the global XML Cache upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the XML 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 XML 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.xml({\r key: 'wavedata',\r url: 'files/AlienWaveData.xml'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.XMLFileConfig` 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.xml('wavedata', 'files/AlienWaveData.xml');\r// and later in your game ...\rvar data = this.cache.xml.get('wavedata');\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 XML 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.xml\". It will always add `.xml` 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 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": "xml", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.XMLFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.XMLFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.XMLFileConfig", "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 `.xml`, i.e. if `key` was \"alien\" then the URL will be \"alien.xml\".", "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#xml", "scope": "instance", "___id": "T000002R024705", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Loader.FileTypesManager\r\n */", "meta": { "filename": "FileTypesManager.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "kind": "namespace", "name": "FileTypesManager", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.FileTypesManager", "scope": "static", "___id": "T000002R024709", "___s": true }, { "comment": "/**\r\n * Static method called when a LoaderPlugin is created.\r\n *\r\n * Loops through the local types object and injects all of them as\r\n * properties into the LoaderPlugin instance.\r\n *\r\n * @method Phaser.Loader.FileTypesManager.install\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.LoaderPlugin} loader - The LoaderPlugin to install the types into.\r\n */", "meta": { "filename": "FileTypesManager.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Static method called when a LoaderPlugin is created.\r\rLoops through the local types object and injects all of them as\rproperties into the LoaderPlugin instance.", "kind": "function", "name": "install", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "description": "The LoaderPlugin to install the types into.", "name": "loader" } ], "memberof": "Phaser.Loader.FileTypesManager", "longname": "Phaser.Loader.FileTypesManager.install", "scope": "static", "___id": "T000002R024711", "___s": true }, { "comment": "/**\r\n * Static method called directly by the File Types.\r\n *\r\n * The key is a reference to the function used to load the files via the Loader, i.e. `image`.\r\n *\r\n * @method Phaser.Loader.FileTypesManager.register\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key that will be used as the method name in the LoaderPlugin.\r\n * @param {function} factoryFunction - The function that will be called when LoaderPlugin.key is invoked.\r\n */", "meta": { "filename": "FileTypesManager.js", "lineno": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Static method called directly by the File Types.\r\rThe key is a reference to the function used to load the files via the Loader, i.e. `image`.", "kind": "function", "name": "register", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key that will be used as the method name in the LoaderPlugin.", "name": "key" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The function that will be called when LoaderPlugin.key is invoked.", "name": "factoryFunction" } ], "memberof": "Phaser.Loader.FileTypesManager", "longname": "Phaser.Loader.FileTypesManager.register", "scope": "static", "___id": "T000002R024715", "___s": true }, { "comment": "/**\r\n * Removed all associated file types.\r\n *\r\n * @method Phaser.Loader.FileTypesManager.destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "FileTypesManager.js", "lineno": 50, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Removed all associated file types.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypesManager", "longname": "Phaser.Loader.FileTypesManager.destroy", "scope": "static", "___id": "T000002R024718", "___s": true }, { "comment": "/**\r\n * Given a File and a baseURL value this returns the URL the File will use to download from.\r\n *\r\n * @function Phaser.Loader.GetURL\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File object.\r\n * @param {string} baseURL - A default base URL.\r\n *\r\n * @return {string} The URL the File will use.\r\n */", "meta": { "filename": "GetURL.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Given a File and a baseURL value this returns the URL the File will use to download from.", "kind": "function", "name": "GetURL", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File object.", "name": "file" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A default base URL.", "name": "baseURL" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The URL the File will use." } ], "memberof": "Phaser.Loader", "longname": "Phaser.Loader.GetURL", "scope": "static", "___id": "T000002R024722", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Loader\r\n */", "meta": { "filename": "index.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "kind": "namespace", "name": "Loader", "memberof": "Phaser", "longname": "Phaser.Loader", "scope": "static", "___id": "T000002R024727", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Loader handles loading all external content such as Images, Sounds, Texture Atlases and data files.\r\n * You typically interact with it via `this.load` in your Scene. Scenes can have a `preload` method, which is always\r\n * called before the Scenes `create` method, allowing you to preload assets that the Scene may need.\r\n *\r\n * If you call any `this.load` methods from outside of `Scene.preload` then you need to start the Loader going\r\n * yourself by calling `Loader.start()`. It's only automatically started during the Scene preload.\r\n *\r\n * The Loader uses a combination of tag loading (eg. Audio elements) and XHR and provides progress and completion events.\r\n * Files are loaded in parallel by default. The amount of concurrent connections can be controlled in your Game Configuration.\r\n *\r\n * Once the Loader has started loading you are still able to add files to it. These can be injected as a result of a loader\r\n * event, the type of file being loaded (such as a pack file) or other external events. As long as the Loader hasn't finished\r\n * simply adding a new file to it, while running, will ensure it's added into the current queue.\r\n *\r\n * Every Scene has its own instance of the Loader and they are bound to the Scene in which they are created. However,\r\n * assets loaded by the Loader are placed into global game-level caches. For example, loading an XML file will place that\r\n * file inside `Game.cache.xml`, which is accessible from every Scene in your game, no matter who was responsible\r\n * for loading it. The same is true of Textures. A texture loaded in one Scene is instantly available to all other Scenes\r\n * in your game.\r\n *\r\n * The Loader works by using custom File Types. These are stored in the FileTypesManager, which injects them into the Loader\r\n * when it's instantiated. You can create your own custom file types by extending either the File or MultiFile classes.\r\n * See those files for more details.\r\n *\r\n * @class LoaderPlugin\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Loader\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene which owns this Loader instance.\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "classdesc": "The Loader handles loading all external content such as Images, Sounds, Texture Atlases and data files.\rYou typically interact with it via `this.load` in your Scene. Scenes can have a `preload` method, which is always\rcalled before the Scenes `create` method, allowing you to preload assets that the Scene may need.\r\rIf you call any `this.load` methods from outside of `Scene.preload` then you need to start the Loader going\ryourself by calling `Loader.start()`. It's only automatically started during the Scene preload.\r\rThe Loader uses a combination of tag loading (eg. Audio elements) and XHR and provides progress and completion events.\rFiles are loaded in parallel by default. The amount of concurrent connections can be controlled in your Game Configuration.\r\rOnce the Loader has started loading you are still able to add files to it. These can be injected as a result of a loader\revent, the type of file being loaded (such as a pack file) or other external events. As long as the Loader hasn't finished\rsimply adding a new file to it, while running, will ensure it's added into the current queue.\r\rEvery Scene has its own instance of the Loader and they are bound to the Scene in which they are created. However,\rassets loaded by the Loader are placed into global game-level caches. For example, loading an XML file will place that\rfile inside `Game.cache.xml`, which is accessible from every Scene in your game, no matter who was responsible\rfor loading it. The same is true of Textures. A texture loaded in one Scene is instantly available to all other Scenes\rin your game.\r\rThe Loader works by using custom File Types. These are stored in the FileTypesManager, which injects them into the Loader\rwhen it's instantiated. You can create your own custom file types by extending either the File or MultiFile classes.\rSee those files for more details.", "kind": "class", "name": "LoaderPlugin", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Loader", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene which owns this Loader instance.", "name": "scene" } ], "scope": "static", "longname": "Phaser.Loader.LoaderPlugin", "___id": "T000002R024752", "___s": true }, { "comment": "/**\r\n * The Scene which owns this Loader instance.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The Scene which owns this Loader instance.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#scene", "scope": "instance", "kind": "member", "___id": "T000002R024758", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Systems.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#systems\r\n * @type {Phaser.Scenes.Systems}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "A reference to the Scene Systems.", "name": "systems", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "since": "3.0.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#systems", "scope": "instance", "kind": "member", "___id": "T000002R024760", "___s": true }, { "comment": "/**\r\n * A reference to the global Cache Manager.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#cacheManager\r\n * @type {Phaser.Cache.CacheManager}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "A reference to the global Cache Manager.", "name": "cacheManager", "type": { "names": [ "Phaser.Cache.CacheManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.CacheManager" } }, "since": "3.7.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#cacheManager", "scope": "instance", "kind": "member", "___id": "T000002R024762", "___s": true }, { "comment": "/**\r\n * A reference to the global Texture Manager.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#textureManager\r\n * @type {Phaser.Textures.TextureManager}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "A reference to the global Texture Manager.", "name": "textureManager", "type": { "names": [ "Phaser.Textures.TextureManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } }, "since": "3.7.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#textureManager", "scope": "instance", "kind": "member", "___id": "T000002R024764", "___s": true }, { "comment": "/**\r\n * A reference to the global Scene Manager.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#sceneManager\r\n * @type {Phaser.Scenes.SceneManager}\r\n * @protected\r\n * @since 3.16.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "A reference to the global Scene Manager.", "name": "sceneManager", "type": { "names": [ "Phaser.Scenes.SceneManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.SceneManager" } }, "access": "protected", "since": "3.16.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#sceneManager", "scope": "instance", "kind": "member", "___id": "T000002R024766", "___s": true }, { "comment": "/**\r\n * An optional prefix that is automatically prepended to the start of every file key.\r\n * If prefix was `MENU.` and you load an image with the key 'Background' the resulting key would be `MENU.Background`.\r\n * You can set this directly, or call `Loader.setPrefix()`. It will then affect every file added to the Loader\r\n * from that point on. It does _not_ change any file already in the load queue.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#prefix\r\n * @type {string}\r\n * @default ''\r\n * @since 3.7.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 115, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "An optional prefix that is automatically prepended to the start of every file key.\rIf prefix was `MENU.` and you load an image with the key 'Background' the resulting key would be `MENU.Background`.\rYou can set this directly, or call `Loader.setPrefix()`. It will then affect every file added to the Loader\rfrom that point on. It does _not_ change any file already in the load queue.", "name": "prefix", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.7.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#prefix", "scope": "instance", "kind": "member", "___id": "T000002R024768", "___s": true }, { "comment": "/**\r\n * The value of `path`, if set, is placed before any _relative_ file path given. For example:\r\n *\r\n * ```javascript\r\n * this.load.path = \"images/sprites/\";\r\n * this.load.image(\"ball\", \"ball.png\");\r\n * this.load.image(\"tree\", \"level1/oaktree.png\");\r\n * this.load.image(\"boom\", \"http://server.com/explode.png\");\r\n * ```\r\n *\r\n * Would load the `ball` file from `images/sprites/ball.png` and the tree from\r\n * `images/sprites/level1/oaktree.png` but the file `boom` would load from the URL\r\n * given as it's an absolute URL.\r\n *\r\n * Please note that the path is added before the filename but *after* the baseURL (if set.)\r\n *\r\n * If you set this property directly then it _must_ end with a \"/\". Alternatively, call `setPath()` and it'll do it for you.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#path\r\n * @type {string}\r\n * @default ''\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 128, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The value of `path`, if set, is placed before any _relative_ file path given. For example:\r\r```javascript\rthis.load.path = \"images/sprites/\";\rthis.load.image(\"ball\", \"ball.png\");\rthis.load.image(\"tree\", \"level1/oaktree.png\");\rthis.load.image(\"boom\", \"http://server.com/explode.png\");\r```\r\rWould load the `ball` file from `images/sprites/ball.png` and the tree from\r`images/sprites/level1/oaktree.png` but the file `boom` would load from the URL\rgiven as it's an absolute URL.\r\rPlease note that the path is added before the filename but *after* the baseURL (if set.)\r\rIf you set this property directly then it _must_ end with a \"/\". Alternatively, call `setPath()` and it'll do it for you.", "name": "path", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#path", "scope": "instance", "kind": "member", "___id": "T000002R024770", "___s": true }, { "comment": "/**\r\n * If you want to append a URL before the path of any asset you can set this here.\r\n *\r\n * Useful if allowing the asset base url to be configured outside of the game code.\r\n *\r\n * If you set this property directly then it _must_ end with a \"/\". Alternatively, call `setBaseURL()` and it'll do it for you.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#baseURL\r\n * @type {string}\r\n * @default ''\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 153, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "If you want to append a URL before the path of any asset you can set this here.\r\rUseful if allowing the asset base url to be configured outside of the game code.\r\rIf you set this property directly then it _must_ end with a \"/\". Alternatively, call `setBaseURL()` and it'll do it for you.", "name": "baseURL", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#baseURL", "scope": "instance", "kind": "member", "___id": "T000002R024772", "___s": true }, { "comment": "/**\r\n * The number of concurrent / parallel resources to try and fetch at once.\r\n *\r\n * Old browsers limit 6 requests per domain; modern ones, especially those with HTTP/2 don't limit it at all.\r\n *\r\n * The default is 32 but you can change this in your Game Config, or by changing this property before the Loader starts.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#maxParallelDownloads\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 173, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The number of concurrent / parallel resources to try and fetch at once.\r\rOld browsers limit 6 requests per domain; modern ones, especially those with HTTP/2 don't limit it at all.\r\rThe default is 32 but you can change this in your Game Config, or by changing this property before the Loader starts.", "name": "maxParallelDownloads", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#maxParallelDownloads", "scope": "instance", "kind": "member", "___id": "T000002R024774", "___s": true }, { "comment": "/**\r\n * xhr specific global settings (can be overridden on a per-file basis)\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#xhr\r\n * @type {Phaser.Types.Loader.XHRSettingsObject}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "xhr specific global settings (can be overridden on a per-file basis)", "name": "xhr", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#xhr", "scope": "instance", "kind": "member", "___id": "T000002R024776", "___s": true }, { "comment": "/**\r\n * The crossOrigin value applied to loaded images. Very often this needs to be set to 'anonymous'.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#crossOrigin\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 202, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The crossOrigin value applied to loaded images. Very often this needs to be set to 'anonymous'.", "name": "crossOrigin", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#crossOrigin", "scope": "instance", "kind": "member", "___id": "T000002R024778", "___s": true }, { "comment": "/**\r\n * Optional load type for image files. `XHR` is the default. Set to `HTMLImageElement` to load images using the Image tag instead.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#imageLoadType\r\n * @type {string}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Optional load type for image files. `XHR` is the default. Set to `HTMLImageElement` to load images using the Image tag instead.", "name": "imageLoadType", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#imageLoadType", "scope": "instance", "kind": "member", "___id": "T000002R024780", "___s": true }, { "comment": "/**\r\n * An array of all schemes that the Loader considers as being 'local'.\r\n *\r\n * This is populated by the `Phaser.Core.Config#loaderLocalScheme` game configuration setting and defaults to\r\n * `[ 'file://', 'capacitor://' ]`. Additional local schemes can be added to this array as needed.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#localSchemes\r\n * @type {string[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 220, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "An array of all schemes that the Loader considers as being 'local'.\r\rThis is populated by the `Phaser.Core.Config#loaderLocalScheme` game configuration setting and defaults to\r`[ 'file://', 'capacitor://' ]`. Additional local schemes can be added to this array as needed.", "name": "localSchemes", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#localSchemes", "scope": "instance", "kind": "member", "___id": "T000002R024782", "___s": true }, { "comment": "/**\r\n * The total number of files to load. It may not always be accurate because you may add to the Loader during the process\r\n * of loading, especially if you load a Pack File. Therefore this value can change, but in most cases remains static.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#totalToLoad\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 232, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The total number of files to load. It may not always be accurate because you may add to the Loader during the process\rof loading, especially if you load a Pack File. Therefore this value can change, but in most cases remains static.", "name": "totalToLoad", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#totalToLoad", "scope": "instance", "kind": "member", "___id": "T000002R024784", "___s": true }, { "comment": "/**\r\n * The progress of the current load queue, as a float value between 0 and 1.\r\n * This is updated automatically as files complete loading.\r\n * Note that it is possible for this value to go down again if you add content to the current load queue during a load.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#progress\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 243, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The progress of the current load queue, as a float value between 0 and 1.\rThis is updated automatically as files complete loading.\rNote that it is possible for this value to go down again if you add content to the current load queue during a load.", "name": "progress", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#progress", "scope": "instance", "kind": "member", "___id": "T000002R024786", "___s": true }, { "comment": "/**\r\n * Files are placed in this Set when they're added to the Loader via `addFile`.\r\n *\r\n * They are moved to the `inflight` Set when they start loading, and assuming a successful\r\n * load, to the `queue` Set for further processing.\r\n *\r\n * By the end of the load process this Set will be empty.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#list\r\n * @type {Phaser.Structs.Set.}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 255, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Files are placed in this Set when they're added to the Loader via `addFile`.\r\rThey are moved to the `inflight` Set when they start loading, and assuming a successful\rload, to the `queue` Set for further processing.\r\rBy the end of the load process this Set will be empty.", "name": "list", "type": { "names": [ "Phaser.Structs.Set." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.Set" }, "applications": [ { "type": "NameExpression", "name": "Phaser.Loader.File" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#list", "scope": "instance", "kind": "member", "___id": "T000002R024788", "___s": true }, { "comment": "/**\r\n * Files are stored in this Set while they're in the process of being loaded.\r\n *\r\n * Upon a successful load they are moved to the `queue` Set.\r\n *\r\n * By the end of the load process this Set will be empty.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#inflight\r\n * @type {Phaser.Structs.Set.}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Files are stored in this Set while they're in the process of being loaded.\r\rUpon a successful load they are moved to the `queue` Set.\r\rBy the end of the load process this Set will be empty.", "name": "inflight", "type": { "names": [ "Phaser.Structs.Set." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.Set" }, "applications": [ { "type": "NameExpression", "name": "Phaser.Loader.File" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#inflight", "scope": "instance", "kind": "member", "___id": "T000002R024790", "___s": true }, { "comment": "/**\r\n * Files are stored in this Set while they're being processed.\r\n *\r\n * If the process is successful they are moved to their final destination, which could be\r\n * a Cache or the Texture Manager.\r\n *\r\n * At the end of the load process this Set will be empty.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#queue\r\n * @type {Phaser.Structs.Set.}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 282, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Files are stored in this Set while they're being processed.\r\rIf the process is successful they are moved to their final destination, which could be\ra Cache or the Texture Manager.\r\rAt the end of the load process this Set will be empty.", "name": "queue", "type": { "names": [ "Phaser.Structs.Set." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.Set" }, "applications": [ { "type": "NameExpression", "name": "Phaser.Loader.File" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#queue", "scope": "instance", "kind": "member", "___id": "T000002R024792", "___s": true }, { "comment": "/**\r\n * The total number of files that failed to load during the most recent load.\r\n * This value is reset when you call `Loader.start`.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#totalFailed\r\n * @type {number}\r\n * @default 0\r\n * @since 3.7.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The total number of files that failed to load during the most recent load.\rThis value is reset when you call `Loader.start`.", "name": "totalFailed", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.7.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#totalFailed", "scope": "instance", "kind": "member", "___id": "T000002R024796", "___s": true }, { "comment": "/**\r\n * The total number of files that successfully loaded during the most recent load.\r\n * This value is reset when you call `Loader.start`.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#totalComplete\r\n * @type {number}\r\n * @default 0\r\n * @since 3.7.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 318, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The total number of files that successfully loaded during the most recent load.\rThis value is reset when you call `Loader.start`.", "name": "totalComplete", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.7.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#totalComplete", "scope": "instance", "kind": "member", "___id": "T000002R024798", "___s": true }, { "comment": "/**\r\n * The current state of the Loader.\r\n *\r\n * @name Phaser.Loader.LoaderPlugin#state\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 329, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The current state of the Loader.", "name": "state", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#state", "scope": "instance", "kind": "member", "___id": "T000002R024800", "___s": true }, { "comment": "/**\r\n * If you want to append a URL before the path of any asset you can set this here.\r\n *\r\n * Useful if allowing the asset base url to be configured outside of the game code.\r\n *\r\n * Once a base URL is set it will affect every file loaded by the Loader from that point on. It does _not_ change any\r\n * file _already_ being loaded. To reset it, call this method with no arguments.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#setBaseURL\r\n * @since 3.0.0\r\n *\r\n * @param {string} [url] - The URL to use. Leave empty to reset.\r\n *\r\n * @return {this} This Loader object.\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "If you want to append a URL before the path of any asset you can set this here.\r\rUseful if allowing the asset base url to be configured outside of the game code.\r\rOnce a base URL is set it will affect every file loaded by the Loader from that point on. It does _not_ change any\rfile _already_ being loaded. To reset it, call this method with no arguments.", "kind": "function", "name": "setBaseURL", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The URL to use. Leave empty to reset.", "name": "url" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Loader object." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#setBaseURL", "scope": "instance", "___id": "T000002R024808", "___s": true }, { "comment": "/**\r\n * The value of `path`, if set, is placed before any _relative_ file path given. For example:\r\n *\r\n * ```javascript\r\n * this.load.setPath(\"images/sprites/\");\r\n * this.load.image(\"ball\", \"ball.png\");\r\n * this.load.image(\"tree\", \"level1/oaktree.png\");\r\n * this.load.image(\"boom\", \"http://server.com/explode.png\");\r\n * ```\r\n *\r\n * Would load the `ball` file from `images/sprites/ball.png` and the tree from\r\n * `images/sprites/level1/oaktree.png` but the file `boom` would load from the URL\r\n * given as it's an absolute URL.\r\n *\r\n * Please note that the path is added before the filename but *after* the baseURL (if set.)\r\n *\r\n * Once a path is set it will then affect every file added to the Loader from that point on. It does _not_ change any\r\n * file _already_ in the load queue. To reset it, call this method with no arguments.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#setPath\r\n * @since 3.0.0\r\n *\r\n * @param {string} [path] - The path to use. Leave empty to reset.\r\n *\r\n * @return {this} This Loader object.\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 409, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The value of `path`, if set, is placed before any _relative_ file path given. For example:\r\r```javascript\rthis.load.setPath(\"images/sprites/\");\rthis.load.image(\"ball\", \"ball.png\");\rthis.load.image(\"tree\", \"level1/oaktree.png\");\rthis.load.image(\"boom\", \"http://server.com/explode.png\");\r```\r\rWould load the `ball` file from `images/sprites/ball.png` and the tree from\r`images/sprites/level1/oaktree.png` but the file `boom` would load from the URL\rgiven as it's an absolute URL.\r\rPlease note that the path is added before the filename but *after* the baseURL (if set.)\r\rOnce a path is set it will then affect every file added to the Loader from that point on. It does _not_ change any\rfile _already_ in the load queue. To reset it, call this method with no arguments.", "kind": "function", "name": "setPath", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The path to use. Leave empty to reset.", "name": "path" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Loader object." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#setPath", "scope": "instance", "___id": "T000002R024813", "___s": true }, { "comment": "/**\r\n * An optional prefix that is automatically prepended to the start of every file key.\r\n *\r\n * If prefix was `MENU.` and you load an image with the key 'Background' the resulting key would be `MENU.Background`.\r\n *\r\n * Once a prefix is set it will then affect every file added to the Loader from that point on. It does _not_ change any\r\n * file _already_ in the load queue. To reset it, call this method with no arguments.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#setPrefix\r\n * @since 3.7.0\r\n *\r\n * @param {string} [prefix] - The prefix to use. Leave empty to reset.\r\n *\r\n * @return {this} This Loader object.\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 449, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "An optional prefix that is automatically prepended to the start of every file key.\r\rIf prefix was `MENU.` and you load an image with the key 'Background' the resulting key would be `MENU.Background`.\r\rOnce a prefix is set it will then affect every file added to the Loader from that point on. It does _not_ change any\rfile _already_ in the load queue. To reset it, call this method with no arguments.", "kind": "function", "name": "setPrefix", "since": "3.7.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The prefix to use. Leave empty to reset.", "name": "prefix" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Loader object." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#setPrefix", "scope": "instance", "___id": "T000002R024818", "___s": true }, { "comment": "/**\r\n * Sets the Cross Origin Resource Sharing value used when loading files.\r\n *\r\n * Files can override this value on a per-file basis by specifying an alternative `crossOrigin` value in their file config.\r\n *\r\n * Once CORs is set it will then affect every file loaded by the Loader from that point on, as long as they don't have\r\n * their own CORs setting. To reset it, call this method with no arguments.\r\n *\r\n * For more details about CORs see https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#setCORS\r\n * @since 3.0.0\r\n *\r\n * @param {string} [crossOrigin] - The value to use for the `crossOrigin` property in the load request.\r\n *\r\n * @return {this} This Loader object.\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 473, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Sets the Cross Origin Resource Sharing value used when loading files.\r\rFiles can override this value on a per-file basis by specifying an alternative `crossOrigin` value in their file config.\r\rOnce CORs is set it will then affect every file loaded by the Loader from that point on, as long as they don't have\rtheir own CORs setting. To reset it, call this method with no arguments.\r\rFor more details about CORs see https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS", "kind": "function", "name": "setCORS", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The value to use for the `crossOrigin` property in the load request.", "name": "crossOrigin" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Loader object." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#setCORS", "scope": "instance", "___id": "T000002R024822", "___s": true }, { "comment": "/**\r\n * Adds a file, or array of files, into the load queue.\r\n *\r\n * The file must be an instance of `Phaser.Loader.File`, or a class that extends it. The Loader will check that the key\r\n * used by the file won't conflict with any other key either in the loader, the inflight queue or the target cache.\r\n * If allowed it will then add the file into the pending list, read for the load to start. Or, if the load has already\r\n * started, ready for the next batch of files to be pulled from the list to the inflight queue.\r\n *\r\n * You should not normally call this method directly, but rather use one of the Loader methods like `image` or `atlas`,\r\n * however you can call this as long as the file given to it is well formed.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#addFile\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Loader.File|Phaser.Loader.File[])} file - The file, or array of files, to be added to the load queue.\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 497, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Adds a file, or array of files, into the load queue.\r\rThe file must be an instance of `Phaser.Loader.File`, or a class that extends it. The Loader will check that the key\rused by the file won't conflict with any other key either in the loader, the inflight queue or the target cache.\rIf allowed it will then add the file into the pending list, read for the load to start. Or, if the load has already\rstarted, ready for the next batch of files to be pulled from the list to the inflight queue.\r\rYou should not normally call this method directly, but rather use one of the Loader methods like `image` or `atlas`,\rhowever you can call this as long as the file given to it is well formed.", "kind": "function", "name": "addFile", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.File", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Loader.File" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Loader.File", "type": "NameExpression" } ] } ] } }, "description": "The file, or array of files, to be added to the load queue.", "name": "file" } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#addFile", "scope": "instance", "___id": "T000002R024825", "___s": true }, { "comment": "/**\r\n * Checks the key and type of the given file to see if it will conflict with anything already\r\n * in a Cache, the Texture Manager, or the list or inflight queues.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#keyExists\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} file - The file to check the key of.\r\n *\r\n * @return {boolean} `true` if adding this file will cause a cache or queue conflict, otherwise `false`.\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Checks the key and type of the given file to see if it will conflict with anything already\rin a Cache, the Texture Manager, or the list or inflight queues.", "kind": "function", "name": "keyExists", "since": "3.7.0", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to check the key of.", "name": "file" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if adding this file will cause a cache or queue conflict, otherwise `false`." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#keyExists", "scope": "instance", "___id": "T000002R024830", "___s": true }, { "comment": "/**\r\n * Takes a well formed, fully parsed pack file object and adds its entries into the load queue. Usually you do not call\r\n * this method directly, but instead use `Loader.pack` and supply a path to a JSON file that holds the\r\n * pack data. However, if you've got the data prepared you can pass it to this method.\r\n *\r\n * You can also provide an optional key. If you do then it will only add the entries from that part of the pack into\r\n * to the load queue. If not specified it will add all entries it finds. For more details about the pack file format\r\n * see the `LoaderPlugin.pack` method.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#addPack\r\n * @since 3.7.0\r\n *\r\n * @param {any} pack - The Pack File data to be parsed and each entry of it to added to the load queue.\r\n * @param {string} [packKey] - An optional key to use from the pack file data.\r\n *\r\n * @return {boolean} `true` if any files were added to the queue, otherwise `false`.\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Takes a well formed, fully parsed pack file object and adds its entries into the load queue. Usually you do not call\rthis method directly, but instead use `Loader.pack` and supply a path to a JSON file that holds the\rpack data. However, if you've got the data prepared you can pass it to this method.\r\rYou can also provide an optional key. If you do then it will only add the entries from that part of the pack into\rto the load queue. If not specified it will add all entries it finds. For more details about the pack file format\rsee the `LoaderPlugin.pack` method.", "kind": "function", "name": "addPack", "since": "3.7.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The Pack File data to be parsed and each entry of it to added to the load queue.", "name": "pack" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "An optional key to use from the pack file data.", "name": "packKey" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if any files were added to the queue, otherwise `false`." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#addPack", "scope": "instance", "___id": "T000002R024836", "___s": true }, { "comment": "/**\r\n * Is the Loader actively loading, or processing loaded files?\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#isLoading\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if the Loader is busy loading or processing, otherwise `false`.\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 681, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Is the Loader actively loading, or processing loaded files?", "kind": "function", "name": "isLoading", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Loader is busy loading or processing, otherwise `false`." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#isLoading", "scope": "instance", "___id": "T000002R024855", "___s": true }, { "comment": "/**\r\n * Is the Loader ready to start a new load?\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#isReady\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if the Loader is ready to start a new load, otherwise `false`.\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 694, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Is the Loader ready to start a new load?", "kind": "function", "name": "isReady", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Loader is ready to start a new load, otherwise `false`." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#isReady", "scope": "instance", "___id": "T000002R024857", "___s": true }, { "comment": "/**\r\n * Starts the Loader running. This will reset the progress and totals and then emit a `start` event.\r\n * If there is nothing in the queue the Loader will immediately complete, otherwise it will start\r\n * loading the first batch of files.\r\n *\r\n * The Loader is started automatically if the queue is populated within your Scenes `preload` method.\r\n *\r\n * However, outside of this, you need to call this method to start it.\r\n *\r\n * If the Loader is already running this method will simply return.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#start\r\n * @fires Phaser.Loader.Events#START\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 707, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Starts the Loader running. This will reset the progress and totals and then emit a `start` event.\rIf there is nothing in the queue the Loader will immediately complete, otherwise it will start\rloading the first batch of files.\r\rThe Loader is started automatically if the queue is populated within your Scenes `preload` method.\r\rHowever, outside of this, you need to call this method to start it.\r\rIf the Loader is already running this method will simply return.", "kind": "function", "name": "start", "fires": [ "Phaser.Loader.Events#event:START" ], "since": "3.0.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#start", "scope": "instance", "___id": "T000002R024859", "___s": true }, { "comment": "/**\r\n * Called automatically during the load process.\r\n * It updates the `progress` value and then emits a progress event, which you can use to\r\n * display a loading bar in your game.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#updateProgress\r\n * @fires Phaser.Loader.Events#PROGRESS\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 756, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Called automatically during the load process.\rIt updates the `progress` value and then emits a progress event, which you can use to\rdisplay a loading bar in your game.", "kind": "function", "name": "updateProgress", "fires": [ "Phaser.Loader.Events#event:PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#updateProgress", "scope": "instance", "___id": "T000002R024866", "___s": true }, { "comment": "/**\r\n * Called automatically during the load process.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#update\r\n * @since 3.10.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 772, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Called automatically during the load process.", "kind": "function", "name": "update", "since": "3.10.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#update", "scope": "instance", "___id": "T000002R024869", "___s": true }, { "comment": "/**\r\n * An internal method called automatically by the XHRLoader belong to a File.\r\n *\r\n * This method will remove the given file from the inflight Set and update the load progress.\r\n * If the file was successful its `onProcess` method is called, otherwise it is added to the delete queue.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#nextFile\r\n * @fires Phaser.Loader.Events#FILE_LOAD\r\n * @fires Phaser.Loader.Events#FILE_LOAD_ERROR\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File that just finished loading, or errored during load.\r\n * @param {boolean} success - `true` if the file loaded successfully, otherwise `false`.\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 826, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "An internal method called automatically by the XHRLoader belong to a File.\r\rThis method will remove the given file from the inflight Set and update the load progress.\rIf the file was successful its `onProcess` method is called, otherwise it is added to the delete queue.", "kind": "function", "name": "nextFile", "fires": [ "Phaser.Loader.Events#event:FILE_LOAD", "Phaser.Loader.Events#event:FILE_LOAD_ERROR" ], "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that just finished loading, or errored during load.", "name": "file" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the file loaded successfully, otherwise `false`.", "name": "success" } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#nextFile", "scope": "instance", "___id": "T000002R024874", "___s": true }, { "comment": "/**\r\n * An internal method that is called automatically by the File when it has finished processing.\r\n *\r\n * If the process was successful, and the File isn't part of a MultiFile, its `addToCache` method is called.\r\n *\r\n * It this then removed from the queue. If there are no more files to load `loadComplete` is called.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#fileProcessComplete\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} file - The file that has finished processing.\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 874, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "An internal method that is called automatically by the File when it has finished processing.\r\rIf the process was successful, and the File isn't part of a MultiFile, its `addToCache` method is called.\r\rIt this then removed from the queue. If there are no more files to load `loadComplete` is called.", "kind": "function", "name": "fileProcessComplete", "since": "3.7.0", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file that has finished processing.", "name": "file" } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#fileProcessComplete", "scope": "instance", "___id": "T000002R024876", "___s": true }, { "comment": "/**\r\n * Called at the end when the load queue is exhausted and all files have either loaded or errored.\r\n * By this point every loaded file will now be in its associated cache and ready for use.\r\n *\r\n * Also clears down the Sets, puts progress to 1 and clears the deletion queue.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#loadComplete\r\n * @fires Phaser.Loader.Events#COMPLETE\r\n * @fires Phaser.Loader.Events#POST_PROCESS\r\n * @since 3.7.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 932, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Called at the end when the load queue is exhausted and all files have either loaded or errored.\rBy this point every loaded file will now be in its associated cache and ready for use.\r\rAlso clears down the Sets, puts progress to 1 and clears the deletion queue.", "kind": "function", "name": "loadComplete", "fires": [ "Phaser.Loader.Events#event:COMPLETE", "Phaser.Loader.Events#event:POST_PROCESS" ], "since": "3.7.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#loadComplete", "scope": "instance", "___id": "T000002R024878", "___s": true }, { "comment": "/**\r\n * Adds a File into the pending-deletion queue.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#flagForRemoval\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File to be queued for deletion when the Loader completes.\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 965, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Adds a File into the pending-deletion queue.", "kind": "function", "name": "flagForRemoval", "since": "3.7.0", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File to be queued for deletion when the Loader completes.", "name": "file" } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#flagForRemoval", "scope": "instance", "___id": "T000002R024882", "___s": true }, { "comment": "/**\r\n * Converts the given JSON data into a file that the browser then prompts you to download so you can save it locally.\r\n *\r\n * The data must be well formed JSON and ready-parsed, not a JavaScript object.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#saveJSON\r\n * @since 3.0.0\r\n *\r\n * @param {*} data - The JSON data, ready parsed.\r\n * @param {string} [filename=file.json] - The name to save the JSON file as.\r\n *\r\n * @return {this} This Loader plugin.\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 978, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Converts the given JSON data into a file that the browser then prompts you to download so you can save it locally.\r\rThe data must be well formed JSON and ready-parsed, not a JavaScript object.", "kind": "function", "name": "saveJSON", "since": "3.0.0", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The JSON data, ready parsed.", "name": "data" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "file.json", "description": "The name to save the JSON file as.", "name": "filename" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Loader plugin." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#saveJSON", "scope": "instance", "___id": "T000002R024884", "___s": true }, { "comment": "/**\r\n * Causes the browser to save the given data as a file to its default Downloads folder.\r\n *\r\n * Creates a DOM level anchor link, assigns it as being a `download` anchor, sets the href\r\n * to be an ObjectURL based on the given data, and then invokes a click event.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#save\r\n * @since 3.0.0\r\n *\r\n * @param {*} data - The data to be saved. Will be passed through URL.createObjectURL.\r\n * @param {string} [filename=file.json] - The filename to save the file as.\r\n * @param {string} [filetype=application/json] - The file type to use when saving the file. Defaults to JSON.\r\n *\r\n * @return {this} This Loader plugin.\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Causes the browser to save the given data as a file to its default Downloads folder.\r\rCreates a DOM level anchor link, assigns it as being a `download` anchor, sets the href\rto be an ObjectURL based on the given data, and then invokes a click event.", "kind": "function", "name": "save", "since": "3.0.0", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The data to be saved. Will be passed through URL.createObjectURL.", "name": "data" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "file.json", "description": "The filename to save the file as.", "name": "filename" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "application/json", "description": "The file type to use when saving the file. Defaults to JSON.", "name": "filetype" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Loader plugin." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#save", "scope": "instance", "___id": "T000002R024886", "___s": true }, { "comment": "/**\r\n * Resets the Loader.\r\n *\r\n * This will clear all lists and reset the base URL, path and prefix.\r\n *\r\n * Warning: If the Loader is currently downloading files, or has files in its queue, they will be aborted.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#reset\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LoaderPlugin.js", "lineno": 1030, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Resets the Loader.\r\rThis will clear all lists and reset the base URL, path and prefix.\r\rWarning: If the Loader is currently downloading files, or has files in its queue, they will be aborted.", "kind": "function", "name": "reset", "since": "3.0.0", "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#reset", "scope": "instance", "___id": "T000002R024897", "___s": true }, { "comment": "/**\r\n * Takes two XHRSettings Objects and creates a new XHRSettings object from them.\r\n *\r\n * The new object is seeded by the values given in the global settings, but any setting in\r\n * the local object overrides the global ones.\r\n *\r\n * @function Phaser.Loader.MergeXHRSettings\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} global - The global XHRSettings object.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} local - The local XHRSettings object.\r\n *\r\n * @return {Phaser.Types.Loader.XHRSettingsObject} A newly formed XHRSettings object.\r\n */", "meta": { "filename": "MergeXHRSettings.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Takes two XHRSettings Objects and creates a new XHRSettings object from them.\r\rThe new object is seeded by the values given in the global settings, but any setting in\rthe local object overrides the global ones.", "kind": "function", "name": "MergeXHRSettings", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "description": "The global XHRSettings object.", "name": "global" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "description": "The local XHRSettings object.", "name": "local" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "description": "A newly formed XHRSettings object." } ], "memberof": "Phaser.Loader", "longname": "Phaser.Loader.MergeXHRSettings", "scope": "static", "___id": "T000002R024919", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A MultiFile is a special kind of parent that contains two, or more, Files as children and looks after\r\n * the loading and processing of them all. It is commonly extended and used as a base class for file types such as AtlasJSON or BitmapFont.\r\n *\r\n * You shouldn't create an instance of a MultiFile directly, but should extend it with your own class, setting a custom type and processing methods.\r\n *\r\n * @class MultiFile\r\n * @memberof Phaser.Loader\r\n * @constructor\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.LoaderPlugin} loader - The Loader that is going to load this File.\r\n * @param {string} type - The file type string for sorting within the Loader.\r\n * @param {string} key - The key of the file within the loader.\r\n * @param {Phaser.Loader.File[]} files - An array of Files that make-up this MultiFile.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "classdesc": "A MultiFile is a special kind of parent that contains two, or more, Files as children and looks after\rthe loading and processing of them all. It is commonly extended and used as a base class for file types such as AtlasJSON or BitmapFont.\r\rYou shouldn't create an instance of a MultiFile directly, but should extend it with your own class, setting a custom type and processing methods.", "kind": "class", "name": "MultiFile", "memberof": "Phaser.Loader", "since": "3.7.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "description": "The Loader that is going to load this File.", "name": "loader" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The file type string for sorting within the Loader.", "name": "type" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file within the loader.", "name": "key" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Loader.File", "type": "NameExpression" } ] } }, "description": "An array of Files that make-up this MultiFile.", "name": "files" } ], "scope": "static", "longname": "Phaser.Loader.MultiFile", "___id": "T000002R024928", "___s": true }, { "comment": "/**\r\n * A reference to the Loader that is going to load this file.\r\n *\r\n * @name Phaser.Loader.MultiFile#loader\r\n * @type {Phaser.Loader.LoaderPlugin}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 45, "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.7.0", "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#loader", "scope": "instance", "kind": "member", "___id": "T000002R024932", "___s": true }, { "comment": "/**\r\n * The file type string for sorting within the Loader.\r\n *\r\n * @name Phaser.Loader.MultiFile#type\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The file type string for sorting within the Loader.", "name": "type", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#type", "scope": "instance", "kind": "member", "___id": "T000002R024934", "___s": true }, { "comment": "/**\r\n * Unique cache key (unique within its file type)\r\n *\r\n * @name Phaser.Loader.MultiFile#key\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 63, "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.7.0", "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#key", "scope": "instance", "kind": "member", "___id": "T000002R024936", "___s": true }, { "comment": "/**\r\n * Array of files that make up this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#files\r\n * @type {Phaser.Loader.File[]}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Array of files that make up this MultiFile.", "name": "files", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Loader.File", "type": "NameExpression" } ] } }, "since": "3.7.0", "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#files", "scope": "instance", "kind": "member", "___id": "T000002R024940", "___s": true }, { "comment": "/**\r\n * The current state of the file. One of the FILE_CONST values.\r\n *\r\n * @name Phaser.Loader.MultiFile#state\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 91, "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.60.0", "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#state", "scope": "instance", "kind": "member", "___id": "T000002R024942", "___s": true }, { "comment": "/**\r\n * The completion status of this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#complete\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The completion status of this MultiFile.", "name": "complete", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.7.0", "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#complete", "scope": "instance", "kind": "member", "___id": "T000002R024944", "___s": true }, { "comment": "/**\r\n * The number of files to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#pending\r\n * @type {number}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The number of files to load.", "name": "pending", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.7.0", "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#pending", "scope": "instance", "kind": "member", "___id": "T000002R024946", "___s": true }, { "comment": "/**\r\n * The number of files that failed to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#failed\r\n * @type {number}\r\n * @default 0\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The number of files that failed to load.", "name": "failed", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.7.0", "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#failed", "scope": "instance", "kind": "member", "___id": "T000002R024948", "___s": true }, { "comment": "/**\r\n * A storage container for transient data that the loading files need.\r\n *\r\n * @name Phaser.Loader.MultiFile#config\r\n * @type {any}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "A storage container for transient data that the loading files need.", "name": "config", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.7.0", "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#config", "scope": "instance", "kind": "member", "___id": "T000002R024950", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders baseURL at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#baseURL\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "A reference to the Loaders baseURL at the time this MultiFile was created.\rUsed to populate child-files.", "name": "baseURL", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#baseURL", "scope": "instance", "kind": "member", "___id": "T000002R024952", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders path at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#path\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "A reference to the Loaders path at the time this MultiFile was created.\rUsed to populate child-files.", "name": "path", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#path", "scope": "instance", "kind": "member", "___id": "T000002R024954", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders prefix at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#prefix\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "A reference to the Loaders prefix at the time this MultiFile was created.\rUsed to populate child-files.", "name": "prefix", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#prefix", "scope": "instance", "kind": "member", "___id": "T000002R024956", "___s": true }, { "comment": "/**\r\n * Checks if this MultiFile is ready to process its children or not.\r\n *\r\n * @method Phaser.Loader.MultiFile#isReadyToProcess\r\n * @since 3.7.0\r\n *\r\n * @return {boolean} `true` if all children of this MultiFile have loaded, otherwise `false`.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Checks if this MultiFile is ready to process its children or not.", "kind": "function", "name": "isReadyToProcess", "since": "3.7.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if all children of this MultiFile have loaded, otherwise `false`." } ], "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#isReadyToProcess", "scope": "instance", "___id": "T000002R024960", "___s": true }, { "comment": "/**\r\n * Adds another child to this MultiFile, increases the pending count and resets the completion status.\r\n *\r\n * @method Phaser.Loader.MultiFile#addToMultiFile\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} files - The File to add to this MultiFile.\r\n *\r\n * @return {Phaser.Loader.MultiFile} This MultiFile instance.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Adds another child to this MultiFile, increases the pending count and resets the completion status.", "kind": "function", "name": "addToMultiFile", "since": "3.7.0", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File to add to this MultiFile.", "name": "files" } ], "returns": [ { "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile" } }, "description": "This MultiFile instance." } ], "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#addToMultiFile", "scope": "instance", "___id": "T000002R024962", "___s": true }, { "comment": "/**\r\n * Called by each File when it finishes loading.\r\n *\r\n * @method Phaser.Loader.MultiFile#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": "MultiFile.js", "lineno": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "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.MultiFile", "longname": "Phaser.Loader.MultiFile#onFileComplete", "scope": "instance", "___id": "T000002R024966", "___s": true }, { "comment": "/**\r\n * Called by each File that fails to load.\r\n *\r\n * @method Phaser.Loader.MultiFile#onFileFailed\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File that has failed to load.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Called by each File that fails to load.", "kind": "function", "name": "onFileFailed", "since": "3.7.0", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has failed to load.", "name": "file" } ], "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#onFileFailed", "scope": "instance", "___id": "T000002R024969", "___s": true }, { "comment": "/**\r\n * Called once all children of this multi file have been added to their caches and is now\r\n * ready for deletion from the Loader.\r\n *\r\n * It will emit a `filecomplete` event from the LoaderPlugin.\r\n *\r\n * @method Phaser.Loader.MultiFile#pendingDestroy\r\n * @fires Phaser.Loader.Events#FILE_COMPLETE\r\n * @fires Phaser.Loader.Events#FILE_KEY_COMPLETE\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Called once all children of this multi file have been added to their caches and is now\rready for deletion from the Loader.\r\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.60.0", "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#pendingDestroy", "scope": "instance", "___id": "T000002R024972", "___s": true }, { "comment": "/**\r\n * Destroy this Multi File and any references it holds.\r\n *\r\n * @method Phaser.Loader.MultiFile#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Destroy this Multi File and any references it holds.", "kind": "function", "name": "destroy", "since": "3.60.0", "memberof": "Phaser.Loader.MultiFile", "longname": "Phaser.Loader.MultiFile#destroy", "scope": "instance", "___id": "T000002R024978", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.FileConfig\r\n * @since 3.0.0\r\n *\r\n * @property {string} type - The name of the Loader method that loads this file, e.g., 'image', 'json', 'spritesheet'.\r\n * @property {string} key - Unique cache key (unique within its file type)\r\n * @property {object|string} [url] - The URL of the file, not including baseURL.\r\n * @property {string} [path] - The path of the file, not including the baseURL.\r\n * @property {string} [extension] - The default extension this file uses.\r\n * @property {XMLHttpRequestResponseType} [responseType] - The responseType to be used by the XHR request.\r\n * @property {(Phaser.Types.Loader.XHRSettingsObject|false)} [xhrSettings=false] - Custom XHR Settings specific to this file and merged with the Loader defaults.\r\n * @property {any} [config] - A config object that can be used by file types to store transitional data.\r\n * @property {string} [textureURL] - The absolute or relative URL to load the texture image file from.\r\n * @property {string} [textureExtension='png'] - The default file extension to use for the image texture if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - Extra XHR Settings specifically for the texture image file.\r\n * @property {object|string} [atlasURL] - The absolute or relative URL to load the atlas json file from. Or, a well formed JSON object to use instead.\r\n * @property {string} [atlasExtension='json'] - The default file extension to use for the atlas json if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [atlasXhrSettings] - Extra XHR Settings specifically for the atlas json file.\r\n * @property {string} [normalMap] - The filename of an associated normal map. It uses the same path and url to load as the texture image.\r\n * @property {AudioContext} [context] - The optional AudioContext this file will use to process itself (only used by Sound objects).\r\n * @property {string} [jsonURL] - The absolute or relative URL to load the json file from. Or a well formed JSON object to use instead.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [jsonXhrSettings] - Extra XHR Settings specifically for the json file.\r\n * @property {{(string|string[])}} [audioURL] - The absolute or relative URL to load the audio file from.\r\n * @property {any} [audioConfig] - The audio configuration options.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [audioXhrSettings] - Extra XHR Settings specifically for the audio file.\r\n * @property {any} [dataType] - Optional type to cast the binary file to once loaded. For example, `Uint8Array`.\r\n * @property {string} [fontDataURL] - The absolute or relative URL to load the font data xml file from.\r\n * @property {string} [fontDataExtension='xml'] - The default file extension to use for the font data xml if no url is provided.\r\n * @property {Phaser.Types.Loader.XHRSettingsObject} [fontDataXhrSettings] - Extra XHR Settings specifically for the font data xml file.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [ETC] - The string, or file entry object, for an ETC format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [ETC1] - The string, or file entry object, for an ETC1 format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [ATC] - The string, or file entry object, for an ATC format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [ASTC] - The string, or file entry object, for an ASTC format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [BPTC] - The string, or file entry object, for an BPTC format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [RGTC] - The string, or file entry object, for an RGTC format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [PVRTC] - The string, or file entry object, for an PVRTC format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [S3TC] - The string, or file entry object, for an S3TC format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [S3TCRGB] - The string, or file entry object, for an S3TCRGB format texture.\r\n * @property {(Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string)} [IMG] - The string, or file entry object, for the fallback image file.\r\n * @property {string} [shaderType='fragment'] - The type of shader. Either `fragment` for a fragment shader, or `vertex` for a vertex shader. This is ignored if you load a shader bundle.\r\n * @property {number} [width=512] - The width of the texture the HTML will be rendered to.\r\n * @property {number} [height=512] - The height of the texture the HTML will be rendered to.\r\n * @property {Phaser.Types.Loader.FileTypes.ImageFrameConfig} [frameConfig] - The frame configuration object. Only provided for, and used by, Sprite Sheets.\r\n * @property {string} [dataKey] - If specified instead of the whole JSON file being parsed and added to the Cache, only the section corresponding to this property key will be added. If the property you want to extract is nested, use periods to divide it.\r\n * @property {string} [baseURL] - Optional Base URL to use when loading the textures defined in the atlas data.\r\n * @property {boolean} [flipUV] - Flip the UV coordinates stored in the model data?\r\n * @property {string} [matURL] - An optional absolute or relative URL to the object material file from. If undefined or `null`, no material file will be loaded.\r\n * @property {string} [matExtension='mat'] - The default material file extension to use if no url is provided.\r\n * @property {boolean} [start=false] - Automatically start the plugin after loading?\r\n * @property {string} [mapping] - If this plugin is to be injected into the Scene, this is the property key used.\r\n * @property {string} [systemKey] - If this plugin is to be added to Scene.Systems, this is the property key for it.\r\n * @property {string} [sceneKey] - If this plugin is to be added to the Scene, this is the property key for it.\r\n * @property {Phaser.Types.Loader.FileTypes.SVGSizeConfig} [svgConfig] - The svg size configuration object.\r\n */", "meta": { "filename": "FileConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\typedefs", "code": {} }, "kind": "typedef", "name": "FileConfig", "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 Loader method that loads this file, e.g., 'image', 'json', 'spritesheet'.", "name": "type" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Unique cache key (unique within its file type)", "name": "key" }, { "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The URL of the file, not including baseURL.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The path of the file, not including the baseURL.", "name": "path" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The default extension this file uses.", "name": "extension" }, { "type": { "names": [ "XMLHttpRequestResponseType" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequestResponseType" } }, "optional": true, "description": "The responseType to be used by the XHR request.", "name": "responseType" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject", "false" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" }, { "type": "NameExpression", "name": "false", "reservedWord": true } ] } }, "optional": true, "defaultvalue": false, "description": "Custom XHR Settings specific to this file and merged with the Loader defaults.", "name": "xhrSettings" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "A config object that can be used by file types to store transitional data.", "name": "config" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the texture image file from.", "name": "textureURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'png'", "description": "The default file extension to use for the image texture if no url is provided.", "name": "textureExtension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the texture image file.", "name": "textureXhrSettings" }, { "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 atlas json file from. Or, a well formed JSON object to use instead.", "name": "atlasURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'json'", "description": "The default file extension to use for the atlas json if no url is provided.", "name": "atlasExtension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the atlas json file.", "name": "atlasXhrSettings" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The filename of an associated normal map. It uses the same path and url to load as the texture image.", "name": "normalMap" }, { "type": { "names": [ "AudioContext" ], "parsedType": { "type": "NameExpression", "name": "AudioContext" } }, "optional": true, "description": "The optional AudioContext this file will use to process itself (only used by Sound objects).", "name": "context" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the json file from. Or a well formed JSON object to use instead.", "name": "jsonURL" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the json file.", "name": "jsonXhrSettings" }, { "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.", "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": "Extra XHR Settings specifically for the audio file.", "name": "audioXhrSettings" }, { "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": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the font data xml file from.", "name": "fontDataURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'xml'", "description": "The default file extension to use for the font data xml if no url is provided.", "name": "fontDataExtension" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for the font data xml file.", "name": "fontDataXhrSettings" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an ETC format texture.", "name": "ETC" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an ETC1 format texture.", "name": "ETC1" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an ATC format texture.", "name": "ATC" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an ASTC format texture.", "name": "ASTC" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an BPTC format texture.", "name": "BPTC" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an RGTC format texture.", "name": "RGTC" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an PVRTC format texture.", "name": "PVRTC" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an S3TC format texture.", "name": "S3TC" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for an S3TCRGB format texture.", "name": "S3TCRGB" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string, or file entry object, for the fallback image file.", "name": "IMG" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'fragment'", "description": "The type of shader. Either `fragment` for a fragment shader, or `vertex` for a vertex shader. This is ignored if you load a shader bundle.", "name": "shaderType" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 512, "description": "The width of the texture the HTML will be rendered to.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 512, "description": "The height of the texture the HTML will be rendered to.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.ImageFrameConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.ImageFrameConfig" } }, "optional": true, "description": "The frame configuration object. Only provided for, and used by, Sprite Sheets.", "name": "frameConfig" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If specified instead of the whole JSON file being parsed and added to the Cache, only the section corresponding to this property key will be added. If the property you want to extract is nested, use periods to divide it.", "name": "dataKey" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional Base URL to use when loading the textures defined in the atlas data.", "name": "baseURL" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Flip the UV coordinates stored in the model data?", "name": "flipUV" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "An optional absolute or relative URL to the object material file from. If undefined or `null`, no material file will be loaded.", "name": "matURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'mat'", "description": "The default material file extension to use if no url is provided.", "name": "matExtension" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Automatically start the plugin after loading?", "name": "start" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If this plugin is to be injected into the Scene, this is the property key used.", "name": "mapping" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If this plugin is to be added to Scene.Systems, this is the property key for it.", "name": "systemKey" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If this plugin is to be added to the Scene, this is the property key for it.", "name": "sceneKey" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.SVGSizeConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.SVGSizeConfig" } }, "optional": true, "description": "The svg size configuration object.", "name": "svgConfig" } ], "memberof": "Phaser.Types.Loader", "longname": "Phaser.Types.Loader.FileConfig", "scope": "static", "___id": "T000002R024984", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Loader\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\typedefs", "code": {} }, "kind": "namespace", "name": "Loader", "memberof": "Phaser.Types", "longname": "Phaser.Types.Loader", "scope": "static", "___id": "T000002R024985", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Loader.XHRSettingsObject\r\n * @since 3.0.0\r\n *\r\n * @property {XMLHttpRequestResponseType} responseType - The response type of the XHR request, i.e. `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 the XHR request.\r\n * @property {string} [password=''] - Optional password for the XHR request.\r\n * @property {number} [timeout=0] - Optional XHR timeout value.\r\n * @property {(object|undefined)} [headers] - This value is used to populate the XHR `setRequestHeader` and is undefined by default.\r\n * @property {(string|undefined)} [header] - This value is used to populate the XHR `setRequestHeader` and is undefined by default.\r\n * @property {(string|undefined)} [headerValue] - This value is used to populate the XHR `setRequestHeader` and is undefined by default.\r\n * @property {(string|undefined)} [requestedWith] - This value is used to populate the XHR `setRequestHeader` and is undefined by default.\r\n * @property {(string|undefined)} [overrideMimeType] - Provide a custom mime-type to use instead of the default.\r\n * @property {boolean} [withCredentials=false] - The withCredentials property indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates. Setting withCredentials has no effect on same-site requests.\r\n */", "meta": { "filename": "XHRSettingsObject.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\typedefs", "code": {} }, "kind": "typedef", "name": "XHRSettingsObject", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "XMLHttpRequestResponseType" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequestResponseType" } }, "description": "The response type of the XHR request, i.e. `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, "defaultvalue": "''", "description": "Optional username for the XHR request.", "name": "user" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "''", "description": "Optional password for the XHR request.", "name": "password" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional XHR timeout value.", "name": "timeout" }, { "type": { "names": [ "object", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "UndefinedLiteral" } ] } }, "optional": true, "description": "This value is used to populate the XHR `setRequestHeader` and is undefined by default.", "name": "headers" }, { "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "optional": true, "description": "This value is used to populate the XHR `setRequestHeader` and is undefined by default.", "name": "header" }, { "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "optional": true, "description": "This value is used to populate the XHR `setRequestHeader` and is undefined by default.", "name": "headerValue" }, { "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "optional": true, "description": "This value is used to populate the XHR `setRequestHeader` and is undefined by default.", "name": "requestedWith" }, { "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "optional": true, "description": "Provide a custom mime-type to use instead of the default.", "name": "overrideMimeType" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "The withCredentials property indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates. Setting withCredentials has no effect on same-site requests.", "name": "withCredentials" } ], "memberof": "Phaser.Types.Loader", "longname": "Phaser.Types.Loader.XHRSettingsObject", "scope": "static", "___id": "T000002R024986", "___s": true }, { "comment": "/**\r\n * Creates a new XMLHttpRequest (xhr) object based on the given File and XHRSettings\r\n * and starts the download of it. It uses the Files own XHRSettings and merges them\r\n * with the global XHRSettings object to set the xhr values before download.\r\n *\r\n * @function Phaser.Loader.XHRLoader\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File to download.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} globalXHRSettings - The global XHRSettings object.\r\n *\r\n * @return {XMLHttpRequest} The XHR object.\r\n */", "meta": { "filename": "XHRLoader.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Creates a new XMLHttpRequest (xhr) object based on the given File and XHRSettings\rand starts the download of it. It uses the Files own XHRSettings and merges them\rwith the global XHRSettings object to set the xhr values before download.", "kind": "function", "name": "XHRLoader", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File to download.", "name": "file" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "description": "The global XHRSettings object.", "name": "globalXHRSettings" } ], "returns": [ { "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest" } }, "description": "The XHR object." } ], "memberof": "Phaser.Loader", "longname": "Phaser.Loader.XHRLoader", "scope": "static", "___id": "T000002R024988", "___s": true }, { "comment": "/**\r\n * Creates an XHRSettings Object with default values.\r\n *\r\n * @function Phaser.Loader.XHRSettings\r\n * @since 3.0.0\r\n *\r\n * @param {XMLHttpRequestResponseType} [responseType=''] - The responseType, such as 'text'.\r\n * @param {boolean} [async=true] - Should the XHR request use async or not?\r\n * @param {string} [user=''] - Optional username for the XHR request.\r\n * @param {string} [password=''] - Optional password for the XHR request.\r\n * @param {number} [timeout=0] - Optional XHR timeout value.\r\n * @param {boolean} [withCredentials=false] - Optional XHR withCredentials value.\r\n *\r\n * @return {Phaser.Types.Loader.XHRSettingsObject} The XHRSettings object as used by the Loader.\r\n */", "meta": { "filename": "XHRSettings.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Creates an XHRSettings Object with default values.", "kind": "function", "name": "XHRSettings", "since": "3.0.0", "params": [ { "type": { "names": [ "XMLHttpRequestResponseType" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequestResponseType" } }, "optional": true, "defaultvalue": "''", "description": "The responseType, such as 'text'.", "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, "defaultvalue": "''", "description": "Optional username for the XHR request.", "name": "user" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "''", "description": "Optional password for the XHR request.", "name": "password" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional XHR timeout value.", "name": "timeout" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Optional XHR withCredentials value.", "name": "withCredentials" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "description": "The XHRSettings object as used by the Loader." } ], "memberof": "Phaser.Loader", "longname": "Phaser.Loader.XHRSettings", "scope": "static", "___id": "T000002R025000", "___s": true }, { "comment": "/**\r\n * Find the angle of a segment from (x1, y1) -> (x2, y2).\r\n *\r\n * @function Phaser.Math.Angle.Between\r\n * @since 3.0.0\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 *\r\n * @return {number} The angle in radians.\r\n */", "meta": { "filename": "Between.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\angle", "code": {} }, "description": "Find the angle of a segment from (x1, y1) -> (x2, y2).", "kind": "function", "name": "Between", "since": "3.0.0", "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" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle in radians." } ], "memberof": "Phaser.Math.Angle", "longname": "Phaser.Math.Angle.Between", "scope": "static", "___id": "T000002R025020", "___s": true }, { "comment": "/**\r\n * Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).\r\n *\r\n * Calculates the angle of the vector from the first point to the second point.\r\n *\r\n * @function Phaser.Math.Angle.BetweenPoints\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} point1 - The first point.\r\n * @param {Phaser.Types.Math.Vector2Like} point2 - The second point.\r\n *\r\n * @return {number} The angle in radians.\r\n */", "meta": { "filename": "BetweenPoints.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\angle", "code": {} }, "description": "Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).\r\rCalculates the angle of the vector from the first point to the second point.", "kind": "function", "name": "BetweenPoints", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The first point.", "name": "point1" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The second point.", "name": "point2" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle in radians." } ], "memberof": "Phaser.Math.Angle", "longname": "Phaser.Math.Angle.BetweenPoints", "scope": "static", "___id": "T000002R025023", "___s": true }, { "comment": "/**\r\n * Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).\r\n *\r\n * The difference between this method and {@link Phaser.Math.Angle.BetweenPoints} is that this assumes the y coordinate\r\n * travels down the screen.\r\n *\r\n * @function Phaser.Math.Angle.BetweenPointsY\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} point1 - The first point.\r\n * @param {Phaser.Types.Math.Vector2Like} point2 - The second point.\r\n *\r\n * @return {number} The angle in radians.\r\n */", "meta": { "filename": "BetweenPointsY.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\angle", "code": {} }, "description": "Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).\r\rThe difference between this method and {@link Phaser.Math.Angle.BetweenPoints} is that this assumes the y coordinate\rtravels down the screen.", "kind": "function", "name": "BetweenPointsY", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The first point.", "name": "point1" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The second point.", "name": "point2" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle in radians." } ], "memberof": "Phaser.Math.Angle", "longname": "Phaser.Math.Angle.BetweenPointsY", "scope": "static", "___id": "T000002R025026", "___s": true }, { "comment": "/**\r\n * Find the angle of a segment from (x1, y1) -> (x2, y2).\r\n *\r\n * The difference between this method and {@link Phaser.Math.Angle.Between} is that this assumes the y coordinate\r\n * travels down the screen.\r\n *\r\n * @function Phaser.Math.Angle.BetweenY\r\n * @since 3.0.0\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 *\r\n * @return {number} The angle in radians.\r\n */", "meta": { "filename": "BetweenY.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\angle", "code": {} }, "description": "Find the angle of a segment from (x1, y1) -> (x2, y2).\r\rThe difference between this method and {@link Phaser.Math.Angle.Between} is that this assumes the y coordinate\rtravels down the screen.", "kind": "function", "name": "BetweenY", "since": "3.0.0", "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" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle in radians." } ], "memberof": "Phaser.Math.Angle", "longname": "Phaser.Math.Angle.BetweenY", "scope": "static", "___id": "T000002R025029", "___s": true }, { "comment": "/**\r\n * Takes an angle in Phasers default clockwise format and converts it so that\r\n * 0 is North, 90 is West, 180 is South and 270 is East,\r\n * therefore running counter-clockwise instead of clockwise.\r\n * \r\n * You can pass in the angle from a Game Object using:\r\n * \r\n * ```javascript\r\n * var converted = CounterClockwise(gameobject.rotation);\r\n * ```\r\n * \r\n * All values for this function are in radians.\r\n *\r\n * @function Phaser.Math.Angle.CounterClockwise\r\n * @since 3.16.0\r\n *\r\n * @param {number} angle - The angle to convert, in radians.\r\n *\r\n * @return {number} The converted angle, in radians.\r\n */", "meta": { "filename": "CounterClockwise.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\angle", "code": {} }, "description": "Takes an angle in Phasers default clockwise format and converts it so that\r0 is North, 90 is West, 180 is South and 270 is East,\rtherefore running counter-clockwise instead of clockwise.\r\rYou can pass in the angle from a Game Object using:\r\r```javascript\rvar converted = CounterClockwise(gameobject.rotation);\r```\r\rAll values for this function are in radians.", "kind": "function", "name": "CounterClockwise", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle to convert, in radians.", "name": "angle" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The converted angle, in radians." } ], "memberof": "Phaser.Math.Angle", "longname": "Phaser.Math.Angle.CounterClockwise", "scope": "static", "___id": "T000002R025033", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Angle\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\angle", "code": {} }, "kind": "namespace", "name": "Angle", "memberof": "Phaser.Math", "longname": "Phaser.Math.Angle", "scope": "static", "___id": "T000002R025037", "___s": true }, { "comment": "/**\r\n * Normalize an angle to the [0, 2pi] range.\r\n *\r\n * @function Phaser.Math.Angle.Normalize\r\n * @since 3.0.0\r\n *\r\n * @param {number} angle - The angle to normalize, in radians.\r\n *\r\n * @return {number} The normalized angle, in radians.\r\n */", "meta": { "filename": "Normalize.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\angle", "code": {} }, "description": "Normalize an angle to the [0, 2pi] range.", "kind": "function", "name": "Normalize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle to normalize, in radians.", "name": "angle" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The normalized angle, in radians." } ], "memberof": "Phaser.Math.Angle", "longname": "Phaser.Math.Angle.Normalize", "scope": "static", "___id": "T000002R025052", "___s": true }, { "comment": "/**\r\n * Returns a random angle in the range [-pi, pi].\r\n *\r\n * @function Phaser.Math.Angle.Random\r\n * @since 3.23.0\r\n *\r\n * @return {number} The angle, in radians.\r\n */", "meta": { "filename": "Random.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\angle", "code": {} }, "description": "Returns a random angle in the range [-pi, pi].", "kind": "function", "name": "Random", "since": "3.23.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle, in radians." } ], "memberof": "Phaser.Math.Angle", "longname": "Phaser.Math.Angle.Random", "scope": "static", "___id": "T000002R025057", "___s": true }, { "comment": "/**\r\n * Returns a random angle in the range [-180, 180].\r\n *\r\n * @function Phaser.Math.Angle.RandomDegrees\r\n * @since 3.23.0\r\n *\r\n * @return {number} The angle, in degrees.\r\n */", "meta": { "filename": "RandomDegrees.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\angle", "code": {} }, "description": "Returns a random angle in the range [-180, 180].", "kind": "function", "name": "RandomDegrees", "since": "3.23.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle, in degrees." } ], "memberof": "Phaser.Math.Angle", "longname": "Phaser.Math.Angle.RandomDegrees", "scope": "static", "___id": "T000002R025061", "___s": true }, { "comment": "/**\r\n * Reverse the given angle.\r\n *\r\n * @function Phaser.Math.Angle.Reverse\r\n * @since 3.0.0\r\n *\r\n * @param {number} angle - The angle to reverse, in radians.\r\n *\r\n * @return {number} The reversed angle, in radians.\r\n */", "meta": { "filename": "Reverse.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\angle", "code": {} }, "description": "Reverse the given angle.", "kind": "function", "name": "Reverse", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle to reverse, in radians.", "name": "angle" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The reversed angle, in radians." } ], "memberof": "Phaser.Math.Angle", "longname": "Phaser.Math.Angle.Reverse", "scope": "static", "___id": "T000002R025065", "___s": true }, { "comment": "/**\r\n * Rotates `currentAngle` towards `targetAngle`, taking the shortest rotation distance. The `lerp` argument is the amount to rotate by in this call.\r\n *\r\n * @function Phaser.Math.Angle.RotateTo\r\n * @since 3.0.0\r\n *\r\n * @param {number} currentAngle - The current angle, in radians.\r\n * @param {number} targetAngle - The target angle to rotate to, in radians.\r\n * @param {number} [lerp=0.05] - The lerp value to add to the current angle.\r\n *\r\n * @return {number} The adjusted angle.\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\angle", "code": {} }, "description": "Rotates `currentAngle` towards `targetAngle`, taking the shortest rotation distance. The `lerp` argument is the amount to rotate by in this call.", "kind": "function", "name": "RotateTo", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current angle, in radians.", "name": "currentAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The target angle to rotate to, in radians.", "name": "targetAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.05, "description": "The lerp value to add to the current angle.", "name": "lerp" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The adjusted angle." } ], "memberof": "Phaser.Math.Angle", "longname": "Phaser.Math.Angle.RotateTo", "scope": "static", "___id": "T000002R025069", "___s": true }, { "comment": "/**\r\n * Gets the shortest angle between `angle1` and `angle2`.\r\n *\r\n * Both angles must be in the range -180 to 180, which is the same clamped\r\n * range that `sprite.angle` uses, so you can pass in two sprite angles to\r\n * this method and get the shortest angle back between the two of them.\r\n *\r\n * The angle returned will be in the same range. If the returned angle is\r\n * greater than 0 then it's a counter-clockwise rotation, if < 0 then it's\r\n * a clockwise rotation.\r\n *\r\n * @function Phaser.Math.Angle.ShortestBetween\r\n * @since 3.0.0\r\n *\r\n * @param {number} angle1 - The first angle in the range -180 to 180.\r\n * @param {number} angle2 - The second angle in the range -180 to 180.\r\n *\r\n * @return {number} The shortest angle, in degrees. If greater than zero it's a counter-clockwise rotation.\r\n */", "meta": { "filename": "ShortestBetween.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\angle", "code": {} }, "description": "Gets the shortest angle between `angle1` and `angle2`.\r\rBoth angles must be in the range -180 to 180, which is the same clamped\rrange that `sprite.angle` uses, so you can pass in two sprite angles to\rthis method and get the shortest angle back between the two of them.\r\rThe angle returned will be in the same range. If the returned angle is\rgreater than 0 then it's a counter-clockwise rotation, if < 0 then it's\ra clockwise rotation.", "kind": "function", "name": "ShortestBetween", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The first angle in the range -180 to 180.", "name": "angle1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The second angle in the range -180 to 180.", "name": "angle2" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The shortest angle, in degrees. If greater than zero it's a counter-clockwise rotation." } ], "memberof": "Phaser.Math.Angle", "longname": "Phaser.Math.Angle.ShortestBetween", "scope": "static", "___id": "T000002R025078", "___s": true }, { "comment": "/**\r\n * Wrap an angle.\r\n *\r\n * Wraps the angle to a value in the range of -PI to PI.\r\n *\r\n * @function Phaser.Math.Angle.Wrap\r\n * @since 3.0.0\r\n *\r\n * @param {number} angle - The angle to wrap, in radians.\r\n *\r\n * @return {number} The wrapped angle, in radians.\r\n */", "meta": { "filename": "Wrap.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\angle", "code": {} }, "description": "Wrap an angle.\r\rWraps the angle to a value in the range of -PI to PI.", "kind": "function", "name": "Wrap", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle to wrap, in radians.", "name": "angle" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The wrapped angle, in radians." } ], "memberof": "Phaser.Math.Angle", "longname": "Phaser.Math.Angle.Wrap", "scope": "static", "___id": "T000002R025084", "___s": true }, { "comment": "/**\r\n * Wrap an angle in degrees.\r\n *\r\n * Wraps the angle to a value in the range of -180 to 180.\r\n *\r\n * @function Phaser.Math.Angle.WrapDegrees\r\n * @since 3.0.0\r\n *\r\n * @param {number} angle - The angle to wrap, in degrees.\r\n *\r\n * @return {number} The wrapped angle, in degrees.\r\n */", "meta": { "filename": "WrapDegrees.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\angle", "code": {} }, "description": "Wrap an angle in degrees.\r\rWraps the angle to a value in the range of -180 to 180.", "kind": "function", "name": "WrapDegrees", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle to wrap, in degrees.", "name": "angle" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The wrapped angle, in degrees." } ], "memberof": "Phaser.Math.Angle", "longname": "Phaser.Math.Angle.WrapDegrees", "scope": "static", "___id": "T000002R025088", "___s": true }, { "comment": "/**\r\n * Calculate the mean average of the given values.\r\n *\r\n * @function Phaser.Math.Average\r\n * @since 3.0.0\r\n *\r\n * @param {number[]} values - The values to average.\r\n *\r\n * @return {number} The average value.\r\n */", "meta": { "filename": "Average.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the mean average of the given values.", "kind": "function", "name": "Average", "since": "3.0.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The values to average.", "name": "values" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The average value." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.Average", "scope": "static", "___id": "T000002R025091", "___s": true }, { "comment": "/**\r\n * Calculates the Bernstein basis from the three factorial coefficients.\r\n *\r\n * @function Phaser.Math.Bernstein\r\n * @since 3.0.0\r\n *\r\n * @param {number} n - The first value.\r\n * @param {number} i - The second value.\r\n *\r\n * @return {number} The Bernstein basis of Factorial(n) / Factorial(i) / Factorial(n - i)\r\n */", "meta": { "filename": "Bernstein.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculates the Bernstein basis from the three factorial coefficients.", "kind": "function", "name": "Bernstein", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The first value.", "name": "n" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The second value.", "name": "i" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Bernstein basis of Factorial(n) / Factorial(i) / Factorial(n - i)" } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.Bernstein", "scope": "static", "___id": "T000002R025098", "___s": true }, { "comment": "/**\r\n * Compute a random integer between the `min` and `max` values, inclusive.\r\n *\r\n * @function Phaser.Math.Between\r\n * @since 3.0.0\r\n *\r\n * @param {number} min - The minimum value.\r\n * @param {number} max - The maximum value.\r\n *\r\n * @return {number} The random integer.\r\n */", "meta": { "filename": "Between.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Compute a random integer between the `min` and `max` values, inclusive.", "kind": "function", "name": "Between", "since": "3.0.0", "params": [ { "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" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The random integer." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.Between", "scope": "static", "___id": "T000002R025101", "___s": true }, { "comment": "/**\r\n * Calculates a Catmull-Rom value from the given points, based on an alpha of 0.5.\r\n *\r\n * @function Phaser.Math.CatmullRom\r\n * @since 3.0.0\r\n *\r\n * @param {number} t - The amount to interpolate by.\r\n * @param {number} p0 - The first control point.\r\n * @param {number} p1 - The second control point.\r\n * @param {number} p2 - The third control point.\r\n * @param {number} p3 - The fourth control point.\r\n *\r\n * @return {number} The Catmull-Rom value.\r\n */", "meta": { "filename": "CatmullRom.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculates a Catmull-Rom value from the given points, based on an alpha of 0.5.", "kind": "function", "name": "CatmullRom", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to interpolate by.", "name": "t" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The first control point.", "name": "p0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The second control point.", "name": "p1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The third control point.", "name": "p2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The fourth control point.", "name": "p3" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Catmull-Rom value." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.CatmullRom", "scope": "static", "___id": "T000002R025104", "___s": true }, { "comment": "/**\r\n * Ceils to some place comparative to a `base`, default is 10 for decimal place.\r\n *\r\n * The `place` is represented by the power applied to `base` to get that place.\r\n *\r\n * @function Phaser.Math.CeilTo\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value to round.\r\n * @param {number} [place=0] - The place to round to.\r\n * @param {number} [base=10] - The base to round in. Default is 10 for decimal.\r\n *\r\n * @return {number} The rounded value.\r\n */", "meta": { "filename": "CeilTo.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Ceils to some place comparative to a `base`, default is 10 for decimal place.\r\rThe `place` is represented by the power applied to `base` to get that place.", "kind": "function", "name": "CeilTo", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to round.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The place to round to.", "name": "place" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The base to round in. Default is 10 for decimal.", "name": "base" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rounded value." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.CeilTo", "scope": "static", "___id": "T000002R025111", "___s": true }, { "comment": "/**\r\n * Force a value within the boundaries by clamping it to the range `min`, `max`.\r\n *\r\n * @function Phaser.Math.Clamp\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value to be clamped.\r\n * @param {number} min - The minimum bounds.\r\n * @param {number} max - The maximum bounds.\r\n *\r\n * @return {number} The clamped value.\r\n */", "meta": { "filename": "Clamp.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Force a value within the boundaries by clamping it to the range `min`, `max`.", "kind": "function", "name": "Clamp", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be clamped.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum bounds.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum bounds.", "name": "max" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The clamped value." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.Clamp", "scope": "static", "___id": "T000002R025117", "___s": true }, { "comment": "/**\r\n * The value of PI * 2.\r\n *\r\n * @name Phaser.Math.PI2\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\\math", "code": {} }, "description": "The value of PI * 2.", "name": "PI2", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Math", "longname": "Phaser.Math.PI2", "scope": "static", "kind": "member", "___id": "T000002R025121", "___s": true }, { "comment": "/**\r\n * The value of PI * 0.5.\r\n *\r\n * Yes, we understand that this should actually be PI * 2, but\r\n * it has been like this for so long we can't change it now.\r\n * If you need PI * 2, use the PI2 constant instead.\r\n *\r\n * @name Phaser.Math.TAU\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\\math", "code": {} }, "description": "The value of PI * 0.5.\r\rYes, we understand that this should actually be PI * 2, but\rit has been like this for so long we can't change it now.\rIf you need PI * 2, use the PI2 constant instead.", "name": "TAU", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Math", "longname": "Phaser.Math.TAU", "scope": "static", "kind": "member", "___id": "T000002R025123", "___s": true }, { "comment": "/**\r\n * An epsilon value (1.0e-6)\r\n *\r\n * @name Phaser.Math.EPSILON\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "An epsilon value (1.0e-6)", "name": "EPSILON", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Math", "longname": "Phaser.Math.EPSILON", "scope": "static", "kind": "member", "___id": "T000002R025125", "___s": true }, { "comment": "/**\r\n * For converting degrees to radians (PI / 180)\r\n *\r\n * @name Phaser.Math.DEG_TO_RAD\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "For converting degrees to radians (PI / 180)", "name": "DEG_TO_RAD", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Math", "longname": "Phaser.Math.DEG_TO_RAD", "scope": "static", "kind": "member", "___id": "T000002R025127", "___s": true }, { "comment": "/**\r\n * For converting radians to degrees (180 / PI)\r\n *\r\n * @name Phaser.Math.RAD_TO_DEG\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "For converting radians to degrees (180 / PI)", "name": "RAD_TO_DEG", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Math", "longname": "Phaser.Math.RAD_TO_DEG", "scope": "static", "kind": "member", "___id": "T000002R025129", "___s": true }, { "comment": "/**\r\n * An instance of the Random Number Generator.\r\n * This is not set until the Game boots.\r\n *\r\n * @name Phaser.Math.RND\r\n * @type {Phaser.Math.RandomDataGenerator}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 58, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "An instance of the Random Number Generator.\rThis is not set until the Game boots.", "name": "RND", "type": { "names": [ "Phaser.Math.RandomDataGenerator" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.RandomDataGenerator" } }, "since": "3.0.0", "memberof": "Phaser.Math", "longname": "Phaser.Math.RND", "scope": "static", "kind": "member", "___id": "T000002R025131", "___s": true }, { "comment": "/**\r\n * The minimum safe integer this browser supports.\r\n * We use a const for backward compatibility with Internet Explorer.\r\n *\r\n * @name Phaser.Math.MIN_SAFE_INTEGER\r\n * @type {number}\r\n * @since 3.21.0\r\n */", "meta": { "filename": "const.js", "lineno": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The minimum safe integer this browser supports.\rWe use a const for backward compatibility with Internet Explorer.", "name": "MIN_SAFE_INTEGER", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.21.0", "memberof": "Phaser.Math", "longname": "Phaser.Math.MIN_SAFE_INTEGER", "scope": "static", "kind": "member", "___id": "T000002R025133", "___s": true }, { "comment": "/**\r\n * The maximum safe integer this browser supports.\r\n * We use a const for backward compatibility with Internet Explorer.\r\n *\r\n * @name Phaser.Math.MAX_SAFE_INTEGER\r\n * @type {number}\r\n * @since 3.21.0\r\n */", "meta": { "filename": "const.js", "lineno": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The maximum safe integer this browser supports.\rWe use a const for backward compatibility with Internet Explorer.", "name": "MAX_SAFE_INTEGER", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.21.0", "memberof": "Phaser.Math", "longname": "Phaser.Math.MAX_SAFE_INTEGER", "scope": "static", "kind": "member", "___id": "T000002R025135", "___s": true }, { "comment": "/**\r\n * Convert the given angle from degrees, to the equivalent angle in radians.\r\n *\r\n * @function Phaser.Math.DegToRad\r\n * @since 3.0.0\r\n *\r\n * @param {number} degrees - The angle (in degrees) to convert to radians.\r\n *\r\n * @return {number} The given angle converted to radians.\r\n */", "meta": { "filename": "DegToRad.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Convert the given angle from degrees, to the equivalent angle in radians.", "kind": "function", "name": "DegToRad", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle (in degrees) to convert to radians.", "name": "degrees" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The given angle converted to radians." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.DegToRad", "scope": "static", "___id": "T000002R025139", "___s": true }, { "comment": "/**\r\n * Calculates the positive difference of two given numbers.\r\n *\r\n * @function Phaser.Math.Difference\r\n * @since 3.0.0\r\n *\r\n * @param {number} a - The first number in the calculation.\r\n * @param {number} b - The second number in the calculation.\r\n *\r\n * @return {number} The positive difference of the two given numbers.\r\n */", "meta": { "filename": "Difference.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculates the positive difference of two given numbers.", "kind": "function", "name": "Difference", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The first number in the calculation.", "name": "a" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The second number in the calculation.", "name": "b" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The positive difference of the two given numbers." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.Difference", "scope": "static", "___id": "T000002R025142", "___s": true }, { "comment": "/**\r\n * Calculate the distance between two sets of coordinates (points).\r\n *\r\n * @function Phaser.Math.Distance.Between\r\n * @since 3.0.0\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 *\r\n * @return {number} The distance between each point.\r\n */", "meta": { "filename": "DistanceBetween.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\distance", "code": {} }, "description": "Calculate the distance between two sets of coordinates (points).", "kind": "function", "name": "Between", "since": "3.0.0", "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" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance between each point." } ], "memberof": "Phaser.Math.Distance", "longname": "Phaser.Math.Distance.Between", "scope": "static", "___id": "T000002R025145", "___s": true }, { "comment": "/**\r\n * Calculate the distance between two points.\r\n *\r\n * @function Phaser.Math.Distance.BetweenPoints\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} a - The first point.\r\n * @param {Phaser.Types.Math.Vector2Like} b - The second point.\r\n *\r\n * @return {number} The distance between the points.\r\n */", "meta": { "filename": "DistanceBetweenPoints.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\distance", "code": {} }, "description": "Calculate the distance between two points.", "kind": "function", "name": "BetweenPoints", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The first point.", "name": "a" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The second point.", "name": "b" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance between the points." } ], "memberof": "Phaser.Math.Distance", "longname": "Phaser.Math.Distance.BetweenPoints", "scope": "static", "___id": "T000002R025150", "___s": true }, { "comment": "/**\r\n * Calculate the squared distance between two points.\r\n *\r\n * @function Phaser.Math.Distance.BetweenPointsSquared\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} a - The first point.\r\n * @param {Phaser.Types.Math.Vector2Like} b - The second point.\r\n *\r\n * @return {number} The squared distance between the points.\r\n */", "meta": { "filename": "DistanceBetweenPointsSquared.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\distance", "code": {} }, "description": "Calculate the squared distance between two points.", "kind": "function", "name": "BetweenPointsSquared", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The first point.", "name": "a" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The second point.", "name": "b" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The squared distance between the points." } ], "memberof": "Phaser.Math.Distance", "longname": "Phaser.Math.Distance.BetweenPointsSquared", "scope": "static", "___id": "T000002R025155", "___s": true }, { "comment": "/**\r\n * Calculate the Chebyshev distance between two sets of coordinates (points).\r\n *\r\n * Chebyshev distance (or chessboard distance) is the maximum of the horizontal and vertical distances.\r\n * It's the effective distance when movement can be horizontal, vertical, or diagonal.\r\n *\r\n * @function Phaser.Math.Distance.Chebyshev\r\n * @since 3.22.0\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 *\r\n * @return {number} The distance between each point.\r\n */", "meta": { "filename": "DistanceChebyshev.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\distance", "code": {} }, "description": "Calculate the Chebyshev distance between two sets of coordinates (points).\r\rChebyshev distance (or chessboard distance) is the maximum of the horizontal and vertical distances.\rIt's the effective distance when movement can be horizontal, vertical, or diagonal.", "kind": "function", "name": "Chebyshev", "since": "3.22.0", "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" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance between each point." } ], "memberof": "Phaser.Math.Distance", "longname": "Phaser.Math.Distance.Chebyshev", "scope": "static", "___id": "T000002R025160", "___s": true }, { "comment": "/**\r\n * Calculate the distance between two sets of coordinates (points) to the power of `pow`.\r\n *\r\n * @function Phaser.Math.Distance.Power\r\n * @since 3.0.0\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 {number} pow - The exponent.\r\n *\r\n * @return {number} The distance between each point.\r\n */", "meta": { "filename": "DistancePower.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\distance", "code": {} }, "description": "Calculate the distance between two sets of coordinates (points) to the power of `pow`.", "kind": "function", "name": "Power", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The exponent.", "name": "pow" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance between each point." } ], "memberof": "Phaser.Math.Distance", "longname": "Phaser.Math.Distance.Power", "scope": "static", "___id": "T000002R025163", "___s": true }, { "comment": "/**\r\n * Calculate the snake distance between two sets of coordinates (points).\r\n *\r\n * Snake distance (rectilinear distance, Manhattan distance) is the sum of the horizontal and vertical distances.\r\n * It's the effective distance when movement is allowed only horizontally or vertically (but not both).\r\n *\r\n * @function Phaser.Math.Distance.Snake\r\n * @since 3.22.0\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 *\r\n * @return {number} The distance between each point.\r\n */", "meta": { "filename": "DistanceSnake.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\distance", "code": {} }, "description": "Calculate the snake distance between two sets of coordinates (points).\r\rSnake distance (rectilinear distance, Manhattan distance) is the sum of the horizontal and vertical distances.\rIt's the effective distance when movement is allowed only horizontally or vertically (but not both).", "kind": "function", "name": "Snake", "since": "3.22.0", "params": [ { "type": { "names": [ "number" ], "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" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance between each point." } ], "memberof": "Phaser.Math.Distance", "longname": "Phaser.Math.Distance.Snake", "scope": "static", "___id": "T000002R025167", "___s": true }, { "comment": "/**\r\n * Calculate the distance between two sets of coordinates (points), squared.\r\n *\r\n * @function Phaser.Math.Distance.Squared\r\n * @since 3.0.0\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 *\r\n * @return {number} The distance between each point, squared.\r\n */", "meta": { "filename": "DistanceSquared.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\distance", "code": {} }, "description": "Calculate the distance between two sets of coordinates (points), squared.", "kind": "function", "name": "Squared", "since": "3.0.0", "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" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance between each point, squared." } ], "memberof": "Phaser.Math.Distance", "longname": "Phaser.Math.Distance.Squared", "scope": "static", "___id": "T000002R025170", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Distance\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\distance", "code": {} }, "kind": "namespace", "name": "Distance", "memberof": "Phaser.Math", "longname": "Phaser.Math.Distance", "scope": "static", "___id": "T000002R025175", "___s": true }, { "comment": "/**\r\n * Back ease-in.\r\n *\r\n * @function Phaser.Math.Easing.Back.In\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n * @param {number} [overshoot=1.70158] - The overshoot amount.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "In.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\back", "code": {} }, "description": "Back ease-in.", "kind": "function", "name": "In", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1.70158, "description": "The overshoot amount.", "name": "overshoot" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Back", "longname": "Phaser.Math.Easing.Back.In", "scope": "static", "___id": "T000002R025184", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Easing.Back\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\back", "code": {} }, "kind": "namespace", "name": "Back", "memberof": "Phaser.Math.Easing", "longname": "Phaser.Math.Easing.Back", "scope": "static", "___id": "T000002R025188", "___s": true }, { "comment": "/**\r\n * Back ease-in/out.\r\n *\r\n * @function Phaser.Math.Easing.Back.InOut\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n * @param {number} [overshoot=1.70158] - The overshoot amount.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "InOut.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\back", "code": {} }, "description": "Back ease-in/out.", "kind": "function", "name": "InOut", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1.70158, "description": "The overshoot amount.", "name": "overshoot" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Back", "longname": "Phaser.Math.Easing.Back.InOut", "scope": "static", "___id": "T000002R025193", "___s": true }, { "comment": "/**\r\n * Back ease-out.\r\n *\r\n * @function Phaser.Math.Easing.Back.Out\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n * @param {number} [overshoot=1.70158] - The overshoot amount.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "Out.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\back", "code": {} }, "description": "Back ease-out.", "kind": "function", "name": "Out", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1.70158, "description": "The overshoot amount.", "name": "overshoot" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Back", "longname": "Phaser.Math.Easing.Back.Out", "scope": "static", "___id": "T000002R025200", "___s": true }, { "comment": "/**\r\n * Bounce ease-in.\r\n *\r\n * @function Phaser.Math.Easing.Bounce.In\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "In.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\bounce", "code": {} }, "description": "Bounce ease-in.", "kind": "function", "name": "In", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Bounce", "longname": "Phaser.Math.Easing.Bounce.In", "scope": "static", "___id": "T000002R025204", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Easing.Bounce\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\bounce", "code": {} }, "kind": "namespace", "name": "Bounce", "memberof": "Phaser.Math.Easing", "longname": "Phaser.Math.Easing.Bounce", "scope": "static", "___id": "T000002R025211", "___s": true }, { "comment": "/**\r\n * Bounce ease-in/out.\r\n *\r\n * @function Phaser.Math.Easing.Bounce.InOut\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "InOut.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\bounce", "code": {} }, "description": "Bounce ease-in/out.", "kind": "function", "name": "InOut", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Bounce", "longname": "Phaser.Math.Easing.Bounce.InOut", "scope": "static", "___id": "T000002R025216", "___s": true }, { "comment": "/**\r\n * Bounce ease-out.\r\n *\r\n * @function Phaser.Math.Easing.Bounce.Out\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "Out.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\bounce", "code": {} }, "description": "Bounce ease-out.", "kind": "function", "name": "Out", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Bounce", "longname": "Phaser.Math.Easing.Bounce.Out", "scope": "static", "___id": "T000002R025230", "___s": true }, { "comment": "/**\r\n * Circular ease-in.\r\n *\r\n * @function Phaser.Math.Easing.Circular.In\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "In.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\circular", "code": {} }, "description": "Circular ease-in.", "kind": "function", "name": "In", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Circular", "longname": "Phaser.Math.Easing.Circular.In", "scope": "static", "___id": "T000002R025236", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Easing.Circular\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\circular", "code": {} }, "kind": "namespace", "name": "Circular", "memberof": "Phaser.Math.Easing", "longname": "Phaser.Math.Easing.Circular", "scope": "static", "___id": "T000002R025239", "___s": true }, { "comment": "/**\r\n * Circular ease-in/out.\r\n *\r\n * @function Phaser.Math.Easing.Circular.InOut\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "InOut.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\circular", "code": {} }, "description": "Circular ease-in/out.", "kind": "function", "name": "InOut", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Circular", "longname": "Phaser.Math.Easing.Circular.InOut", "scope": "static", "___id": "T000002R025244", "___s": true }, { "comment": "/**\r\n * Circular ease-out.\r\n *\r\n * @function Phaser.Math.Easing.Circular.Out\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "Out.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\circular", "code": {} }, "description": "Circular ease-out.", "kind": "function", "name": "Out", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Circular", "longname": "Phaser.Math.Easing.Circular.Out", "scope": "static", "___id": "T000002R025249", "___s": true }, { "comment": "/**\r\n * Cubic ease-in.\r\n *\r\n * @function Phaser.Math.Easing.Cubic.In\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "In.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\cubic", "code": {} }, "description": "Cubic ease-in.", "kind": "function", "name": "In", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Cubic", "longname": "Phaser.Math.Easing.Cubic.In", "scope": "static", "___id": "T000002R025252", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Easing.Cubic\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\cubic", "code": {} }, "kind": "namespace", "name": "Cubic", "memberof": "Phaser.Math.Easing", "longname": "Phaser.Math.Easing.Cubic", "scope": "static", "___id": "T000002R025255", "___s": true }, { "comment": "/**\r\n * Cubic ease-in/out.\r\n *\r\n * @function Phaser.Math.Easing.Cubic.InOut\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "InOut.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\cubic", "code": {} }, "description": "Cubic ease-in/out.", "kind": "function", "name": "InOut", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Cubic", "longname": "Phaser.Math.Easing.Cubic.InOut", "scope": "static", "___id": "T000002R025260", "___s": true }, { "comment": "/**\r\n * Cubic ease-out.\r\n *\r\n * @function Phaser.Math.Easing.Cubic.Out\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "Out.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\cubic", "code": {} }, "description": "Cubic ease-out.", "kind": "function", "name": "Out", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Cubic", "longname": "Phaser.Math.Easing.Cubic.Out", "scope": "static", "___id": "T000002R025265", "___s": true }, { "comment": "/**\r\n * Elastic ease-in.\r\n *\r\n * @function Phaser.Math.Easing.Elastic.In\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n * @param {number} [amplitude=0.1] - The amplitude of the elastic ease.\r\n * @param {number} [period=0.1] - Sets how tight the sine-wave is, where smaller values are tighter waves, which result in more cycles.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "In.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\elastic", "code": {} }, "description": "Elastic ease-in.", "kind": "function", "name": "In", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.1, "description": "The amplitude of the elastic ease.", "name": "amplitude" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.1, "description": "Sets how tight the sine-wave is, where smaller values are tighter waves, which result in more cycles.", "name": "period" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Elastic", "longname": "Phaser.Math.Easing.Elastic.In", "scope": "static", "___id": "T000002R025328", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Easing.Elastic\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\elastic", "code": {} }, "kind": "namespace", "name": "Elastic", "memberof": "Phaser.Math.Easing", "longname": "Phaser.Math.Easing.Elastic", "scope": "static", "___id": "T000002R025337", "___s": true }, { "comment": "/**\r\n * Elastic ease-in/out.\r\n *\r\n * @function Phaser.Math.Easing.Elastic.InOut\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n * @param {number} [amplitude=0.1] - The amplitude of the elastic ease.\r\n * @param {number} [period=0.1] - Sets how tight the sine-wave is, where smaller values are tighter waves, which result in more cycles.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "InOut.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\elastic", "code": {} }, "description": "Elastic ease-in/out.", "kind": "function", "name": "InOut", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.1, "description": "The amplitude of the elastic ease.", "name": "amplitude" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.1, "description": "Sets how tight the sine-wave is, where smaller values are tighter waves, which result in more cycles.", "name": "period" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Elastic", "longname": "Phaser.Math.Easing.Elastic.InOut", "scope": "static", "___id": "T000002R025342", "___s": true }, { "comment": "/**\r\n * Elastic ease-out.\r\n *\r\n * @function Phaser.Math.Easing.Elastic.Out\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n * @param {number} [amplitude=0.1] - The amplitude of the elastic ease.\r\n * @param {number} [period=0.1] - Sets how tight the sine-wave is, where smaller values are tighter waves, which result in more cycles.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "Out.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\elastic", "code": {} }, "description": "Elastic ease-out.", "kind": "function", "name": "Out", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.1, "description": "The amplitude of the elastic ease.", "name": "amplitude" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.1, "description": "Sets how tight the sine-wave is, where smaller values are tighter waves, which result in more cycles.", "name": "period" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Elastic", "longname": "Phaser.Math.Easing.Elastic.Out", "scope": "static", "___id": "T000002R025353", "___s": true }, { "comment": "/**\r\n * Exponential ease-in.\r\n *\r\n * @function Phaser.Math.Easing.Expo.In\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "In.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\expo", "code": {} }, "description": "Exponential ease-in.", "kind": "function", "name": "In", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Expo", "longname": "Phaser.Math.Easing.Expo.In", "scope": "static", "___id": "T000002R025361", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Easing.Expo\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\expo", "code": {} }, "kind": "namespace", "name": "Expo", "memberof": "Phaser.Math.Easing", "longname": "Phaser.Math.Easing.Expo", "scope": "static", "___id": "T000002R025364", "___s": true }, { "comment": "/**\r\n * Exponential ease-in/out.\r\n *\r\n * @function Phaser.Math.Easing.Expo.InOut\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "InOut.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\expo", "code": {} }, "description": "Exponential ease-in/out.", "kind": "function", "name": "InOut", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Expo", "longname": "Phaser.Math.Easing.Expo.InOut", "scope": "static", "___id": "T000002R025369", "___s": true }, { "comment": "/**\r\n * Exponential ease-out.\r\n *\r\n * @function Phaser.Math.Easing.Expo.Out\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "Out.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\expo", "code": {} }, "description": "Exponential ease-out.", "kind": "function", "name": "Out", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Expo", "longname": "Phaser.Math.Easing.Expo.Out", "scope": "static", "___id": "T000002R025373", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Easing\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing", "code": {} }, "kind": "namespace", "name": "Easing", "memberof": "Phaser.Math", "longname": "Phaser.Math.Easing", "scope": "static", "___id": "T000002R025376", "___s": true }, { "comment": "/**\r\n * Linear easing (no variation).\r\n *\r\n * @function Phaser.Math.Easing.Linear\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "Linear.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\linear", "code": {} }, "description": "Linear easing (no variation).", "kind": "function", "name": "Linear", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing", "longname": "Phaser.Math.Easing.Linear", "scope": "static", "___id": "T000002R025391", "___s": true }, { "comment": "/**\r\n * Quadratic ease-in.\r\n *\r\n * @function Phaser.Math.Easing.Quadratic.In\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "In.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\quadratic", "code": {} }, "description": "Quadratic ease-in.", "kind": "function", "name": "In", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Quadratic", "longname": "Phaser.Math.Easing.Quadratic.In", "scope": "static", "___id": "T000002R025394", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Easing.Quadratic\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\quadratic", "code": {} }, "kind": "namespace", "name": "Quadratic", "memberof": "Phaser.Math.Easing", "longname": "Phaser.Math.Easing.Quadratic", "scope": "static", "___id": "T000002R025397", "___s": true }, { "comment": "/**\r\n * Quadratic ease-in/out.\r\n *\r\n * @function Phaser.Math.Easing.Quadratic.InOut\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "InOut.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\quadratic", "code": {} }, "description": "Quadratic ease-in/out.", "kind": "function", "name": "InOut", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Quadratic", "longname": "Phaser.Math.Easing.Quadratic.InOut", "scope": "static", "___id": "T000002R025402", "___s": true }, { "comment": "/**\r\n * Quadratic ease-out.\r\n *\r\n * @function Phaser.Math.Easing.Quadratic.Out\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "Out.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\quadratic", "code": {} }, "description": "Quadratic ease-out.", "kind": "function", "name": "Out", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Quadratic", "longname": "Phaser.Math.Easing.Quadratic.Out", "scope": "static", "___id": "T000002R025406", "___s": true }, { "comment": "/**\r\n * Quartic ease-in.\r\n *\r\n * @function Phaser.Math.Easing.Quartic.In\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "In.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\quartic", "code": {} }, "description": "Quartic ease-in.", "kind": "function", "name": "In", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Quartic", "longname": "Phaser.Math.Easing.Quartic.In", "scope": "static", "___id": "T000002R025409", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Easing.Quartic\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\quartic", "code": {} }, "kind": "namespace", "name": "Quartic", "memberof": "Phaser.Math.Easing", "longname": "Phaser.Math.Easing.Quartic", "scope": "static", "___id": "T000002R025412", "___s": true }, { "comment": "/**\r\n * Quartic ease-in/out.\r\n *\r\n * @function Phaser.Math.Easing.Quartic.InOut\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "InOut.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\quartic", "code": {} }, "description": "Quartic ease-in/out.", "kind": "function", "name": "InOut", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Quartic", "longname": "Phaser.Math.Easing.Quartic.InOut", "scope": "static", "___id": "T000002R025417", "___s": true }, { "comment": "/**\r\n * Quartic ease-out.\r\n *\r\n * @function Phaser.Math.Easing.Quartic.Out\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "Out.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\quartic", "code": {} }, "description": "Quartic ease-out.", "kind": "function", "name": "Out", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Quartic", "longname": "Phaser.Math.Easing.Quartic.Out", "scope": "static", "___id": "T000002R025422", "___s": true }, { "comment": "/**\r\n * Quintic ease-in.\r\n *\r\n * @function Phaser.Math.Easing.Quintic.In\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "In.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\quintic", "code": {} }, "description": "Quintic ease-in.", "kind": "function", "name": "In", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Quintic", "longname": "Phaser.Math.Easing.Quintic.In", "scope": "static", "___id": "T000002R025425", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Easing.Quintic\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\quintic", "code": {} }, "kind": "namespace", "name": "Quintic", "memberof": "Phaser.Math.Easing", "longname": "Phaser.Math.Easing.Quintic", "scope": "static", "___id": "T000002R025428", "___s": true }, { "comment": "/**\r\n * Quintic ease-in/out.\r\n *\r\n * @function Phaser.Math.Easing.Quintic.InOut\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "InOut.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\quintic", "code": {} }, "description": "Quintic ease-in/out.", "kind": "function", "name": "InOut", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Quintic", "longname": "Phaser.Math.Easing.Quintic.InOut", "scope": "static", "___id": "T000002R025433", "___s": true }, { "comment": "/**\r\n * Quintic ease-out.\r\n *\r\n * @function Phaser.Math.Easing.Quintic.Out\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "Out.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\quintic", "code": {} }, "description": "Quintic ease-out.", "kind": "function", "name": "Out", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Quintic", "longname": "Phaser.Math.Easing.Quintic.Out", "scope": "static", "___id": "T000002R025438", "___s": true }, { "comment": "/**\r\n * Sinusoidal ease-in.\r\n *\r\n * @function Phaser.Math.Easing.Sine.In\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "In.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\sine", "code": {} }, "description": "Sinusoidal ease-in.", "kind": "function", "name": "In", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Sine", "longname": "Phaser.Math.Easing.Sine.In", "scope": "static", "___id": "T000002R025441", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Easing.Sine\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\sine", "code": {} }, "kind": "namespace", "name": "Sine", "memberof": "Phaser.Math.Easing", "longname": "Phaser.Math.Easing.Sine", "scope": "static", "___id": "T000002R025444", "___s": true }, { "comment": "/**\r\n * Sinusoidal ease-in/out.\r\n *\r\n * @function Phaser.Math.Easing.Sine.InOut\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "InOut.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\sine", "code": {} }, "description": "Sinusoidal ease-in/out.", "kind": "function", "name": "InOut", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Sine", "longname": "Phaser.Math.Easing.Sine.InOut", "scope": "static", "___id": "T000002R025449", "___s": true }, { "comment": "/**\r\n * Sinusoidal ease-out.\r\n *\r\n * @function Phaser.Math.Easing.Sine.Out\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "Out.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\sine", "code": {} }, "description": "Sinusoidal ease-out.", "kind": "function", "name": "Out", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing.Sine", "longname": "Phaser.Math.Easing.Sine.Out", "scope": "static", "___id": "T000002R025452", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Easing.Stepped\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\stepped", "code": {} }, "kind": "namespace", "name": "Stepped", "memberof": "Phaser.Math.Easing", "longname": "Phaser.Math.Easing.Stepped", "scope": "static", "___id": "T000002R025455", "___s": true }, { "comment": "/**\r\n * Stepped easing.\r\n *\r\n * @function Phaser.Math.Easing.Stepped\r\n * @since 3.0.0\r\n *\r\n * @param {number} v - The value to be tweened.\r\n * @param {number} [steps=1] - The number of steps in the ease.\r\n *\r\n * @return {number} The tweened value.\r\n */", "meta": { "filename": "Stepped.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\easing\\stepped", "code": {} }, "description": "Stepped easing.", "kind": "function", "name": "Stepped", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to be tweened.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The number of steps in the ease.", "name": "steps" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tweened value." } ], "memberof": "Phaser.Math.Easing", "longname": "Phaser.Math.Easing.Stepped", "scope": "static", "___id": "T000002R025457", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n *\r\n * @class Euler\r\n * @memberof Phaser.Math\r\n * @constructor\r\n * @since 3.50.0\r\n *\r\n * @param {number} [x] - The x component.\r\n * @param {number} [y] - The y component.\r\n * @param {number} [z] - The z component.\r\n */", "meta": { "filename": "Euler.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "kind": "class", "name": "Euler", "memberof": "Phaser.Math", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The x component.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y component.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The z component.", "name": "z" } ], "scope": "static", "longname": "Phaser.Math.Euler", "___id": "T000002R025466", "___s": true }, { "comment": "/**\r\n * Calculates the factorial of a given number for integer values greater than 0.\r\n *\r\n * @function Phaser.Math.Factorial\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - A positive integer to calculate the factorial of.\r\n *\r\n * @return {number} The factorial of the given number.\r\n */", "meta": { "filename": "Factorial.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculates the factorial of a given number for integer values greater than 0.", "kind": "function", "name": "Factorial", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A positive integer to calculate the factorial of.", "name": "value" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The factorial of the given number." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.Factorial", "scope": "static", "___id": "T000002R025552", "___s": true }, { "comment": "/**\r\n * Generate a random floating point number between the two given bounds, minimum inclusive, maximum exclusive.\r\n *\r\n * @function Phaser.Math.FloatBetween\r\n * @since 3.0.0\r\n *\r\n * @param {number} min - The lower bound for the float, inclusive.\r\n * @param {number} max - The upper bound for the float exclusive.\r\n *\r\n * @return {number} A random float within the given range.\r\n */", "meta": { "filename": "FloatBetween.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Generate a random floating point number between the two given bounds, minimum inclusive, maximum exclusive.", "kind": "function", "name": "FloatBetween", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The lower bound for the float, inclusive.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The upper bound for the float exclusive.", "name": "max" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A random float within the given range." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.FloatBetween", "scope": "static", "___id": "T000002R025557", "___s": true }, { "comment": "/**\r\n * Floors to some place comparative to a `base`, default is 10 for decimal place.\r\n *\r\n * The `place` is represented by the power applied to `base` to get that place.\r\n *\r\n * @function Phaser.Math.FloorTo\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value to round.\r\n * @param {number} [place=0] - The place to round to.\r\n * @param {number} [base=10] - The base to round in. Default is 10 for decimal.\r\n *\r\n * @return {number} The rounded value.\r\n */", "meta": { "filename": "FloorTo.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Floors to some place comparative to a `base`, default is 10 for decimal place.\r\rThe `place` is represented by the power applied to `base` to get that place.", "kind": "function", "name": "FloorTo", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to round.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The place to round to.", "name": "place" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The base to round in. Default is 10 for decimal.", "name": "base" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rounded value." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.FloorTo", "scope": "static", "___id": "T000002R025560", "___s": true }, { "comment": "/**\r\n * Return a value based on the range between `min` and `max` and the percentage given.\r\n *\r\n * @function Phaser.Math.FromPercent\r\n * @since 3.0.0\r\n *\r\n * @param {number} percent - A value between 0 and 1 representing the percentage.\r\n * @param {number} min - The minimum value.\r\n * @param {number} [max] - The maximum value.\r\n *\r\n * @return {number} The value that is `percent` percent between `min` and `max`.\r\n */", "meta": { "filename": "FromPercent.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Return a value based on the range between `min` and `max` and the percentage given.", "kind": "function", "name": "FromPercent", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A value between 0 and 1 representing the percentage.", "name": "percent" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum value.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The maximum value.", "name": "max" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value that is `percent` percent between `min` and `max`." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.FromPercent", "scope": "static", "___id": "T000002R025567", "___s": true }, { "comment": "/**\r\n * Calculate the fuzzy ceiling of the given value.\r\n *\r\n * @function Phaser.Math.Fuzzy.Ceil\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value.\r\n * @param {number} [epsilon=0.0001] - The epsilon.\r\n *\r\n * @return {number} The fuzzy ceiling of the value.\r\n */", "meta": { "filename": "Ceil.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\fuzzy", "code": {} }, "description": "Calculate the fuzzy ceiling of the given value.", "kind": "function", "name": "Ceil", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.0001, "description": "The epsilon.", "name": "epsilon" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The fuzzy ceiling of the value." } ], "memberof": "Phaser.Math.Fuzzy", "longname": "Phaser.Math.Fuzzy.Ceil", "scope": "static", "___id": "T000002R025571", "___s": true }, { "comment": "/**\r\n * Check whether the given values are fuzzily equal.\r\n *\r\n * Two numbers are fuzzily equal if their difference is less than `epsilon`.\r\n *\r\n * @function Phaser.Math.Fuzzy.Equal\r\n * @since 3.0.0\r\n *\r\n * @param {number} a - The first value.\r\n * @param {number} b - The second value.\r\n * @param {number} [epsilon=0.0001] - The epsilon.\r\n *\r\n * @return {boolean} `true` if the values are fuzzily equal, otherwise `false`.\r\n */", "meta": { "filename": "Equal.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\fuzzy", "code": {} }, "description": "Check whether the given values are fuzzily equal.\r\rTwo numbers are fuzzily equal if their difference is less than `epsilon`.", "kind": "function", "name": "Equal", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The first value.", "name": "a" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The second value.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.0001, "description": "The epsilon.", "name": "epsilon" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the values are fuzzily equal, otherwise `false`." } ], "memberof": "Phaser.Math.Fuzzy", "longname": "Phaser.Math.Fuzzy.Equal", "scope": "static", "___id": "T000002R025575", "___s": true }, { "comment": "/**\r\n * Calculate the fuzzy floor of the given value.\r\n *\r\n * @function Phaser.Math.Fuzzy.Floor\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value.\r\n * @param {number} [epsilon=0.0001] - The epsilon.\r\n *\r\n * @return {number} The floor of the value.\r\n */", "meta": { "filename": "Floor.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\fuzzy", "code": {} }, "description": "Calculate the fuzzy floor of the given value.", "kind": "function", "name": "Floor", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.0001, "description": "The epsilon.", "name": "epsilon" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The floor of the value." } ], "memberof": "Phaser.Math.Fuzzy", "longname": "Phaser.Math.Fuzzy.Floor", "scope": "static", "___id": "T000002R025579", "___s": true }, { "comment": "/**\r\n * Check whether `a` is fuzzily greater than `b`.\r\n *\r\n * `a` is fuzzily greater than `b` if it is more than `b - epsilon`.\r\n *\r\n * @function Phaser.Math.Fuzzy.GreaterThan\r\n * @since 3.0.0\r\n *\r\n * @param {number} a - The first value.\r\n * @param {number} b - The second value.\r\n * @param {number} [epsilon=0.0001] - The epsilon.\r\n *\r\n * @return {boolean} `true` if `a` is fuzzily greater than than `b`, otherwise `false`.\r\n */", "meta": { "filename": "GreaterThan.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\fuzzy", "code": {} }, "description": "Check whether `a` is fuzzily greater than `b`.\r\r`a` is fuzzily greater than `b` if it is more than `b - epsilon`.", "kind": "function", "name": "GreaterThan", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The first value.", "name": "a" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The second value.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.0001, "description": "The epsilon.", "name": "epsilon" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if `a` is fuzzily greater than than `b`, otherwise `false`." } ], "memberof": "Phaser.Math.Fuzzy", "longname": "Phaser.Math.Fuzzy.GreaterThan", "scope": "static", "___id": "T000002R025583", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Fuzzy\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\fuzzy", "code": {} }, "kind": "namespace", "name": "Fuzzy", "memberof": "Phaser.Math", "longname": "Phaser.Math.Fuzzy", "scope": "static", "___id": "T000002R025587", "___s": true }, { "comment": "/**\r\n * Check whether `a` is fuzzily less than `b`.\r\n *\r\n * `a` is fuzzily less than `b` if it is less than `b + epsilon`.\r\n *\r\n * @function Phaser.Math.Fuzzy.LessThan\r\n * @since 3.0.0\r\n *\r\n * @param {number} a - The first value.\r\n * @param {number} b - The second value.\r\n * @param {number} [epsilon=0.0001] - The epsilon.\r\n *\r\n * @return {boolean} `true` if `a` is fuzzily less than `b`, otherwise `false`.\r\n */", "meta": { "filename": "LessThan.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\fuzzy", "code": {} }, "description": "Check whether `a` is fuzzily less than `b`.\r\r`a` is fuzzily less than `b` if it is less than `b + epsilon`.", "kind": "function", "name": "LessThan", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The first value.", "name": "a" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The second value.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.0001, "description": "The epsilon.", "name": "epsilon" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if `a` is fuzzily less than `b`, otherwise `false`." } ], "memberof": "Phaser.Math.Fuzzy", "longname": "Phaser.Math.Fuzzy.LessThan", "scope": "static", "___id": "T000002R025594", "___s": true }, { "comment": "/**\r\n * Calculate a per-ms speed from a distance and time (given in seconds).\r\n *\r\n * @function Phaser.Math.GetSpeed\r\n * @since 3.0.0\r\n *\r\n * @param {number} distance - The distance.\r\n * @param {number} time - The time, in seconds.\r\n *\r\n * @return {number} The speed, in distance per ms.\r\n *\r\n * @example\r\n * // 400px over 1 second is 0.4 px/ms\r\n * Phaser.Math.GetSpeed(400, 1) // -> 0.4\r\n */", "meta": { "filename": "GetSpeed.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate a per-ms speed from a distance and time (given in seconds).", "kind": "function", "name": "GetSpeed", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance.", "name": "distance" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time, in seconds.", "name": "time" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The speed, in distance per ms." } ], "examples": [ "// 400px over 1 second is 0.4 px/ms\rPhaser.Math.GetSpeed(400, 1) // -> 0.4" ], "memberof": "Phaser.Math", "longname": "Phaser.Math.GetSpeed", "scope": "static", "___id": "T000002R025598", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math\r\n */", "meta": { "filename": "index.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "kind": "namespace", "name": "Math", "memberof": "Phaser", "longname": "Phaser.Math", "scope": "static", "___id": "T000002R025603", "___s": true }, { "comment": "/**\r\n * A bezier interpolation method.\r\n *\r\n * @function Phaser.Math.Interpolation.Bezier\r\n * @since 3.0.0\r\n *\r\n * @param {number[]} v - The input array of values to interpolate between.\r\n * @param {number} k - The percentage of interpolation, between 0 and 1.\r\n *\r\n * @return {number} The interpolated value.\r\n */", "meta": { "filename": "BezierInterpolation.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\interpolation", "code": {} }, "description": "A bezier interpolation method.", "kind": "function", "name": "Bezier", "since": "3.0.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The input array of values to interpolate between.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The percentage of interpolation, between 0 and 1.", "name": "k" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The interpolated value." } ], "memberof": "Phaser.Math.Interpolation", "longname": "Phaser.Math.Interpolation.Bezier", "scope": "static", "___id": "T000002R025662", "___s": true }, { "comment": "/**\r\n * A Catmull-Rom interpolation method.\r\n *\r\n * @function Phaser.Math.Interpolation.CatmullRom\r\n * @since 3.0.0\r\n *\r\n * @param {number[]} v - The input array of values to interpolate between.\r\n * @param {number} k - The percentage of interpolation, between 0 and 1.\r\n *\r\n * @return {number} The interpolated value.\r\n */", "meta": { "filename": "CatmullRomInterpolation.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\interpolation", "code": {} }, "description": "A Catmull-Rom interpolation method.", "kind": "function", "name": "CatmullRom", "since": "3.0.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The input array of values to interpolate between.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The percentage of interpolation, between 0 and 1.", "name": "k" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The interpolated value." } ], "memberof": "Phaser.Math.Interpolation", "longname": "Phaser.Math.Interpolation.CatmullRom", "scope": "static", "___id": "T000002R025670", "___s": true }, { "comment": "/**\r\n * A cubic bezier interpolation method.\r\n *\r\n * https://medium.com/@adrian_cooney/bezier-interpolation-13b68563313a\r\n *\r\n * @function Phaser.Math.Interpolation.CubicBezier\r\n * @since 3.0.0\r\n *\r\n * @param {number} t - The percentage of interpolation, between 0 and 1.\r\n * @param {number} p0 - The start point.\r\n * @param {number} p1 - The first control point.\r\n * @param {number} p2 - The second control point.\r\n * @param {number} p3 - The end point.\r\n *\r\n * @return {number} The interpolated value.\r\n */", "meta": { "filename": "CubicBezierInterpolation.js", "lineno": 43, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\interpolation", "code": {} }, "description": "A cubic bezier interpolation method.\r\rhttps://medium.com/@adrian_cooney/bezier-interpolation-13b68563313a", "kind": "function", "name": "CubicBezier", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The percentage of interpolation, between 0 and 1.", "name": "t" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The start point.", "name": "p0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The first control point.", "name": "p1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The second control point.", "name": "p2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The end point.", "name": "p3" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The interpolated value." } ], "memberof": "Phaser.Math.Interpolation", "longname": "Phaser.Math.Interpolation.CubicBezier", "scope": "static", "___id": "T000002R025684", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Interpolation\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\interpolation", "code": {} }, "kind": "namespace", "name": "Interpolation", "memberof": "Phaser.Math", "longname": "Phaser.Math.Interpolation", "scope": "static", "___id": "T000002R025687", "___s": true }, { "comment": "/**\r\n * A linear interpolation method.\r\n *\r\n * @function Phaser.Math.Interpolation.Linear\r\n * @since 3.0.0\r\n * @see {@link https://en.wikipedia.org/wiki/Linear_interpolation}\r\n *\r\n * @param {number[]} v - The input array of values to interpolate between.\r\n * @param {!number} k - The percentage of interpolation, between 0 and 1.\r\n *\r\n * @return {!number} The interpolated value.\r\n */", "meta": { "filename": "LinearInterpolation.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\interpolation", "code": {} }, "description": "A linear interpolation method.", "kind": "function", "name": "Linear", "since": "3.0.0", "see": [ "{@link https://en.wikipedia.org/wiki/Linear_interpolation}" ], "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The input array of values to interpolate between.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": false } }, "nullable": false, "description": "The percentage of interpolation, between 0 and 1.", "name": "k" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": false } }, "nullable": false, "description": "The interpolated value." } ], "memberof": "Phaser.Math.Interpolation", "longname": "Phaser.Math.Interpolation.Linear", "scope": "static", "___id": "T000002R025697", "___s": true }, { "comment": "/**\r\n * A quadratic bezier interpolation method.\r\n *\r\n * @function Phaser.Math.Interpolation.QuadraticBezier\r\n * @since 3.2.0\r\n *\r\n * @param {number} t - The percentage of interpolation, between 0 and 1.\r\n * @param {number} p0 - The start point.\r\n * @param {number} p1 - The control point.\r\n * @param {number} p2 - The end point.\r\n *\r\n * @return {number} The interpolated value.\r\n */", "meta": { "filename": "QuadraticBezierInterpolation.js", "lineno": 35, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\interpolation", "code": {} }, "description": "A quadratic bezier interpolation method.", "kind": "function", "name": "QuadraticBezier", "since": "3.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The percentage of interpolation, between 0 and 1.", "name": "t" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The start point.", "name": "p0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The control point.", "name": "p1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The end point.", "name": "p2" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The interpolated value." } ], "memberof": "Phaser.Math.Interpolation", "longname": "Phaser.Math.Interpolation.QuadraticBezier", "scope": "static", "___id": "T000002R025707", "___s": true }, { "comment": "/**\r\n * A Smoother Step interpolation method.\r\n *\r\n * @function Phaser.Math.Interpolation.SmootherStep\r\n * @since 3.9.0\r\n * @see {@link https://en.wikipedia.org/wiki/Smoothstep#Variations}\r\n *\r\n * @param {number} t - The percentage of interpolation, between 0 and 1.\r\n * @param {number} min - The minimum value, also known as the 'left edge', assumed smaller than the 'right edge'.\r\n * @param {number} max - The maximum value, also known as the 'right edge', assumed greater than the 'left edge'.\r\n *\r\n * @return {number} The interpolated value.\r\n */", "meta": { "filename": "SmootherStepInterpolation.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\interpolation", "code": {} }, "description": "A Smoother Step interpolation method.", "kind": "function", "name": "SmootherStep", "since": "3.9.0", "see": [ "{@link https://en.wikipedia.org/wiki/Smoothstep#Variations}" ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The percentage of interpolation, between 0 and 1.", "name": "t" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum value, also known as the 'left edge', assumed smaller than the 'right edge'.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum value, also known as the 'right edge', assumed greater than the 'left edge'.", "name": "max" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The interpolated value." } ], "memberof": "Phaser.Math.Interpolation", "longname": "Phaser.Math.Interpolation.SmootherStep", "scope": "static", "___id": "T000002R025711", "___s": true }, { "comment": "/**\r\n * A Smooth Step interpolation method.\r\n *\r\n * @function Phaser.Math.Interpolation.SmoothStep\r\n * @since 3.9.0\r\n * @see {@link https://en.wikipedia.org/wiki/Smoothstep}\r\n *\r\n * @param {number} t - The percentage of interpolation, between 0 and 1.\r\n * @param {number} min - The minimum value, also known as the 'left edge', assumed smaller than the 'right edge'.\r\n * @param {number} max - The maximum value, also known as the 'right edge', assumed greater than the 'left edge'.\r\n *\r\n * @return {number} The interpolated value.\r\n */", "meta": { "filename": "SmoothStepInterpolation.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\interpolation", "code": {} }, "description": "A Smooth Step interpolation method.", "kind": "function", "name": "SmoothStep", "since": "3.9.0", "see": [ "{@link https://en.wikipedia.org/wiki/Smoothstep}" ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The percentage of interpolation, between 0 and 1.", "name": "t" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum value, also known as the 'left edge', assumed smaller than the 'right edge'.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum value, also known as the 'right edge', assumed greater than the 'left edge'.", "name": "max" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The interpolated value." } ], "memberof": "Phaser.Math.Interpolation", "longname": "Phaser.Math.Interpolation.SmoothStep", "scope": "static", "___id": "T000002R025715", "___s": true }, { "comment": "/**\r\n * Check if a given value is an even number.\r\n *\r\n * @function Phaser.Math.IsEven\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The number to perform the check with.\r\n *\r\n * @return {boolean} Whether the number is even or not.\r\n */", "meta": { "filename": "IsEven.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Check if a given value is an even number.", "kind": "function", "name": "IsEven", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number to perform the check with.", "name": "value" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the number is even or not." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.IsEven", "scope": "static", "___id": "T000002R025718", "___s": true }, { "comment": "/**\r\n * Check if a given value is an even number using a strict type check.\r\n *\r\n * @function Phaser.Math.IsEvenStrict\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The number to perform the check with.\r\n *\r\n * @return {boolean} Whether the number is even or not.\r\n */", "meta": { "filename": "IsEvenStrict.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Check if a given value is an even number using a strict type check.", "kind": "function", "name": "IsEvenStrict", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number to perform the check with.", "name": "value" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the number is even or not." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.IsEvenStrict", "scope": "static", "___id": "T000002R025721", "___s": true }, { "comment": "/**\r\n * Calculates a linear (interpolation) value over t.\r\n *\r\n * @function Phaser.Math.Linear\r\n * @since 3.0.0\r\n *\r\n * @param {number} p0 - The first point.\r\n * @param {number} p1 - The second point.\r\n * @param {number} t - The percentage between p0 and p1 to return, represented as a number between 0 and 1.\r\n *\r\n * @return {number} The step t% of the way between p0 and p1.\r\n */", "meta": { "filename": "Linear.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculates a linear (interpolation) value over t.", "kind": "function", "name": "Linear", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The first point.", "name": "p0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The second point.", "name": "p1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The percentage between p0 and p1 to return, represented as a number between 0 and 1.", "name": "t" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The step t% of the way between p0 and p1." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.Linear", "scope": "static", "___id": "T000002R025724", "___s": true }, { "comment": "/**\r\n * Interpolates two given Vectors and returns a new Vector between them.\r\n *\r\n * Does not modify either of the passed Vectors.\r\n *\r\n * @function Phaser.Math.LinearXY\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Math.Vector2} vector1 - Starting vector\r\n * @param {Phaser.Math.Vector2} vector2 - Ending vector\r\n * @param {number} [t=0] - The percentage between vector1 and vector2 to return, represented as a number between 0 and 1.\r\n *\r\n * @return {Phaser.Math.Vector2} The step t% of the way between vector1 and vector2.\r\n */", "meta": { "filename": "LinearXY.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Interpolates two given Vectors and returns a new Vector between them.\r\rDoes not modify either of the passed Vectors.", "kind": "function", "name": "LinearXY", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "Starting vector", "name": "vector1" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "Ending vector", "name": "vector2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The percentage between vector1 and vector2 to return, represented as a number between 0 and 1.", "name": "t" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The step t% of the way between vector1 and vector2." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.LinearXY", "scope": "static", "___id": "T000002R025727", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A three-dimensional matrix.\r\n *\r\n * Defaults to the identity matrix when instantiated.\r\n *\r\n * @class Matrix3\r\n * @memberof Phaser.Math\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix3} [m] - Optional Matrix3 to copy values from.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "classdesc": "A three-dimensional matrix.\r\rDefaults to the identity matrix when instantiated.", "kind": "class", "name": "Matrix3", "memberof": "Phaser.Math", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "optional": true, "description": "Optional Matrix3 to copy values from.", "name": "m" } ], "scope": "static", "longname": "Phaser.Math.Matrix3", "___id": "T000002R025732", "___s": true }, { "comment": "/**\r\n * The matrix values.\r\n *\r\n * @name Phaser.Math.Matrix3#val\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 31, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The matrix values.", "name": "val", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#val", "scope": "instance", "kind": "member", "___id": "T000002R025735", "___s": true }, { "comment": "/**\r\n * Make a clone of this Matrix3.\r\n *\r\n * @method Phaser.Math.Matrix3#clone\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Matrix3} A clone of this Matrix3.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 52, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Make a clone of this Matrix3.", "kind": "function", "name": "clone", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "A clone of this Matrix3." } ], "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#clone", "scope": "instance", "___id": "T000002R025737", "___s": true }, { "comment": "/**\r\n * This method is an alias for `Matrix3.copy`.\r\n *\r\n * @method Phaser.Math.Matrix3#set\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix3} src - The Matrix to set the values of this Matrix's from.\r\n *\r\n * @return {Phaser.Math.Matrix3} This Matrix3.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 65, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "This method is an alias for `Matrix3.copy`.", "kind": "function", "name": "set", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "The Matrix to set the values of this Matrix's from.", "name": "src" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "This Matrix3." } ], "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#set", "scope": "instance", "___id": "T000002R025739", "___s": true }, { "comment": "/**\r\n * Copy the values of a given Matrix into this Matrix.\r\n *\r\n * @method Phaser.Math.Matrix3#copy\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix3} src - The Matrix to copy the values from.\r\n *\r\n * @return {Phaser.Math.Matrix3} This Matrix3.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Copy the values of a given Matrix into this Matrix.", "kind": "function", "name": "copy", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "The Matrix to copy the values from.", "name": "src" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "This Matrix3." } ], "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#copy", "scope": "instance", "___id": "T000002R025741", "___s": true }, { "comment": "/**\r\n * Copy the values of a given Matrix4 into this Matrix3.\r\n *\r\n * @method Phaser.Math.Matrix3#fromMat4\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix4} m - The Matrix4 to copy the values from.\r\n *\r\n * @return {Phaser.Math.Matrix3} This Matrix3.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Copy the values of a given Matrix4 into this Matrix3.", "kind": "function", "name": "fromMat4", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to copy the values from.", "name": "m" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "This Matrix3." } ], "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#fromMat4", "scope": "instance", "___id": "T000002R025754", "___s": true }, { "comment": "/**\r\n * Set the values of this Matrix from the given array.\r\n *\r\n * @method Phaser.Math.Matrix3#fromArray\r\n * @since 3.0.0\r\n *\r\n * @param {array} a - The array to copy the values from.\r\n *\r\n * @return {Phaser.Math.Matrix3} This Matrix3.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 136, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the values of this Matrix from the given array.", "kind": "function", "name": "fromArray", "since": "3.0.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to copy the values from.", "name": "a" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "This Matrix3." } ], "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#fromArray", "scope": "instance", "___id": "T000002R025767", "___s": true }, { "comment": "/**\r\n * Reset this Matrix to an identity (default) matrix.\r\n *\r\n * @method Phaser.Math.Matrix3#identity\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Matrix3} This Matrix3.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 163, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Reset this Matrix to an identity (default) matrix.", "kind": "function", "name": "identity", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "This Matrix3." } ], "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#identity", "scope": "instance", "___id": "T000002R025779", "___s": true }, { "comment": "/**\r\n * Transpose this Matrix.\r\n *\r\n * @method Phaser.Math.Matrix3#transpose\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Matrix3} This Matrix3.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 188, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Transpose this Matrix.", "kind": "function", "name": "transpose", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "This Matrix3." } ], "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#transpose", "scope": "instance", "___id": "T000002R025791", "___s": true }, { "comment": "/**\r\n * Invert this Matrix.\r\n *\r\n * @method Phaser.Math.Matrix3#invert\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Matrix3} This Matrix3.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 213, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Invert this Matrix.", "kind": "function", "name": "invert", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "This Matrix3." } ], "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#invert", "scope": "instance", "___id": "T000002R025803", "___s": true }, { "comment": "/**\r\n * Calculate the adjoint, or adjugate, of this Matrix.\r\n *\r\n * @method Phaser.Math.Matrix3#adjoint\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Matrix3} This Matrix3.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the adjoint, or adjugate, of this Matrix.", "kind": "function", "name": "adjoint", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "This Matrix3." } ], "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#adjoint", "scope": "instance", "___id": "T000002R025829", "___s": true }, { "comment": "/**\r\n * Calculate the determinant of this Matrix.\r\n *\r\n * @method Phaser.Math.Matrix3#determinant\r\n * @since 3.0.0\r\n *\r\n * @return {number} The determinant of this Matrix.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 297, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the determinant of this Matrix.", "kind": "function", "name": "determinant", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The determinant of this Matrix." } ], "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#determinant", "scope": "instance", "___id": "T000002R025850", "___s": true }, { "comment": "/**\r\n * Multiply this Matrix by the given Matrix.\r\n *\r\n * @method Phaser.Math.Matrix3#multiply\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix3} src - The Matrix to multiply this Matrix by.\r\n *\r\n * @return {Phaser.Math.Matrix3} This Matrix3.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 322, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Multiply this Matrix by the given Matrix.", "kind": "function", "name": "multiply", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "The Matrix to multiply this Matrix by.", "name": "src" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "This Matrix3." } ], "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#multiply", "scope": "instance", "___id": "T000002R025862", "___s": true }, { "comment": "/**\r\n * Translate this Matrix using the given Vector.\r\n *\r\n * @method Phaser.Math.Matrix3#translate\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3|Phaser.Math.Vector4)} v - The Vector to translate this Matrix with.\r\n *\r\n * @return {Phaser.Math.Matrix3} This Matrix3.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Translate this Matrix using the given Vector.", "kind": "function", "name": "translate", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Vector to translate this Matrix with.", "name": "v" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "This Matrix3." } ], "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#translate", "scope": "instance", "___id": "T000002R025893", "___s": true }, { "comment": "/**\r\n * Apply a rotation transformation to this Matrix.\r\n *\r\n * @method Phaser.Math.Matrix3#rotate\r\n * @since 3.0.0\r\n *\r\n * @param {number} rad - The angle in radians to rotate by.\r\n *\r\n * @return {Phaser.Math.Matrix3} This Matrix3.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 396, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Apply a rotation transformation to this Matrix.", "kind": "function", "name": "rotate", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle in radians to rotate by.", "name": "rad" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "This Matrix3." } ], "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#rotate", "scope": "instance", "___id": "T000002R025901", "___s": true }, { "comment": "/**\r\n * Apply a scale transformation to this Matrix.\r\n *\r\n * Uses the `x` and `y` components of the given Vector to scale the Matrix.\r\n *\r\n * @method Phaser.Math.Matrix3#scale\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3|Phaser.Math.Vector4)} v - The Vector to scale this Matrix with.\r\n *\r\n * @return {Phaser.Math.Matrix3} This Matrix3.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 431, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Apply a scale transformation to this Matrix.\r\rUses the `x` and `y` components of the given Vector to scale the Matrix.", "kind": "function", "name": "scale", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Vector to scale this Matrix with.", "name": "v" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "This Matrix3." } ], "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#scale", "scope": "instance", "___id": "T000002R025918", "___s": true }, { "comment": "/**\r\n * Set the values of this Matrix from the given Quaternion.\r\n *\r\n * @method Phaser.Math.Matrix3#fromQuat\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Quaternion} q - The Quaternion to set the values of this Matrix from.\r\n *\r\n * @return {Phaser.Math.Matrix3} This Matrix3.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 460, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the values of this Matrix from the given Quaternion.", "kind": "function", "name": "fromQuat", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "The Quaternion to set the values of this Matrix from.", "name": "q" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "This Matrix3." } ], "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#fromQuat", "scope": "instance", "___id": "T000002R025929", "___s": true }, { "comment": "/**\r\n * Set the values of this Matrix3 to be normalized from the given Matrix4.\r\n *\r\n * @method Phaser.Math.Matrix3#normalFromMat4\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix4} m - The Matrix4 to normalize the values from.\r\n *\r\n * @return {Phaser.Math.Matrix3} This Matrix3.\r\n */", "meta": { "filename": "Matrix3.js", "lineno": 510, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the values of this Matrix3 to be normalized from the given Matrix4.", "kind": "function", "name": "normalFromMat4", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to normalize the values from.", "name": "m" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "This Matrix3." } ], "memberof": "Phaser.Math.Matrix3", "longname": "Phaser.Math.Matrix3#normalFromMat4", "scope": "instance", "___id": "T000002R025957", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A four-dimensional matrix.\r\n *\r\n * Adapted from [gl-matrix](https://github.com/toji/gl-matrix) by toji\r\n * and [vecmath](https://github.com/mattdesl/vecmath) by mattdesl\r\n *\r\n * @class Matrix4\r\n * @memberof Phaser.Math\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix4} [m] - Optional Matrix4 to copy values from.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "classdesc": "A four-dimensional matrix.\r\rAdapted from [gl-matrix](https://github.com/toji/gl-matrix) by toji\rand [vecmath](https://github.com/mattdesl/vecmath) by mattdesl", "kind": "class", "name": "Matrix4", "memberof": "Phaser.Math", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "optional": true, "description": "Optional Matrix4 to copy values from.", "name": "m" } ], "scope": "static", "longname": "Phaser.Math.Matrix4", "___id": "T000002R026004", "___s": true }, { "comment": "/**\r\n * The matrix values.\r\n *\r\n * @name Phaser.Math.Matrix4#val\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The matrix values.", "name": "val", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#val", "scope": "instance", "kind": "member", "___id": "T000002R026007", "___s": true }, { "comment": "/**\r\n * Make a clone of this Matrix4.\r\n *\r\n * @method Phaser.Math.Matrix4#clone\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Matrix4} A clone of this Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Make a clone of this Matrix4.", "kind": "function", "name": "clone", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "A clone of this Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#clone", "scope": "instance", "___id": "T000002R026009", "___s": true }, { "comment": "/**\r\n * This method is an alias for `Matrix4.copy`.\r\n *\r\n * @method Phaser.Math.Matrix4#set\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix4} src - The Matrix to set the values of this Matrix's from.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 69, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "This method is an alias for `Matrix4.copy`.", "kind": "function", "name": "set", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix to set the values of this Matrix's from.", "name": "src" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#set", "scope": "instance", "___id": "T000002R026011", "___s": true }, { "comment": "/**\r\n * Sets all values of this Matrix4.\r\n *\r\n * @method Phaser.Math.Matrix4#setValues\r\n * @since 3.50.0\r\n *\r\n * @param {number} m00 - The m00 value.\r\n * @param {number} m01 - The m01 value.\r\n * @param {number} m02 - The m02 value.\r\n * @param {number} m03 - The m03 value.\r\n * @param {number} m10 - The m10 value.\r\n * @param {number} m11 - The m11 value.\r\n * @param {number} m12 - The m12 value.\r\n * @param {number} m13 - The m13 value.\r\n * @param {number} m20 - The m20 value.\r\n * @param {number} m21 - The m21 value.\r\n * @param {number} m22 - The m22 value.\r\n * @param {number} m23 - The m23 value.\r\n * @param {number} m30 - The m30 value.\r\n * @param {number} m31 - The m31 value.\r\n * @param {number} m32 - The m32 value.\r\n * @param {number} m33 - The m33 value.\r\n *\r\n * @return {this} This Matrix4 instance.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 84, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Sets all values of this Matrix4.", "kind": "function", "name": "setValues", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The m00 value.", "name": "m00" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The m01 value.", "name": "m01" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The m02 value.", "name": "m02" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The m03 value.", "name": "m03" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The m10 value.", "name": "m10" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The m11 value.", "name": "m11" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The m12 value.", "name": "m12" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The m13 value.", "name": "m13" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The m20 value.", "name": "m20" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The m21 value.", "name": "m21" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The m22 value.", "name": "m22" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The m23 value.", "name": "m23" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The m30 value.", "name": "m30" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The m31 value.", "name": "m31" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The m32 value.", "name": "m32" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The m33 value.", "name": "m33" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4 instance." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#setValues", "scope": "instance", "___id": "T000002R026013", "___s": true }, { "comment": "/**\r\n * Copy the values of a given Matrix into this Matrix.\r\n *\r\n * @method Phaser.Math.Matrix4#copy\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix4} src - The Matrix to copy the values from.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 133, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Copy the values of a given Matrix into this Matrix.", "kind": "function", "name": "copy", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix to copy the values from.", "name": "src" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#copy", "scope": "instance", "___id": "T000002R026032", "___s": true }, { "comment": "/**\r\n * Set the values of this Matrix from the given array.\r\n *\r\n * @method Phaser.Math.Matrix4#fromArray\r\n * @since 3.0.0\r\n *\r\n * @param {number[]} a - The array to copy the values from. Must have at least 16 elements.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 150, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the values of this Matrix from the given array.", "kind": "function", "name": "fromArray", "since": "3.0.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The array to copy the values from. Must have at least 16 elements.", "name": "a" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#fromArray", "scope": "instance", "___id": "T000002R026035", "___s": true }, { "comment": "/**\r\n * Reset this Matrix.\r\n *\r\n * Sets all values to `0`.\r\n *\r\n * @method Phaser.Math.Matrix4#zero\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Matrix4} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 165, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Reset this Matrix.\r\rSets all values to `0`.", "kind": "function", "name": "zero", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#zero", "scope": "instance", "___id": "T000002R026037", "___s": true }, { "comment": "/**\r\n * Generates a transform matrix based on the given position, scale and rotation.\r\n *\r\n * @method Phaser.Math.Matrix4#transform\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Vector3} position - The position vector.\r\n * @param {Phaser.Math.Vector3} scale - The scale vector.\r\n * @param {Phaser.Math.Quaternion} rotation - The rotation quaternion.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 180, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Generates a transform matrix based on the given position, scale and rotation.", "kind": "function", "name": "transform", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The position vector.", "name": "position" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The scale vector.", "name": "scale" }, { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "The rotation quaternion.", "name": "rotation" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#transform", "scope": "instance", "___id": "T000002R026039", "___s": true }, { "comment": "/**\r\n * Set the `x`, `y` and `z` values of this Matrix.\r\n *\r\n * @method Phaser.Math.Matrix4#xyz\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x value.\r\n * @param {number} y - The y value.\r\n * @param {number} z - The z value.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 225, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the `x`, `y` and `z` values of this Matrix.", "kind": "function", "name": "xyz", "since": "3.0.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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The z value.", "name": "z" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#xyz", "scope": "instance", "___id": "T000002R026046", "___s": true }, { "comment": "/**\r\n * Set the scaling values of this Matrix.\r\n *\r\n * @method Phaser.Math.Matrix4#scaling\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x scaling value.\r\n * @param {number} y - The y scaling value.\r\n * @param {number} z - The z scaling value.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 250, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the scaling values of this Matrix.", "kind": "function", "name": "scaling", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x scaling value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y scaling value.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The z scaling value.", "name": "z" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#scaling", "scope": "instance", "___id": "T000002R026052", "___s": true }, { "comment": "/**\r\n * Reset this Matrix to an identity (default) matrix.\r\n *\r\n * @method Phaser.Math.Matrix4#identity\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Reset this Matrix to an identity (default) matrix.", "kind": "function", "name": "identity", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#identity", "scope": "instance", "___id": "T000002R026059", "___s": true }, { "comment": "/**\r\n * Transpose this Matrix.\r\n *\r\n * @method Phaser.Math.Matrix4#transpose\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Transpose this Matrix.", "kind": "function", "name": "transpose", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#transpose", "scope": "instance", "___id": "T000002R026061", "___s": true }, { "comment": "/**\r\n * Copies the given Matrix4 into this Matrix and then inverses it.\r\n *\r\n * @method Phaser.Math.Matrix4#getInverse\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} m - The Matrix4 to invert into this Matrix4.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 324, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Copies the given Matrix4 into this Matrix and then inverses it.", "kind": "function", "name": "getInverse", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to invert into this Matrix4.", "name": "m" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#getInverse", "scope": "instance", "___id": "T000002R026082", "___s": true }, { "comment": "/**\r\n * Invert this Matrix.\r\n *\r\n * @method Phaser.Math.Matrix4#invert\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 341, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Invert this Matrix.", "kind": "function", "name": "invert", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#invert", "scope": "instance", "___id": "T000002R026084", "___s": true }, { "comment": "/**\r\n * Calculate the adjoint, or adjugate, of this Matrix.\r\n *\r\n * @method Phaser.Math.Matrix4#adjoint\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 418, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the adjoint, or adjugate, of this Matrix.", "kind": "function", "name": "adjoint", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#adjoint", "scope": "instance", "___id": "T000002R026117", "___s": true }, { "comment": "/**\r\n * Calculate the determinant of this Matrix.\r\n *\r\n * @method Phaser.Math.Matrix4#determinant\r\n * @since 3.0.0\r\n *\r\n * @return {number} The determinant of this Matrix.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 470, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the determinant of this Matrix.", "kind": "function", "name": "determinant", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The determinant of this Matrix." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#determinant", "scope": "instance", "___id": "T000002R026136", "___s": true }, { "comment": "/**\r\n * Multiply this Matrix by the given Matrix.\r\n *\r\n * @method Phaser.Math.Matrix4#multiply\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix4} src - The Matrix to multiply this Matrix by.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 519, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Multiply this Matrix by the given Matrix.", "kind": "function", "name": "multiply", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix to multiply this Matrix by.", "name": "src" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#multiply", "scope": "instance", "___id": "T000002R026167", "___s": true }, { "comment": "/**\r\n * Multiply the values of this Matrix4 by those given in the `src` argument.\r\n *\r\n * @method Phaser.Math.Matrix4#multiplyLocal\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix4} src - The source Matrix4 that this Matrix4 is multiplied by.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Multiply the values of this Matrix4 by those given in the `src` argument.", "kind": "function", "name": "multiplyLocal", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The source Matrix4 that this Matrix4 is multiplied by.", "name": "src" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#multiplyLocal", "scope": "instance", "___id": "T000002R026219", "___s": true }, { "comment": "/**\r\n * Multiplies the given Matrix4 object with this Matrix.\r\n *\r\n * This is the same as calling `multiplyMatrices(m, this)`.\r\n *\r\n * @method Phaser.Math.Matrix4#premultiply\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} m - The Matrix4 to multiply with this one.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 637, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Multiplies the given Matrix4 object with this Matrix.\r\rThis is the same as calling `multiplyMatrices(m, this)`.", "kind": "function", "name": "premultiply", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to multiply with this one.", "name": "m" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#premultiply", "scope": "instance", "___id": "T000002R026223", "___s": true }, { "comment": "/**\r\n * Multiplies the two given Matrix4 objects and stores the results in this Matrix.\r\n *\r\n * @method Phaser.Math.Matrix4#multiplyMatrices\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} a - The first Matrix4 to multiply.\r\n * @param {Phaser.Math.Matrix4} b - The second Matrix4 to multiply.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 654, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Multiplies the two given Matrix4 objects and stores the results in this Matrix.", "kind": "function", "name": "multiplyMatrices", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The first Matrix4 to multiply.", "name": "a" }, { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The second Matrix4 to multiply.", "name": "b" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#multiplyMatrices", "scope": "instance", "___id": "T000002R026225", "___s": true }, { "comment": "/**\r\n * Translate this Matrix using the given Vector.\r\n *\r\n * @method Phaser.Math.Matrix4#translate\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector3|Phaser.Math.Vector4)} v - The Vector to translate this Matrix with.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 724, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Translate this Matrix using the given Vector.", "kind": "function", "name": "translate", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector3" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Vector to translate this Matrix with.", "name": "v" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#translate", "scope": "instance", "___id": "T000002R026261", "___s": true }, { "comment": "/**\r\n * Translate this Matrix using the given values.\r\n *\r\n * @method Phaser.Math.Matrix4#translateXYZ\r\n * @since 3.16.0\r\n *\r\n * @param {number} x - The x component.\r\n * @param {number} y - The y component.\r\n * @param {number} z - The z component.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 739, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Translate this Matrix using the given values.", "kind": "function", "name": "translateXYZ", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x component.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y component.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The z component.", "name": "z" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#translateXYZ", "scope": "instance", "___id": "T000002R026263", "___s": true }, { "comment": "/**\r\n * Apply a scale transformation to this Matrix.\r\n *\r\n * Uses the `x`, `y` and `z` components of the given Vector to scale the Matrix.\r\n *\r\n * @method Phaser.Math.Matrix4#scale\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector3|Phaser.Math.Vector4)} v - The Vector to scale this Matrix with.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 763, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Apply a scale transformation to this Matrix.\r\rUses the `x`, `y` and `z` components of the given Vector to scale the Matrix.", "kind": "function", "name": "scale", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector3" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Vector to scale this Matrix with.", "name": "v" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#scale", "scope": "instance", "___id": "T000002R026270", "___s": true }, { "comment": "/**\r\n * Apply a scale transformation to this Matrix.\r\n *\r\n * @method Phaser.Math.Matrix4#scaleXYZ\r\n * @since 3.16.0\r\n *\r\n * @param {number} x - The x component.\r\n * @param {number} y - The y component.\r\n * @param {number} z - The z component.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 780, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Apply a scale transformation to this Matrix.", "kind": "function", "name": "scaleXYZ", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x component.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y component.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The z component.", "name": "z" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#scaleXYZ", "scope": "instance", "___id": "T000002R026272", "___s": true }, { "comment": "/**\r\n * Derive a rotation matrix around the given axis.\r\n *\r\n * @method Phaser.Math.Matrix4#makeRotationAxis\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector3|Phaser.Math.Vector4)} axis - The rotation axis.\r\n * @param {number} angle - The rotation angle in radians.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 814, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Derive a rotation matrix around the given axis.", "kind": "function", "name": "makeRotationAxis", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector3" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The rotation axis.", "name": "axis" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rotation angle in radians.", "name": "angle" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#makeRotationAxis", "scope": "instance", "___id": "T000002R026287", "___s": true }, { "comment": "/**\r\n * Apply a rotation transformation to this Matrix.\r\n *\r\n * @method Phaser.Math.Matrix4#rotate\r\n * @since 3.0.0\r\n *\r\n * @param {number} rad - The angle in radians to rotate by.\r\n * @param {Phaser.Math.Vector3} axis - The axis to rotate upon.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 846, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Apply a rotation transformation to this Matrix.", "kind": "function", "name": "rotate", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle in radians to rotate by.", "name": "rad" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The axis to rotate upon.", "name": "axis" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#rotate", "scope": "instance", "___id": "T000002R026297", "___s": true }, { "comment": "/**\r\n * Rotate this matrix on its X axis.\r\n *\r\n * @method Phaser.Math.Matrix4#rotateX\r\n * @since 3.0.0\r\n *\r\n * @param {number} rad - The angle in radians to rotate by.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 930, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Rotate this matrix on its X axis.", "kind": "function", "name": "rotateX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle in radians to rotate by.", "name": "rad" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#rotateX", "scope": "instance", "___id": "T000002R026336", "___s": true }, { "comment": "/**\r\n * Rotate this matrix on its Y axis.\r\n *\r\n * @method Phaser.Math.Matrix4#rotateY\r\n * @since 3.0.0\r\n *\r\n * @param {number} rad - The angle to rotate by, in radians.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 969, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Rotate this matrix on its Y axis.", "kind": "function", "name": "rotateY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle to rotate by, in radians.", "name": "rad" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#rotateY", "scope": "instance", "___id": "T000002R026357", "___s": true }, { "comment": "/**\r\n * Rotate this matrix on its Z axis.\r\n *\r\n * @method Phaser.Math.Matrix4#rotateZ\r\n * @since 3.0.0\r\n *\r\n * @param {number} rad - The angle to rotate by, in radians.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 1008, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Rotate this matrix on its Z axis.", "kind": "function", "name": "rotateZ", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle to rotate by, in radians.", "name": "rad" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#rotateZ", "scope": "instance", "___id": "T000002R026378", "___s": true }, { "comment": "/**\r\n * Set the values of this Matrix from the given rotation Quaternion and translation Vector.\r\n *\r\n * @method Phaser.Math.Matrix4#fromRotationTranslation\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Quaternion} q - The Quaternion to set rotation from.\r\n * @param {Phaser.Math.Vector3} v - The Vector to set translation from.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 1047, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the values of this Matrix from the given rotation Quaternion and translation Vector.", "kind": "function", "name": "fromRotationTranslation", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "The Quaternion to set rotation from.", "name": "q" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The Vector to set translation from.", "name": "v" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#fromRotationTranslation", "scope": "instance", "___id": "T000002R026399", "___s": true }, { "comment": "/**\r\n * Set the values of this Matrix from the given Quaternion.\r\n *\r\n * @method Phaser.Math.Matrix4#fromQuat\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Quaternion} q - The Quaternion to set the values of this Matrix from.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 1105, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the values of this Matrix from the given Quaternion.", "kind": "function", "name": "fromQuat", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "The Quaternion to set the values of this Matrix from.", "name": "q" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#fromQuat", "scope": "instance", "___id": "T000002R026417", "___s": true }, { "comment": "/**\r\n * Generate a frustum matrix with the given bounds.\r\n *\r\n * @method Phaser.Math.Matrix4#frustum\r\n * @since 3.0.0\r\n *\r\n * @param {number} left - The left bound of the frustum.\r\n * @param {number} right - The right bound of the frustum.\r\n * @param {number} bottom - The bottom bound of the frustum.\r\n * @param {number} top - The top bound of the frustum.\r\n * @param {number} near - The near bound of the frustum.\r\n * @param {number} far - The far bound of the frustum.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 1161, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Generate a frustum matrix with the given bounds.", "kind": "function", "name": "frustum", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left bound of the frustum.", "name": "left" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The right bound of the frustum.", "name": "right" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom bound of the frustum.", "name": "bottom" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top bound of the frustum.", "name": "top" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The near bound of the frustum.", "name": "near" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The far bound of the frustum.", "name": "far" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#frustum", "scope": "instance", "___id": "T000002R026435", "___s": true }, { "comment": "/**\r\n * Generate a perspective projection matrix with the given bounds.\r\n *\r\n * @method Phaser.Math.Matrix4#perspective\r\n * @since 3.0.0\r\n *\r\n * @param {number} fovy - Vertical field of view in radians\r\n * @param {number} aspect - Aspect ratio. Typically viewport width /height.\r\n * @param {number} near - Near bound of the frustum.\r\n * @param {number} far - Far bound of the frustum.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 1205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Generate a perspective projection matrix with the given bounds.", "kind": "function", "name": "perspective", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical field of view in radians", "name": "fovy" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Aspect ratio. Typically viewport width /height.", "name": "aspect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Near bound of the frustum.", "name": "near" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Far bound of the frustum.", "name": "far" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#perspective", "scope": "instance", "___id": "T000002R026440", "___s": true }, { "comment": "/**\r\n * Generate a perspective projection matrix with the given bounds.\r\n *\r\n * @method Phaser.Math.Matrix4#perspectiveLH\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The width of the frustum.\r\n * @param {number} height - The height of the frustum.\r\n * @param {number} near - Near bound of the frustum.\r\n * @param {number} far - Far bound of the frustum.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 1246, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Generate a perspective projection matrix with the given bounds.", "kind": "function", "name": "perspectiveLH", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the frustum.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the frustum.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Near bound of the frustum.", "name": "near" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Far bound of the frustum.", "name": "far" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#perspectiveLH", "scope": "instance", "___id": "T000002R026444", "___s": true }, { "comment": "/**\r\n * Generate an orthogonal projection matrix with the given bounds.\r\n *\r\n * @method Phaser.Math.Matrix4#ortho\r\n * @since 3.0.0\r\n *\r\n * @param {number} left - The left bound of the frustum.\r\n * @param {number} right - The right bound of the frustum.\r\n * @param {number} bottom - The bottom bound of the frustum.\r\n * @param {number} top - The top bound of the frustum.\r\n * @param {number} near - The near bound of the frustum.\r\n * @param {number} far - The far bound of the frustum.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 1284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Generate an orthogonal projection matrix with the given bounds.", "kind": "function", "name": "ortho", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left bound of the frustum.", "name": "left" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The right bound of the frustum.", "name": "right" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom bound of the frustum.", "name": "bottom" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top bound of the frustum.", "name": "top" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The near bound of the frustum.", "name": "near" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The far bound of the frustum.", "name": "far" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#ortho", "scope": "instance", "___id": "T000002R026446", "___s": true }, { "comment": "/**\r\n * Generate a right-handed look-at matrix with the given eye position, target and up axis.\r\n *\r\n * @method Phaser.Math.Matrix4#lookAtRH\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Vector3} eye - Position of the viewer.\r\n * @param {Phaser.Math.Vector3} target - Point the viewer is looking at.\r\n * @param {Phaser.Math.Vector3} up - vec3 pointing up.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 1333, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Generate a right-handed look-at matrix with the given eye position, target and up axis.", "kind": "function", "name": "lookAtRH", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "Position of the viewer.", "name": "eye" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "Point the viewer is looking at.", "name": "target" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "vec3 pointing up.", "name": "up" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#lookAtRH", "scope": "instance", "___id": "T000002R026454", "___s": true }, { "comment": "/**\r\n * Generate a look-at matrix with the given eye position, focal point, and up axis.\r\n *\r\n * @method Phaser.Math.Matrix4#lookAt\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} eye - Position of the viewer\r\n * @param {Phaser.Math.Vector3} center - Point the viewer is looking at\r\n * @param {Phaser.Math.Vector3} up - vec3 pointing up.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 1393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Generate a look-at matrix with the given eye position, focal point, and up axis.", "kind": "function", "name": "lookAt", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "Position of the viewer", "name": "eye" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "Point the viewer is looking at", "name": "center" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "vec3 pointing up.", "name": "up" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#lookAt", "scope": "instance", "___id": "T000002R026469", "___s": true }, { "comment": "/**\r\n * Set the values of this matrix from the given `yaw`, `pitch` and `roll` values.\r\n *\r\n * @method Phaser.Math.Matrix4#yawPitchRoll\r\n * @since 3.0.0\r\n *\r\n * @param {number} yaw - The yaw value.\r\n * @param {number} pitch - The pitch value.\r\n * @param {number} roll - The roll value.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the values of this matrix from the given `yaw`, `pitch` and `roll` values.", "kind": "function", "name": "yawPitchRoll", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The yaw value.", "name": "yaw" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The pitch value.", "name": "pitch" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The roll value.", "name": "roll" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#yawPitchRoll", "scope": "instance", "___id": "T000002R026509", "___s": true }, { "comment": "/**\r\n * Generate a world matrix from the given rotation, position, scale, view matrix and projection matrix.\r\n *\r\n * @method Phaser.Math.Matrix4#setWorldMatrix\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} rotation - The rotation of the world matrix.\r\n * @param {Phaser.Math.Vector3} position - The position of the world matrix.\r\n * @param {Phaser.Math.Vector3} scale - The scale of the world matrix.\r\n * @param {Phaser.Math.Matrix4} [viewMatrix] - The view matrix.\r\n * @param {Phaser.Math.Matrix4} [projectionMatrix] - The projection matrix.\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 1560, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Generate a world matrix from the given rotation, position, scale, view matrix and projection matrix.", "kind": "function", "name": "setWorldMatrix", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The rotation of the world matrix.", "name": "rotation" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The position of the world matrix.", "name": "position" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The scale of the world matrix.", "name": "scale" }, { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "optional": true, "description": "The view matrix.", "name": "viewMatrix" }, { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "optional": true, "description": "The projection matrix.", "name": "projectionMatrix" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#setWorldMatrix", "scope": "instance", "___id": "T000002R026538", "___s": true }, { "comment": "/**\r\n * Multiplies this Matrix4 by the given `src` Matrix4 and stores the results in the `out` Matrix4.\r\n *\r\n * @method Phaser.Math.Matrix4#multiplyToMat4\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} src - The Matrix4 to multiply with this one.\r\n * @param {Phaser.Math.Matrix4} out - The receiving Matrix.\r\n *\r\n * @return {Phaser.Math.Matrix4} This `out` Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 1597, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Multiplies this Matrix4 by the given `src` Matrix4 and stores the results in the `out` Matrix4.", "kind": "function", "name": "multiplyToMat4", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to multiply with this one.", "name": "src" }, { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The receiving Matrix.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "This `out` Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#multiplyToMat4", "scope": "instance", "___id": "T000002R026540", "___s": true }, { "comment": "/**\r\n * Takes the rotation and position vectors and builds this Matrix4 from them.\r\n *\r\n * @method Phaser.Math.Matrix4#fromRotationXYTranslation\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Vector3} rotation - The rotation vector.\r\n * @param {Phaser.Math.Vector3} position - The position vector.\r\n * @param {boolean} translateFirst - Should the operation translate then rotate (`true`), or rotate then translate? (`false`)\r\n *\r\n * @return {this} This Matrix4.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 1670, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Takes the rotation and position vectors and builds this Matrix4 from them.", "kind": "function", "name": "fromRotationXYTranslation", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The rotation vector.", "name": "rotation" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The position vector.", "name": "position" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should the operation translate then rotate (`true`), or rotate then translate? (`false`)", "name": "translateFirst" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matrix4." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#fromRotationXYTranslation", "scope": "instance", "___id": "T000002R026576", "___s": true }, { "comment": "/**\r\n * Returns the maximum axis scale from this Matrix4.\r\n *\r\n * @method Phaser.Math.Matrix4#getMaxScaleOnAxis\r\n * @since 3.50.0\r\n *\r\n * @return {number} The maximum axis scale.\r\n */", "meta": { "filename": "Matrix4.js", "lineno": 1741, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Returns the maximum axis scale from this Matrix4.", "kind": "function", "name": "getMaxScaleOnAxis", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum axis scale." } ], "memberof": "Phaser.Math.Matrix4", "longname": "Phaser.Math.Matrix4#getMaxScaleOnAxis", "scope": "instance", "___id": "T000002R026596", "___s": true }, { "comment": "/**\r\n * Add an `amount` to a `value`, limiting the maximum result to `max`.\r\n *\r\n * @function Phaser.Math.MaxAdd\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value to add to.\r\n * @param {number} amount - The amount to add.\r\n * @param {number} max - The maximum value to return.\r\n *\r\n * @return {number} The resulting value.\r\n */", "meta": { "filename": "MaxAdd.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Add an `amount` to a `value`, limiting the maximum result to `max`.", "kind": "function", "name": "MaxAdd", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to add to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to add.", "name": "amount" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum value to return.", "name": "max" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resulting value." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.MaxAdd", "scope": "static", "___id": "T000002R026608", "___s": true }, { "comment": "/**\r\n * Calculate the median of the given values. The values are sorted and the middle value is returned.\r\n * In case of an even number of values, the average of the two middle values is returned.\r\n *\r\n * @function Phaser.Math.Median\r\n * @since 3.54.0\r\n *\r\n * @param {number[]} values - The values to average.\r\n *\r\n * @return {number} The median value.\r\n */", "meta": { "filename": "Median.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the median of the given values. The values are sorted and the middle value is returned.\rIn case of an even number of values, the average of the two middle values is returned.", "kind": "function", "name": "Median", "since": "3.54.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The values to average.", "name": "values" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The median value." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.Median", "scope": "static", "___id": "T000002R026611", "___s": true }, { "comment": "/**\r\n * Subtract an `amount` from `value`, limiting the minimum result to `min`.\r\n *\r\n * @function Phaser.Math.MinSub\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value to subtract from.\r\n * @param {number} amount - The amount to subtract.\r\n * @param {number} min - The minimum value to return.\r\n *\r\n * @return {number} The resulting value.\r\n */", "meta": { "filename": "MinSub.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Subtract an `amount` from `value`, limiting the minimum result to `min`.", "kind": "function", "name": "MinSub", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to subtract from.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to subtract.", "name": "amount" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum value to return.", "name": "min" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resulting value." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.MinSub", "scope": "static", "___id": "T000002R026616", "___s": true }, { "comment": "/**\r\n * Work out what percentage `value` is of the range between `min` and `max`.\r\n * If `max` isn't given then it will return the percentage of `value` to `min`.\r\n *\r\n * You can optionally specify an `upperMax` value, which is a mid-way point in the range that represents 100%, after which the % starts to go down to zero again.\r\n *\r\n * @function Phaser.Math.Percent\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value to determine the percentage of.\r\n * @param {number} min - The minimum value.\r\n * @param {number} [max] - The maximum value.\r\n * @param {number} [upperMax] - The mid-way point in the range that represents 100%.\r\n *\r\n * @return {number} A value between 0 and 1 representing the percentage.\r\n */", "meta": { "filename": "Percent.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Work out what percentage `value` is of the range between `min` and `max`.\rIf `max` isn't given then it will return the percentage of `value` to `min`.\r\rYou can optionally specify an `upperMax` value, which is a mid-way point in the range that represents 100%, after which the % starts to go down to zero again.", "kind": "function", "name": "Percent", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to determine the percentage of.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum value.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The maximum value.", "name": "max" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The mid-way point in the range that represents 100%.", "name": "upperMax" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A value between 0 and 1 representing the percentage." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.Percent", "scope": "static", "___id": "T000002R026619", "___s": true }, { "comment": "/**\r\n * Returns the nearest power of 2 to the given `value`.\r\n *\r\n * @function Phaser.Math.Pow2.GetNext\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value.\r\n *\r\n * @return {number} The nearest power of 2 to `value`.\r\n */", "meta": { "filename": "GetPowerOfTwo.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\pow2", "code": {} }, "description": "Returns the nearest power of 2 to the given `value`.", "kind": "function", "name": "GetNext", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value.", "name": "value" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The nearest power of 2 to `value`." } ], "memberof": "Phaser.Math.Pow2", "longname": "Phaser.Math.Pow2.GetNext", "scope": "static", "___id": "T000002R026628", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Pow2\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\pow2", "code": {} }, "kind": "namespace", "name": "Pow2", "memberof": "Phaser.Math", "longname": "Phaser.Math.Pow2", "scope": "static", "___id": "T000002R026632", "___s": true }, { "comment": "/**\r\n * Checks if the given `width` and `height` are a power of two.\r\n * Useful for checking texture dimensions.\r\n *\r\n * @function Phaser.Math.Pow2.IsSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The width.\r\n * @param {number} height - The height.\r\n *\r\n * @return {boolean} `true` if `width` and `height` are a power of two, otherwise `false`.\r\n */", "meta": { "filename": "IsSizePowerOfTwo.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\pow2", "code": {} }, "description": "Checks if the given `width` and `height` are a power of two.\rUseful for checking texture dimensions.", "kind": "function", "name": "IsSize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height.", "name": "height" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if `width` and `height` are a power of two, otherwise `false`." } ], "memberof": "Phaser.Math.Pow2", "longname": "Phaser.Math.Pow2.IsSize", "scope": "static", "___id": "T000002R026637", "___s": true }, { "comment": "/**\r\n * Tests the value and returns `true` if it is a power of two.\r\n *\r\n * @function Phaser.Math.Pow2.IsValue\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value to check if it's a power of two.\r\n *\r\n * @return {boolean} Returns `true` if `value` is a power of two, otherwise `false`.\r\n */", "meta": { "filename": "IsValuePowerOfTwo.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\pow2", "code": {} }, "description": "Tests the value and returns `true` if it is a power of two.", "kind": "function", "name": "IsValue", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to check if it's a power of two.", "name": "value" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `true` if `value` is a power of two, otherwise `false`." } ], "memberof": "Phaser.Math.Pow2", "longname": "Phaser.Math.Pow2.IsValue", "scope": "static", "___id": "T000002R026640", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A quaternion.\r\n *\r\n * @class Quaternion\r\n * @memberof Phaser.Math\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The x component.\r\n * @param {number} [y=0] - The y component.\r\n * @param {number} [z=0] - The z component.\r\n * @param {number} [w=1] - The w component.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 27, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "classdesc": "A quaternion.", "kind": "class", "name": "Quaternion", "memberof": "Phaser.Math", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x component.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y component.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z component.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The w component.", "name": "w" } ], "scope": "static", "longname": "Phaser.Math.Quaternion", "___id": "T000002R026654", "___s": true }, { "comment": "/**\r\n * This callback is invoked, if set, each time a value in this quaternion is changed.\r\n * The callback is passed one argument, a reference to this quaternion.\r\n *\r\n * @name Phaser.Math.Quaternion#onChangeCallback\r\n * @type {function}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 87, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "This callback is invoked, if set, each time a value in this quaternion is changed.\rThe callback is passed one argument, a reference to this quaternion.", "name": "onChangeCallback", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.50.0", "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#onChangeCallback", "scope": "instance", "kind": "member", "___id": "T000002R026661", "___s": true }, { "comment": "/**\r\n * The x component of this Quaternion.\r\n *\r\n * @name Phaser.Math.Quaternion#x\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The x component of this Quaternion.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#x", "scope": "instance", "kind": "member", "___id": "T000002R026663", "___s": true }, { "comment": "/**\r\n * The y component of this Quaternion.\r\n *\r\n * @name Phaser.Math.Quaternion#y\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 122, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The y component of this Quaternion.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#y", "scope": "instance", "kind": "member", "___id": "T000002R026668", "___s": true }, { "comment": "/**\r\n * The z component of this Quaternion.\r\n *\r\n * @name Phaser.Math.Quaternion#z\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The z component of this Quaternion.", "name": "z", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#z", "scope": "instance", "kind": "member", "___id": "T000002R026673", "___s": true }, { "comment": "/**\r\n * The w component of this Quaternion.\r\n *\r\n * @name Phaser.Math.Quaternion#w\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The w component of this Quaternion.", "name": "w", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#w", "scope": "instance", "kind": "member", "___id": "T000002R026678", "___s": true }, { "comment": "/**\r\n * Copy the components of a given Quaternion or Vector into this Quaternion.\r\n *\r\n * @method Phaser.Math.Quaternion#copy\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Quaternion|Phaser.Math.Vector4)} src - The Quaternion or Vector to copy the components from.\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 188, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Copy the components of a given Quaternion or Vector into this Quaternion.", "kind": "function", "name": "copy", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Quaternion", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Quaternion" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Quaternion or Vector to copy the components from.", "name": "src" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#copy", "scope": "instance", "___id": "T000002R026683", "___s": true }, { "comment": "/**\r\n * Set the components of this Quaternion and optionally call the `onChangeCallback`.\r\n *\r\n * @method Phaser.Math.Quaternion#set\r\n * @since 3.0.0\r\n *\r\n * @param {(number|object)} [x=0] - The x component, or an object containing x, y, z, and w components.\r\n * @param {number} [y=0] - The y component.\r\n * @param {number} [z=0] - The z component.\r\n * @param {number} [w=0] - The w component.\r\n * @param {boolean} [update=true] - Call the `onChangeCallback`?\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 203, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the components of this Quaternion and optionally call the `onChangeCallback`.", "kind": "function", "name": "set", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "defaultvalue": 0, "description": "The x component, or an object containing x, y, z, and w components.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y component.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z component.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w component.", "name": "w" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Call the `onChangeCallback`?", "name": "update" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#set", "scope": "instance", "___id": "T000002R026685", "___s": true }, { "comment": "/**\r\n * Add a given Quaternion or Vector to this Quaternion. Addition is component-wise.\r\n *\r\n * @method Phaser.Math.Quaternion#add\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Quaternion|Phaser.Math.Vector4)} v - The Quaternion or Vector to add to this Quaternion.\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 244, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Add a given Quaternion or Vector to this Quaternion. Addition is component-wise.", "kind": "function", "name": "add", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Quaternion", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Quaternion" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Quaternion or Vector to add to this Quaternion.", "name": "v" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#add", "scope": "instance", "___id": "T000002R026696", "___s": true }, { "comment": "/**\r\n * Subtract a given Quaternion or Vector from this Quaternion. Subtraction is component-wise.\r\n *\r\n * @method Phaser.Math.Quaternion#subtract\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Quaternion|Phaser.Math.Vector4)} v - The Quaternion or Vector to subtract from this Quaternion.\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 266, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Subtract a given Quaternion or Vector from this Quaternion. Subtraction is component-wise.", "kind": "function", "name": "subtract", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Quaternion", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Quaternion" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Quaternion or Vector to subtract from this Quaternion.", "name": "v" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#subtract", "scope": "instance", "___id": "T000002R026702", "___s": true }, { "comment": "/**\r\n * Scale this Quaternion by the given value.\r\n *\r\n * @method Phaser.Math.Quaternion#scale\r\n * @since 3.0.0\r\n *\r\n * @param {number} scale - The value to scale this Quaternion by.\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Scale this Quaternion by the given value.", "kind": "function", "name": "scale", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to scale this Quaternion by.", "name": "scale" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#scale", "scope": "instance", "___id": "T000002R026708", "___s": true }, { "comment": "/**\r\n * Calculate the length of this Quaternion.\r\n *\r\n * @method Phaser.Math.Quaternion#length\r\n * @since 3.0.0\r\n *\r\n * @return {number} The length of this Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 310, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the length of this Quaternion.", "kind": "function", "name": "length", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length of this Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#length", "scope": "instance", "___id": "T000002R026714", "___s": true }, { "comment": "/**\r\n * Calculate the length of this Quaternion squared.\r\n *\r\n * @method Phaser.Math.Quaternion#lengthSq\r\n * @since 3.0.0\r\n *\r\n * @return {number} The length of this Quaternion, squared.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 328, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the length of this Quaternion squared.", "kind": "function", "name": "lengthSq", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length of this Quaternion, squared." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#lengthSq", "scope": "instance", "___id": "T000002R026720", "___s": true }, { "comment": "/**\r\n * Normalize this Quaternion.\r\n *\r\n * @method Phaser.Math.Quaternion#normalize\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 346, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Normalize this Quaternion.", "kind": "function", "name": "normalize", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#normalize", "scope": "instance", "___id": "T000002R026726", "___s": true }, { "comment": "/**\r\n * Calculate the dot product of this Quaternion and the given Quaternion or Vector.\r\n *\r\n * @method Phaser.Math.Quaternion#dot\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Quaternion|Phaser.Math.Vector4)} v - The Quaternion or Vector to dot product with this Quaternion.\r\n *\r\n * @return {number} The dot product of this Quaternion and the given Quaternion or Vector.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 377, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the dot product of this Quaternion and the given Quaternion or Vector.", "kind": "function", "name": "dot", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Quaternion", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Quaternion" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Quaternion or Vector to dot product with this Quaternion.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The dot product of this Quaternion and the given Quaternion or Vector." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#dot", "scope": "instance", "___id": "T000002R026738", "___s": true }, { "comment": "/**\r\n * Linearly interpolate this Quaternion towards the given Quaternion or Vector.\r\n *\r\n * @method Phaser.Math.Quaternion#lerp\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Quaternion|Phaser.Math.Vector4)} v - The Quaternion or Vector to interpolate towards.\r\n * @param {number} [t=0] - The percentage of interpolation.\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Linearly interpolate this Quaternion towards the given Quaternion or Vector.", "kind": "function", "name": "lerp", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Quaternion", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Quaternion" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Quaternion or Vector to interpolate towards.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The percentage of interpolation.", "name": "t" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#lerp", "scope": "instance", "___id": "T000002R026740", "___s": true }, { "comment": "/**\r\n * Rotates this Quaternion based on the two given vectors.\r\n *\r\n * @method Phaser.Math.Quaternion#rotationTo\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} a - The transform rotation vector.\r\n * @param {Phaser.Math.Vector3} b - The target rotation vector.\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 420, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Rotates this Quaternion based on the two given vectors.", "kind": "function", "name": "rotationTo", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The transform rotation vector.", "name": "a" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The target rotation vector.", "name": "b" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#rotationTo", "scope": "instance", "___id": "T000002R026747", "___s": true }, { "comment": "/**\r\n * Set the axes of this Quaternion.\r\n *\r\n * @method Phaser.Math.Quaternion#setAxes\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} view - The view axis.\r\n * @param {Phaser.Math.Vector3} right - The right axis.\r\n * @param {Phaser.Math.Vector3} up - The upwards axis.\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the axes of this Quaternion.", "kind": "function", "name": "setAxes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The view axis.", "name": "view" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The right axis.", "name": "right" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The upwards axis.", "name": "up" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#setAxes", "scope": "instance", "___id": "T000002R026754", "___s": true }, { "comment": "/**\r\n * Reset this Matrix to an identity (default) Quaternion.\r\n *\r\n * @method Phaser.Math.Quaternion#identity\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Reset this Matrix to an identity (default) Quaternion.", "kind": "function", "name": "identity", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#identity", "scope": "instance", "___id": "T000002R026766", "___s": true }, { "comment": "/**\r\n * Set the axis angle of this Quaternion.\r\n *\r\n * @method Phaser.Math.Quaternion#setAxisAngle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} axis - The axis.\r\n * @param {number} rad - The angle in radians.\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 508, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the axis angle of this Quaternion.", "kind": "function", "name": "setAxisAngle", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The axis.", "name": "axis" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle in radians.", "name": "rad" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#setAxisAngle", "scope": "instance", "___id": "T000002R026768", "___s": true }, { "comment": "/**\r\n * Multiply this Quaternion by the given Quaternion or Vector.\r\n *\r\n * @method Phaser.Math.Quaternion#multiply\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Quaternion|Phaser.Math.Vector4)} b - The Quaternion or Vector to multiply this Quaternion by.\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 533, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Multiply this Quaternion by the given Quaternion or Vector.", "kind": "function", "name": "multiply", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Quaternion", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Quaternion" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Quaternion or Vector to multiply this Quaternion by.", "name": "b" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#multiply", "scope": "instance", "___id": "T000002R026772", "___s": true }, { "comment": "/**\r\n * Smoothly linearly interpolate this Quaternion towards the given Quaternion or Vector.\r\n *\r\n * @method Phaser.Math.Quaternion#slerp\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Quaternion|Phaser.Math.Vector4)} b - The Quaternion or Vector to interpolate towards.\r\n * @param {number} t - The percentage of interpolation.\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 563, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Smoothly linearly interpolate this Quaternion towards the given Quaternion or Vector.", "kind": "function", "name": "slerp", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Quaternion", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Quaternion" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Quaternion or Vector to interpolate towards.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The percentage of interpolation.", "name": "t" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#slerp", "scope": "instance", "___id": "T000002R026782", "___s": true }, { "comment": "/**\r\n * Invert this Quaternion.\r\n *\r\n * @method Phaser.Math.Quaternion#invert\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 626, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Invert this Quaternion.", "kind": "function", "name": "invert", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#invert", "scope": "instance", "___id": "T000002R026804", "___s": true }, { "comment": "/**\r\n * Convert this Quaternion into its conjugate.\r\n *\r\n * Sets the x, y and z components.\r\n *\r\n * @method Phaser.Math.Quaternion#conjugate\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 652, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Convert this Quaternion into its conjugate.\r\rSets the x, y and z components.", "kind": "function", "name": "conjugate", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#conjugate", "scope": "instance", "___id": "T000002R026812", "___s": true }, { "comment": "/**\r\n * Rotate this Quaternion on the X axis.\r\n *\r\n * @method Phaser.Math.Quaternion#rotateX\r\n * @since 3.0.0\r\n *\r\n * @param {number} rad - The rotation angle in radians.\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Rotate this Quaternion on the X axis.", "kind": "function", "name": "rotateX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rotation angle in radians.", "name": "rad" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#rotateX", "scope": "instance", "___id": "T000002R026817", "___s": true }, { "comment": "/**\r\n * Rotate this Quaternion on the Y axis.\r\n *\r\n * @method Phaser.Math.Quaternion#rotateY\r\n * @since 3.0.0\r\n *\r\n * @param {number} rad - The rotation angle in radians.\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 703, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Rotate this Quaternion on the Y axis.", "kind": "function", "name": "rotateY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rotation angle in radians.", "name": "rad" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#rotateY", "scope": "instance", "___id": "T000002R026826", "___s": true }, { "comment": "/**\r\n * Rotate this Quaternion on the Z axis.\r\n *\r\n * @method Phaser.Math.Quaternion#rotateZ\r\n * @since 3.0.0\r\n *\r\n * @param {number} rad - The rotation angle in radians.\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 733, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Rotate this Quaternion on the Z axis.", "kind": "function", "name": "rotateZ", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rotation angle in radians.", "name": "rad" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#rotateZ", "scope": "instance", "___id": "T000002R026835", "___s": true }, { "comment": "/**\r\n * Create a unit (or rotation) Quaternion from its x, y, and z components.\r\n *\r\n * Sets the w component.\r\n *\r\n * @method Phaser.Math.Quaternion#calculateW\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 763, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Create a unit (or rotation) Quaternion from its x, y, and z components.\r\rSets the w component.", "kind": "function", "name": "calculateW", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#calculateW", "scope": "instance", "___id": "T000002R026844", "___s": true }, { "comment": "/**\r\n * Set this Quaternion from the given Euler, based on Euler order.\r\n *\r\n * @method Phaser.Math.Quaternion#setFromEuler\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Euler} euler - The Euler to convert from.\r\n * @param {boolean} [update=true] - Run the `onChangeCallback`?\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 784, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set this Quaternion from the given Euler, based on Euler order.", "kind": "function", "name": "setFromEuler", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Euler" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Euler" } }, "description": "The Euler to convert from.", "name": "euler" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Run the `onChangeCallback`?", "name": "update" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#setFromEuler", "scope": "instance", "___id": "T000002R026850", "___s": true }, { "comment": "/**\r\n * Sets the rotation of this Quaternion from the given Matrix4.\r\n *\r\n * @method Phaser.Math.Quaternion#setFromRotationMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} mat4 - The Matrix4 to set the rotation from.\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 893, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Sets the rotation of this Quaternion from the given Matrix4.", "kind": "function", "name": "setFromRotationMatrix", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to set the rotation from.", "name": "mat4" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#setFromRotationMatrix", "scope": "instance", "___id": "T000002R026861", "___s": true }, { "comment": "/**\r\n * Convert the given Matrix into this Quaternion.\r\n *\r\n * @method Phaser.Math.Quaternion#fromMat3\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix3} mat - The Matrix to convert from.\r\n *\r\n * @return {Phaser.Math.Quaternion} This Quaternion.\r\n */", "meta": { "filename": "Quaternion.js", "lineno": 968, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Convert the given Matrix into this Quaternion.", "kind": "function", "name": "fromMat3", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "The Matrix to convert from.", "name": "mat" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "This Quaternion." } ], "memberof": "Phaser.Math.Quaternion", "longname": "Phaser.Math.Quaternion#fromMat3", "scope": "instance", "___id": "T000002R026879", "___s": true }, { "comment": "/**\r\n * Convert the given angle in radians, to the equivalent angle in degrees.\r\n *\r\n * @function Phaser.Math.RadToDeg\r\n * @since 3.0.0\r\n *\r\n * @param {number} radians - The angle in radians to convert ot degrees.\r\n *\r\n * @return {number} The given angle converted to degrees.\r\n */", "meta": { "filename": "RadToDeg.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Convert the given angle in radians, to the equivalent angle in degrees.", "kind": "function", "name": "RadToDeg", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle in radians to convert ot degrees.", "name": "radians" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The given angle converted to degrees." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.RadToDeg", "scope": "static", "___id": "T000002R026906", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A seeded Random Data Generator.\r\n *\r\n * Access via `Phaser.Math.RND` which is an instance of this class pre-defined\r\n * by Phaser. Or, create your own instance to use as you require.\r\n *\r\n * The `Math.RND` generator is seeded by the Game Config property value `seed`.\r\n * If no such config property exists, a random number is used.\r\n *\r\n * If you create your own instance of this class you should provide a seed for it.\r\n * If no seed is given it will use a 'random' one based on Date.now.\r\n *\r\n * @class RandomDataGenerator\r\n * @memberof Phaser.Math\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {(string|string[])} [seeds] - The seeds to use for the random number generator.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "classdesc": "A seeded Random Data Generator.\r\rAccess via `Phaser.Math.RND` which is an instance of this class pre-defined\rby Phaser. Or, create your own instance to use as you require.\r\rThe `Math.RND` generator is seeded by the Game Config property value `seed`.\rIf no such config property exists, a random number is used.\r\rIf you create your own instance of this class you should provide a seed for it.\rIf no seed is given it will use a 'random' one based on Date.now.", "kind": "class", "name": "RandomDataGenerator", "memberof": "Phaser.Math", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The seeds to use for the random number generator.", "name": "seeds" } ], "scope": "static", "longname": "Phaser.Math.RandomDataGenerator", "___id": "T000002R026910", "___s": true }, { "comment": "/**\r\n * Signs to choose from.\r\n *\r\n * @name Phaser.Math.RandomDataGenerator#signs\r\n * @type {number[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Signs to choose from.", "name": "signs", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#signs", "scope": "instance", "kind": "member", "___id": "T000002R026924", "___s": true }, { "comment": "/**\r\n * Initialize the state of the random data generator.\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#init\r\n * @since 3.0.0\r\n *\r\n * @param {(string|string[])} seeds - The seeds to initialize the random data generator with.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 163, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Initialize the state of the random data generator.", "kind": "function", "name": "init", "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 seeds to initialize the random data generator with.", "name": "seeds" } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#init", "scope": "instance", "___id": "T000002R026948", "___s": true }, { "comment": "/**\r\n * Reset the seed of the random data generator.\r\n *\r\n * _Note_: the seed array is only processed up to the first `undefined` (or `null`) value, should such be present.\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#sow\r\n * @since 3.0.0\r\n *\r\n * @param {string[]} seeds - The array of seeds: the `toString()` of each value is used.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Reset the seed of the random data generator.\r\r_Note_: the seed array is only processed up to the first `undefined` (or `null`) value, should such be present.", "kind": "function", "name": "sow", "since": "3.0.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "The array of seeds: the `toString()` of each value is used.", "name": "seeds" } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#sow", "scope": "instance", "___id": "T000002R026950", "___s": true }, { "comment": "/**\r\n * Returns a random integer between 0 and 2^32.\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#integer\r\n * @since 3.0.0\r\n *\r\n * @return {number} A random integer between 0 and 2^32.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 221, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Returns a random integer between 0 and 2^32.", "kind": "function", "name": "integer", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A random integer between 0 and 2^32." } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#integer", "scope": "instance", "___id": "T000002R026965", "___s": true }, { "comment": "/**\r\n * Returns a random real number between 0 and 1.\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#frac\r\n * @since 3.0.0\r\n *\r\n * @return {number} A random real number between 0 and 1.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 235, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Returns a random real number between 0 and 1.", "kind": "function", "name": "frac", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A random real number between 0 and 1." } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#frac", "scope": "instance", "___id": "T000002R026967", "___s": true }, { "comment": "/**\r\n * Returns a random real number between 0 and 2^32.\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#real\r\n * @since 3.0.0\r\n *\r\n * @return {number} A random real number between 0 and 2^32.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 249, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Returns a random real number between 0 and 2^32.", "kind": "function", "name": "real", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A random real number between 0 and 2^32." } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#real", "scope": "instance", "___id": "T000002R026969", "___s": true }, { "comment": "/**\r\n * Returns a random integer between and including min and max.\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#integerInRange\r\n * @since 3.0.0\r\n *\r\n * @param {number} min - The minimum value in the range.\r\n * @param {number} max - The maximum value in the range.\r\n *\r\n * @return {number} A random number between min and max.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Returns a random integer between and including min and max.", "kind": "function", "name": "integerInRange", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum value in the range.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum value in the range.", "name": "max" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A random number between min and max." } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#integerInRange", "scope": "instance", "___id": "T000002R026971", "___s": true }, { "comment": "/**\r\n * Returns a random integer between and including min and max.\r\n * This method is an alias for RandomDataGenerator.integerInRange.\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#between\r\n * @since 3.0.0\r\n *\r\n * @param {number} min - The minimum value in the range.\r\n * @param {number} max - The maximum value in the range.\r\n *\r\n * @return {number} A random number between min and max.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 278, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Returns a random integer between and including min and max.\rThis method is an alias for RandomDataGenerator.integerInRange.", "kind": "function", "name": "between", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum value in the range.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum value in the range.", "name": "max" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A random number between min and max." } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#between", "scope": "instance", "___id": "T000002R026973", "___s": true }, { "comment": "/**\r\n * Returns a random real number between min and max.\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#realInRange\r\n * @since 3.0.0\r\n *\r\n * @param {number} min - The minimum value in the range.\r\n * @param {number} max - The maximum value in the range.\r\n *\r\n * @return {number} A random number between min and max.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Returns a random real number between min and max.", "kind": "function", "name": "realInRange", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum value in the range.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum value in the range.", "name": "max" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A random number between min and max." } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#realInRange", "scope": "instance", "___id": "T000002R026975", "___s": true }, { "comment": "/**\r\n * Returns a random real number between -1 and 1.\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#normal\r\n * @since 3.0.0\r\n *\r\n * @return {number} A random real number between -1 and 1.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 311, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Returns a random real number between -1 and 1.", "kind": "function", "name": "normal", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A random real number between -1 and 1." } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#normal", "scope": "instance", "___id": "T000002R026977", "___s": true }, { "comment": "/**\r\n * Returns a valid RFC4122 version4 ID hex string from https://gist.github.com/1308368\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#uuid\r\n * @since 3.0.0\r\n *\r\n * @return {string} A valid RFC4122 version4 ID hex string\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 324, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Returns a valid RFC4122 version4 ID hex string from https://gist.github.com/1308368", "kind": "function", "name": "uuid", "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A valid RFC4122 version4 ID hex string" } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#uuid", "scope": "instance", "___id": "T000002R026979", "___s": true }, { "comment": "/**\r\n * Returns a random element from within the given array.\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#pick\r\n * @since 3.0.0\r\n *\r\n * @generic T\r\n * @genericUse {T[]} - [array]\r\n * @genericUse {T} - [$return]\r\n *\r\n * @param {T[]} array - The array to pick a random element from.\r\n *\r\n * @return {T} A random member of the array.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 345, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Returns a random element from within the given array.", "kind": "function", "name": "pick", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [array]", "value": "{T[]} - [array]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$return]", "value": "{T} - [$return]" } ], "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } }, "description": "The array to pick a random element from.", "name": "array" } ], "returns": [ { "type": { "names": [ "T" ], "parsedType": { "type": "NameExpression", "name": "T" } }, "description": "A random member of the array." } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#pick", "scope": "instance", "___id": "T000002R026986", "___s": true }, { "comment": "/**\r\n * Returns a sign to be used with multiplication operator.\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#sign\r\n * @since 3.0.0\r\n *\r\n * @return {number} -1 or +1.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 364, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Returns a sign to be used with multiplication operator.", "kind": "function", "name": "sign", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "-1 or +1." } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#sign", "scope": "instance", "___id": "T000002R026988", "___s": true }, { "comment": "/**\r\n * Returns a random element from within the given array, favoring the earlier entries.\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#weightedPick\r\n * @since 3.0.0\r\n *\r\n * @generic T\r\n * @genericUse {T[]} - [array]\r\n * @genericUse {T} - [$return]\r\n *\r\n * @param {T[]} array - The array to pick a random element from.\r\n *\r\n * @return {T} A random member of the array.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 377, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Returns a random element from within the given array, favoring the earlier entries.", "kind": "function", "name": "weightedPick", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [array]", "value": "{T[]} - [array]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$return]", "value": "{T} - [$return]" } ], "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } }, "description": "The array to pick a random element from.", "name": "array" } ], "returns": [ { "type": { "names": [ "T" ], "parsedType": { "type": "NameExpression", "name": "T" } }, "description": "A random member of the array." } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#weightedPick", "scope": "instance", "___id": "T000002R026990", "___s": true }, { "comment": "/**\r\n * Returns a random timestamp between min and max, or between the beginning of 2000 and the end of 2020 if min and max aren't specified.\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#timestamp\r\n * @since 3.0.0\r\n *\r\n * @param {number} min - The minimum value in the range.\r\n * @param {number} max - The maximum value in the range.\r\n *\r\n * @return {number} A random timestamp between min and max.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 396, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Returns a random timestamp between min and max, or between the beginning of 2000 and the end of 2020 if min and max aren't specified.", "kind": "function", "name": "timestamp", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum value in the range.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum value in the range.", "name": "max" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A random timestamp between min and max." } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#timestamp", "scope": "instance", "___id": "T000002R026992", "___s": true }, { "comment": "/**\r\n * Returns a random angle between -180 and 180.\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#angle\r\n * @since 3.0.0\r\n *\r\n * @return {number} A random number between -180 and 180.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Returns a random angle between -180 and 180.", "kind": "function", "name": "angle", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A random number between -180 and 180." } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#angle", "scope": "instance", "___id": "T000002R026994", "___s": true }, { "comment": "/**\r\n * Returns a random rotation in radians, between -3.141 and 3.141\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#rotation\r\n * @since 3.0.0\r\n *\r\n * @return {number} A random number between -3.141 and 3.141\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 425, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Returns a random rotation in radians, between -3.141 and 3.141", "kind": "function", "name": "rotation", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A random number between -3.141 and 3.141" } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#rotation", "scope": "instance", "___id": "T000002R026996", "___s": true }, { "comment": "/**\r\n * Gets or Sets the state of the generator. This allows you to retain the values\r\n * that the generator is using between games, i.e. in a game save file.\r\n *\r\n * To seed this generator with a previously saved state you can pass it as the\r\n * `seed` value in your game config, or call this method directly after Phaser has booted.\r\n *\r\n * Call this method with no parameters to return the current state.\r\n *\r\n * If providing a state it should match the same format that this method\r\n * returns, which is a string with a header `!rnd` followed by the `c`,\r\n * `s0`, `s1` and `s2` values respectively, each comma-delimited.\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#state\r\n * @since 3.0.0\r\n *\r\n * @param {string} [state] - Generator state to be set.\r\n *\r\n * @return {string} The current state of the generator.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 438, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Gets or Sets the state of the generator. This allows you to retain the values\rthat the generator is using between games, i.e. in a game save file.\r\rTo seed this generator with a previously saved state you can pass it as the\r`seed` value in your game config, or call this method directly after Phaser has booted.\r\rCall this method with no parameters to return the current state.\r\rIf providing a state it should match the same format that this method\rreturns, which is a string with a header `!rnd` followed by the `c`,\r`s0`, `s1` and `s2` values respectively, each comma-delimited.", "kind": "function", "name": "state", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Generator state to be set.", "name": "state" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The current state of the generator." } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#state", "scope": "instance", "___id": "T000002R026998", "___s": true }, { "comment": "/**\r\n * Shuffles the given array, using the current seed.\r\n *\r\n * @method Phaser.Math.RandomDataGenerator#shuffle\r\n * @since 3.7.0\r\n *\r\n * @generic T\r\n * @genericUse {T[]} - [array,$return]\r\n *\r\n * @param {T[]} [array] - The array to be shuffled.\r\n *\r\n * @return {T[]} The shuffled array.\r\n */", "meta": { "filename": "RandomDataGenerator.js", "lineno": 473, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math\\random-data-generator", "code": {} }, "description": "Shuffles the given array, using the current seed.", "kind": "function", "name": "shuffle", "since": "3.7.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [array,$return]", "value": "{T[]} - [array,$return]" } ], "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } }, "optional": true, "description": "The array to be shuffled.", "name": "array" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } }, "description": "The shuffled array." } ], "memberof": "Phaser.Math.RandomDataGenerator", "longname": "Phaser.Math.RandomDataGenerator#shuffle", "scope": "instance", "___id": "T000002R027005", "___s": true }, { "comment": "/**\r\n * Compute a random unit vector.\r\n *\r\n * Computes random values for the given vector between -1 and 1 that can be used to represent a direction.\r\n *\r\n * Optionally accepts a scale value to scale the resulting vector by.\r\n *\r\n * @function Phaser.Math.RandomXY\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector2} vector - The Vector to compute random values for.\r\n * @param {number} [scale=1] - The scale of the random values.\r\n *\r\n * @return {Phaser.Math.Vector2} The given Vector.\r\n */", "meta": { "filename": "RandomXY.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Compute a random unit vector.\r\rComputes random values for the given vector between -1 and 1 that can be used to represent a direction.\r\rOptionally accepts a scale value to scale the resulting vector by.", "kind": "function", "name": "RandomXY", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The Vector to compute random values for.", "name": "vector" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The scale of the random values.", "name": "scale" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The given Vector." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.RandomXY", "scope": "static", "___id": "T000002R027014", "___s": true }, { "comment": "/**\r\n * Compute a random position vector in a spherical area, optionally defined by the given radius.\r\n *\r\n * @function Phaser.Math.RandomXYZ\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} vec3 - The Vector to compute random values for.\r\n * @param {number} [radius=1] - The radius.\r\n *\r\n * @return {Phaser.Math.Vector3} The given Vector.\r\n */", "meta": { "filename": "RandomXYZ.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Compute a random position vector in a spherical area, optionally defined by the given radius.", "kind": "function", "name": "RandomXYZ", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The Vector to compute random values for.", "name": "vec3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The radius.", "name": "radius" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The given Vector." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.RandomXYZ", "scope": "static", "___id": "T000002R027021", "___s": true }, { "comment": "/**\r\n * Compute a random four-dimensional vector.\r\n *\r\n * @function Phaser.Math.RandomXYZW\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector4} vec4 - The Vector to compute random values for.\r\n * @param {number} [scale=1] - The scale of the random values.\r\n *\r\n * @return {Phaser.Math.Vector4} The given Vector.\r\n */", "meta": { "filename": "RandomXYZW.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Compute a random four-dimensional vector.", "kind": "function", "name": "RandomXYZW", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "The Vector to compute random values for.", "name": "vec4" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The scale of the random values.", "name": "scale" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "The given Vector." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.RandomXYZW", "scope": "static", "___id": "T000002R027031", "___s": true }, { "comment": "/**\r\n * Rotate a given point by a given angle around the origin (0, 0), in an anti-clockwise direction.\r\n *\r\n * @function Phaser.Math.Rotate\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Geom.Point|object)} point - The point to be rotated.\r\n * @param {number} angle - The angle to be rotated by in an anticlockwise direction.\r\n *\r\n * @return {Phaser.Geom.Point} The given point, rotated by the given angle in an anticlockwise direction.\r\n */", "meta": { "filename": "Rotate.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Rotate a given point by a given angle around the origin (0, 0), in an anti-clockwise direction.", "kind": "function", "name": "Rotate", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The point to be rotated.", "name": "point" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle to be rotated by in an anticlockwise direction.", "name": "angle" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Point" } }, "description": "The given point, rotated by the given angle in an anticlockwise direction." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.Rotate", "scope": "static", "___id": "T000002R027039", "___s": true }, { "comment": "/**\r\n * Rotate a `point` around `x` and `y` to the given `angle`, at the same distance.\r\n *\r\n * In polar notation, this maps a point from (r, t) to (r, angle), vs. the origin (x, y).\r\n *\r\n * @function Phaser.Math.RotateAround\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Types.Math.Vector2Like} T - [point,$return]\r\n *\r\n * @param {(Phaser.Geom.Point|object)} point - The point to be rotated.\r\n * @param {number} x - The horizontal coordinate to rotate around.\r\n * @param {number} y - The vertical coordinate to rotate around.\r\n * @param {number} angle - The angle of rotation in radians.\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The given point.\r\n */", "meta": { "filename": "RotateAround.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Rotate a `point` around `x` and `y` to the given `angle`, at the same distance.\r\rIn polar notation, this maps a point from (r, t) to (r, angle), vs. the origin (x, y).", "kind": "function", "name": "RotateAround", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Types.Math.Vector2Like} T - [point,$return]", "value": "{Phaser.Types.Math.Vector2Like} T - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The point to be rotated.", "name": "point" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate to rotate around.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate to rotate around.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle of rotation in radians.", "name": "angle" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The given point." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.RotateAround", "scope": "static", "___id": "T000002R027046", "___s": true }, { "comment": "/**\r\n * Rotate a `point` around `x` and `y` by the given `angle` and `distance`.\r\n *\r\n * In polar notation, this maps a point from (r, t) to (distance, t + angle), vs. the origin (x, y).\r\n *\r\n * @function Phaser.Math.RotateAroundDistance\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Types.Math.Vector2Like} T - [point,$return]\r\n *\r\n * @param {(Phaser.Geom.Point|object)} point - The point to be rotated.\r\n * @param {number} x - The horizontal coordinate to rotate around.\r\n * @param {number} y - The vertical coordinate to rotate around.\r\n * @param {number} angle - The angle of rotation in radians.\r\n * @param {number} distance - The distance from (x, y) to place the point at.\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The given point.\r\n */", "meta": { "filename": "RotateAroundDistance.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Rotate a `point` around `x` and `y` by the given `angle` and `distance`.\r\rIn polar notation, this maps a point from (r, t) to (distance, t + angle), vs. the origin (x, y).", "kind": "function", "name": "RotateAroundDistance", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Types.Math.Vector2Like} T - [point,$return]", "value": "{Phaser.Types.Math.Vector2Like} T - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The point to be rotated.", "name": "point" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate to rotate around.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate to rotate around.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle of rotation in radians.", "name": "angle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance from (x, y) to place the point at.", "name": "distance" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The given point." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.RotateAroundDistance", "scope": "static", "___id": "T000002R027055", "___s": true }, { "comment": "/**\n * Position a `point` at the given `angle` and `distance` to (`x`, `y`).\n *\n * @function Phaser.Math.RotateTo\n * @since 3.24.0\n *\n * @generic {Phaser.Types.Math.Vector2Like} T - [point,$return]\n *\n * @param {Phaser.Types.Math.Vector2Like} point - The point to be positioned.\n * @param {number} x - The horizontal coordinate to position from.\n * @param {number} y - The vertical coordinate to position from.\n * @param {number} angle - The angle of rotation in radians.\n * @param {number} distance - The distance from (x, y) to place the point at.\n *\n * @return {Phaser.Types.Math.Vector2Like} The given point.\n */", "meta": { "filename": "RotateTo.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Position a `point` at the given `angle` and `distance` to (`x`, `y`).", "kind": "function", "name": "RotateTo", "since": "3.24.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Types.Math.Vector2Like} T - [point,$return]", "value": "{Phaser.Types.Math.Vector2Like} T - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The point to be positioned.", "name": "point" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate to position from.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate to position from.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle of rotation in radians.", "name": "angle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance from (x, y) to place the point at.", "name": "distance" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The given point." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.RotateTo", "scope": "static", "___id": "T000002R027061", "___s": true }, { "comment": "/**\r\n * Rotates a vector in place by axis angle.\r\n *\r\n * This is the same as transforming a point by an\r\n * axis-angle quaternion, but it has higher precision.\r\n *\r\n * @function Phaser.Math.RotateVec3\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} vec - The vector to be rotated.\r\n * @param {Phaser.Math.Vector3} axis - The axis to rotate around.\r\n * @param {number} radians - The angle of rotation in radians.\r\n *\r\n * @return {Phaser.Math.Vector3} The given vector.\r\n */", "meta": { "filename": "RotateVec3.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Rotates a vector in place by axis angle.\r\rThis is the same as transforming a point by an\raxis-angle quaternion, but it has higher precision.", "kind": "function", "name": "RotateVec3", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The vector to be rotated.", "name": "vec" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The axis to rotate around.", "name": "axis" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle of rotation in radians.", "name": "radians" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The given vector." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.RotateVec3", "scope": "static", "___id": "T000002R027072", "___s": true }, { "comment": "/**\r\n * Round a given number so it is further away from zero. That is, positive numbers are rounded up, and negative numbers are rounded down.\r\n *\r\n * @function Phaser.Math.RoundAwayFromZero\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The number to round.\r\n *\r\n * @return {number} The rounded number, rounded away from zero.\r\n */", "meta": { "filename": "RoundAwayFromZero.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Round a given number so it is further away from zero. That is, positive numbers are rounded up, and negative numbers are rounded down.", "kind": "function", "name": "RoundAwayFromZero", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number to round.", "name": "value" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rounded number, rounded away from zero." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.RoundAwayFromZero", "scope": "static", "___id": "T000002R027075", "___s": true }, { "comment": "/**\r\n * Round a value to the given precision.\r\n *\r\n * For example:\r\n *\r\n * ```javascript\r\n * RoundTo(123.456, 0) = 123\r\n * RoundTo(123.456, 1) = 120\r\n * RoundTo(123.456, 2) = 100\r\n * ```\r\n *\r\n * To round the decimal, i.e. to round to precision, pass in a negative `place`:\r\n *\r\n * ```javascript\r\n * RoundTo(123.456789, 0) = 123\r\n * RoundTo(123.456789, -1) = 123.5\r\n * RoundTo(123.456789, -2) = 123.46\r\n * RoundTo(123.456789, -3) = 123.457\r\n * ```\r\n *\r\n * @function Phaser.Math.RoundTo\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value to round.\r\n * @param {number} [place=0] - The place to round to. Positive to round the units, negative to round the decimal.\r\n * @param {number} [base=10] - The base to round in. Default is 10 for decimal.\r\n *\r\n * @return {number} The rounded value.\r\n */", "meta": { "filename": "RoundTo.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Round a value to the given precision.\r\rFor example:\r\r```javascript\rRoundTo(123.456, 0) = 123\rRoundTo(123.456, 1) = 120\rRoundTo(123.456, 2) = 100\r```\r\rTo round the decimal, i.e. to round to precision, pass in a negative `place`:\r\r```javascript\rRoundTo(123.456789, 0) = 123\rRoundTo(123.456789, -1) = 123.5\rRoundTo(123.456789, -2) = 123.46\rRoundTo(123.456789, -3) = 123.457\r```", "kind": "function", "name": "RoundTo", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to round.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The place to round to. Positive to round the units, negative to round the decimal.", "name": "place" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The base to round in. Default is 10 for decimal.", "name": "base" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rounded value." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.RoundTo", "scope": "static", "___id": "T000002R027078", "___s": true }, { "comment": "/**\r\n * Generate a series of sine and cosine values.\r\n *\r\n * @function Phaser.Math.SinCosTableGenerator\r\n * @since 3.0.0\r\n *\r\n * @param {number} length - The number of values to generate.\r\n * @param {number} [sinAmp=1] - The sine value amplitude.\r\n * @param {number} [cosAmp=1] - The cosine value amplitude.\r\n * @param {number} [frequency=1] - The frequency of the values.\r\n *\r\n * @return {Phaser.Types.Math.SinCosTable} The generated values.\r\n */", "meta": { "filename": "SinCosTableGenerator.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Generate a series of sine and cosine values.", "kind": "function", "name": "SinCosTableGenerator", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of values to generate.", "name": "length" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The sine value amplitude.", "name": "sinAmp" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The cosine value amplitude.", "name": "cosAmp" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The frequency of the values.", "name": "frequency" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Math.SinCosTable" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.SinCosTable" } }, "description": "The generated values." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.SinCosTableGenerator", "scope": "static", "___id": "T000002R027084", "___s": true }, { "comment": "/**\r\n * Calculate a smoother interpolation percentage of `x` between `min` and `max`.\r\n *\r\n * The function receives the number `x` as an argument and returns 0 if `x` is less than or equal to the left edge,\r\n * 1 if `x` is greater than or equal to the right edge, and smoothly interpolates, using a Hermite polynomial,\r\n * between 0 and 1 otherwise.\r\n *\r\n * Produces an even smoother interpolation than {@link Phaser.Math.SmoothStep}.\r\n *\r\n * @function Phaser.Math.SmootherStep\r\n * @since 3.0.0\r\n * @see {@link https://en.wikipedia.org/wiki/Smoothstep#Variations}\r\n *\r\n * @param {number} x - The input value.\r\n * @param {number} min - The minimum value, also known as the 'left edge', assumed smaller than the 'right edge'.\r\n * @param {number} max - The maximum value, also known as the 'right edge', assumed greater than the 'left edge'.\r\n *\r\n * @return {number} The percentage of interpolation, between 0 and 1.\r\n */", "meta": { "filename": "SmootherStep.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate a smoother interpolation percentage of `x` between `min` and `max`.\r\rThe function receives the number `x` as an argument and returns 0 if `x` is less than or equal to the left edge,\r1 if `x` is greater than or equal to the right edge, and smoothly interpolates, using a Hermite polynomial,\rbetween 0 and 1 otherwise.\r\rProduces an even smoother interpolation than {@link Phaser.Math.SmoothStep}.", "kind": "function", "name": "SmootherStep", "since": "3.0.0", "see": [ "{@link https://en.wikipedia.org/wiki/Smoothstep#Variations}" ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The input value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum value, also known as the 'left edge', assumed smaller than the 'right edge'.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum value, also known as the 'right edge', assumed greater than the 'left edge'.", "name": "max" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The percentage of interpolation, between 0 and 1." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.SmootherStep", "scope": "static", "___id": "T000002R027101", "___s": true }, { "comment": "/**\r\n * Calculate a smooth interpolation percentage of `x` between `min` and `max`.\r\n *\r\n * The function receives the number `x` as an argument and returns 0 if `x` is less than or equal to the left edge,\r\n * 1 if `x` is greater than or equal to the right edge, and smoothly interpolates, using a Hermite polynomial,\r\n * between 0 and 1 otherwise.\r\n *\r\n * @function Phaser.Math.SmoothStep\r\n * @since 3.0.0\r\n * @see {@link https://en.wikipedia.org/wiki/Smoothstep}\r\n *\r\n * @param {number} x - The input value.\r\n * @param {number} min - The minimum value, also known as the 'left edge', assumed smaller than the 'right edge'.\r\n * @param {number} max - The maximum value, also known as the 'right edge', assumed greater than the 'left edge'.\r\n *\r\n * @return {number} The percentage of interpolation, between 0 and 1.\r\n */", "meta": { "filename": "SmoothStep.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate a smooth interpolation percentage of `x` between `min` and `max`.\r\rThe function receives the number `x` as an argument and returns 0 if `x` is less than or equal to the left edge,\r1 if `x` is greater than or equal to the right edge, and smoothly interpolates, using a Hermite polynomial,\rbetween 0 and 1 otherwise.", "kind": "function", "name": "SmoothStep", "since": "3.0.0", "see": [ "{@link https://en.wikipedia.org/wiki/Smoothstep}" ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The input value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum value, also known as the 'left edge', assumed smaller than the 'right edge'.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum value, also known as the 'right edge', assumed greater than the 'left edge'.", "name": "max" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The percentage of interpolation, between 0 and 1." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.SmoothStep", "scope": "static", "___id": "T000002R027105", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Math.Snap\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\snap", "code": {} }, "kind": "namespace", "name": "Snap", "memberof": "Phaser.Math", "longname": "Phaser.Math.Snap", "scope": "static", "___id": "T000002R027109", "___s": true }, { "comment": "/**\r\n * Snap a value to nearest grid slice, using ceil.\r\n *\r\n * Example: if you have an interval gap of `5` and a position of `12`... you will snap to `15`.\r\n * As will `14` snap to `15`... but `16` will snap to `20`.\r\n *\r\n * @function Phaser.Math.Snap.Ceil\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value to snap.\r\n * @param {number} gap - The interval gap of the grid.\r\n * @param {number} [start=0] - Optional starting offset for gap.\r\n * @param {boolean} [divide=false] - If `true` it will divide the snapped value by the gap before returning.\r\n *\r\n * @return {number} The snapped value.\r\n */", "meta": { "filename": "SnapCeil.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\snap", "code": {} }, "description": "Snap a value to nearest grid slice, using ceil.\r\rExample: if you have an interval gap of `5` and a position of `12`... you will snap to `15`.\rAs will `14` snap to `15`... but `16` will snap to `20`.", "kind": "function", "name": "Ceil", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to snap.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The interval gap of the grid.", "name": "gap" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional starting offset for gap.", "name": "start" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true` it will divide the snapped value by the gap before returning.", "name": "divide" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The snapped value." } ], "memberof": "Phaser.Math.Snap", "longname": "Phaser.Math.Snap.Ceil", "scope": "static", "___id": "T000002R027114", "___s": true }, { "comment": "/**\r\n * Snap a value to nearest grid slice, using floor.\r\n *\r\n * Example: if you have an interval gap of `5` and a position of `12`... you will snap to `10`.\r\n * As will `14` snap to `10`... but `16` will snap to `15`.\r\n *\r\n * @function Phaser.Math.Snap.Floor\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value to snap.\r\n * @param {number} gap - The interval gap of the grid.\r\n * @param {number} [start=0] - Optional starting offset for gap.\r\n * @param {boolean} [divide=false] - If `true` it will divide the snapped value by the gap before returning.\r\n *\r\n * @return {number} The snapped value.\r\n */", "meta": { "filename": "SnapFloor.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\snap", "code": {} }, "description": "Snap a value to nearest grid slice, using floor.\r\rExample: if you have an interval gap of `5` and a position of `12`... you will snap to `10`.\rAs will `14` snap to `10`... but `16` will snap to `15`.", "kind": "function", "name": "Floor", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to snap.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The interval gap of the grid.", "name": "gap" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional starting offset for gap.", "name": "start" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true` it will divide the snapped value by the gap before returning.", "name": "divide" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The snapped value." } ], "memberof": "Phaser.Math.Snap", "longname": "Phaser.Math.Snap.Floor", "scope": "static", "___id": "T000002R027120", "___s": true }, { "comment": "/**\r\n * Snap a value to nearest grid slice, using rounding.\r\n *\r\n * Example: if you have an interval gap of `5` and a position of `12`... you will snap to `10` whereas `14` will snap to `15`.\r\n *\r\n * @function Phaser.Math.Snap.To\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value to snap.\r\n * @param {number} gap - The interval gap of the grid.\r\n * @param {number} [start=0] - Optional starting offset for gap.\r\n * @param {boolean} [divide=false] - If `true` it will divide the snapped value by the gap before returning.\r\n *\r\n * @return {number} The snapped value.\r\n */", "meta": { "filename": "SnapTo.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\snap", "code": {} }, "description": "Snap a value to nearest grid slice, using rounding.\r\rExample: if you have an interval gap of `5` and a position of `12`... you will snap to `10` whereas `14` will snap to `15`.", "kind": "function", "name": "To", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to snap.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The interval gap of the grid.", "name": "gap" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional starting offset for gap.", "name": "start" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true` it will divide the snapped value by the gap before returning.", "name": "divide" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The snapped value." } ], "memberof": "Phaser.Math.Snap", "longname": "Phaser.Math.Snap.To", "scope": "static", "___id": "T000002R027126", "___s": true }, { "comment": "/**\r\n * Returns a Vector2 containing the x and y position of the given index in a `width` x `height` sized grid.\r\n *\r\n * For example, in a 6 x 4 grid, index 16 would equal x: 4 y: 2.\r\n *\r\n * If the given index is out of range an empty Vector2 is returned.\r\n *\r\n * @function Phaser.Math.ToXY\r\n * @since 3.19.0\r\n *\r\n * @param {number} index - The position within the grid to get the x/y value for.\r\n * @param {number} width - The width of the grid.\r\n * @param {number} height - The height of the grid.\r\n * @param {Phaser.Math.Vector2} [out] - An optional Vector2 to store the result in. If not given, a new Vector2 instance will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 where the x and y properties contain the given grid index.\r\n */", "meta": { "filename": "ToXY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Returns a Vector2 containing the x and y position of the given index in a `width` x `height` sized grid.\r\rFor example, in a 6 x 4 grid, index 16 would equal x: 4 y: 2.\r\rIf the given index is out of range an empty Vector2 is returned.", "kind": "function", "name": "ToXY", "since": "3.19.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The position within the grid to get the x/y value for.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the grid.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the grid.", "name": "height" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "An optional Vector2 to store the result in. If not given, a new Vector2 instance will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 where the x and y properties contain the given grid index." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.ToXY", "scope": "static", "___id": "T000002R027133", "___s": true }, { "comment": "/**\r\n * Takes the `x` and `y` coordinates and transforms them into the same space as\r\n * defined by the position, rotation and scale values.\r\n *\r\n * @function Phaser.Math.TransformXY\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate to be transformed.\r\n * @param {number} y - The y coordinate to be transformed.\r\n * @param {number} positionX - Horizontal position of the transform point.\r\n * @param {number} positionY - Vertical position of the transform point.\r\n * @param {number} rotation - Rotation of the transform point, in radians.\r\n * @param {number} scaleX - Horizontal scale of the transform point.\r\n * @param {number} scaleY - Vertical scale of the transform point.\r\n * @param {(Phaser.Math.Vector2|Phaser.Geom.Point|object)} [output] - The output vector, point or object for the translated coordinates.\r\n *\r\n * @return {(Phaser.Math.Vector2|Phaser.Geom.Point|object)} The translated point.\r\n */", "meta": { "filename": "TransformXY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Takes the `x` and `y` coordinates and transforms them into the same space as\rdefined by the position, rotation and scale values.", "kind": "function", "name": "TransformXY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to be transformed.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to be transformed.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal position of the transform point.", "name": "positionX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical position of the transform point.", "name": "positionY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Rotation of the transform point, in radians.", "name": "rotation" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal scale of the transform point.", "name": "scaleX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical scale of the transform point.", "name": "scaleY" }, { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "The output vector, point or object for the translated coordinates.", "name": "output" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The translated point." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.TransformXY", "scope": "static", "___id": "T000002R027144", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Math\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\typedefs", "code": {} }, "kind": "namespace", "name": "Math", "memberof": "Phaser.Types", "longname": "Phaser.Types.Math", "scope": "static", "___id": "T000002R027157", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Math.SinCosTable\r\n * @since 3.0.0\r\n *\r\n * @property {number} sin - The sine value.\r\n * @property {number} cos - The cosine value.\r\n * @property {number} length - The length.\r\n */", "meta": { "filename": "SinCosTable.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\typedefs", "code": {} }, "kind": "typedef", "name": "SinCosTable", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The sine value.", "name": "sin" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The cosine value.", "name": "cos" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length.", "name": "length" } ], "memberof": "Phaser.Types.Math", "longname": "Phaser.Types.Math.SinCosTable", "scope": "static", "___id": "T000002R027158", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Math.Vector2Like\r\n * @since 3.0.0\r\n *\r\n * @property {number} [x] - The x component.\r\n * @property {number} [y] - The y component.\r\n */", "meta": { "filename": "Vector2Like.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\typedefs", "code": {} }, "kind": "typedef", "name": "Vector2Like", "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 x component.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y component.", "name": "y" } ], "memberof": "Phaser.Types.Math", "longname": "Phaser.Types.Math.Vector2Like", "scope": "static", "___id": "T000002R027159", "___s": true }, { "comment": "/**\n * @typedef {object} Phaser.Types.Math.Vector3Like\n * @since 3.50.0\n *\n * @property {number} [x] - The x component.\n * @property {number} [y] - The y component.\n * @property {number} [z] - The z component.\n */", "meta": { "filename": "Vector3Like.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\typedefs", "code": {} }, "kind": "typedef", "name": "Vector3Like", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The x component.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y component.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The z component.", "name": "z" } ], "memberof": "Phaser.Types.Math", "longname": "Phaser.Types.Math.Vector3Like", "scope": "static", "___id": "T000002R027160", "___s": true }, { "comment": "/**\n * @typedef {object} Phaser.Types.Math.Vector4Like\n * @since 3.50.0\n *\n * @property {number} [x] - The x component.\n * @property {number} [y] - The y component.\n * @property {number} [z] - The z component.\n * @property {number} [w] - The w component.\n */", "meta": { "filename": "Vector4Like.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math\\typedefs", "code": {} }, "kind": "typedef", "name": "Vector4Like", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The x component.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y component.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The z component.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The w component.", "name": "w" } ], "memberof": "Phaser.Types.Math", "longname": "Phaser.Types.Math.Vector4Like", "scope": "static", "___id": "T000002R027161", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A representation of a vector in 2D space.\r\n *\r\n * A two-component vector.\r\n *\r\n * @class Vector2\r\n * @memberof Phaser.Math\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {number|Phaser.Types.Math.Vector2Like} [x=0] - The x component, or an object with `x` and `y` properties.\r\n * @param {number} [y=x] - The y component.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "classdesc": "A representation of a vector in 2D space.\r\rA two-component vector.", "kind": "class", "name": "Vector2", "memberof": "Phaser.Math", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } ] } }, "optional": true, "defaultvalue": 0, "description": "The x component, or an object with `x` and `y` properties.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The y component.", "name": "y" } ], "scope": "static", "longname": "Phaser.Math.Vector2", "___id": "T000002R027164", "___s": true }, { "comment": "/**\r\n * The x component of this Vector.\r\n *\r\n * @name Phaser.Math.Vector2#x\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Vector2.js", "lineno": 33, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The x component of this Vector.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#x", "scope": "instance", "kind": "member", "___id": "T000002R027167", "___s": true }, { "comment": "/**\r\n * The y component of this Vector.\r\n *\r\n * @name Phaser.Math.Vector2#y\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Vector2.js", "lineno": 43, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The y component of this Vector.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#y", "scope": "instance", "kind": "member", "___id": "T000002R027169", "___s": true }, { "comment": "/**\r\n * Make a clone of this Vector2.\r\n *\r\n * @method Phaser.Math.Vector2#clone\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector2} A clone of this Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 67, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Make a clone of this Vector2.", "kind": "function", "name": "clone", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A clone of this Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#clone", "scope": "instance", "___id": "T000002R027176", "___s": true }, { "comment": "/**\r\n * Copy the components of a given Vector into this Vector.\r\n *\r\n * @method Phaser.Math.Vector2#copy\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} src - The Vector to copy the components from.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Copy the components of a given Vector into this Vector.", "kind": "function", "name": "copy", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The Vector to copy the components from.", "name": "src" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#copy", "scope": "instance", "___id": "T000002R027178", "___s": true }, { "comment": "/**\r\n * Set the component values of this Vector from a given Vector2Like object.\r\n *\r\n * @method Phaser.Math.Vector2#setFromObject\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} obj - The object containing the component values to set for this Vector.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the component values of this Vector from a given Vector2Like object.", "kind": "function", "name": "setFromObject", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The object containing the component values to set for this Vector.", "name": "obj" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#setFromObject", "scope": "instance", "___id": "T000002R027182", "___s": true }, { "comment": "/**\r\n * Set the `x` and `y` components of the this Vector to the given `x` and `y` values.\r\n *\r\n * @method Phaser.Math.Vector2#set\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x value to set for this Vector.\r\n * @param {number} [y=x] - The y value to set for this Vector.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 116, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the `x` and `y` components of the this Vector to the given `x` and `y` values.", "kind": "function", "name": "set", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x value to set for this Vector.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The y value to set for this Vector.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#set", "scope": "instance", "___id": "T000002R027186", "___s": true }, { "comment": "/**\r\n * This method is an alias for `Vector2.set`.\r\n *\r\n * @method Phaser.Math.Vector2#setTo\r\n * @since 3.4.0\r\n *\r\n * @param {number} x - The x value to set for this Vector.\r\n * @param {number} [y=x] - The y value to set for this Vector.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "This method is an alias for `Vector2.set`.", "kind": "function", "name": "setTo", "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x value to set for this Vector.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The y value to set for this Vector.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#setTo", "scope": "instance", "___id": "T000002R027191", "___s": true }, { "comment": "/**\r\n * Sets the `x` and `y` values of this object from a given polar coordinate.\r\n *\r\n * @method Phaser.Math.Vector2#setToPolar\r\n * @since 3.0.0\r\n *\r\n * @param {number} azimuth - The angular coordinate, in radians.\r\n * @param {number} [radius=1] - The radial coordinate (length).\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 153, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Sets the `x` and `y` values of this object from a given polar coordinate.", "kind": "function", "name": "setToPolar", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angular coordinate, in radians.", "name": "azimuth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The radial coordinate (length).", "name": "radius" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#setToPolar", "scope": "instance", "___id": "T000002R027193", "___s": true }, { "comment": "/**\r\n * Check whether this Vector is equal to a given Vector.\r\n *\r\n * Performs a strict equality check against each Vector's components.\r\n *\r\n * @method Phaser.Math.Vector2#equals\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} v - The vector to compare with this Vector.\r\n *\r\n * @return {boolean} Whether the given Vector is equal to this Vector.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 174, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Check whether this Vector is equal to a given Vector.\r\rPerforms a strict equality check against each Vector's components.", "kind": "function", "name": "equals", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The vector to compare with this Vector.", "name": "v" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the given Vector is equal to this Vector." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#equals", "scope": "instance", "___id": "T000002R027198", "___s": true }, { "comment": "/**\r\n * Check whether this Vector is approximately equal to a given Vector.\r\n *\r\n * @method Phaser.Math.Vector2#fuzzyEquals\r\n * @since 3.23.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} v - The vector to compare with this Vector.\r\n * @param {number} [epsilon=0.0001] - The tolerance value.\r\n *\r\n * @return {boolean} Whether both absolute differences of the x and y components are smaller than `epsilon`.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Check whether this Vector is approximately equal to a given Vector.", "kind": "function", "name": "fuzzyEquals", "since": "3.23.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The vector to compare with this Vector.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.0001, "description": "The tolerance value.", "name": "epsilon" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether both absolute differences of the x and y components are smaller than `epsilon`." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#fuzzyEquals", "scope": "instance", "___id": "T000002R027200", "___s": true }, { "comment": "/**\r\n * Calculate the angle between this Vector and the positive x-axis, in radians.\r\n *\r\n * @method Phaser.Math.Vector2#angle\r\n * @since 3.0.0\r\n *\r\n * @return {number} The angle between this Vector, and the positive x-axis, given in radians.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 207, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the angle between this Vector and the positive x-axis, in radians.", "kind": "function", "name": "angle", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle between this Vector, and the positive x-axis, given in radians." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#angle", "scope": "instance", "___id": "T000002R027202", "___s": true }, { "comment": "/**\r\n * Set the angle of this Vector.\r\n *\r\n * @method Phaser.Math.Vector2#setAngle\r\n * @since 3.23.0\r\n *\r\n * @param {number} angle - The angle, in radians.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 229, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the angle of this Vector.", "kind": "function", "name": "setAngle", "since": "3.23.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle, in radians.", "name": "angle" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#setAngle", "scope": "instance", "___id": "T000002R027206", "___s": true }, { "comment": "/**\r\n * Add a given Vector to this Vector. Addition is component-wise.\r\n *\r\n * @method Phaser.Math.Vector2#add\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} src - The Vector to add to this Vector.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 244, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Add a given Vector to this Vector. Addition is component-wise.", "kind": "function", "name": "add", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The Vector to add to this Vector.", "name": "src" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#add", "scope": "instance", "___id": "T000002R027208", "___s": true }, { "comment": "/**\r\n * Subtract the given Vector from this Vector. Subtraction is component-wise.\r\n *\r\n * @method Phaser.Math.Vector2#subtract\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} src - The Vector to subtract from this Vector.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Subtract the given Vector from this Vector. Subtraction is component-wise.", "kind": "function", "name": "subtract", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The Vector to subtract from this Vector.", "name": "src" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#subtract", "scope": "instance", "___id": "T000002R027212", "___s": true }, { "comment": "/**\r\n * Perform a component-wise multiplication between this Vector and the given Vector.\r\n *\r\n * Multiplies this Vector by the given Vector.\r\n *\r\n * @method Phaser.Math.Vector2#multiply\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} src - The Vector to multiply this Vector by.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 280, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Perform a component-wise multiplication between this Vector and the given Vector.\r\rMultiplies this Vector by the given Vector.", "kind": "function", "name": "multiply", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The Vector to multiply this Vector by.", "name": "src" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#multiply", "scope": "instance", "___id": "T000002R027216", "___s": true }, { "comment": "/**\r\n * Scale this Vector by the given value.\r\n *\r\n * @method Phaser.Math.Vector2#scale\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value to scale this Vector by.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 300, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Scale this Vector by the given value.", "kind": "function", "name": "scale", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to scale this Vector by.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#scale", "scope": "instance", "___id": "T000002R027220", "___s": true }, { "comment": "/**\r\n * Perform a component-wise division between this Vector and the given Vector.\r\n *\r\n * Divides this Vector by the given Vector.\r\n *\r\n * @method Phaser.Math.Vector2#divide\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} src - The Vector to divide this Vector by.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Perform a component-wise division between this Vector and the given Vector.\r\rDivides this Vector by the given Vector.", "kind": "function", "name": "divide", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The Vector to divide this Vector by.", "name": "src" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#divide", "scope": "instance", "___id": "T000002R027226", "___s": true }, { "comment": "/**\r\n * Negate the `x` and `y` components of this Vector.\r\n *\r\n * @method Phaser.Math.Vector2#negate\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 346, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Negate the `x` and `y` components of this Vector.", "kind": "function", "name": "negate", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#negate", "scope": "instance", "___id": "T000002R027230", "___s": true }, { "comment": "/**\r\n * Calculate the distance between this Vector and the given Vector.\r\n *\r\n * @method Phaser.Math.Vector2#distance\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} src - The Vector to calculate the distance to.\r\n *\r\n * @return {number} The distance from this Vector to the given Vector.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 362, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the distance between this Vector and the given Vector.", "kind": "function", "name": "distance", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The Vector to calculate the distance to.", "name": "src" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance from this Vector to the given Vector." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#distance", "scope": "instance", "___id": "T000002R027234", "___s": true }, { "comment": "/**\r\n * Calculate the distance between this Vector and the given Vector, squared.\r\n *\r\n * @method Phaser.Math.Vector2#distanceSq\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} src - The Vector to calculate the distance to.\r\n *\r\n * @return {number} The distance from this Vector to the given Vector, squared.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the distance between this Vector and the given Vector, squared.", "kind": "function", "name": "distanceSq", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The Vector to calculate the distance to.", "name": "src" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance from this Vector to the given Vector, squared." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#distanceSq", "scope": "instance", "___id": "T000002R027238", "___s": true }, { "comment": "/**\r\n * Calculate the length (or magnitude) of this Vector.\r\n *\r\n * @method Phaser.Math.Vector2#length\r\n * @since 3.0.0\r\n *\r\n * @return {number} The length of this Vector.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 398, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the length (or magnitude) of this Vector.", "kind": "function", "name": "length", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length of this Vector." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#length", "scope": "instance", "___id": "T000002R027242", "___s": true }, { "comment": "/**\r\n * Set the length (or magnitude) of this Vector.\r\n *\r\n * @method Phaser.Math.Vector2#setLength\r\n * @since 3.23.0\r\n *\r\n * @param {number} length\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 414, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the length (or magnitude) of this Vector.", "kind": "function", "name": "setLength", "since": "3.23.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "name": "length" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#setLength", "scope": "instance", "___id": "T000002R027246", "___s": true }, { "comment": "/**\r\n * Calculate the length of this Vector squared.\r\n *\r\n * @method Phaser.Math.Vector2#lengthSq\r\n * @since 3.0.0\r\n *\r\n * @return {number} The length of this Vector, squared.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 429, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the length of this Vector squared.", "kind": "function", "name": "lengthSq", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length of this Vector, squared." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#lengthSq", "scope": "instance", "___id": "T000002R027248", "___s": true }, { "comment": "/**\r\n * Normalize this Vector.\r\n *\r\n * Makes the vector a unit length vector (magnitude of 1) in the same direction.\r\n *\r\n * @method Phaser.Math.Vector2#normalize\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Normalize this Vector.\r\rMakes the vector a unit length vector (magnitude of 1) in the same direction.", "kind": "function", "name": "normalize", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#normalize", "scope": "instance", "___id": "T000002R027252", "___s": true }, { "comment": "/**\r\n * Rotate this Vector to its perpendicular, in the positive direction.\r\n *\r\n * @method Phaser.Math.Vector2#normalizeRightHand\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 472, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Rotate this Vector to its perpendicular, in the positive direction.", "kind": "function", "name": "normalizeRightHand", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#normalizeRightHand", "scope": "instance", "___id": "T000002R027260", "___s": true }, { "comment": "/**\r\n * Rotate this Vector to its perpendicular, in the negative direction.\r\n *\r\n * @method Phaser.Math.Vector2#normalizeLeftHand\r\n * @since 3.23.0\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 490, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Rotate this Vector to its perpendicular, in the negative direction.", "kind": "function", "name": "normalizeLeftHand", "since": "3.23.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#normalizeLeftHand", "scope": "instance", "___id": "T000002R027265", "___s": true }, { "comment": "/**\r\n * Calculate the dot product of this Vector and the given Vector.\r\n *\r\n * @method Phaser.Math.Vector2#dot\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} src - The Vector2 to dot product with this Vector2.\r\n *\r\n * @return {number} The dot product of this Vector and the given Vector.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 508, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the dot product of this Vector and the given Vector.", "kind": "function", "name": "dot", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The Vector2 to dot product with this Vector2.", "name": "src" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The dot product of this Vector and the given Vector." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#dot", "scope": "instance", "___id": "T000002R027270", "___s": true }, { "comment": "/**\r\n * Calculate the cross product of this Vector and the given Vector.\r\n *\r\n * @method Phaser.Math.Vector2#cross\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} src - The Vector2 to cross with this Vector2.\r\n *\r\n * @return {number} The cross product of this Vector and the given Vector.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the cross product of this Vector and the given Vector.", "kind": "function", "name": "cross", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The Vector2 to cross with this Vector2.", "name": "src" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The cross product of this Vector and the given Vector." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#cross", "scope": "instance", "___id": "T000002R027272", "___s": true }, { "comment": "/**\r\n * Linearly interpolate between this Vector and the given Vector.\r\n *\r\n * Interpolates this Vector towards the given Vector.\r\n *\r\n * @method Phaser.Math.Vector2#lerp\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} src - The Vector2 to interpolate towards.\r\n * @param {number} [t=0] - The interpolation percentage, between 0 and 1.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 538, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Linearly interpolate between this Vector and the given Vector.\r\rInterpolates this Vector towards the given Vector.", "kind": "function", "name": "lerp", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The Vector2 to interpolate towards.", "name": "src" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The interpolation percentage, between 0 and 1.", "name": "t" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#lerp", "scope": "instance", "___id": "T000002R027274", "___s": true }, { "comment": "/**\r\n * Transform this Vector with the given Matrix.\r\n *\r\n * @method Phaser.Math.Vector2#transformMat3\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix3} mat - The Matrix3 to transform this Vector2 with.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Transform this Vector with the given Matrix.", "kind": "function", "name": "transformMat3", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "The Matrix3 to transform this Vector2 with.", "name": "mat" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#transformMat3", "scope": "instance", "___id": "T000002R027281", "___s": true }, { "comment": "/**\r\n * Transform this Vector with the given Matrix.\r\n *\r\n * @method Phaser.Math.Vector2#transformMat4\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix4} mat - The Matrix4 to transform this Vector2 with.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 586, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Transform this Vector with the given Matrix.", "kind": "function", "name": "transformMat4", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to transform this Vector2 with.", "name": "mat" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#transformMat4", "scope": "instance", "___id": "T000002R027288", "___s": true }, { "comment": "/**\r\n * Make this Vector the zero vector (0, 0).\r\n *\r\n * @method Phaser.Math.Vector2#reset\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 608, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Make this Vector the zero vector (0, 0).", "kind": "function", "name": "reset", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#reset", "scope": "instance", "___id": "T000002R027295", "___s": true }, { "comment": "/**\r\n * Limit the length (or magnitude) of this Vector.\r\n *\r\n * @method Phaser.Math.Vector2#limit\r\n * @since 3.23.0\r\n *\r\n * @param {number} max - The maximum length.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 624, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Limit the length (or magnitude) of this Vector.", "kind": "function", "name": "limit", "since": "3.23.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum length.", "name": "max" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#limit", "scope": "instance", "___id": "T000002R027299", "___s": true }, { "comment": "/**\r\n * Reflect this Vector off a line defined by a normal.\r\n *\r\n * @method Phaser.Math.Vector2#reflect\r\n * @since 3.23.0\r\n *\r\n * @param {Phaser.Math.Vector2} normal - A vector perpendicular to the line.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 646, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Reflect this Vector off a line defined by a normal.", "kind": "function", "name": "reflect", "since": "3.23.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A vector perpendicular to the line.", "name": "normal" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#reflect", "scope": "instance", "___id": "T000002R027302", "___s": true }, { "comment": "/**\r\n * Reflect this Vector across another.\r\n *\r\n * @method Phaser.Math.Vector2#mirror\r\n * @since 3.23.0\r\n *\r\n * @param {Phaser.Math.Vector2} axis - A vector to reflect across.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 663, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Reflect this Vector across another.", "kind": "function", "name": "mirror", "since": "3.23.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A vector to reflect across.", "name": "axis" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#mirror", "scope": "instance", "___id": "T000002R027305", "___s": true }, { "comment": "/**\r\n * Rotate this Vector by an angle amount.\r\n *\r\n * @method Phaser.Math.Vector2#rotate\r\n * @since 3.23.0\r\n *\r\n * @param {number} delta - The angle to rotate by, in radians.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 678, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Rotate this Vector by an angle amount.", "kind": "function", "name": "rotate", "since": "3.23.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle to rotate by, in radians.", "name": "delta" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#rotate", "scope": "instance", "___id": "T000002R027307", "___s": true }, { "comment": "/**\r\n * Project this Vector onto another.\r\n *\r\n * @method Phaser.Math.Vector2#project\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Math.Vector2} src - The vector to project onto.\r\n *\r\n * @return {Phaser.Math.Vector2} This Vector2.\r\n */", "meta": { "filename": "Vector2.js", "lineno": 696, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Project this Vector onto another.", "kind": "function", "name": "project", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The vector to project onto.", "name": "src" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "This Vector2." } ], "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2#project", "scope": "instance", "___id": "T000002R027311", "___s": true }, { "comment": "/**\r\n * A static zero Vector2 for use by reference.\r\n *\r\n * This constant is meant for comparison operations and should not be modified directly.\r\n *\r\n * @constant\r\n * @name Phaser.Math.Vector2.ZERO\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.1.0\r\n */", "meta": { "filename": "Vector2.js", "lineno": 715, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "A static zero Vector2 for use by reference.\r\rThis constant is meant for comparison operations and should not be modified directly.", "kind": "constant", "name": "ZERO", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.1.0", "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2.ZERO", "scope": "static", "___id": "T000002R027314", "___s": true }, { "comment": "/**\r\n * A static right Vector2 for use by reference.\r\n *\r\n * This constant is meant for comparison operations and should not be modified directly.\r\n *\r\n * @constant\r\n * @name Phaser.Math.Vector2.RIGHT\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Vector2.js", "lineno": 727, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "A static right Vector2 for use by reference.\r\rThis constant is meant for comparison operations and should not be modified directly.", "kind": "constant", "name": "RIGHT", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.16.0", "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2.RIGHT", "scope": "static", "___id": "T000002R027316", "___s": true }, { "comment": "/**\r\n * A static left Vector2 for use by reference.\r\n *\r\n * This constant is meant for comparison operations and should not be modified directly.\r\n *\r\n * @constant\r\n * @name Phaser.Math.Vector2.LEFT\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Vector2.js", "lineno": 739, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "A static left Vector2 for use by reference.\r\rThis constant is meant for comparison operations and should not be modified directly.", "kind": "constant", "name": "LEFT", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.16.0", "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2.LEFT", "scope": "static", "___id": "T000002R027318", "___s": true }, { "comment": "/**\r\n * A static up Vector2 for use by reference.\r\n *\r\n * This constant is meant for comparison operations and should not be modified directly.\r\n *\r\n * @constant\r\n * @name Phaser.Math.Vector2.UP\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Vector2.js", "lineno": 751, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "A static up Vector2 for use by reference.\r\rThis constant is meant for comparison operations and should not be modified directly.", "kind": "constant", "name": "UP", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.16.0", "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2.UP", "scope": "static", "___id": "T000002R027320", "___s": true }, { "comment": "/**\r\n * A static down Vector2 for use by reference.\r\n *\r\n * This constant is meant for comparison operations and should not be modified directly.\r\n *\r\n * @constant\r\n * @name Phaser.Math.Vector2.DOWN\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Vector2.js", "lineno": 763, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "A static down Vector2 for use by reference.\r\rThis constant is meant for comparison operations and should not be modified directly.", "kind": "constant", "name": "DOWN", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.16.0", "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2.DOWN", "scope": "static", "___id": "T000002R027322", "___s": true }, { "comment": "/**\r\n * A static one Vector2 for use by reference.\r\n *\r\n * This constant is meant for comparison operations and should not be modified directly.\r\n *\r\n * @constant\r\n * @name Phaser.Math.Vector2.ONE\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Vector2.js", "lineno": 775, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "A static one Vector2 for use by reference.\r\rThis constant is meant for comparison operations and should not be modified directly.", "kind": "constant", "name": "ONE", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.16.0", "memberof": "Phaser.Math.Vector2", "longname": "Phaser.Math.Vector2.ONE", "scope": "static", "___id": "T000002R027324", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A representation of a vector in 3D space.\r\n *\r\n * A three-component vector.\r\n *\r\n * @class Vector3\r\n * @memberof Phaser.Math\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x] - The x component.\r\n * @param {number} [y] - The y component.\r\n * @param {number} [z] - The z component.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "classdesc": "A representation of a vector in 3D space.\r\rA three-component vector.", "kind": "class", "name": "Vector3", "memberof": "Phaser.Math", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The x component.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y component.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The z component.", "name": "z" } ], "scope": "static", "longname": "Phaser.Math.Vector3", "___id": "T000002R027328", "___s": true }, { "comment": "/**\r\n * The x component of this Vector.\r\n *\r\n * @name Phaser.Math.Vector3#x\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Vector3.js", "lineno": 33, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The x component of this Vector.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#x", "scope": "instance", "kind": "member", "___id": "T000002R027331", "___s": true }, { "comment": "/**\r\n * The y component of this Vector.\r\n *\r\n * @name Phaser.Math.Vector3#y\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Vector3.js", "lineno": 43, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The y component of this Vector.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#y", "scope": "instance", "kind": "member", "___id": "T000002R027333", "___s": true }, { "comment": "/**\r\n * The z component of this Vector.\r\n *\r\n * @name Phaser.Math.Vector3#z\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Vector3.js", "lineno": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The z component of this Vector.", "name": "z", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#z", "scope": "instance", "kind": "member", "___id": "T000002R027335", "___s": true }, { "comment": "/**\r\n * Set this Vector to point up.\r\n *\r\n * Sets the y component of the vector to 1, and the others to 0.\r\n *\r\n * @method Phaser.Math.Vector3#up\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set this Vector to point up.\r\rSets the y component of the vector to 1, and the others to 0.", "kind": "function", "name": "up", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#up", "scope": "instance", "___id": "T000002R027343", "___s": true }, { "comment": "/**\r\n * Sets the components of this Vector to be the `Math.min` result from the given vector.\r\n *\r\n * @method Phaser.Math.Vector3#min\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Vector3} v - The Vector3 to check the minimum values against.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 96, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Sets the components of this Vector to be the `Math.min` result from the given vector.", "kind": "function", "name": "min", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The Vector3 to check the minimum values against.", "name": "v" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#min", "scope": "instance", "___id": "T000002R027348", "___s": true }, { "comment": "/**\r\n * Sets the components of this Vector to be the `Math.max` result from the given vector.\r\n *\r\n * @method Phaser.Math.Vector3#max\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Vector3} v - The Vector3 to check the maximum values against.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 115, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Sets the components of this Vector to be the `Math.max` result from the given vector.", "kind": "function", "name": "max", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The Vector3 to check the maximum values against.", "name": "v" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#max", "scope": "instance", "___id": "T000002R027353", "___s": true }, { "comment": "/**\r\n * Make a clone of this Vector3.\r\n *\r\n * @method Phaser.Math.Vector3#clone\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector3} A new Vector3 object containing this Vectors values.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 134, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Make a clone of this Vector3.", "kind": "function", "name": "clone", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "A new Vector3 object containing this Vectors values." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#clone", "scope": "instance", "___id": "T000002R027358", "___s": true }, { "comment": "/**\r\n * Adds the two given Vector3s and sets the results into this Vector3.\r\n *\r\n * @method Phaser.Math.Vector3#addVectors\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Vector3} a - The first Vector to add.\r\n * @param {Phaser.Math.Vector3} b - The second Vector to add.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 147, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Adds the two given Vector3s and sets the results into this Vector3.", "kind": "function", "name": "addVectors", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The first Vector to add.", "name": "a" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The second Vector to add.", "name": "b" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#addVectors", "scope": "instance", "___id": "T000002R027360", "___s": true }, { "comment": "/**\r\n * Calculate the cross (vector) product of two given Vectors.\r\n *\r\n * @method Phaser.Math.Vector3#crossVectors\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} a - The first Vector to multiply.\r\n * @param {Phaser.Math.Vector3} b - The second Vector to multiply.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the cross (vector) product of two given Vectors.", "kind": "function", "name": "crossVectors", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The first Vector to multiply.", "name": "a" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The second Vector to multiply.", "name": "b" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#crossVectors", "scope": "instance", "___id": "T000002R027365", "___s": true }, { "comment": "/**\r\n * Check whether this Vector is equal to a given Vector.\r\n *\r\n * Performs a strict equality check against each Vector's components.\r\n *\r\n * @method Phaser.Math.Vector3#equals\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} v - The Vector3 to compare against.\r\n *\r\n * @return {boolean} True if the two vectors strictly match, otherwise false.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 194, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Check whether this Vector is equal to a given Vector.\r\rPerforms a strict equality check against each Vector's components.", "kind": "function", "name": "equals", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The Vector3 to compare against.", "name": "v" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the two vectors strictly match, otherwise false." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#equals", "scope": "instance", "___id": "T000002R027376", "___s": true }, { "comment": "/**\r\n * Copy the components of a given Vector into this Vector.\r\n *\r\n * @method Phaser.Math.Vector3#copy\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} src - The Vector to copy the components from.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 211, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Copy the components of a given Vector into this Vector.", "kind": "function", "name": "copy", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" } ] } }, "description": "The Vector to copy the components from.", "name": "src" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#copy", "scope": "instance", "___id": "T000002R027378", "___s": true }, { "comment": "/**\r\n * Set the `x`, `y`, and `z` components of this Vector to the given `x`, `y`, and `z` values.\r\n *\r\n * @method Phaser.Math.Vector3#set\r\n * @since 3.0.0\r\n *\r\n * @param {(number|object)} x - The x value to set for this Vector, or an object containing x, y and z components.\r\n * @param {number} [y] - The y value to set for this Vector.\r\n * @param {number} [z] - The z value to set for this Vector.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the `x`, `y`, and `z` components of this Vector to the given `x`, `y`, and `z` values.", "kind": "function", "name": "set", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The x value to set for this Vector, or an object containing x, y and z components.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y value to set for this Vector.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The z value to set for this Vector.", "name": "z" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#set", "scope": "instance", "___id": "T000002R027383", "___s": true }, { "comment": "/**\r\n * Sets the components of this Vector3 from the position of the given Matrix4.\r\n *\r\n * @method Phaser.Math.Vector3#setFromMatrixPosition\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} mat4 - The Matrix4 to get the position from.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 260, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Sets the components of this Vector3 from the position of the given Matrix4.", "kind": "function", "name": "setFromMatrixPosition", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to get the position from.", "name": "mat4" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#setFromMatrixPosition", "scope": "instance", "___id": "T000002R027391", "___s": true }, { "comment": "/**\r\n * Sets the components of this Vector3 from the Matrix4 column specified.\r\n *\r\n * @method Phaser.Math.Vector3#setFromMatrixColumn\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} mat4 - The Matrix4 to get the column from.\r\n * @param {number} index - The column index.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 275, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Sets the components of this Vector3 from the Matrix4 column specified.", "kind": "function", "name": "setFromMatrixColumn", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to get the column from.", "name": "mat4" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The column index.", "name": "index" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#setFromMatrixColumn", "scope": "instance", "___id": "T000002R027393", "___s": true }, { "comment": "/**\r\n * Sets the components of this Vector3 from the given array, based on the offset.\r\n *\r\n * Vector3.x = array[offset]\r\n * Vector3.y = array[offset + 1]\r\n * Vector3.z = array[offset + 2]\r\n *\r\n * @method Phaser.Math.Vector3#fromArray\r\n * @since 3.50.0\r\n *\r\n * @param {number[]} array - The array of values to get this Vector from.\r\n * @param {number} [offset=0] - The offset index into the array.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 291, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Sets the components of this Vector3 from the given array, based on the offset.\r\rVector3.x = array[offset]\rVector3.y = array[offset + 1]\rVector3.z = array[offset + 2]", "kind": "function", "name": "fromArray", "since": "3.50.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The array of values to get this Vector from.", "name": "array" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The offset index into the array.", "name": "offset" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#fromArray", "scope": "instance", "___id": "T000002R027395", "___s": true }, { "comment": "/**\r\n * Add a given Vector to this Vector. Addition is component-wise.\r\n *\r\n * @method Phaser.Math.Vector3#add\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - The Vector to add to this Vector.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 317, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Add a given Vector to this Vector. Addition is component-wise.", "kind": "function", "name": "add", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" } ] } }, "description": "The Vector to add to this Vector.", "name": "v" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#add", "scope": "instance", "___id": "T000002R027401", "___s": true }, { "comment": "/**\r\n * Add the given value to each component of this Vector.\r\n *\r\n * @method Phaser.Math.Vector3#addScalar\r\n * @since 3.50.0\r\n *\r\n * @param {number} s - The amount to add to this Vector.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 336, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Add the given value to each component of this Vector.", "kind": "function", "name": "addScalar", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to add to this Vector.", "name": "s" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#addScalar", "scope": "instance", "___id": "T000002R027406", "___s": true }, { "comment": "/**\r\n * Add and scale a given Vector to this Vector. Addition is component-wise.\r\n *\r\n * @method Phaser.Math.Vector3#addScale\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - The Vector to add to this Vector.\r\n * @param {number} scale - The amount to scale `v` by.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 355, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Add and scale a given Vector to this Vector. Addition is component-wise.", "kind": "function", "name": "addScale", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" } ] } }, "description": "The Vector to add to this Vector.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to scale `v` by.", "name": "scale" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#addScale", "scope": "instance", "___id": "T000002R027411", "___s": true }, { "comment": "/**\r\n * Subtract the given Vector from this Vector. Subtraction is component-wise.\r\n *\r\n * @method Phaser.Math.Vector3#subtract\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - The Vector to subtract from this Vector.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 375, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Subtract the given Vector from this Vector. Subtraction is component-wise.", "kind": "function", "name": "subtract", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" } ] } }, "description": "The Vector to subtract from this Vector.", "name": "v" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#subtract", "scope": "instance", "___id": "T000002R027416", "___s": true }, { "comment": "/**\r\n * Perform a component-wise multiplication between this Vector and the given Vector.\r\n *\r\n * Multiplies this Vector by the given Vector.\r\n *\r\n * @method Phaser.Math.Vector3#multiply\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - The Vector to multiply this Vector by.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Perform a component-wise multiplication between this Vector and the given Vector.\r\rMultiplies this Vector by the given Vector.", "kind": "function", "name": "multiply", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" } ] } }, "description": "The Vector to multiply this Vector by.", "name": "v" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#multiply", "scope": "instance", "___id": "T000002R027421", "___s": true }, { "comment": "/**\r\n * Scale this Vector by the given value.\r\n *\r\n * @method Phaser.Math.Vector3#scale\r\n * @since 3.0.0\r\n *\r\n * @param {number} scale - The value to scale this Vector by.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 415, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Scale this Vector by the given value.", "kind": "function", "name": "scale", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to scale this Vector by.", "name": "scale" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#scale", "scope": "instance", "___id": "T000002R027426", "___s": true }, { "comment": "/**\r\n * Perform a component-wise division between this Vector and the given Vector.\r\n *\r\n * Divides this Vector by the given Vector.\r\n *\r\n * @method Phaser.Math.Vector3#divide\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - The Vector to divide this Vector by.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 443, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Perform a component-wise division between this Vector and the given Vector.\r\rDivides this Vector by the given Vector.", "kind": "function", "name": "divide", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" } ] } }, "description": "The Vector to divide this Vector by.", "name": "v" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#divide", "scope": "instance", "___id": "T000002R027434", "___s": true }, { "comment": "/**\r\n * Negate the `x`, `y` and `z` components of this Vector.\r\n *\r\n * @method Phaser.Math.Vector3#negate\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Negate the `x`, `y` and `z` components of this Vector.", "kind": "function", "name": "negate", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#negate", "scope": "instance", "___id": "T000002R027439", "___s": true }, { "comment": "/**\r\n * Calculate the distance between this Vector and the given Vector.\r\n *\r\n * @method Phaser.Math.Vector3#distance\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - The Vector to calculate the distance to.\r\n *\r\n * @return {number} The distance from this Vector to the given Vector.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 481, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the distance between this Vector and the given Vector.", "kind": "function", "name": "distance", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" } ] } }, "description": "The Vector to calculate the distance to.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance from this Vector to the given Vector." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#distance", "scope": "instance", "___id": "T000002R027444", "___s": true }, { "comment": "/**\r\n * Calculate the distance between this Vector and the given Vector, squared.\r\n *\r\n * @method Phaser.Math.Vector3#distanceSq\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - The Vector to calculate the distance to.\r\n *\r\n * @return {number} The distance from this Vector to the given Vector, squared.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 500, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the distance between this Vector and the given Vector, squared.", "kind": "function", "name": "distanceSq", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" } ] } }, "description": "The Vector to calculate the distance to.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance from this Vector to the given Vector, squared." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#distanceSq", "scope": "instance", "___id": "T000002R027449", "___s": true }, { "comment": "/**\r\n * Calculate the length (or magnitude) of this Vector.\r\n *\r\n * @method Phaser.Math.Vector3#length\r\n * @since 3.0.0\r\n *\r\n * @return {number} The length of this Vector.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 519, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the length (or magnitude) of this Vector.", "kind": "function", "name": "length", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length of this Vector." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#length", "scope": "instance", "___id": "T000002R027454", "___s": true }, { "comment": "/**\r\n * Calculate the length of this Vector squared.\r\n *\r\n * @method Phaser.Math.Vector3#lengthSq\r\n * @since 3.0.0\r\n *\r\n * @return {number} The length of this Vector, squared.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 536, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the length of this Vector squared.", "kind": "function", "name": "lengthSq", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length of this Vector, squared." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#lengthSq", "scope": "instance", "___id": "T000002R027459", "___s": true }, { "comment": "/**\r\n * Normalize this Vector.\r\n *\r\n * Makes the vector a unit length vector (magnitude of 1) in the same direction.\r\n *\r\n * @method Phaser.Math.Vector3#normalize\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 553, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Normalize this Vector.\r\rMakes the vector a unit length vector (magnitude of 1) in the same direction.", "kind": "function", "name": "normalize", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#normalize", "scope": "instance", "___id": "T000002R027464", "___s": true }, { "comment": "/**\r\n * Calculate the dot product of this Vector and the given Vector.\r\n *\r\n * @method Phaser.Math.Vector3#dot\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} v - The Vector3 to dot product with this Vector3.\r\n *\r\n * @return {number} The dot product of this Vector and `v`.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 582, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the dot product of this Vector and the given Vector.", "kind": "function", "name": "dot", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The Vector3 to dot product with this Vector3.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The dot product of this Vector and `v`." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#dot", "scope": "instance", "___id": "T000002R027474", "___s": true }, { "comment": "/**\r\n * Calculate the cross (vector) product of this Vector (which will be modified) and the given Vector.\r\n *\r\n * @method Phaser.Math.Vector3#cross\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} v - The Vector to cross product with.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 597, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the cross (vector) product of this Vector (which will be modified) and the given Vector.", "kind": "function", "name": "cross", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The Vector to cross product with.", "name": "v" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#cross", "scope": "instance", "___id": "T000002R027476", "___s": true }, { "comment": "/**\r\n * Linearly interpolate between this Vector and the given Vector.\r\n *\r\n * Interpolates this Vector towards the given Vector.\r\n *\r\n * @method Phaser.Math.Vector3#lerp\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} v - The Vector3 to interpolate towards.\r\n * @param {number} [t=0] - The interpolation percentage, between 0 and 1.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 623, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Linearly interpolate between this Vector and the given Vector.\r\rInterpolates this Vector towards the given Vector.", "kind": "function", "name": "lerp", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The Vector3 to interpolate towards.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The interpolation percentage, between 0 and 1.", "name": "t" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#lerp", "scope": "instance", "___id": "T000002R027487", "___s": true }, { "comment": "/**\r\n * Takes a Matrix3 and applies it to this Vector3.\r\n *\r\n * @method Phaser.Math.Vector3#applyMatrix3\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix3} mat3 - The Matrix3 to apply to this Vector3.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 651, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Takes a Matrix3 and applies it to this Vector3.", "kind": "function", "name": "applyMatrix3", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "The Matrix3 to apply to this Vector3.", "name": "mat3" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#applyMatrix3", "scope": "instance", "___id": "T000002R027496", "___s": true }, { "comment": "/**\r\n * Takes a Matrix4 and applies it to this Vector3.\r\n *\r\n * @method Phaser.Math.Vector3#applyMatrix4\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} mat4 - The Matrix4 to apply to this Vector3.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 675, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Takes a Matrix4 and applies it to this Vector3.", "kind": "function", "name": "applyMatrix4", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to apply to this Vector3.", "name": "mat4" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#applyMatrix4", "scope": "instance", "___id": "T000002R027505", "___s": true }, { "comment": "/**\r\n * Transform this Vector with the given Matrix.\r\n *\r\n * @method Phaser.Math.Vector3#transformMat3\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix3} mat - The Matrix3 to transform this Vector3 with.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 701, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Transform this Vector with the given Matrix.", "kind": "function", "name": "transformMat3", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "The Matrix3 to transform this Vector3 with.", "name": "mat" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#transformMat3", "scope": "instance", "___id": "T000002R027515", "___s": true }, { "comment": "/**\r\n * Transform this Vector with the given Matrix4.\r\n *\r\n * @method Phaser.Math.Vector3#transformMat4\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix4} mat - The Matrix4 to transform this Vector3 with.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 725, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Transform this Vector with the given Matrix4.", "kind": "function", "name": "transformMat4", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to transform this Vector3 with.", "name": "mat" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#transformMat4", "scope": "instance", "___id": "T000002R027524", "___s": true }, { "comment": "/**\r\n * Transforms the coordinates of this Vector3 with the given Matrix4.\r\n *\r\n * @method Phaser.Math.Vector3#transformCoordinates\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix4} mat - The Matrix4 to transform this Vector3 with.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 749, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Transforms the coordinates of this Vector3 with the given Matrix4.", "kind": "function", "name": "transformCoordinates", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to transform this Vector3 with.", "name": "mat" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#transformCoordinates", "scope": "instance", "___id": "T000002R027533", "___s": true }, { "comment": "/**\r\n * Transform this Vector with the given Quaternion.\r\n *\r\n * @method Phaser.Math.Vector3#transformQuat\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Quaternion} q - The Quaternion to transform this Vector with.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 778, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Transform this Vector with the given Quaternion.", "kind": "function", "name": "transformQuat", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "The Quaternion to transform this Vector with.", "name": "q" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#transformQuat", "scope": "instance", "___id": "T000002R027546", "___s": true }, { "comment": "/**\r\n * Multiplies this Vector3 by the specified matrix, applying a W divide. This is useful for projection,\r\n * e.g. unprojecting a 2D point into 3D space.\r\n *\r\n * @method Phaser.Math.Vector3#project\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix4} mat - The Matrix4 to multiply this Vector3 with.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 813, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Multiplies this Vector3 by the specified matrix, applying a W divide. This is useful for projection,\re.g. unprojecting a 2D point into 3D space.", "kind": "function", "name": "project", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to multiply this Vector3 with.", "name": "mat" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#project", "scope": "instance", "___id": "T000002R027562", "___s": true }, { "comment": "/**\r\n * Multiplies this Vector3 by the given view and projection matrices.\r\n *\r\n * @method Phaser.Math.Vector3#projectViewMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} viewMatrix - A View Matrix.\r\n * @param {Phaser.Math.Matrix4} projectionMatrix - A Projection Matrix.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 857, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Multiplies this Vector3 by the given view and projection matrices.", "kind": "function", "name": "projectViewMatrix", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "A View Matrix.", "name": "viewMatrix" }, { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "A Projection Matrix.", "name": "projectionMatrix" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#projectViewMatrix", "scope": "instance", "___id": "T000002R027588", "___s": true }, { "comment": "/**\r\n * Multiplies this Vector3 by the given inversed projection matrix and world matrix.\r\n *\r\n * @method Phaser.Math.Vector3#unprojectViewMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} projectionMatrix - An inversed Projection Matrix.\r\n * @param {Phaser.Math.Matrix4} worldMatrix - A World View Matrix.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 873, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Multiplies this Vector3 by the given inversed projection matrix and world matrix.", "kind": "function", "name": "unprojectViewMatrix", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "An inversed Projection Matrix.", "name": "projectionMatrix" }, { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "A World View Matrix.", "name": "worldMatrix" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#unprojectViewMatrix", "scope": "instance", "___id": "T000002R027590", "___s": true }, { "comment": "/**\r\n * Unproject this point from 2D space to 3D space.\r\n * The point should have its x and y properties set to\r\n * 2D screen space, and the z either at 0 (near plane)\r\n * or 1 (far plane). The provided matrix is assumed to already\r\n * be combined, i.e. projection * view * model.\r\n *\r\n * After this operation, this vector's (x, y, z) components will\r\n * represent the unprojected 3D coordinate.\r\n *\r\n * @method Phaser.Math.Vector3#unproject\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector4} viewport - Screen x, y, width and height in pixels.\r\n * @param {Phaser.Math.Matrix4} invProjectionView - Combined projection and view matrix.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 889, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Unproject this point from 2D space to 3D space.\rThe point should have its x and y properties set to\r2D screen space, and the z either at 0 (near plane)\ror 1 (far plane). The provided matrix is assumed to already\rbe combined, i.e. projection * view * model.\r\rAfter this operation, this vector's (x, y, z) components will\rrepresent the unprojected 3D coordinate.", "kind": "function", "name": "unproject", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "Screen x, y, width and height in pixels.", "name": "viewport" }, { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "Combined projection and view matrix.", "name": "invProjectionView" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#unproject", "scope": "instance", "___id": "T000002R027592", "___s": true }, { "comment": "/**\r\n * Make this Vector the zero vector (0, 0, 0).\r\n *\r\n * @method Phaser.Math.Vector3#reset\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 925, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Make this Vector the zero vector (0, 0, 0).", "kind": "function", "name": "reset", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3#reset", "scope": "instance", "___id": "T000002R027604", "___s": true }, { "comment": "/**\r\n * A static zero Vector3 for use by reference.\r\n *\r\n * This constant is meant for comparison operations and should not be modified directly.\r\n *\r\n * @constant\r\n * @name Phaser.Math.Vector3.ZERO\r\n * @type {Phaser.Math.Vector3}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Vector3.js", "lineno": 944, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "A static zero Vector3 for use by reference.\r\rThis constant is meant for comparison operations and should not be modified directly.", "kind": "constant", "name": "ZERO", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "3.16.0", "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3.ZERO", "scope": "static", "___id": "T000002R027609", "___s": true }, { "comment": "/**\r\n * A static right Vector3 for use by reference.\r\n *\r\n * This constant is meant for comparison operations and should not be modified directly.\r\n *\r\n * @constant\r\n * @name Phaser.Math.Vector3.RIGHT\r\n * @type {Phaser.Math.Vector3}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Vector3.js", "lineno": 956, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "A static right Vector3 for use by reference.\r\rThis constant is meant for comparison operations and should not be modified directly.", "kind": "constant", "name": "RIGHT", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "3.16.0", "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3.RIGHT", "scope": "static", "___id": "T000002R027611", "___s": true }, { "comment": "/**\r\n * A static left Vector3 for use by reference.\r\n *\r\n * This constant is meant for comparison operations and should not be modified directly.\r\n *\r\n * @constant\r\n * @name Phaser.Math.Vector3.LEFT\r\n * @type {Phaser.Math.Vector3}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Vector3.js", "lineno": 968, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "A static left Vector3 for use by reference.\r\rThis constant is meant for comparison operations and should not be modified directly.", "kind": "constant", "name": "LEFT", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "3.16.0", "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3.LEFT", "scope": "static", "___id": "T000002R027613", "___s": true }, { "comment": "/**\r\n * A static up Vector3 for use by reference.\r\n *\r\n * This constant is meant for comparison operations and should not be modified directly.\r\n *\r\n * @constant\r\n * @name Phaser.Math.Vector3.UP\r\n * @type {Phaser.Math.Vector3}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Vector3.js", "lineno": 980, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "A static up Vector3 for use by reference.\r\rThis constant is meant for comparison operations and should not be modified directly.", "kind": "constant", "name": "UP", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "3.16.0", "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3.UP", "scope": "static", "___id": "T000002R027615", "___s": true }, { "comment": "/**\r\n * A static down Vector3 for use by reference.\r\n *\r\n * This constant is meant for comparison operations and should not be modified directly.\r\n *\r\n * @constant\r\n * @name Phaser.Math.Vector3.DOWN\r\n * @type {Phaser.Math.Vector3}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Vector3.js", "lineno": 992, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "A static down Vector3 for use by reference.\r\rThis constant is meant for comparison operations and should not be modified directly.", "kind": "constant", "name": "DOWN", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "3.16.0", "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3.DOWN", "scope": "static", "___id": "T000002R027617", "___s": true }, { "comment": "/**\r\n * A static forward Vector3 for use by reference.\r\n *\r\n * This constant is meant for comparison operations and should not be modified directly.\r\n *\r\n * @constant\r\n * @name Phaser.Math.Vector3.FORWARD\r\n * @type {Phaser.Math.Vector3}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Vector3.js", "lineno": 1004, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "A static forward Vector3 for use by reference.\r\rThis constant is meant for comparison operations and should not be modified directly.", "kind": "constant", "name": "FORWARD", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "3.16.0", "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3.FORWARD", "scope": "static", "___id": "T000002R027619", "___s": true }, { "comment": "/**\r\n * A static back Vector3 for use by reference.\r\n *\r\n * This constant is meant for comparison operations and should not be modified directly.\r\n *\r\n * @constant\r\n * @name Phaser.Math.Vector3.BACK\r\n * @type {Phaser.Math.Vector3}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Vector3.js", "lineno": 1016, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "A static back Vector3 for use by reference.\r\rThis constant is meant for comparison operations and should not be modified directly.", "kind": "constant", "name": "BACK", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "3.16.0", "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3.BACK", "scope": "static", "___id": "T000002R027621", "___s": true }, { "comment": "/**\r\n * A static one Vector3 for use by reference.\r\n *\r\n * This constant is meant for comparison operations and should not be modified directly.\r\n *\r\n * @constant\r\n * @name Phaser.Math.Vector3.ONE\r\n * @type {Phaser.Math.Vector3}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Vector3.js", "lineno": 1028, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "A static one Vector3 for use by reference.\r\rThis constant is meant for comparison operations and should not be modified directly.", "kind": "constant", "name": "ONE", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "3.16.0", "memberof": "Phaser.Math.Vector3", "longname": "Phaser.Math.Vector3.ONE", "scope": "static", "___id": "T000002R027623", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A representation of a vector in 4D space.\r\n *\r\n * A four-component vector.\r\n *\r\n * @class Vector4\r\n * @memberof Phaser.Math\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x] - The x component.\r\n * @param {number} [y] - The y component.\r\n * @param {number} [z] - The z component.\r\n * @param {number} [w] - The w component.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "classdesc": "A representation of a vector in 4D space.\r\rA four-component vector.", "kind": "class", "name": "Vector4", "memberof": "Phaser.Math", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The x component.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y component.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The z component.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The w component.", "name": "w" } ], "scope": "static", "longname": "Phaser.Math.Vector4", "___id": "T000002R027627", "___s": true }, { "comment": "/**\r\n * The x component of this Vector.\r\n *\r\n * @name Phaser.Math.Vector4#x\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Vector4.js", "lineno": 34, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The x component of this Vector.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#x", "scope": "instance", "kind": "member", "___id": "T000002R027630", "___s": true }, { "comment": "/**\r\n * The y component of this Vector.\r\n *\r\n * @name Phaser.Math.Vector4#y\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Vector4.js", "lineno": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The y component of this Vector.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#y", "scope": "instance", "kind": "member", "___id": "T000002R027632", "___s": true }, { "comment": "/**\r\n * The z component of this Vector.\r\n *\r\n * @name Phaser.Math.Vector4#z\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Vector4.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The z component of this Vector.", "name": "z", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#z", "scope": "instance", "kind": "member", "___id": "T000002R027634", "___s": true }, { "comment": "/**\r\n * The w component of this Vector.\r\n *\r\n * @name Phaser.Math.Vector4#w\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Vector4.js", "lineno": 64, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "The w component of this Vector.", "name": "w", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#w", "scope": "instance", "kind": "member", "___id": "T000002R027636", "___s": true }, { "comment": "/**\r\n * Make a clone of this Vector4.\r\n *\r\n * @method Phaser.Math.Vector4#clone\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector4} A clone of this Vector4.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 90, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Make a clone of this Vector4.", "kind": "function", "name": "clone", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "A clone of this Vector4." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#clone", "scope": "instance", "___id": "T000002R027646", "___s": true }, { "comment": "/**\r\n * Copy the components of a given Vector into this Vector.\r\n *\r\n * @method Phaser.Math.Vector4#copy\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector4} src - The Vector to copy the components from.\r\n *\r\n * @return {Phaser.Math.Vector4} This Vector4.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Copy the components of a given Vector into this Vector.", "kind": "function", "name": "copy", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "The Vector to copy the components from.", "name": "src" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "This Vector4." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#copy", "scope": "instance", "___id": "T000002R027648", "___s": true }, { "comment": "/**\r\n * Check whether this Vector is equal to a given Vector.\r\n *\r\n * Performs a strict quality check against each Vector's components.\r\n *\r\n * @method Phaser.Math.Vector4#equals\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector4} v - The vector to check equality with.\r\n *\r\n * @return {boolean} A boolean indicating whether the two Vectors are equal or not.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 123, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Check whether this Vector is equal to a given Vector.\r\rPerforms a strict quality check against each Vector's components.", "kind": "function", "name": "equals", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "The vector to check equality with.", "name": "v" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "A boolean indicating whether the two Vectors are equal or not." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#equals", "scope": "instance", "___id": "T000002R027654", "___s": true }, { "comment": "/**\r\n * Set the `x`, `y`, `z` and `w` components of the this Vector to the given `x`, `y`, `z` and `w` values.\r\n *\r\n * @method Phaser.Math.Vector4#set\r\n * @since 3.0.0\r\n *\r\n * @param {(number|object)} x - The x value to set for this Vector, or an object containing x, y, z and w components.\r\n * @param {number} y - The y value to set for this Vector.\r\n * @param {number} z - The z value to set for this Vector.\r\n * @param {number} w - The z value to set for this Vector.\r\n *\r\n * @return {Phaser.Math.Vector4} This Vector4.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Set the `x`, `y`, `z` and `w` components of the this Vector to the given `x`, `y`, `z` and `w` values.", "kind": "function", "name": "set", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The x value to set for this Vector, or an object containing x, y, z and w components.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y value to set for this Vector.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The z value to set for this Vector.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The z value to set for this Vector.", "name": "w" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "This Vector4." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#set", "scope": "instance", "___id": "T000002R027656", "___s": true }, { "comment": "/**\r\n * Add a given Vector to this Vector. Addition is component-wise.\r\n *\r\n * @method Phaser.Math.Vector4#add\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3|Phaser.Math.Vector4)} v - The Vector to add to this Vector.\r\n *\r\n * @return {Phaser.Math.Vector4} This Vector4.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 173, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Add a given Vector to this Vector. Addition is component-wise.", "kind": "function", "name": "add", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Vector to add to this Vector.", "name": "v" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "This Vector4." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#add", "scope": "instance", "___id": "T000002R027666", "___s": true }, { "comment": "/**\r\n * Subtract the given Vector from this Vector. Subtraction is component-wise.\r\n *\r\n * @method Phaser.Math.Vector4#subtract\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3|Phaser.Math.Vector4)} v - The Vector to subtract from this Vector.\r\n *\r\n * @return {Phaser.Math.Vector4} This Vector4.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 193, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Subtract the given Vector from this Vector. Subtraction is component-wise.", "kind": "function", "name": "subtract", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Vector to subtract from this Vector.", "name": "v" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "This Vector4." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#subtract", "scope": "instance", "___id": "T000002R027672", "___s": true }, { "comment": "/**\r\n * Scale this Vector by the given value.\r\n *\r\n * @method Phaser.Math.Vector4#scale\r\n * @since 3.0.0\r\n *\r\n * @param {number} scale - The value to scale this Vector by.\r\n *\r\n * @return {Phaser.Math.Vector4} This Vector4.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 213, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Scale this Vector by the given value.", "kind": "function", "name": "scale", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to scale this Vector by.", "name": "scale" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "This Vector4." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#scale", "scope": "instance", "___id": "T000002R027678", "___s": true }, { "comment": "/**\r\n * Calculate the length (or magnitude) of this Vector.\r\n *\r\n * @method Phaser.Math.Vector4#length\r\n * @since 3.0.0\r\n *\r\n * @return {number} The length of this Vector.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 233, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the length (or magnitude) of this Vector.", "kind": "function", "name": "length", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length of this Vector." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#length", "scope": "instance", "___id": "T000002R027684", "___s": true }, { "comment": "/**\r\n * Calculate the length of this Vector squared.\r\n *\r\n * @method Phaser.Math.Vector4#lengthSq\r\n * @since 3.0.0\r\n *\r\n * @return {number} The length of this Vector, squared.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the length of this Vector squared.", "kind": "function", "name": "lengthSq", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length of this Vector, squared." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#lengthSq", "scope": "instance", "___id": "T000002R027690", "___s": true }, { "comment": "/**\r\n * Normalize this Vector.\r\n *\r\n * Makes the vector a unit length vector (magnitude of 1) in the same direction.\r\n *\r\n * @method Phaser.Math.Vector4#normalize\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector4} This Vector4.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Normalize this Vector.\r\rMakes the vector a unit length vector (magnitude of 1) in the same direction.", "kind": "function", "name": "normalize", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "This Vector4." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#normalize", "scope": "instance", "___id": "T000002R027696", "___s": true }, { "comment": "/**\r\n * Calculate the dot product of this Vector and the given Vector.\r\n *\r\n * @method Phaser.Math.Vector4#dot\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector4} v - The Vector4 to dot product with this Vector4.\r\n *\r\n * @return {number} The dot product of this Vector and the given Vector.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 300, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the dot product of this Vector and the given Vector.", "kind": "function", "name": "dot", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "The Vector4 to dot product with this Vector4.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The dot product of this Vector and the given Vector." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#dot", "scope": "instance", "___id": "T000002R027708", "___s": true }, { "comment": "/**\r\n * Linearly interpolate between this Vector and the given Vector.\r\n *\r\n * Interpolates this Vector towards the given Vector.\r\n *\r\n * @method Phaser.Math.Vector4#lerp\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector4} v - The Vector4 to interpolate towards.\r\n * @param {number} [t=0] - The interpolation percentage, between 0 and 1.\r\n *\r\n * @return {Phaser.Math.Vector4} This Vector4.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 315, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Linearly interpolate between this Vector and the given Vector.\r\rInterpolates this Vector towards the given Vector.", "kind": "function", "name": "lerp", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "The Vector4 to interpolate towards.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The interpolation percentage, between 0 and 1.", "name": "t" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "This Vector4." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#lerp", "scope": "instance", "___id": "T000002R027710", "___s": true }, { "comment": "/**\r\n * Perform a component-wise multiplication between this Vector and the given Vector.\r\n *\r\n * Multiplies this Vector by the given Vector.\r\n *\r\n * @method Phaser.Math.Vector4#multiply\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3|Phaser.Math.Vector4)} v - The Vector to multiply this Vector by.\r\n *\r\n * @return {Phaser.Math.Vector4} This Vector4.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 345, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Perform a component-wise multiplication between this Vector and the given Vector.\r\rMultiplies this Vector by the given Vector.", "kind": "function", "name": "multiply", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Vector to multiply this Vector by.", "name": "v" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "This Vector4." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#multiply", "scope": "instance", "___id": "T000002R027721", "___s": true }, { "comment": "/**\r\n * Perform a component-wise division between this Vector and the given Vector.\r\n *\r\n * Divides this Vector by the given Vector.\r\n *\r\n * @method Phaser.Math.Vector4#divide\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3|Phaser.Math.Vector4)} v - The Vector to divide this Vector by.\r\n *\r\n * @return {Phaser.Math.Vector4} This Vector4.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 367, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Perform a component-wise division between this Vector and the given Vector.\r\rDivides this Vector by the given Vector.", "kind": "function", "name": "divide", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Vector to divide this Vector by.", "name": "v" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "This Vector4." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#divide", "scope": "instance", "___id": "T000002R027727", "___s": true }, { "comment": "/**\r\n * Calculate the distance between this Vector and the given Vector.\r\n *\r\n * @method Phaser.Math.Vector4#distance\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3|Phaser.Math.Vector4)} v - The Vector to calculate the distance to.\r\n *\r\n * @return {number} The distance from this Vector to the given Vector.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 389, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the distance between this Vector and the given Vector.", "kind": "function", "name": "distance", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Vector to calculate the distance to.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance from this Vector to the given Vector." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#distance", "scope": "instance", "___id": "T000002R027733", "___s": true }, { "comment": "/**\r\n * Calculate the distance between this Vector and the given Vector, squared.\r\n *\r\n * @method Phaser.Math.Vector4#distanceSq\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3|Phaser.Math.Vector4)} v - The Vector to calculate the distance to.\r\n *\r\n * @return {number} The distance from this Vector to the given Vector, squared.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 409, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Calculate the distance between this Vector and the given Vector, squared.", "kind": "function", "name": "distanceSq", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3", "Phaser.Math.Vector4" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" }, { "type": "NameExpression", "name": "Phaser.Math.Vector4" } ] } }, "description": "The Vector to calculate the distance to.", "name": "v" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance from this Vector to the given Vector, squared." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#distanceSq", "scope": "instance", "___id": "T000002R027739", "___s": true }, { "comment": "/**\r\n * Negate the `x`, `y`, `z` and `w` components of this Vector.\r\n *\r\n * @method Phaser.Math.Vector4#negate\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector4} This Vector4.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 429, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Negate the `x`, `y`, `z` and `w` components of this Vector.", "kind": "function", "name": "negate", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "This Vector4." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#negate", "scope": "instance", "___id": "T000002R027745", "___s": true }, { "comment": "/**\r\n * Transform this Vector with the given Matrix.\r\n *\r\n * @method Phaser.Math.Vector4#transformMat4\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix4} mat - The Matrix4 to transform this Vector4 with.\r\n *\r\n * @return {Phaser.Math.Vector4} This Vector4.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 447, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Transform this Vector with the given Matrix.", "kind": "function", "name": "transformMat4", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to transform this Vector4 with.", "name": "mat" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "This Vector4." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#transformMat4", "scope": "instance", "___id": "T000002R027751", "___s": true }, { "comment": "/**\r\n * Transform this Vector with the given Quaternion.\r\n *\r\n * @method Phaser.Math.Vector4#transformQuat\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Quaternion} q - The Quaternion to transform this Vector with.\r\n *\r\n * @return {Phaser.Math.Vector4} This Vector4.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 473, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Transform this Vector with the given Quaternion.", "kind": "function", "name": "transformQuat", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "The Quaternion to transform this Vector with.", "name": "q" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "This Vector4." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#transformQuat", "scope": "instance", "___id": "T000002R027762", "___s": true }, { "comment": "/**\r\n * Make this Vector the zero vector (0, 0, 0, 0).\r\n *\r\n * @method Phaser.Math.Vector4#reset\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector4} This Vector4.\r\n */", "meta": { "filename": "Vector4.js", "lineno": 507, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Make this Vector the zero vector (0, 0, 0, 0).", "kind": "function", "name": "reset", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "This Vector4." } ], "memberof": "Phaser.Math.Vector4", "longname": "Phaser.Math.Vector4#reset", "scope": "instance", "___id": "T000002R027778", "___s": true }, { "comment": "/**\r\n * Checks if the two values are within the given `tolerance` of each other.\r\n *\r\n * @function Phaser.Math.Within\r\n * @since 3.0.0\r\n *\r\n * @param {number} a - The first value to use in the calculation.\r\n * @param {number} b - The second value to use in the calculation.\r\n * @param {number} tolerance - The tolerance. Anything equal to or less than this value is considered as being within range.\r\n *\r\n * @return {boolean} Returns `true` if `a` is less than or equal to the tolerance of `b`.\r\n */", "meta": { "filename": "Within.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Checks if the two values are within the given `tolerance` of each other.", "kind": "function", "name": "Within", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The first value to use in the calculation.", "name": "a" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The second value to use in the calculation.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tolerance. Anything equal to or less than this value is considered as being within range.", "name": "tolerance" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `true` if `a` is less than or equal to the tolerance of `b`." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.Within", "scope": "static", "___id": "T000002R027792", "___s": true }, { "comment": "/**\r\n * Wrap the given `value` between `min` and `max`.\r\n *\r\n * @function Phaser.Math.Wrap\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value to wrap.\r\n * @param {number} min - The minimum value.\r\n * @param {number} max - The maximum value.\r\n *\r\n * @return {number} The wrapped value.\r\n */", "meta": { "filename": "Wrap.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "description": "Wrap the given `value` between `min` and `max`.", "kind": "function", "name": "Wrap", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to wrap.", "name": "value" }, { "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" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The wrapped value." } ], "memberof": "Phaser.Math", "longname": "Phaser.Math.Wrap", "scope": "static", "___id": "T000002R027795", "___s": true }, { "comment": "/**\r\n * @namespace Phaser\r\n */", "meta": { "filename": "phaser.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "kind": "namespace", "name": "Phaser", "longname": "Phaser", "scope": "global", "___id": "T000002R027801", "___s": true }, { "comment": "/**\r\n * The root types namespace.\r\n *\r\n * @namespace Phaser.Types\r\n * @since 3.17.0\r\n */", "meta": { "filename": "phaser.js", "lineno": 78, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "The root types namespace.", "kind": "namespace", "name": "Types", "since": "3.17.0", "memberof": "Phaser", "longname": "Phaser.Types", "scope": "static", "___id": "T000002R027843", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * An Arcade Physics Image is an Image with an Arcade Physics body and related components.\r\n * The body can be dynamic or static.\r\n *\r\n * The main difference between an Arcade Image and an Arcade Sprite is that you cannot animate an Arcade Image.\r\n *\r\n * @class Image\r\n * @extends Phaser.GameObjects.Image\r\n * @memberof Phaser.Physics.Arcade\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.Physics.Arcade.Components.Acceleration\r\n * @extends Phaser.Physics.Arcade.Components.Angular\r\n * @extends Phaser.Physics.Arcade.Components.Bounce\r\n * @extends Phaser.Physics.Arcade.Components.Collision\r\n * @extends Phaser.Physics.Arcade.Components.Debug\r\n * @extends Phaser.Physics.Arcade.Components.Drag\r\n * @extends Phaser.Physics.Arcade.Components.Enable\r\n * @extends Phaser.Physics.Arcade.Components.Friction\r\n * @extends Phaser.Physics.Arcade.Components.Gravity\r\n * @extends Phaser.Physics.Arcade.Components.Immovable\r\n * @extends Phaser.Physics.Arcade.Components.Mass\r\n * @extends Phaser.Physics.Arcade.Components.Pushable\r\n * @extends Phaser.Physics.Arcade.Components.Size\r\n * @extends Phaser.Physics.Arcade.Components.Velocity\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.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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 * @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": "ArcadeImage.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "classdesc": "An Arcade Physics Image is an Image with an Arcade Physics body and related components.\rThe body can be dynamic or static.\r\rThe main difference between an Arcade Image and an Arcade Sprite is that you cannot animate an Arcade Image.", "kind": "class", "name": "Image", "augments": [ "Phaser.GameObjects.Image", "Phaser.Physics.Arcade.Components.Acceleration", "Phaser.Physics.Arcade.Components.Angular", "Phaser.Physics.Arcade.Components.Bounce", "Phaser.Physics.Arcade.Components.Collision", "Phaser.Physics.Arcade.Components.Debug", "Phaser.Physics.Arcade.Components.Drag", "Phaser.Physics.Arcade.Components.Enable", "Phaser.Physics.Arcade.Components.Friction", "Phaser.Physics.Arcade.Components.Gravity", "Phaser.Physics.Arcade.Components.Immovable", "Phaser.Physics.Arcade.Components.Mass", "Phaser.Physics.Arcade.Components.Pushable", "Phaser.Physics.Arcade.Components.Size", "Phaser.Physics.Arcade.Components.Velocity", "Phaser.GameObjects.Components.Alpha", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.Flip", "Phaser.GameObjects.Components.GetBounds", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "Phaser.GameObjects.Components.ScrollFactor", "Phaser.GameObjects.Components.Size", "Phaser.GameObjects.Components.Texture", "Phaser.GameObjects.Components.Tint", "Phaser.GameObjects.Components.Transform", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.Physics.Arcade", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "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.Physics.Arcade.Image", "___id": "T000002R027849", "___s": true }, { "comment": "/**\r\n * This Game Object's Physics Body.\r\n *\r\n * @name Phaser.Physics.Arcade.Image#body\r\n * @type {?(Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody)}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ArcadeImage.js", "lineno": 87, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "This Game Object's Physics Body.", "name": "body", "type": { "names": [ "Phaser.Physics.Arcade.Body", "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } ], "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "longname": "Phaser.Physics.Arcade.Image#body", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Image#body", "___id": "T000002R027854", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Arcade Physics Plugin belongs to a Scene and sets up and manages the Scene's physics simulation.\r\n * It also holds some useful methods for moving and rotating Arcade Physics Bodies.\r\n *\r\n * You can access it from within a Scene using `this.physics`.\r\n *\r\n * Arcade Physics uses the Projection Method of collision resolution and separation. While it's fast and suitable\r\n * for 'arcade' style games it lacks stability when multiple objects are in close proximity or resting upon each other.\r\n * The separation that stops two objects penetrating may create a new penetration against a different object. If you\r\n * require a high level of stability please consider using an alternative physics system, such as Matter.js.\r\n *\r\n * @class ArcadePhysics\r\n * @memberof Phaser.Physics.Arcade\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene that this Plugin belongs to.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 21, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "classdesc": "The Arcade Physics Plugin belongs to a Scene and sets up and manages the Scene's physics simulation.\rIt also holds some useful methods for moving and rotating Arcade Physics Bodies.\r\rYou can access it from within a Scene using `this.physics`.\r\rArcade Physics uses the Projection Method of collision resolution and separation. While it's fast and suitable\rfor 'arcade' style games it lacks stability when multiple objects are in close proximity or resting upon each other.\rThe separation that stops two objects penetrating may create a new penetration against a different object. If you\rrequire a high level of stability please consider using an alternative physics system, such as Matter.js.", "kind": "class", "name": "ArcadePhysics", "memberof": "Phaser.Physics.Arcade", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene that this Plugin belongs to.", "name": "scene" } ], "scope": "static", "longname": "Phaser.Physics.Arcade.ArcadePhysics", "___id": "T000002R027870", "___s": true }, { "comment": "/**\r\n * The Scene that this Plugin belongs to.\r\n *\r\n * @name Phaser.Physics.Arcade.ArcadePhysics#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 46, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Scene that this Plugin belongs to.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#scene", "scope": "instance", "kind": "member", "___id": "T000002R027873", "___s": true }, { "comment": "/**\r\n * The Scene's Systems.\r\n *\r\n * @name Phaser.Physics.Arcade.ArcadePhysics#systems\r\n * @type {Phaser.Scenes.Systems}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 55, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "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.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#systems", "scope": "instance", "kind": "member", "___id": "T000002R027875", "___s": true }, { "comment": "/**\r\n * A configuration object. Union of the `physics.arcade.*` properties of the GameConfig and SceneConfig objects.\r\n *\r\n * @name Phaser.Physics.Arcade.ArcadePhysics#config\r\n * @type {Phaser.Types.Physics.Arcade.ArcadeWorldConfig}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 64, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "A configuration object. Union of the `physics.arcade.*` properties of the GameConfig and SceneConfig objects.", "name": "config", "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeWorldConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeWorldConfig" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#config", "scope": "instance", "kind": "member", "___id": "T000002R027877", "___s": true }, { "comment": "/**\r\n * The physics simulation.\r\n *\r\n * @name Phaser.Physics.Arcade.ArcadePhysics#world\r\n * @type {Phaser.Physics.Arcade.World}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The physics simulation.", "name": "world", "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#world", "scope": "instance", "kind": "member", "___id": "T000002R027879", "___s": true }, { "comment": "/**\r\n * An object holding the Arcade Physics factory methods.\r\n *\r\n * @name Phaser.Physics.Arcade.ArcadePhysics#add\r\n * @type {Phaser.Physics.Arcade.Factory}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "An object holding the Arcade Physics factory methods.", "name": "add", "type": { "names": [ "Phaser.Physics.Arcade.Factory" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Factory" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#add", "scope": "instance", "kind": "member", "___id": "T000002R027881", "___s": true }, { "comment": "/**\r\n * Causes `World.update` to be automatically called each time the Scene\r\n * emits and `UPDATE` event. This is the default setting, so only needs\r\n * calling if you have specifically disabled it.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#enableUpdate\r\n * @since 3.50.0\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 149, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Causes `World.update` to be automatically called each time the Scene\remits and `UPDATE` event. This is the default setting, so only needs\rcalling if you have specifically disabled it.", "kind": "function", "name": "enableUpdate", "since": "3.50.0", "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#enableUpdate", "scope": "instance", "___id": "T000002R027894", "___s": true }, { "comment": "/**\r\n * Causes `World.update` to **not** be automatically called each time the Scene\r\n * emits and `UPDATE` event.\r\n *\r\n * If you wish to run the World update at your own rate, or from your own\r\n * component, then you should call this method to disable the built-in link,\r\n * and then call `World.update(delta, time)` accordingly.\r\n *\r\n * Note that `World.postUpdate` is always automatically called when the Scene\r\n * emits a `POST_UPDATE` event, regardless of this setting.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#disableUpdate\r\n * @since 3.50.0\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 162, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Causes `World.update` to **not** be automatically called each time the Scene\remits and `UPDATE` event.\r\rIf you wish to run the World update at your own rate, or from your own\rcomponent, then you should call this method to disable the built-in link,\rand then call `World.update(delta, time)` accordingly.\r\rNote that `World.postUpdate` is always automatically called when the Scene\remits a `POST_UPDATE` event, regardless of this setting.", "kind": "function", "name": "disableUpdate", "since": "3.50.0", "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#disableUpdate", "scope": "instance", "___id": "T000002R027896", "___s": true }, { "comment": "/**\r\n * Creates the physics configuration for the current Scene.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#getConfig\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.Physics.Arcade.ArcadeWorldConfig} The physics configuration.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 181, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Creates the physics configuration for the current Scene.", "kind": "function", "name": "getConfig", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeWorldConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeWorldConfig" } }, "description": "The physics configuration." } ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#getConfig", "scope": "instance", "___id": "T000002R027898", "___s": true }, { "comment": "/**\r\n * Returns the next available collision category.\r\n *\r\n * You can have a maximum of 32 categories.\r\n *\r\n * By default all bodies collide with all other bodies.\r\n *\r\n * Use the `Body.setCollisionCategory()` and\r\n * `Body.setCollidesWith()` methods to change this.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#nextCategory\r\n * @since 3.61.0\r\n *\r\n * @return {number} The next collision category.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 202, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Returns the next available collision category.\r\rYou can have a maximum of 32 categories.\r\rBy default all bodies collide with all other bodies.\r\rUse the `Body.setCollisionCategory()` and\r`Body.setCollidesWith()` methods to change this.", "kind": "function", "name": "nextCategory", "since": "3.61.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The next collision category." } ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#nextCategory", "scope": "instance", "___id": "T000002R027903", "___s": true }, { "comment": "/**\r\n * Tests if Game Objects overlap. See {@link Phaser.Physics.Arcade.World#overlap}\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#overlap\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} object1 - The first object or array of objects to check.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} [object2] - The second object or array of objects to check, or `undefined`.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [overlapCallback] - An optional callback function that is called if the objects overlap.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [processCallback] - An optional callback function that lets you perform additional checks against the two objects if they overlap. If this is set then `collideCallback` will only be called if this callback returns `true`.\r\n * @param {*} [callbackContext] - The context in which to run the callbacks.\r\n *\r\n * @return {boolean} True if at least one Game Object overlaps another.\r\n *\r\n * @see Phaser.Physics.Arcade.World#overlap\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 224, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Tests if Game Objects overlap. See {@link Phaser.Physics.Arcade.World#overlap}", "kind": "function", "name": "overlap", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "description": "The first object or array of objects to check.", "name": "object1" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "optional": true, "description": "The second object or array of objects to check, or `undefined`.", "name": "object2" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that is called if the objects overlap.", "name": "overlapCallback" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that lets you perform additional checks against the two objects if they overlap. If this is set then `collideCallback` will only be called if this callback returns `true`.", "name": "processCallback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The context in which to run the callbacks.", "name": "callbackContext" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if at least one Game Object overlaps another." } ], "see": [ "Phaser.Physics.Arcade.World#overlap" ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#overlap", "scope": "instance", "___id": "T000002R027906", "___s": true }, { "comment": "/**\r\n * Performs a collision check and separation between the two physics enabled objects given, which can be single\r\n * Game Objects, arrays of Game Objects, Physics Groups, arrays of Physics Groups or normal Groups.\r\n *\r\n * If you don't require separation then use {@link #overlap} instead.\r\n *\r\n * If two Groups or arrays are passed, each member of one will be tested against each member of the other.\r\n *\r\n * If **only** one Group is passed (as `object1`), each member of the Group will be collided against the other members.\r\n *\r\n * If **only** one Array is passed, the array is iterated and every element in it is tested against the others.\r\n *\r\n * Two callbacks can be provided. The `collideCallback` is invoked if a collision occurs and the two colliding\r\n * objects are passed to it.\r\n *\r\n * Arcade Physics uses the Projection Method of collision resolution and separation. While it's fast and suitable\r\n * for 'arcade' style games it lacks stability when multiple objects are in close proximity or resting upon each other.\r\n * The separation that stops two objects penetrating may create a new penetration against a different object. If you\r\n * require a high level of stability please consider using an alternative physics system, such as Matter.js.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#collide\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} object1 - The first object or array of objects to check.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} [object2] - The second object or array of objects to check, or `undefined`.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [collideCallback] - An optional callback function that is called if the objects collide.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [processCallback] - An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.\r\n * @param {*} [callbackContext] - The context in which to run the callbacks.\r\n *\r\n * @return {boolean} True if any overlapping Game Objects were separated, otherwise false.\r\n *\r\n * @see Phaser.Physics.Arcade.World#collide\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 249, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Performs a collision check and separation between the two physics enabled objects given, which can be single\rGame Objects, arrays of Game Objects, Physics Groups, arrays of Physics Groups or normal Groups.\r\rIf you don't require separation then use {@link #overlap} instead.\r\rIf two Groups or arrays are passed, each member of one will be tested against each member of the other.\r\rIf **only** one Group is passed (as `object1`), each member of the Group will be collided against the other members.\r\rIf **only** one Array is passed, the array is iterated and every element in it is tested against the others.\r\rTwo callbacks can be provided. The `collideCallback` is invoked if a collision occurs and the two colliding\robjects are passed to it.\r\rArcade Physics uses the Projection Method of collision resolution and separation. While it's fast and suitable\rfor 'arcade' style games it lacks stability when multiple objects are in close proximity or resting upon each other.\rThe separation that stops two objects penetrating may create a new penetration against a different object. If you\rrequire a high level of stability please consider using an alternative physics system, such as Matter.js.", "kind": "function", "name": "collide", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "description": "The first object or array of objects to check.", "name": "object1" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "optional": true, "description": "The second object or array of objects to check, or `undefined`.", "name": "object2" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that is called if the objects collide.", "name": "collideCallback" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.", "name": "processCallback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The context in which to run the callbacks.", "name": "callbackContext" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if any overlapping Game Objects were separated, otherwise false." } ], "see": [ "Phaser.Physics.Arcade.World#collide" ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#collide", "scope": "instance", "___id": "T000002R027911", "___s": true }, { "comment": "/**\r\n * This advanced method is specifically for testing for collision between a single Sprite and an array of Tile objects.\r\n *\r\n * You should generally use the `collide` method instead, with a Sprite vs. a Tilemap Layer, as that will perform\r\n * tile filtering and culling for you, as well as handle the interesting face collision automatically.\r\n *\r\n * This method is offered for those who would like to check for collision with specific Tiles in a layer, without\r\n * having to set any collision attributes on the tiles in question. This allows you to perform quick dynamic collisions\r\n * on small sets of Tiles. As such, no culling or checks are made to the array of Tiles given to this method,\r\n * you should filter them before passing them to this method.\r\n *\r\n * Important: Use of this method skips the `interesting faces` system that Tilemap Layers use. This means if you have\r\n * say a row or column of tiles, and you jump into, or walk over them, it's possible to get stuck on the edges of the\r\n * tiles as the interesting face calculations are skipped. However, for quick-fire small collision set tests on\r\n * dynamic maps, this method can prove very useful.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#collideTiles\r\n * @fires Phaser.Physics.Arcade.Events#TILE_COLLIDE\r\n * @since 3.17.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} sprite - The first object to check for collision.\r\n * @param {Phaser.Tilemaps.Tile[]} tiles - An array of Tiles to check for collision against.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [collideCallback] - An optional callback function that is called if the objects collide.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [processCallback] - An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.\r\n * @param {any} [callbackContext] - The context in which to run the callbacks.\r\n *\r\n * @return {boolean} True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 291, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "This advanced method is specifically for testing for collision between a single Sprite and an array of Tile objects.\r\rYou should generally use the `collide` method instead, with a Sprite vs. a Tilemap Layer, as that will perform\rtile filtering and culling for you, as well as handle the interesting face collision automatically.\r\rThis method is offered for those who would like to check for collision with specific Tiles in a layer, without\rhaving to set any collision attributes on the tiles in question. This allows you to perform quick dynamic collisions\ron small sets of Tiles. As such, no culling or checks are made to the array of Tiles given to this method,\ryou should filter them before passing them to this method.\r\rImportant: Use of this method skips the `interesting faces` system that Tilemap Layers use. This means if you have\rsay a row or column of tiles, and you jump into, or walk over them, it's possible to get stuck on the edges of the\rtiles as the interesting face calculations are skipped. However, for quick-fire small collision set tests on\rdynamic maps, this method can prove very useful.", "kind": "function", "name": "collideTiles", "fires": [ "Phaser.Physics.Arcade.Events#event:TILE_COLLIDE" ], "since": "3.17.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The first object to check for collision.", "name": "sprite" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of Tiles to check for collision against.", "name": "tiles" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that is called if the objects collide.", "name": "collideCallback" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.", "name": "processCallback" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The context in which to run the callbacks.", "name": "callbackContext" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated." } ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#collideTiles", "scope": "instance", "___id": "T000002R027916", "___s": true }, { "comment": "/**\r\n * This advanced method is specifically for testing for overlaps between a single Sprite and an array of Tile objects.\r\n *\r\n * You should generally use the `overlap` method instead, with a Sprite vs. a Tilemap Layer, as that will perform\r\n * tile filtering and culling for you, as well as handle the interesting face collision automatically.\r\n *\r\n * This method is offered for those who would like to check for overlaps with specific Tiles in a layer, without\r\n * having to set any collision attributes on the tiles in question. This allows you to perform quick dynamic overlap\r\n * tests on small sets of Tiles. As such, no culling or checks are made to the array of Tiles given to this method,\r\n * you should filter them before passing them to this method.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#overlapTiles\r\n * @fires Phaser.Physics.Arcade.Events#TILE_OVERLAP\r\n * @since 3.17.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} sprite - The first object to check for collision.\r\n * @param {Phaser.Tilemaps.Tile[]} tiles - An array of Tiles to check for collision against.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [collideCallback] - An optional callback function that is called if the objects overlap.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [processCallback] - An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.\r\n * @param {any} [callbackContext] - The context in which to run the callbacks.\r\n *\r\n * @return {boolean} True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 324, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "This advanced method is specifically for testing for overlaps between a single Sprite and an array of Tile objects.\r\rYou should generally use the `overlap` method instead, with a Sprite vs. a Tilemap Layer, as that will perform\rtile filtering and culling for you, as well as handle the interesting face collision automatically.\r\rThis method is offered for those who would like to check for overlaps with specific Tiles in a layer, without\rhaving to set any collision attributes on the tiles in question. This allows you to perform quick dynamic overlap\rtests on small sets of Tiles. As such, no culling or checks are made to the array of Tiles given to this method,\ryou should filter them before passing them to this method.", "kind": "function", "name": "overlapTiles", "fires": [ "Phaser.Physics.Arcade.Events#event:TILE_OVERLAP" ], "since": "3.17.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The first object to check for collision.", "name": "sprite" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of Tiles to check for collision against.", "name": "tiles" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that is called if the objects overlap.", "name": "collideCallback" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.", "name": "processCallback" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The context in which to run the callbacks.", "name": "callbackContext" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated." } ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#overlapTiles", "scope": "instance", "___id": "T000002R027918", "___s": true }, { "comment": "/**\r\n * Pauses the simulation.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#pause\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Physics.Arcade.World} The simulation.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 352, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Pauses the simulation.", "kind": "function", "name": "pause", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "description": "The simulation." } ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#pause", "scope": "instance", "___id": "T000002R027920", "___s": true }, { "comment": "/**\r\n * Resumes the simulation (if paused).\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#resume\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Physics.Arcade.World} The simulation.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 365, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Resumes the simulation (if paused).", "kind": "function", "name": "resume", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "description": "The simulation." } ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#resume", "scope": "instance", "___id": "T000002R027922", "___s": true }, { "comment": "/**\r\n * Sets the acceleration.x/y property on the game object so it will move towards the x/y coordinates at the given rate (in pixels per second squared)\r\n *\r\n * You must give a maximum speed value, beyond which the game object won't go any faster.\r\n *\r\n * Note: The game object does not continuously track the target. If the target changes location during transit the game object will not modify its course.\r\n * Note: The game object doesn't stop moving once it reaches the destination coordinates.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#accelerateTo\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - Any Game Object with an Arcade Physics body.\r\n * @param {number} x - The x coordinate to accelerate towards.\r\n * @param {number} y - The y coordinate to accelerate towards.\r\n * @param {number} [speed=60] - The acceleration (change in speed) in pixels per second squared.\r\n * @param {number} [xSpeedMax=500] - The maximum x velocity the game object can reach.\r\n * @param {number} [ySpeedMax=500] - The maximum y velocity the game object can reach.\r\n *\r\n * @return {number} The angle (in radians) that the object should be visually set to in order to match its new velocity.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 378, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the acceleration.x/y property on the game object so it will move towards the x/y coordinates at the given rate (in pixels per second squared)\r\rYou must give a maximum speed value, beyond which the game object won't go any faster.\r\rNote: The game object does not continuously track the target. If the target changes location during transit the game object will not modify its course.\rNote: The game object doesn't stop moving once it reaches the destination coordinates.", "kind": "function", "name": "accelerateTo", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "Any Game Object with an Arcade Physics body.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to accelerate towards.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to accelerate towards.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 60, "description": "The acceleration (change in speed) in pixels per second squared.", "name": "speed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 500, "description": "The maximum x velocity the game object can reach.", "name": "xSpeedMax" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 500, "description": "The maximum y velocity the game object can reach.", "name": "ySpeedMax" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle (in radians) that the object should be visually set to in order to match its new velocity." } ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#accelerateTo", "scope": "instance", "___id": "T000002R027924", "___s": true }, { "comment": "/**\r\n * Sets the acceleration.x/y property on the game object so it will move towards the x/y coordinates at the given rate (in pixels per second squared)\r\n *\r\n * You must give a maximum speed value, beyond which the game object won't go any faster.\r\n *\r\n * Note: The game object does not continuously track the target. If the target changes location during transit the game object will not modify its course.\r\n * Note: The game object doesn't stop moving once it reaches the destination coordinates.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#accelerateToObject\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - Any Game Object with an Arcade Physics body.\r\n * @param {Phaser.GameObjects.GameObject} destination - The Game Object to move towards. Can be any object but must have visible x/y properties.\r\n * @param {number} [speed=60] - The acceleration (change in speed) in pixels per second squared.\r\n * @param {number} [xSpeedMax=500] - The maximum x velocity the game object can reach.\r\n * @param {number} [ySpeedMax=500] - The maximum y velocity the game object can reach.\r\n *\r\n * @return {number} The angle (in radians) that the object should be visually set to in order to match its new velocity.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 414, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the acceleration.x/y property on the game object so it will move towards the x/y coordinates at the given rate (in pixels per second squared)\r\rYou must give a maximum speed value, beyond which the game object won't go any faster.\r\rNote: The game object does not continuously track the target. If the target changes location during transit the game object will not modify its course.\rNote: The game object doesn't stop moving once it reaches the destination coordinates.", "kind": "function", "name": "accelerateToObject", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "Any Game Object with an Arcade Physics body.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to move towards. Can be any object but must have visible x/y properties.", "name": "destination" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 60, "description": "The acceleration (change in speed) in pixels per second squared.", "name": "speed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 500, "description": "The maximum x velocity the game object can reach.", "name": "xSpeedMax" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 500, "description": "The maximum y velocity the game object can reach.", "name": "ySpeedMax" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle (in radians) that the object should be visually set to in order to match its new velocity." } ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#accelerateToObject", "scope": "instance", "___id": "T000002R027928", "___s": true }, { "comment": "/**\r\n * Finds the Body or Game Object closest to a source point or object.\r\n *\r\n * If a `targets` argument is passed, this method finds the closest of those.\r\n * The targets can be Arcade Physics Game Objects, Dynamic Bodies, or Static Bodies.\r\n *\r\n * If no `targets` argument is passed, this method finds the closest Dynamic Body.\r\n *\r\n * If two or more targets are the exact same distance from the source point, only the first target\r\n * is returned.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#closest\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody|Phaser.GameObjects.GameObject} Target\r\n * @param {Phaser.Types.Math.Vector2Like} source - Any object with public `x` and `y` properties, such as a Game Object or Geometry object.\r\n * @param {Target[]} [targets] - The targets.\r\n *\r\n * @return {Target|null} The target closest to the given source point.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 438, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Finds the Body or Game Object closest to a source point or object.\r\rIf a `targets` argument is passed, this method finds the closest of those.\rThe targets can be Arcade Physics Game Objects, Dynamic Bodies, or Static Bodies.\r\rIf no `targets` argument is passed, this method finds the closest Dynamic Body.\r\rIf two or more targets are the exact same distance from the source point, only the first target\ris returned.", "kind": "function", "name": "closest", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody|Phaser.GameObjects.GameObject} Target", "value": "{Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody|Phaser.GameObjects.GameObject} Target" } ], "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "Any object with public `x` and `y` properties, such as a Game Object or Geometry object.", "name": "source" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Target", "type": "NameExpression" } ] } }, "optional": true, "description": "The targets.", "name": "targets" } ], "returns": [ { "type": { "names": [ "Target", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Target" }, { "type": "NullLiteral" } ] } }, "description": "The target closest to the given source point." } ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#closest", "scope": "instance", "___id": "T000002R027930", "___s": true }, { "comment": "/**\r\n * Finds the Body or Game Object farthest from a source point or object.\r\n *\r\n * If a `targets` argument is passed, this method finds the farthest of those.\r\n * The targets can be Arcade Physics Game Objects, Dynamic Bodies, or Static Bodies.\r\n *\r\n * If no `targets` argument is passed, this method finds the farthest Dynamic Body.\r\n *\r\n * If two or more targets are the exact same distance from the source point, only the first target\r\n * is returned.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#furthest\r\n * @since 3.0.0\r\n *\r\n * @param {any} source - Any object with public `x` and `y` properties, such as a Game Object or Geometry object.\r\n * @param {(Phaser.Physics.Arcade.Body[]|Phaser.Physics.Arcade.StaticBody[]|Phaser.GameObjects.GameObject[])} [targets] - The targets.\r\n *\r\n * @return {?(Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody|Phaser.GameObjects.GameObject)} The target farthest from the given source point.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 493, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Finds the Body or Game Object farthest from a source point or object.\r\rIf a `targets` argument is passed, this method finds the farthest of those.\rThe targets can be Arcade Physics Game Objects, Dynamic Bodies, or Static Bodies.\r\rIf no `targets` argument is passed, this method finds the farthest Dynamic Body.\r\rIf two or more targets are the exact same distance from the source point, only the first target\ris returned.", "kind": "function", "name": "furthest", "since": "3.0.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "Any object with public `x` and `y` properties, such as a Game Object or Geometry object.", "name": "source" }, { "type": { "names": [ "Array.", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Physics.Arcade.Body", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Physics.Arcade.StaticBody", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The targets.", "name": "targets" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body", "Phaser.Physics.Arcade.StaticBody", "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" }, { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ], "nullable": true } }, "nullable": true, "description": "The target farthest from the given source point." } ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#furthest", "scope": "instance", "___id": "T000002R027944", "___s": true }, { "comment": "/**\r\n * Move the given display object towards the x/y coordinates at a steady velocity.\r\n * If you specify a maxTime then it will adjust the speed (over-writing what you set) so it arrives at the destination in that number of seconds.\r\n * Timings are approximate due to the way browser timers work. Allow for a variance of +- 50ms.\r\n * Note: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.\r\n * Note: The display object doesn't stop moving once it reaches the destination coordinates.\r\n * Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set drag or acceleration too high this object may not move at all)\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#moveTo\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - Any Game Object with an Arcade Physics body.\r\n * @param {number} x - The x coordinate to move towards.\r\n * @param {number} y - The y coordinate to move towards.\r\n * @param {number} [speed=60] - The speed it will move, in pixels per second (default is 60 pixels/sec)\r\n * @param {number} [maxTime=0] - Time given in milliseconds (1000 = 1 sec). If set the speed is adjusted so the object will arrive at destination in the given number of ms.\r\n *\r\n * @return {number} The angle (in radians) that the object should be visually set to in order to match its new velocity.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 548, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Move the given display object towards the x/y coordinates at a steady velocity.\rIf you specify a maxTime then it will adjust the speed (over-writing what you set) so it arrives at the destination in that number of seconds.\rTimings are approximate due to the way browser timers work. Allow for a variance of +- 50ms.\rNote: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.\rNote: The display object doesn't stop moving once it reaches the destination coordinates.\rNote: Doesn't take into account acceleration, maxVelocity or drag (if you've set drag or acceleration too high this object may not move at all)", "kind": "function", "name": "moveTo", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "Any Game Object with an Arcade Physics body.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to move towards.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to move towards.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 60, "description": "The speed it will move, in pixels per second (default is 60 pixels/sec)", "name": "speed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Time given in milliseconds (1000 = 1 sec). If set the speed is adjusted so the object will arrive at destination in the given number of ms.", "name": "maxTime" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle (in radians) that the object should be visually set to in order to match its new velocity." } ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#moveTo", "scope": "instance", "___id": "T000002R027958", "___s": true }, { "comment": "/**\r\n * Move the given display object towards the destination object at a steady velocity.\r\n * If you specify a maxTime then it will adjust the speed (overwriting what you set) so it arrives at the destination in that number of seconds.\r\n * Timings are approximate due to the way browser timers work. Allow for a variance of +- 50ms.\r\n * Note: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.\r\n * Note: The display object doesn't stop moving once it reaches the destination coordinates.\r\n * Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set drag or acceleration too high this object may not move at all)\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#moveToObject\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - Any Game Object with an Arcade Physics body.\r\n * @param {object} destination - Any object with public `x` and `y` properties, such as a Game Object or Geometry object.\r\n * @param {number} [speed=60] - The speed it will move, in pixels per second (default is 60 pixels/sec)\r\n * @param {number} [maxTime=0] - Time given in milliseconds (1000 = 1 sec). If set the speed is adjusted so the object will arrive at destination in the given number of ms.\r\n *\r\n * @return {number} The angle (in radians) that the object should be visually set to in order to match its new velocity.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 585, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Move the given display object towards the destination object at a steady velocity.\rIf you specify a maxTime then it will adjust the speed (overwriting what you set) so it arrives at the destination in that number of seconds.\rTimings are approximate due to the way browser timers work. Allow for a variance of +- 50ms.\rNote: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.\rNote: The display object doesn't stop moving once it reaches the destination coordinates.\rNote: Doesn't take into account acceleration, maxVelocity or drag (if you've set drag or acceleration too high this object may not move at all)", "kind": "function", "name": "moveToObject", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "Any Game Object with an Arcade Physics body.", "name": "gameObject" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "Any object with public `x` and `y` properties, such as a Game Object or Geometry object.", "name": "destination" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 60, "description": "The speed it will move, in pixels per second (default is 60 pixels/sec)", "name": "speed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Time given in milliseconds (1000 = 1 sec). If set the speed is adjusted so the object will arrive at destination in the given number of ms.", "name": "maxTime" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle (in radians) that the object should be visually set to in order to match its new velocity." } ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#moveToObject", "scope": "instance", "___id": "T000002R027964", "___s": true }, { "comment": "/**\r\n * Given the angle (in degrees) and speed calculate the velocity and return it as a vector, or set it to the given vector object.\r\n * One way to use this is: velocityFromAngle(angle, 200, sprite.body.velocity) which will set the values directly to the sprite's velocity and not create a new vector object.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#velocityFromAngle\r\n * @since 3.0.0\r\n *\r\n * @param {number} angle - The angle in degrees calculated in clockwise positive direction (down = 90 degrees positive, right = 0 degrees positive, up = 90 degrees negative)\r\n * @param {number} [speed=60] - The speed it will move, in pixels per second squared.\r\n * @param {Phaser.Math.Vector2} [vec2] - The Vector2 in which the x and y properties will be set to the calculated velocity.\r\n *\r\n * @return {Phaser.Math.Vector2} The Vector2 that stores the velocity.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 608, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Given the angle (in degrees) and speed calculate the velocity and return it as a vector, or set it to the given vector object.\rOne way to use this is: velocityFromAngle(angle, 200, sprite.body.velocity) which will set the values directly to the sprite's velocity and not create a new vector object.", "kind": "function", "name": "velocityFromAngle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle in degrees calculated in clockwise positive direction (down = 90 degrees positive, right = 0 degrees positive, up = 90 degrees negative)", "name": "angle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 60, "description": "The speed it will move, in pixels per second squared.", "name": "speed" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "The Vector2 in which the x and y properties will be set to the calculated velocity.", "name": "vec2" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The Vector2 that stores the velocity." } ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#velocityFromAngle", "scope": "instance", "___id": "T000002R027966", "___s": true }, { "comment": "/**\r\n * Given the rotation (in radians) and speed calculate the velocity and return it as a vector, or set it to the given vector object.\r\n * One way to use this is: velocityFromRotation(rotation, 200, sprite.body.velocity) which will set the values directly to the sprite's velocity and not create a new vector object.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#velocityFromRotation\r\n * @since 3.0.0\r\n *\r\n * @param {number} rotation - The angle in radians.\r\n * @param {number} [speed=60] - The speed it will move, in pixels per second squared\r\n * @param {Phaser.Math.Vector2} [vec2] - The Vector2 in which the x and y properties will be set to the calculated velocity.\r\n *\r\n * @return {Phaser.Math.Vector2} The Vector2 that stores the velocity.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 629, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Given the rotation (in radians) and speed calculate the velocity and return it as a vector, or set it to the given vector object.\rOne way to use this is: velocityFromRotation(rotation, 200, sprite.body.velocity) which will set the values directly to the sprite's velocity and not create a new vector object.", "kind": "function", "name": "velocityFromRotation", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle in radians.", "name": "rotation" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 60, "description": "The speed it will move, in pixels per second squared", "name": "speed" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "The Vector2 in which the x and y properties will be set to the calculated velocity.", "name": "vec2" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The Vector2 that stores the velocity." } ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#velocityFromRotation", "scope": "instance", "___id": "T000002R027970", "___s": true }, { "comment": "/**\r\n * This method will search the given rectangular area and return an array of all physics bodies that\r\n * overlap with it. It can return either Dynamic, Static bodies or a mixture of both.\r\n *\r\n * A body only has to intersect with the search area to be considered, it doesn't have to be fully\r\n * contained within it.\r\n *\r\n * If Arcade Physics is set to use the RTree (which it is by default) then the search for is extremely fast,\r\n * otherwise the search is O(N) for Dynamic Bodies.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#overlapRect\r\n * @since 3.17.0\r\n *\r\n * @param {number} x - The top-left x coordinate of the area to search within.\r\n * @param {number} y - The top-left y coordinate of the area to search within.\r\n * @param {number} width - The width of the area to search within.\r\n * @param {number} height - The height of the area to search within.\r\n * @param {boolean} [includeDynamic=true] - Should the search include Dynamic Bodies?\r\n * @param {boolean} [includeStatic=false] - Should the search include Static Bodies?\r\n *\r\n * @return {(Phaser.Physics.Arcade.Body[]|Phaser.Physics.Arcade.StaticBody[])} An array of bodies that overlap with the given area.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "This method will search the given rectangular area and return an array of all physics bodies that\roverlap with it. It can return either Dynamic, Static bodies or a mixture of both.\r\rA body only has to intersect with the search area to be considered, it doesn't have to be fully\rcontained within it.\r\rIf Arcade Physics is set to use the RTree (which it is by default) then the search for is extremely fast,\rotherwise the search is O(N) for Dynamic Bodies.", "kind": "function", "name": "overlapRect", "since": "3.17.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x coordinate of the area to search within.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y coordinate of the area to search within.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the area to search within.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the area to search within.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the search include Dynamic Bodies?", "name": "includeDynamic" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the search include Static Bodies?", "name": "includeStatic" } ], "returns": [ { "type": { "names": [ "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Physics.Arcade.Body", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Physics.Arcade.StaticBody", "type": "NameExpression" } ] } ] } }, "description": "An array of bodies that overlap with the given area." } ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#overlapRect", "scope": "instance", "___id": "T000002R027974", "___s": true }, { "comment": "/**\r\n * This method will search the given circular area and return an array of all physics bodies that\r\n * overlap with it. It can return either Dynamic, Static bodies or a mixture of both.\r\n *\r\n * A body only has to intersect with the search area to be considered, it doesn't have to be fully\r\n * contained within it.\r\n *\r\n * If Arcade Physics is set to use the RTree (which it is by default) then the search is rather fast,\r\n * otherwise the search is O(N) for Dynamic Bodies.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#overlapCirc\r\n * @since 3.21.0\r\n *\r\n * @param {number} x - The x coordinate of the center of the area to search within.\r\n * @param {number} y - The y coordinate of the center of the area to search within.\r\n * @param {number} radius - The radius of the area to search within.\r\n * @param {boolean} [includeDynamic=true] - Should the search include Dynamic Bodies?\r\n * @param {boolean} [includeStatic=false] - Should the search include Static Bodies?\r\n *\r\n * @return {(Phaser.Physics.Arcade.Body[]|Phaser.Physics.Arcade.StaticBody[])} An array of bodies that overlap with the given area.\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 677, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "This method will search the given circular area and return an array of all physics bodies that\roverlap with it. It can return either Dynamic, Static bodies or a mixture of both.\r\rA body only has to intersect with the search area to be considered, it doesn't have to be fully\rcontained within it.\r\rIf Arcade Physics is set to use the RTree (which it is by default) then the search is rather fast,\rotherwise the search is O(N) for Dynamic Bodies.", "kind": "function", "name": "overlapCirc", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the center of the area to search within.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the center of the area to search within.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the area to search within.", "name": "radius" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the search include Dynamic Bodies?", "name": "includeDynamic" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the search include Static Bodies?", "name": "includeStatic" } ], "returns": [ { "type": { "names": [ "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Physics.Arcade.Body", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Physics.Arcade.StaticBody", "type": "NameExpression" } ] } ] } }, "description": "An array of bodies that overlap with the given area." } ], "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#overlapCirc", "scope": "instance", "___id": "T000002R027976", "___s": true }, { "comment": "/**\r\n * The Scene that owns this plugin is shutting down.\r\n * We need to kill and reset all internal properties as well as stop listening to Scene events.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 703, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Scene that owns this plugin is shutting down.\rWe need to kill and reset all internal properties as well as stop listening to Scene events.", "kind": "function", "name": "shutdown", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#shutdown", "scope": "instance", "___id": "T000002R027978", "___s": true }, { "comment": "/**\r\n * The Scene that owns this plugin is being destroyed.\r\n * We need to shutdown and then kill off all external references.\r\n *\r\n * @method Phaser.Physics.Arcade.ArcadePhysics#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ArcadePhysics.js", "lineno": 732, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Scene that owns this plugin is being destroyed.\rWe need to shutdown and then kill off all external references.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.ArcadePhysics", "longname": "Phaser.Physics.Arcade.ArcadePhysics#destroy", "scope": "instance", "___id": "T000002R027984", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * An Arcade Physics Sprite is a Sprite with an Arcade Physics body and related components.\r\n * The body can be dynamic or static.\r\n *\r\n * The main difference between an Arcade Sprite and an Arcade Image is that you cannot animate an Arcade Image.\r\n * If you do not require animation then you can safely use Arcade Images instead of Arcade Sprites.\r\n *\r\n * @class Sprite\r\n * @extends Phaser.GameObjects.Sprite\r\n * @memberof Phaser.Physics.Arcade\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.Physics.Arcade.Components.Acceleration\r\n * @extends Phaser.Physics.Arcade.Components.Angular\r\n * @extends Phaser.Physics.Arcade.Components.Bounce\r\n * @extends Phaser.Physics.Arcade.Components.Collision\r\n * @extends Phaser.Physics.Arcade.Components.Debug\r\n * @extends Phaser.Physics.Arcade.Components.Drag\r\n * @extends Phaser.Physics.Arcade.Components.Enable\r\n * @extends Phaser.Physics.Arcade.Components.Friction\r\n * @extends Phaser.Physics.Arcade.Components.Gravity\r\n * @extends Phaser.Physics.Arcade.Components.Immovable\r\n * @extends Phaser.Physics.Arcade.Components.Mass\r\n * @extends Phaser.Physics.Arcade.Components.Pushable\r\n * @extends Phaser.Physics.Arcade.Components.Size\r\n * @extends Phaser.Physics.Arcade.Components.Velocity\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.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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 * @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": "ArcadeSprite.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "classdesc": "An Arcade Physics Sprite is a Sprite with an Arcade Physics body and related components.\rThe body can be dynamic or static.\r\rThe main difference between an Arcade Sprite and an Arcade Image is that you cannot animate an Arcade Image.\rIf you do not require animation then you can safely use Arcade Images instead of Arcade Sprites.", "kind": "class", "name": "Sprite", "augments": [ "Phaser.GameObjects.Sprite", "Phaser.Physics.Arcade.Components.Acceleration", "Phaser.Physics.Arcade.Components.Angular", "Phaser.Physics.Arcade.Components.Bounce", "Phaser.Physics.Arcade.Components.Collision", "Phaser.Physics.Arcade.Components.Debug", "Phaser.Physics.Arcade.Components.Drag", "Phaser.Physics.Arcade.Components.Enable", "Phaser.Physics.Arcade.Components.Friction", "Phaser.Physics.Arcade.Components.Gravity", "Phaser.Physics.Arcade.Components.Immovable", "Phaser.Physics.Arcade.Components.Mass", "Phaser.Physics.Arcade.Components.Pushable", "Phaser.Physics.Arcade.Components.Size", "Phaser.Physics.Arcade.Components.Velocity", "Phaser.GameObjects.Components.Alpha", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.Flip", "Phaser.GameObjects.Components.GetBounds", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "Phaser.GameObjects.Components.ScrollFactor", "Phaser.GameObjects.Components.Size", "Phaser.GameObjects.Components.Texture", "Phaser.GameObjects.Components.Tint", "Phaser.GameObjects.Components.Transform", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.Physics.Arcade", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "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.Physics.Arcade.Sprite", "___id": "T000002R027992", "___s": true }, { "comment": "/**\r\n * This Game Object's Physics Body.\r\n *\r\n * @name Phaser.Physics.Arcade.Sprite#body\r\n * @type {?(Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody)}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ArcadeSprite.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "This Game Object's Physics Body.", "name": "body", "type": { "names": [ "Phaser.Physics.Arcade.Body", "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } ], "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "longname": "Phaser.Physics.Arcade.Sprite#body", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Sprite#body", "___id": "T000002R027997", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Dynamic Arcade Body.\r\n *\r\n * Its static counterpart is {@link Phaser.Physics.Arcade.StaticBody}.\r\n *\r\n * @class Body\r\n * @memberof Phaser.Physics.Arcade\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.Physics.Arcade.Components.Collision\r\n *\r\n * @param {Phaser.Physics.Arcade.World} world - The Arcade Physics simulation this Body belongs to.\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object this Body belongs to. As of Phaser 3.60 this is now optional.\r\n */", "meta": { "filename": "Body.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "classdesc": "A Dynamic Arcade Body.\r\rIts static counterpart is {@link Phaser.Physics.Arcade.StaticBody}.", "kind": "class", "name": "Body", "memberof": "Phaser.Physics.Arcade", "since": "3.0.0", "augments": [ "Phaser.Physics.Arcade.Components.Collision" ], "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "description": "The Arcade Physics simulation this Body belongs to.", "name": "world" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object this Body belongs to. As of Phaser 3.60 this is now optional.", "name": "gameObject" } ], "scope": "static", "longname": "Phaser.Physics.Arcade.Body", "___id": "T000002R028009", "___s": true }, { "comment": "/**\r\n * The Arcade Physics simulation this Body belongs to.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#world\r\n * @type {Phaser.Physics.Arcade.World}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Arcade Physics simulation this Body belongs to.", "name": "world", "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#world", "scope": "instance", "kind": "member", "___id": "T000002R028028", "___s": true }, { "comment": "/**\r\n * The Game Object this Body belongs to.\r\n *\r\n * As of Phaser 3.60 this is now optional and can be undefined.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Game Object this Body belongs to.\r\rAs of Phaser 3.60 this is now optional and can be undefined.", "name": "gameObject", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#gameObject", "scope": "instance", "kind": "member", "___id": "T000002R028030", "___s": true }, { "comment": "/**\r\n * A quick-test flag that signifies this is a Body, used in the World collision handler.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#isBody\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Body.js", "lineno": 90, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "A quick-test flag that signifies this is a Body, used in the World collision handler.", "name": "isBody", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#isBody", "scope": "instance", "kind": "member", "___id": "T000002R028032", "___s": true }, { "comment": "/**\r\n * Transformations applied to this Body.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#transform\r\n * @type {object}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Body.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Transformations applied to this Body.", "name": "transform", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.4.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#transform", "scope": "instance", "kind": "member", "___id": "T000002R028034", "___s": true }, { "comment": "/**\r\n * Whether the Body is drawn to the debug display.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#debugShowBody\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 117, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether the Body is drawn to the debug display.", "name": "debugShowBody", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#debugShowBody", "scope": "instance", "kind": "member", "___id": "T000002R028043", "___s": true }, { "comment": "/**\r\n * Whether the Body's velocity is drawn to the debug display.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#debugShowVelocity\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 126, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether the Body's velocity is drawn to the debug display.", "name": "debugShowVelocity", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#debugShowVelocity", "scope": "instance", "kind": "member", "___id": "T000002R028045", "___s": true }, { "comment": "/**\r\n * The color of this Body on the debug display.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#debugBodyColor\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 135, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The color of this Body on the debug display.", "name": "debugBodyColor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#debugBodyColor", "scope": "instance", "kind": "member", "___id": "T000002R028047", "___s": true }, { "comment": "/**\r\n * Whether this Body is updated by the physics simulation.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#enable\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 144, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Body is updated by the physics simulation.", "name": "enable", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#enable", "scope": "instance", "kind": "member", "___id": "T000002R028049", "___s": true }, { "comment": "/**\r\n * Whether this Body is circular (true) or rectangular (false).\r\n *\r\n * @name Phaser.Physics.Arcade.Body#isCircle\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n * @see Phaser.Physics.Arcade.Body#setCircle\r\n */", "meta": { "filename": "Body.js", "lineno": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Body is circular (true) or rectangular (false).", "name": "isCircle", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#setCircle" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#isCircle", "scope": "instance", "kind": "member", "___id": "T000002R028051", "___s": true }, { "comment": "/**\r\n * If this Body is circular, this is the unscaled radius of the Body, as set by setCircle(), in source pixels.\r\n * The true radius is equal to `halfWidth`.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#radius\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n * @see Phaser.Physics.Arcade.Body#setCircle\r\n */", "meta": { "filename": "Body.js", "lineno": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "If this Body is circular, this is the unscaled radius of the Body, as set by setCircle(), in source pixels.\rThe true radius is equal to `halfWidth`.", "name": "radius", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#setCircle" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#radius", "scope": "instance", "kind": "member", "___id": "T000002R028053", "___s": true }, { "comment": "/**\r\n * The offset of this Body's position from its Game Object's position, in source pixels.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#offset\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n * @see Phaser.Physics.Arcade.Body#setOffset\r\n */", "meta": { "filename": "Body.js", "lineno": 177, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The offset of this Body's position from its Game Object's position, in source pixels.", "name": "offset", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#setOffset" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#offset", "scope": "instance", "kind": "member", "___id": "T000002R028055", "___s": true }, { "comment": "/**\r\n * The position of this Body within the simulation.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#position\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The position of this Body within the simulation.", "name": "position", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#position", "scope": "instance", "kind": "member", "___id": "T000002R028057", "___s": true }, { "comment": "/**\r\n * The position of this Body during the previous step.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#prev\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 199, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The position of this Body during the previous step.", "name": "prev", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#prev", "scope": "instance", "kind": "member", "___id": "T000002R028059", "___s": true }, { "comment": "/**\r\n * The position of this Body during the previous frame.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#prevFrame\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "Body.js", "lineno": 208, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The position of this Body during the previous frame.", "name": "prevFrame", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.20.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#prevFrame", "scope": "instance", "kind": "member", "___id": "T000002R028061", "___s": true }, { "comment": "/**\r\n * Whether this Body's `rotation` is affected by its angular acceleration and angular velocity.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#allowRotation\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 217, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Body's `rotation` is affected by its angular acceleration and angular velocity.", "name": "allowRotation", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#allowRotation", "scope": "instance", "kind": "member", "___id": "T000002R028063", "___s": true }, { "comment": "/**\r\n * This body's rotation, in degrees, based on its angular acceleration and angular velocity.\r\n * The Body's rotation controls the `angle` of its Game Object.\r\n * It doesn't rotate the Body's own geometry, which is always an axis-aligned rectangle or a circle.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#rotation\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 227, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "This body's rotation, in degrees, based on its angular acceleration and angular velocity.\rThe Body's rotation controls the `angle` of its Game Object.\rIt doesn't rotate the Body's own geometry, which is always an axis-aligned rectangle or a circle.", "name": "rotation", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#rotation", "scope": "instance", "kind": "member", "___id": "T000002R028065", "___s": true }, { "comment": "/**\r\n * The Body rotation, in degrees, during the previous step.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#preRotation\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 238, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Body rotation, in degrees, during the previous step.", "name": "preRotation", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#preRotation", "scope": "instance", "kind": "member", "___id": "T000002R028067", "___s": true }, { "comment": "/**\r\n * The width of the Body, in pixels.\r\n * If the Body is circular, this is also the diameter.\r\n * If you wish to change the width use the `Body.setSize` method.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#width\r\n * @type {number}\r\n * @readonly\r\n * @default 64\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 247, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The width of the Body, in pixels.\rIf the Body is circular, this is also the diameter.\rIf you wish to change the width use the `Body.setSize` method.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "64", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#width", "scope": "instance", "kind": "member", "___id": "T000002R028069", "___s": true }, { "comment": "/**\r\n * The height of the Body, in pixels.\r\n * If the Body is circular, this is also the diameter.\r\n * If you wish to change the height use the `Body.setSize` method.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#height\r\n * @type {number}\r\n * @readonly\r\n * @default 64\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 260, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The height of the Body, in pixels.\rIf the Body is circular, this is also the diameter.\rIf you wish to change the height use the `Body.setSize` method.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "64", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#height", "scope": "instance", "kind": "member", "___id": "T000002R028071", "___s": true }, { "comment": "/**\r\n * The unscaled width of the Body, in source pixels, as set by setSize().\r\n * The default is the width of the Body's Game Object's texture frame.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#sourceWidth\r\n * @type {number}\r\n * @since 3.0.0\r\n * @see Phaser.Physics.Arcade.Body#setSize\r\n */", "meta": { "filename": "Body.js", "lineno": 273, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The unscaled width of the Body, in source pixels, as set by setSize().\rThe default is the width of the Body's Game Object's texture frame.", "name": "sourceWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#setSize" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#sourceWidth", "scope": "instance", "kind": "member", "___id": "T000002R028073", "___s": true }, { "comment": "/**\r\n * The unscaled height of the Body, in source pixels, as set by setSize().\r\n * The default is the height of the Body's Game Object's texture frame.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#sourceHeight\r\n * @type {number}\r\n * @since 3.0.0\r\n * @see Phaser.Physics.Arcade.Body#setSize\r\n */", "meta": { "filename": "Body.js", "lineno": 284, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The unscaled height of the Body, in source pixels, as set by setSize().\rThe default is the height of the Body's Game Object's texture frame.", "name": "sourceHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#setSize" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#sourceHeight", "scope": "instance", "kind": "member", "___id": "T000002R028075", "___s": true }, { "comment": "/**\r\n * Half the Body's width, in pixels.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#halfWidth\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 301, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Half the Body's width, in pixels.", "name": "halfWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#halfWidth", "scope": "instance", "kind": "member", "___id": "T000002R028079", "___s": true }, { "comment": "/**\r\n * Half the Body's height, in pixels.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#halfHeight\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 310, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Half the Body's height, in pixels.", "name": "halfHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#halfHeight", "scope": "instance", "kind": "member", "___id": "T000002R028081", "___s": true }, { "comment": "/**\r\n * The center of the Body.\r\n * The midpoint of its `position` (top-left corner) and its bottom-right corner.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#center\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 319, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The center of the Body.\rThe midpoint of its `position` (top-left corner) and its bottom-right corner.", "name": "center", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#center", "scope": "instance", "kind": "member", "___id": "T000002R028083", "___s": true }, { "comment": "/**\r\n * The Body's velocity, in pixels per second.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#velocity\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 329, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Body's velocity, in pixels per second.", "name": "velocity", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#velocity", "scope": "instance", "kind": "member", "___id": "T000002R028085", "___s": true }, { "comment": "/**\r\n * The Body's change in position (due to velocity) at the last step, in pixels.\r\n *\r\n * The size of this value depends on the simulation's step rate.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#newVelocity\r\n * @type {Phaser.Math.Vector2}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 338, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Body's change in position (due to velocity) at the last step, in pixels.\r\rThe size of this value depends on the simulation's step rate.", "name": "newVelocity", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#newVelocity", "scope": "instance", "kind": "member", "___id": "T000002R028087", "___s": true }, { "comment": "/**\r\n * The Body's absolute maximum change in position, in pixels per step.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#deltaMax\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 350, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Body's absolute maximum change in position, in pixels per step.", "name": "deltaMax", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#deltaMax", "scope": "instance", "kind": "member", "___id": "T000002R028089", "___s": true }, { "comment": "/**\r\n * The Body's change in velocity, in pixels per second squared.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#acceleration\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 359, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Body's change in velocity, in pixels per second squared.", "name": "acceleration", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#acceleration", "scope": "instance", "kind": "member", "___id": "T000002R028091", "___s": true }, { "comment": "/**\r\n * Whether this Body's velocity is affected by its `drag`.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#allowDrag\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 368, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Body's velocity is affected by its `drag`.", "name": "allowDrag", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#allowDrag", "scope": "instance", "kind": "member", "___id": "T000002R028093", "___s": true }, { "comment": "/**\r\n * When `useDamping` is false (the default), this is absolute loss of velocity due to movement, in pixels per second squared.\r\n *\r\n * When `useDamping` is true, this is a damping multiplier between 0 and 1.\r\n * A value of 0 means the Body stops instantly.\r\n * A value of 0.01 mean the Body keeps 1% of its velocity per second, losing 99%.\r\n * A value of 0.1 means the Body keeps 10% of its velocity per second, losing 90%.\r\n * A value of 1 means the Body loses no velocity.\r\n * You can use very small values (e.g., 0.001) to stop the Body quickly.\r\n *\r\n * The x and y components are applied separately.\r\n *\r\n * Drag is applied only when `acceleration` is zero.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#drag\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 378, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "When `useDamping` is false (the default), this is absolute loss of velocity due to movement, in pixels per second squared.\r\rWhen `useDamping` is true, this is a damping multiplier between 0 and 1.\rA value of 0 means the Body stops instantly.\rA value of 0.01 mean the Body keeps 1% of its velocity per second, losing 99%.\rA value of 0.1 means the Body keeps 10% of its velocity per second, losing 90%.\rA value of 1 means the Body loses no velocity.\rYou can use very small values (e.g., 0.001) to stop the Body quickly.\r\rThe x and y components are applied separately.\r\rDrag is applied only when `acceleration` is zero.", "name": "drag", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#drag", "scope": "instance", "kind": "member", "___id": "T000002R028095", "___s": true }, { "comment": "/**\r\n * Whether this Body's position is affected by gravity (local or world).\r\n *\r\n * @name Phaser.Physics.Arcade.Body#allowGravity\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n * @see Phaser.Physics.Arcade.Body#gravity\r\n * @see Phaser.Physics.Arcade.World#gravity\r\n */", "meta": { "filename": "Body.js", "lineno": 398, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Body's position is affected by gravity (local or world).", "name": "allowGravity", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#gravity", "Phaser.Physics.Arcade.World#gravity" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#allowGravity", "scope": "instance", "kind": "member", "___id": "T000002R028097", "___s": true }, { "comment": "/**\r\n * Acceleration due to gravity (specific to this Body), in pixels per second squared.\r\n * Total gravity is the sum of this vector and the simulation's `gravity`.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#gravity\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n * @see Phaser.Physics.Arcade.World#gravity\r\n */", "meta": { "filename": "Body.js", "lineno": 410, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Acceleration due to gravity (specific to this Body), in pixels per second squared.\rTotal gravity is the sum of this vector and the simulation's `gravity`.", "name": "gravity", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.World#gravity" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#gravity", "scope": "instance", "kind": "member", "___id": "T000002R028099", "___s": true }, { "comment": "/**\r\n * Rebound following a collision, relative to 1.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#bounce\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 421, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Rebound following a collision, relative to 1.", "name": "bounce", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#bounce", "scope": "instance", "kind": "member", "___id": "T000002R028101", "___s": true }, { "comment": "/**\r\n * Rebound following a collision with the world boundary, relative to 1.\r\n * If null, `bounce` is used instead.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#worldBounce\r\n * @type {?Phaser.Math.Vector2}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 430, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Rebound following a collision with the world boundary, relative to 1.\rIf null, `bounce` is used instead.", "name": "worldBounce", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#worldBounce", "scope": "instance", "kind": "member", "___id": "T000002R028103", "___s": true }, { "comment": "/**\r\n * The rectangle used for world boundary collisions.\r\n *\r\n * By default it is set to the world boundary rectangle. Or, if this Body was\r\n * created by a Physics Group, then whatever rectangle that Group defined.\r\n *\r\n * You can also change it by using the `Body.setBoundsRectangle` method.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#customBoundsRectangle\r\n * @type {Phaser.Geom.Rectangle}\r\n * @since 3.20\r\n */", "meta": { "filename": "Body.js", "lineno": 441, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The rectangle used for world boundary collisions.\r\rBy default it is set to the world boundary rectangle. Or, if this Body was\rcreated by a Physics Group, then whatever rectangle that Group defined.\r\rYou can also change it by using the `Body.setBoundsRectangle` method.", "name": "customBoundsRectangle", "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "since": "3.20", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#customBoundsRectangle", "scope": "instance", "kind": "member", "___id": "T000002R028105", "___s": true }, { "comment": "/**\r\n * Whether the simulation emits a `worldbounds` event when this Body collides with the world boundary\r\n * (and `collideWorldBounds` is also true).\r\n *\r\n * @name Phaser.Physics.Arcade.Body#onWorldBounds\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n * @see Phaser.Physics.Arcade.World#WORLD_BOUNDS\r\n */", "meta": { "filename": "Body.js", "lineno": 455, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether the simulation emits a `worldbounds` event when this Body collides with the world boundary\r(and `collideWorldBounds` is also true).", "name": "onWorldBounds", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.World#WORLD_BOUNDS" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#onWorldBounds", "scope": "instance", "kind": "member", "___id": "T000002R028107", "___s": true }, { "comment": "/**\r\n * Whether the simulation emits a `collide` event when this Body collides with another.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#onCollide\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n * @see Phaser.Physics.Arcade.World#COLLIDE\r\n */", "meta": { "filename": "Body.js", "lineno": 467, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether the simulation emits a `collide` event when this Body collides with another.", "name": "onCollide", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.World#COLLIDE" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#onCollide", "scope": "instance", "kind": "member", "___id": "T000002R028109", "___s": true }, { "comment": "/**\r\n * Whether the simulation emits an `overlap` event when this Body overlaps with another.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#onOverlap\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n * @see Phaser.Physics.Arcade.World#OVERLAP\r\n */", "meta": { "filename": "Body.js", "lineno": 478, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether the simulation emits an `overlap` event when this Body overlaps with another.", "name": "onOverlap", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.World#OVERLAP" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#onOverlap", "scope": "instance", "kind": "member", "___id": "T000002R028111", "___s": true }, { "comment": "/**\r\n * The absolute maximum velocity of this body, in pixels per second.\r\n * The horizontal and vertical components are applied separately.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#maxVelocity\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 489, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The absolute maximum velocity of this body, in pixels per second.\rThe horizontal and vertical components are applied separately.", "name": "maxVelocity", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#maxVelocity", "scope": "instance", "kind": "member", "___id": "T000002R028113", "___s": true }, { "comment": "/**\r\n * The maximum speed this Body is allowed to reach, in pixels per second.\r\n *\r\n * If not negative it limits the scalar value of speed.\r\n *\r\n * Any negative value means no maximum is being applied (the default).\r\n *\r\n * @name Phaser.Physics.Arcade.Body#maxSpeed\r\n * @type {number}\r\n * @default -1\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Body.js", "lineno": 499, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The maximum speed this Body is allowed to reach, in pixels per second.\r\rIf not negative it limits the scalar value of speed.\r\rAny negative value means no maximum is being applied (the default).", "name": "maxSpeed", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.16.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#maxSpeed", "scope": "instance", "kind": "member", "___id": "T000002R028115", "___s": true }, { "comment": "/**\r\n * If this Body is `immovable` and in motion, `friction` is the proportion of this Body's motion received by the riding Body on each axis, relative to 1.\r\n * The horizontal component (x) is applied only when two colliding Bodies are separated vertically.\r\n * The vertical component (y) is applied only when two colliding Bodies are separated horizontally.\r\n * The default value (1, 0) moves the riding Body horizontally in equal proportion to this Body and vertically not at all.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#friction\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 513, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "If this Body is `immovable` and in motion, `friction` is the proportion of this Body's motion received by the riding Body on each axis, relative to 1.\rThe horizontal component (x) is applied only when two colliding Bodies are separated vertically.\rThe vertical component (y) is applied only when two colliding Bodies are separated horizontally.\rThe default value (1, 0) moves the riding Body horizontally in equal proportion to this Body and vertically not at all.", "name": "friction", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#friction", "scope": "instance", "kind": "member", "___id": "T000002R028117", "___s": true }, { "comment": "/**\r\n * If this Body is using `drag` for deceleration this property controls how the drag is applied.\r\n * If set to `true` drag will use a damping effect rather than a linear approach. If you are\r\n * creating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\r\n * the game Asteroids) then you will get a far smoother and more visually correct deceleration\r\n * by using damping, avoiding the axis-drift that is prone with linear deceleration.\r\n *\r\n * If you enable this property then you should use far smaller `drag` values than with linear, as\r\n * they are used as a multiplier on the velocity. Values such as 0.05 will give a nice slow\r\n * deceleration.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#useDamping\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Body.js", "lineno": 525, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "If this Body is using `drag` for deceleration this property controls how the drag is applied.\rIf set to `true` drag will use a damping effect rather than a linear approach. If you are\rcreating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\rthe game Asteroids) then you will get a far smoother and more visually correct deceleration\rby using damping, avoiding the axis-drift that is prone with linear deceleration.\r\rIf you enable this property then you should use far smaller `drag` values than with linear, as\rthey are used as a multiplier on the velocity. Values such as 0.05 will give a nice slow\rdeceleration.", "name": "useDamping", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.10.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#useDamping", "scope": "instance", "kind": "member", "___id": "T000002R028119", "___s": true }, { "comment": "/**\r\n * The rate of change of this Body's `rotation`, in degrees per second.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#angularVelocity\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 543, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The rate of change of this Body's `rotation`, in degrees per second.", "name": "angularVelocity", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#angularVelocity", "scope": "instance", "kind": "member", "___id": "T000002R028121", "___s": true }, { "comment": "/**\r\n * The Body's angular acceleration (change in angular velocity), in degrees per second squared.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#angularAcceleration\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 553, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Body's angular acceleration (change in angular velocity), in degrees per second squared.", "name": "angularAcceleration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#angularAcceleration", "scope": "instance", "kind": "member", "___id": "T000002R028123", "___s": true }, { "comment": "/**\r\n * Loss of angular velocity due to angular movement, in degrees per second.\r\n *\r\n * Angular drag is applied only when angular acceleration is zero.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#angularDrag\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 563, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Loss of angular velocity due to angular movement, in degrees per second.\r\rAngular drag is applied only when angular acceleration is zero.", "name": "angularDrag", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#angularDrag", "scope": "instance", "kind": "member", "___id": "T000002R028125", "___s": true }, { "comment": "/**\r\n * The Body's maximum angular velocity, in degrees per second.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#maxAngular\r\n * @type {number}\r\n * @default 1000\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 575, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Body's maximum angular velocity, in degrees per second.", "name": "maxAngular", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1000", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#maxAngular", "scope": "instance", "kind": "member", "___id": "T000002R028127", "___s": true }, { "comment": "/**\r\n * The Body's inertia, relative to a default unit (1).\r\n * With `bounce`, this affects the exchange of momentum (velocities) during collisions.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#mass\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 585, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Body's inertia, relative to a default unit (1).\rWith `bounce`, this affects the exchange of momentum (velocities) during collisions.", "name": "mass", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#mass", "scope": "instance", "kind": "member", "___id": "T000002R028129", "___s": true }, { "comment": "/**\r\n * The calculated angle of this Body's velocity vector, in radians, during the last step.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#angle\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 596, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The calculated angle of this Body's velocity vector, in radians, during the last step.", "name": "angle", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#angle", "scope": "instance", "kind": "member", "___id": "T000002R028131", "___s": true }, { "comment": "/**\r\n * The calculated magnitude of the Body's velocity, in pixels per second, during the last step.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#speed\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 606, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The calculated magnitude of the Body's velocity, in pixels per second, during the last step.", "name": "speed", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#speed", "scope": "instance", "kind": "member", "___id": "T000002R028133", "___s": true }, { "comment": "/**\r\n * The direction of the Body's velocity, as calculated during the last step.\r\n * This is a numeric constant value (FACING_UP, FACING_DOWN, FACING_LEFT, FACING_RIGHT).\r\n * If the Body is moving on both axes, this describes motion on the vertical axis only.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#facing\r\n * @type {number}\r\n * @since 3.0.0\r\n *\r\n * @see Phaser.Physics.Arcade.FACING_UP\r\n * @see Phaser.Physics.Arcade.FACING_DOWN\r\n * @see Phaser.Physics.Arcade.FACING_LEFT\r\n * @see Phaser.Physics.Arcade.FACING_RIGHT\r\n */", "meta": { "filename": "Body.js", "lineno": 616, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The direction of the Body's velocity, as calculated during the last step.\rThis is a numeric constant value (FACING_UP, FACING_DOWN, FACING_LEFT, FACING_RIGHT).\rIf the Body is moving on both axes, this describes motion on the vertical axis only.", "name": "facing", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.FACING_UP", "Phaser.Physics.Arcade.FACING_DOWN", "Phaser.Physics.Arcade.FACING_LEFT", "Phaser.Physics.Arcade.FACING_RIGHT" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#facing", "scope": "instance", "kind": "member", "___id": "T000002R028135", "___s": true }, { "comment": "/**\r\n * Whether this Body can be moved by collisions with another Body.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#immovable\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 632, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Body can be moved by collisions with another Body.", "name": "immovable", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#immovable", "scope": "instance", "kind": "member", "___id": "T000002R028137", "___s": true }, { "comment": "/**\r\n * Sets if this Body can be pushed by another Body.\r\n *\r\n * A body that cannot be pushed will reflect back all of the velocity it is given to the\r\n * colliding body. If that body is also not pushable, then the separation will be split\r\n * between them evenly.\r\n *\r\n * If you want your body to never move or seperate at all, see the `setImmovable` method.\r\n *\r\n * By default, Dynamic Bodies are always pushable.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#pushable\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.50.0\r\n * @see Phaser.GameObjects.Components.Pushable#setPushable\r\n */", "meta": { "filename": "Body.js", "lineno": 642, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets if this Body can be pushed by another Body.\r\rA body that cannot be pushed will reflect back all of the velocity it is given to the\rcolliding body. If that body is also not pushable, then the separation will be split\rbetween them evenly.\r\rIf you want your body to never move or seperate at all, see the `setImmovable` method.\r\rBy default, Dynamic Bodies are always pushable.", "name": "pushable", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.50.0", "see": [ "Phaser.GameObjects.Components.Pushable#setPushable" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#pushable", "scope": "instance", "kind": "member", "___id": "T000002R028139", "___s": true }, { "comment": "/**\r\n * The Slide Factor of this Body.\r\n *\r\n * The Slide Factor controls how much velocity is preserved when\r\n * this Body is pushed by another Body.\r\n *\r\n * The default value is 1, which means that it will take on all\r\n * velocity given in the push. You can adjust this value to control\r\n * how much velocity is retained by this Body when the push ends.\r\n *\r\n * A value of 0, for example, will allow this Body to be pushed\r\n * but then remain completely still after the push ends, such as\r\n * you see in a game like Sokoban.\r\n *\r\n * Or you can set a mid-point, such as 0.25 which will allow it\r\n * to keep 25% of the original velocity when the push ends. You\r\n * can combine this with the `setDrag()` method to create deceleration.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#slideFactor\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.61.0\r\n * @see Phaser.GameObjects.Components.Pushable#setSlideFactor\r\n */", "meta": { "filename": "Body.js", "lineno": 661, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Slide Factor of this Body.\r\rThe Slide Factor controls how much velocity is preserved when\rthis Body is pushed by another Body.\r\rThe default value is 1, which means that it will take on all\rvelocity given in the push. You can adjust this value to control\rhow much velocity is retained by this Body when the push ends.\r\rA value of 0, for example, will allow this Body to be pushed\rbut then remain completely still after the push ends, such as\ryou see in a game like Sokoban.\r\rOr you can set a mid-point, such as 0.25 which will allow it\rto keep 25% of the original velocity when the push ends. You\rcan combine this with the `setDrag()` method to create deceleration.", "name": "slideFactor", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.61.0", "see": [ "Phaser.GameObjects.Components.Pushable#setSlideFactor" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#slideFactor", "scope": "instance", "kind": "member", "___id": "T000002R028141", "___s": true }, { "comment": "/**\r\n * Whether the Body's position and rotation are affected by its velocity, acceleration, drag, and gravity.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#moves\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 686, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether the Body's position and rotation are affected by its velocity, acceleration, drag, and gravity.", "name": "moves", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#moves", "scope": "instance", "kind": "member", "___id": "T000002R028143", "___s": true }, { "comment": "/**\r\n * A flag disabling the default horizontal separation of colliding bodies.\r\n * Pass your own `collideCallback` to the collider.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#customSeparateX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 696, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "A flag disabling the default horizontal separation of colliding bodies.\rPass your own `collideCallback` to the collider.", "name": "customSeparateX", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#customSeparateX", "scope": "instance", "kind": "member", "___id": "T000002R028145", "___s": true }, { "comment": "/**\r\n * A flag disabling the default vertical separation of colliding bodies.\r\n * Pass your own `collideCallback` to the collider.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#customSeparateY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 707, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "A flag disabling the default vertical separation of colliding bodies.\rPass your own `collideCallback` to the collider.", "name": "customSeparateY", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#customSeparateY", "scope": "instance", "kind": "member", "___id": "T000002R028147", "___s": true }, { "comment": "/**\r\n * The amount of horizontal overlap (before separation), if this Body is colliding with another.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#overlapX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 718, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The amount of horizontal overlap (before separation), if this Body is colliding with another.", "name": "overlapX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#overlapX", "scope": "instance", "kind": "member", "___id": "T000002R028149", "___s": true }, { "comment": "/**\r\n * The amount of vertical overlap (before separation), if this Body is colliding with another.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#overlapY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 728, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The amount of vertical overlap (before separation), if this Body is colliding with another.", "name": "overlapY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#overlapY", "scope": "instance", "kind": "member", "___id": "T000002R028151", "___s": true }, { "comment": "/**\r\n * The amount of overlap (before separation), if this Body is circular and colliding with another circular body.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#overlapR\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 738, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The amount of overlap (before separation), if this Body is circular and colliding with another circular body.", "name": "overlapR", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#overlapR", "scope": "instance", "kind": "member", "___id": "T000002R028153", "___s": true }, { "comment": "/**\r\n * Whether this Body is overlapped with another and both are not moving, on at least one axis.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#embedded\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 748, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Body is overlapped with another and both are not moving, on at least one axis.", "name": "embedded", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#embedded", "scope": "instance", "kind": "member", "___id": "T000002R028155", "___s": true }, { "comment": "/**\r\n * Whether this Body interacts with the world boundary.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#collideWorldBounds\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 758, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Body interacts with the world boundary.", "name": "collideWorldBounds", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#collideWorldBounds", "scope": "instance", "kind": "member", "___id": "T000002R028157", "___s": true }, { "comment": "/**\r\n * Whether this Body is checked for collisions and for which directions.\r\n * You can set `checkCollision.none = true` to disable collision checks.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#checkCollision\r\n * @type {Phaser.Types.Physics.Arcade.ArcadeBodyCollision}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 768, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Body is checked for collisions and for which directions.\rYou can set `checkCollision.none = true` to disable collision checks.", "name": "checkCollision", "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#checkCollision", "scope": "instance", "kind": "member", "___id": "T000002R028159", "___s": true }, { "comment": "/**\r\n * Whether this Body is colliding with a Body or Static Body and in which direction.\r\n * In a collision where both bodies have zero velocity, `embedded` will be set instead.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#touching\r\n * @type {Phaser.Types.Physics.Arcade.ArcadeBodyCollision}\r\n * @since 3.0.0\r\n *\r\n * @see Phaser.Physics.Arcade.Body#blocked\r\n * @see Phaser.Physics.Arcade.Body#embedded\r\n */", "meta": { "filename": "Body.js", "lineno": 778, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Body is colliding with a Body or Static Body and in which direction.\rIn a collision where both bodies have zero velocity, `embedded` will be set instead.", "name": "touching", "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" } }, "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#blocked", "Phaser.Physics.Arcade.Body#embedded" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#touching", "scope": "instance", "kind": "member", "___id": "T000002R028161", "___s": true }, { "comment": "/**\r\n * This Body's `touching` value during the previous step.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#wasTouching\r\n * @type {Phaser.Types.Physics.Arcade.ArcadeBodyCollision}\r\n * @since 3.0.0\r\n *\r\n * @see Phaser.Physics.Arcade.Body#touching\r\n */", "meta": { "filename": "Body.js", "lineno": 791, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "This Body's `touching` value during the previous step.", "name": "wasTouching", "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" } }, "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#touching" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#wasTouching", "scope": "instance", "kind": "member", "___id": "T000002R028163", "___s": true }, { "comment": "/**\r\n * Whether this Body is colliding with a Static Body, a tile, or the world boundary.\r\n * In a collision with a Static Body, if this Body has zero velocity then `embedded` will be set instead.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#blocked\r\n * @type {Phaser.Types.Physics.Arcade.ArcadeBodyCollision}\r\n * @since 3.0.0\r\n *\r\n * @see Phaser.Physics.Arcade.Body#embedded\r\n * @see Phaser.Physics.Arcade.Body#touching\r\n */", "meta": { "filename": "Body.js", "lineno": 802, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Body is colliding with a Static Body, a tile, or the world boundary.\rIn a collision with a Static Body, if this Body has zero velocity then `embedded` will be set instead.", "name": "blocked", "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" } }, "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#embedded", "Phaser.Physics.Arcade.Body#touching" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#blocked", "scope": "instance", "kind": "member", "___id": "T000002R028165", "___s": true }, { "comment": "/**\r\n * Whether to automatically synchronize this Body's dimensions to the dimensions of its Game Object's visual bounds.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#syncBounds\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n * @see Phaser.GameObjects.Components.GetBounds#getBounds\r\n */", "meta": { "filename": "Body.js", "lineno": 815, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether to automatically synchronize this Body's dimensions to the dimensions of its Game Object's visual bounds.", "name": "syncBounds", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "see": [ "Phaser.GameObjects.Components.GetBounds#getBounds" ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#syncBounds", "scope": "instance", "kind": "member", "___id": "T000002R028167", "___s": true }, { "comment": "/**\r\n * The Body's physics type (dynamic or static).\r\n *\r\n * @name Phaser.Physics.Arcade.Body#physicsType\r\n * @type {number}\r\n * @readonly\r\n * @default Phaser.Physics.Arcade.DYNAMIC_BODY\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 826, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Body's physics type (dynamic or static).", "name": "physicsType", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "Phaser.Physics.Arcade.DYNAMIC_BODY", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#physicsType", "scope": "instance", "kind": "member", "___id": "T000002R028169", "___s": true }, { "comment": "/**\r\n * The Arcade Physics Body Collision Category.\r\n *\r\n * This can be set to any valid collision bitfield value.\r\n *\r\n * See the `setCollisionCategory` method for more details.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#collisionCategory\r\n * @type {number}\r\n * @since 3.61.0\r\n */", "meta": { "filename": "Body.js", "lineno": 837, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Arcade Physics Body Collision Category.\r\rThis can be set to any valid collision bitfield value.\r\rSee the `setCollisionCategory` method for more details.", "name": "collisionCategory", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.61.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#collisionCategory", "scope": "instance", "kind": "member", "___id": "T000002R028171", "___s": true }, { "comment": "/**\r\n * The Arcade Physics Body Collision Mask.\r\n *\r\n * See the `setCollidesWith` method for more details.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#collisionMask\r\n * @type {number}\r\n * @since 3.61.0\r\n */", "meta": { "filename": "Body.js", "lineno": 850, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Arcade Physics Body Collision Mask.\r\rSee the `setCollidesWith` method for more details.", "name": "collisionMask", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.61.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#collisionMask", "scope": "instance", "kind": "member", "___id": "T000002R028173", "___s": true }, { "comment": "/**\r\n * Is this Body under direct control, outside of the physics engine? For example,\r\n * are you trying to move it via a Tween? Or have it follow a path? If so then\r\n * you can enable this boolean so that the Body will calculate its velocity based\r\n * purely on its change in position each frame. This allows you to then tween\r\n * the position and still have it collide with other objects. However, setting\r\n * the velocity will have no impact on this Body while this is set.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#directControl\r\n * @type {boolean}\r\n * @since 3.61.0\r\n */", "meta": { "filename": "Body.js", "lineno": 935, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Is this Body under direct control, outside of the physics engine? For example,\rare you trying to move it via a Tween? Or have it follow a path? If so then\ryou can enable this boolean so that the Body will calculate its velocity based\rpurely on its change in position each frame. This allows you to then tween\rthe position and still have it collide with other objects. However, setting\rthe velocity will have no impact on this Body while this is set.", "name": "directControl", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.61.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#directControl", "scope": "instance", "kind": "member", "___id": "T000002R028189", "___s": true }, { "comment": "/**\r\n * Updates the Body's `transform`, `width`, `height`, and `center` from its Game Object.\r\n * The Body's `position` isn't changed.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#updateBounds\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 960, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Updates the Body's `transform`, `width`, `height`, and `center` from its Game Object.\rThe Body's `position` isn't changed.", "kind": "function", "name": "updateBounds", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#updateBounds", "scope": "instance", "___id": "T000002R028193", "___s": true }, { "comment": "/**\r\n * Updates the Body's `center` from its `position`, `width`, and `height`.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#updateCenter\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 1031, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Updates the Body's `center` from its `position`, `width`, and `height`.", "kind": "function", "name": "updateCenter", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#updateCenter", "scope": "instance", "___id": "T000002R028226", "___s": true }, { "comment": "/**\r\n * Updates the Body's `position`, `width`, `height`, and `center` from its Game Object and `offset`.\r\n *\r\n * You don't need to call this for Dynamic Bodies, as it happens automatically during the physics step.\r\n * But you could use it if you have modified the Body offset or Game Object transform and need to immediately\r\n * read the Body's new `position` or `center`.\r\n *\r\n * To resynchronize the Body with its Game Object, use `reset()` instead.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#updateFromGameObject\r\n * @since 3.24.0\r\n */", "meta": { "filename": "Body.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Updates the Body's `position`, `width`, `height`, and `center` from its Game Object and `offset`.\r\rYou don't need to call this for Dynamic Bodies, as it happens automatically during the physics step.\rBut you could use it if you have modified the Body offset or Game Object transform and need to immediately\rread the Body's new `position` or `center`.\r\rTo resynchronize the Body with its Game Object, use `reset()` instead.", "kind": "function", "name": "updateFromGameObject", "since": "3.24.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#updateFromGameObject", "scope": "instance", "___id": "T000002R028228", "___s": true }, { "comment": "/**\r\n * Prepares the Body for a physics step by resetting the `wasTouching`, `touching` and `blocked` states.\r\n *\r\n * This method is only called if the physics world is going to run a step this frame.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#resetFlags\r\n * @since 3.18.0\r\n *\r\n * @param {boolean} [clear=false] - Set the `wasTouching` values to their defaults.\r\n */", "meta": { "filename": "Body.js", "lineno": 1066, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Prepares the Body for a physics step by resetting the `wasTouching`, `touching` and `blocked` states.\r\rThis method is only called if the physics world is going to run a step this frame.", "kind": "function", "name": "resetFlags", "since": "3.18.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Set the `wasTouching` values to their defaults.", "name": "clear" } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#resetFlags", "scope": "instance", "___id": "T000002R028233", "___s": true }, { "comment": "/**\r\n * Syncs the position body position with the parent Game Object.\r\n *\r\n * This method is called every game frame, regardless if the world steps or not.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#preUpdate\r\n * @since 3.17.0\r\n *\r\n * @param {boolean} willStep - Will this Body run an update as well?\r\n * @param {number} delta - The delta time, in seconds, elapsed since the last frame.\r\n */", "meta": { "filename": "Body.js", "lineno": 1111, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Syncs the position body position with the parent Game Object.\r\rThis method is called every game frame, regardless if the world steps or not.", "kind": "function", "name": "preUpdate", "since": "3.17.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Will this Body run an update as well?", "name": "willStep" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time, in seconds, elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#preUpdate", "scope": "instance", "___id": "T000002R028248", "___s": true }, { "comment": "/**\r\n * Performs a single physics step and updates the body velocity, angle, speed and other properties.\r\n *\r\n * This method can be called multiple times per game frame, depending on the physics step rate.\r\n *\r\n * The results are synced back to the Game Object in `postUpdate`.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#update\r\n * @fires Phaser.Physics.Arcade.Events#WORLD_BOUNDS\r\n * @since 3.0.0\r\n *\r\n * @param {number} delta - The delta time, in seconds, elapsed since the last frame.\r\n */", "meta": { "filename": "Body.js", "lineno": 1154, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Performs a single physics step and updates the body velocity, angle, speed and other properties.\r\rThis method can be called multiple times per game frame, depending on the physics step rate.\r\rThe results are synced back to the Game Object in `postUpdate`.", "kind": "function", "name": "update", "fires": [ "Phaser.Physics.Arcade.Events#event:WORLD_BOUNDS" ], "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time, in seconds, elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#update", "scope": "instance", "___id": "T000002R028257", "___s": true }, { "comment": "/**\r\n * Feeds the Body results back into the parent Game Object.\r\n *\r\n * This method is called every game frame, regardless if the world steps or not.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#postUpdate\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Feeds the Body results back into the parent Game Object.\r\rThis method is called every game frame, regardless if the world steps or not.", "kind": "function", "name": "postUpdate", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#postUpdate", "scope": "instance", "___id": "T000002R028274", "___s": true }, { "comment": "/**\r\n * Sets a custom collision boundary rectangle. Use if you want to have a custom\r\n * boundary instead of the world boundaries.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setBoundsRectangle\r\n * @since 3.20\r\n *\r\n * @param {?Phaser.Geom.Rectangle} [bounds] - The new boundary rectangle. Pass `null` to use the World bounds.\r\n *\r\n * @return {this} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 1310, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets a custom collision boundary rectangle. Use if you want to have a custom\rboundary instead of the world boundaries.", "kind": "function", "name": "setBoundsRectangle", "since": "3.20", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle", "nullable": true } }, "optional": true, "nullable": true, "description": "The new boundary rectangle. Pass `null` to use the World bounds.", "name": "bounds" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setBoundsRectangle", "scope": "instance", "___id": "T000002R028295", "___s": true }, { "comment": "/**\r\n * Checks for collisions between this Body and the world boundary and separates them.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#checkWorldBounds\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} True if this Body is colliding with the world boundary.\r\n */", "meta": { "filename": "Body.js", "lineno": 1328, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Checks for collisions between this Body and the world boundary and separates them.", "kind": "function", "name": "checkWorldBounds", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if this Body is colliding with the world boundary." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#checkWorldBounds", "scope": "instance", "___id": "T000002R028298", "___s": true }, { "comment": "/**\r\n * Sets the offset of the Body's position from its Game Object's position.\r\n * The Body's `position` isn't changed until the next `preUpdate`.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setOffset\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal offset, in source pixels.\r\n * @param {number} [y=x] - The vertical offset, in source pixels.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 1388, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the offset of the Body's position from its Game Object's position.\rThe Body's `position` isn't changed until the next `preUpdate`.", "kind": "function", "name": "setOffset", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal offset, in source pixels.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical offset, in source pixels.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setOffset", "scope": "instance", "___id": "T000002R028325", "___s": true }, { "comment": "/**\r\n * Assign this Body to a new Game Object.\r\n *\r\n * Removes this body from the Physics World, assigns to the new Game Object, calls `setSize` and then\r\n * adds this body back into the World again, setting it enabled, unless the `enable` argument is set to `false`.\r\n *\r\n * If this body already has a Game Object, then it will remove itself from that Game Object first.\r\n *\r\n * Only if the given `gameObject` has a `body` property will this Body be assigned to it.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setGameObject\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object this Body belongs to.\r\n * @param {boolean} [enable=true] - Automatically enable this Body for physics.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 1409, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Assign this Body to a new Game Object.\r\rRemoves this body from the Physics World, assigns to the new Game Object, calls `setSize` and then\radds this body back into the World again, setting it enabled, unless the `enable` argument is set to `false`.\r\rIf this body already has a Game Object, then it will remove itself from that Game Object first.\r\rOnly if the given `gameObject` has a `body` property will this Body be assigned to it.", "kind": "function", "name": "setGameObject", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object this Body belongs to.", "name": "gameObject" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Automatically enable this Body for physics.", "name": "enable" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setGameObject", "scope": "instance", "___id": "T000002R028328", "___s": true }, { "comment": "/**\r\n * Sizes and positions this Body, as a rectangle.\r\n * Modifies the Body `offset` if `center` is true (the default).\r\n * Resets the width and height to match current frame, if no width and height provided and a frame is found.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} [width] - The width of the Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame width.\r\n * @param {number} [height] - The height of the Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame height.\r\n * @param {boolean} [center=true] - Modify the Body's `offset`, placing the Body's center on its Game Object's center. Only works if the Game Object has the `getCenter` method.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 1456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sizes and positions this Body, as a rectangle.\rModifies the Body `offset` if `center` is true (the default).\rResets the width and height to match current frame, if no width and height provided and a frame is found.", "kind": "function", "name": "setSize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame width.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame height.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Modify the Body's `offset`, placing the Body's center on its Game Object's center. Only works if the Game Object has the `getCenter` method.", "name": "center" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setSize", "scope": "instance", "___id": "T000002R028335", "___s": true }, { "comment": "/**\r\n * Sizes and positions this Body, as a circle.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setCircle\r\n * @since 3.0.0\r\n *\r\n * @param {number} radius - The radius of the Body, in source pixels.\r\n * @param {number} [offsetX] - The horizontal offset of the Body from its Game Object, in source pixels.\r\n * @param {number} [offsetY] - The vertical offset of the Body from its Game Object, in source pixels.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 1514, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sizes and positions this Body, as a circle.", "kind": "function", "name": "setCircle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the Body, in source pixels.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal offset of the Body from its Game Object, in source pixels.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The vertical offset of the Body from its Game Object, in source pixels.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setCircle", "scope": "instance", "___id": "T000002R028351", "___s": true }, { "comment": "/**\r\n * Sets this Body's parent Game Object to the given coordinates and resets this Body at the new coordinates.\r\n * If the Body had any velocity or acceleration it is lost as a result of calling this.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#reset\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal position to place the Game Object.\r\n * @param {number} y - The vertical position to place the Game Object.\r\n */", "meta": { "filename": "Body.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets this Body's parent Game Object to the given coordinates and resets this Body at the new coordinates.\rIf the Body had any velocity or acceleration it is lost as a result of calling this.", "kind": "function", "name": "reset", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position to place the Game Object.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position to place the Game Object.", "name": "y" } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#reset", "scope": "instance", "___id": "T000002R028364", "___s": true }, { "comment": "/**\r\n * Sets acceleration, velocity, and speed to zero.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#stop\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 1611, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets acceleration, velocity, and speed to zero.", "kind": "function", "name": "stop", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#stop", "scope": "instance", "___id": "T000002R028370", "___s": true }, { "comment": "/**\r\n * Copies the coordinates of this Body's edges into an object.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#getBounds\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeBodyBounds} obj - An object to copy the values into.\r\n *\r\n * @return {Phaser.Types.Physics.Arcade.ArcadeBodyBounds} - An object with {x, y, right, bottom}.\r\n */", "meta": { "filename": "Body.js", "lineno": 1630, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Copies the coordinates of this Body's edges into an object.", "kind": "function", "name": "getBounds", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeBodyBounds" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeBodyBounds" } }, "description": "An object to copy the values into.", "name": "obj" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeBodyBounds" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeBodyBounds" } }, "description": "- An object with {x, y, right, bottom}." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#getBounds", "scope": "instance", "___id": "T000002R028375", "___s": true }, { "comment": "/**\r\n * Tests if the coordinates are within this Body.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#hitTest\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal coordinate.\r\n * @param {number} y - The vertical coordinate.\r\n *\r\n * @return {boolean} True if (x, y) is within this Body.\r\n */", "meta": { "filename": "Body.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Tests if the coordinates are within this Body.", "kind": "function", "name": "hitTest", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if (x, y) is within this Body." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#hitTest", "scope": "instance", "___id": "T000002R028381", "___s": true }, { "comment": "/**\r\n * Whether this Body is touching a tile or the world boundary while moving down.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#onFloor\r\n * @since 3.0.0\r\n * @see Phaser.Physics.Arcade.Body#blocked\r\n *\r\n * @return {boolean} True if touching.\r\n */", "meta": { "filename": "Body.js", "lineno": 1680, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Body is touching a tile or the world boundary while moving down.", "kind": "function", "name": "onFloor", "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#blocked" ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if touching." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#onFloor", "scope": "instance", "___id": "T000002R028385", "___s": true }, { "comment": "/**\r\n * Whether this Body is touching a tile or the world boundary while moving up.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#onCeiling\r\n * @since 3.0.0\r\n * @see Phaser.Physics.Arcade.Body#blocked\r\n *\r\n * @return {boolean} True if touching.\r\n */", "meta": { "filename": "Body.js", "lineno": 1694, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Body is touching a tile or the world boundary while moving up.", "kind": "function", "name": "onCeiling", "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#blocked" ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if touching." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#onCeiling", "scope": "instance", "___id": "T000002R028387", "___s": true }, { "comment": "/**\r\n * Whether this Body is touching a tile or the world boundary while moving left or right.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#onWall\r\n * @since 3.0.0\r\n * @see Phaser.Physics.Arcade.Body#blocked\r\n *\r\n * @return {boolean} True if touching.\r\n */", "meta": { "filename": "Body.js", "lineno": 1708, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Body is touching a tile or the world boundary while moving left or right.", "kind": "function", "name": "onWall", "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#blocked" ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if touching." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#onWall", "scope": "instance", "___id": "T000002R028389", "___s": true }, { "comment": "/**\r\n * The absolute (non-negative) change in this Body's horizontal position from the previous step.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#deltaAbsX\r\n * @since 3.0.0\r\n *\r\n * @return {number} The delta value.\r\n */", "meta": { "filename": "Body.js", "lineno": 1722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The absolute (non-negative) change in this Body's horizontal position from the previous step.", "kind": "function", "name": "deltaAbsX", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#deltaAbsX", "scope": "instance", "___id": "T000002R028391", "___s": true }, { "comment": "/**\r\n * The absolute (non-negative) change in this Body's vertical position from the previous step.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#deltaAbsY\r\n * @since 3.0.0\r\n *\r\n * @return {number} The delta value.\r\n */", "meta": { "filename": "Body.js", "lineno": 1735, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The absolute (non-negative) change in this Body's vertical position from the previous step.", "kind": "function", "name": "deltaAbsY", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#deltaAbsY", "scope": "instance", "___id": "T000002R028393", "___s": true }, { "comment": "/**\r\n * The change in this Body's horizontal position from the previous step.\r\n * This value is set during the Body's update phase.\r\n *\r\n * As a Body can update multiple times per step this may not hold the final\r\n * delta value for the Body. In this case, please see the `deltaXFinal` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#deltaX\r\n * @since 3.0.0\r\n *\r\n * @return {number} The delta value.\r\n */", "meta": { "filename": "Body.js", "lineno": 1748, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The change in this Body's horizontal position from the previous step.\rThis value is set during the Body's update phase.\r\rAs a Body can update multiple times per step this may not hold the final\rdelta value for the Body. In this case, please see the `deltaXFinal` method.", "kind": "function", "name": "deltaX", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#deltaX", "scope": "instance", "___id": "T000002R028395", "___s": true }, { "comment": "/**\r\n * The change in this Body's vertical position from the previous step.\r\n * This value is set during the Body's update phase.\r\n *\r\n * As a Body can update multiple times per step this may not hold the final\r\n * delta value for the Body. In this case, please see the `deltaYFinal` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#deltaY\r\n * @since 3.0.0\r\n *\r\n * @return {number} The delta value.\r\n */", "meta": { "filename": "Body.js", "lineno": 1765, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The change in this Body's vertical position from the previous step.\rThis value is set during the Body's update phase.\r\rAs a Body can update multiple times per step this may not hold the final\rdelta value for the Body. In this case, please see the `deltaYFinal` method.", "kind": "function", "name": "deltaY", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#deltaY", "scope": "instance", "___id": "T000002R028397", "___s": true }, { "comment": "/**\r\n * The change in this Body's horizontal position from the previous game update.\r\n *\r\n * This value is set during the `postUpdate` phase and takes into account the\r\n * `deltaMax` and final position of the Body.\r\n *\r\n * Because this value is not calculated until `postUpdate`, you must listen for it\r\n * during a Scene `POST_UPDATE` or `RENDER` event, and not in `update`, as it will\r\n * not be calculated by that point. If you _do_ use these values in `update` they\r\n * will represent the delta from the _previous_ game frame.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#deltaXFinal\r\n * @since 3.22.0\r\n *\r\n * @return {number} The final delta x value.\r\n */", "meta": { "filename": "Body.js", "lineno": 1782, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The change in this Body's horizontal position from the previous game update.\r\rThis value is set during the `postUpdate` phase and takes into account the\r`deltaMax` and final position of the Body.\r\rBecause this value is not calculated until `postUpdate`, you must listen for it\rduring a Scene `POST_UPDATE` or `RENDER` event, and not in `update`, as it will\rnot be calculated by that point. If you _do_ use these values in `update` they\rwill represent the delta from the _previous_ game frame.", "kind": "function", "name": "deltaXFinal", "since": "3.22.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The final delta x value." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#deltaXFinal", "scope": "instance", "___id": "T000002R028399", "___s": true }, { "comment": "/**\r\n * The change in this Body's vertical position from the previous game update.\r\n *\r\n * This value is set during the `postUpdate` phase and takes into account the\r\n * `deltaMax` and final position of the Body.\r\n *\r\n * Because this value is not calculated until `postUpdate`, you must listen for it\r\n * during a Scene `POST_UPDATE` or `RENDER` event, and not in `update`, as it will\r\n * not be calculated by that point. If you _do_ use these values in `update` they\r\n * will represent the delta from the _previous_ game frame.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#deltaYFinal\r\n * @since 3.22.0\r\n *\r\n * @return {number} The final delta y value.\r\n */", "meta": { "filename": "Body.js", "lineno": 1803, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The change in this Body's vertical position from the previous game update.\r\rThis value is set during the `postUpdate` phase and takes into account the\r`deltaMax` and final position of the Body.\r\rBecause this value is not calculated until `postUpdate`, you must listen for it\rduring a Scene `POST_UPDATE` or `RENDER` event, and not in `update`, as it will\rnot be calculated by that point. If you _do_ use these values in `update` they\rwill represent the delta from the _previous_ game frame.", "kind": "function", "name": "deltaYFinal", "since": "3.22.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The final delta y value." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#deltaYFinal", "scope": "instance", "___id": "T000002R028401", "___s": true }, { "comment": "/**\r\n * The change in this Body's rotation from the previous step, in degrees.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#deltaZ\r\n * @since 3.0.0\r\n *\r\n * @return {number} The delta value.\r\n */", "meta": { "filename": "Body.js", "lineno": 1824, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The change in this Body's rotation from the previous step, in degrees.", "kind": "function", "name": "deltaZ", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#deltaZ", "scope": "instance", "___id": "T000002R028403", "___s": true }, { "comment": "/**\r\n * Disables this Body and marks it for deletion by the simulation.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 1837, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Disables this Body and marks it for deletion by the simulation.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#destroy", "scope": "instance", "___id": "T000002R028405", "___s": true }, { "comment": "/**\r\n * Draws this Body and its velocity, if enabled.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#drawDebug\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Graphics} graphic - The Graphics object to draw on.\r\n */", "meta": { "filename": "Body.js", "lineno": 1853, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Draws this Body and its velocity, if enabled.", "kind": "function", "name": "drawDebug", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics object to draw on.", "name": "graphic" } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#drawDebug", "scope": "instance", "___id": "T000002R028408", "___s": true }, { "comment": "/**\r\n * Whether this Body will be drawn to the debug display.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#willDrawDebug\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} True if either `debugShowBody` or `debugShowVelocity` are enabled.\r\n */", "meta": { "filename": "Body.js", "lineno": 1908, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Body will be drawn to the debug display.", "kind": "function", "name": "willDrawDebug", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if either `debugShowBody` or `debugShowVelocity` are enabled." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#willDrawDebug", "scope": "instance", "___id": "T000002R028413", "___s": true }, { "comment": "/**\r\n * Sets whether this Body should calculate its velocity based on its change in\r\n * position every frame. The default, which is to not do this, means that you\r\n * make this Body move by setting the velocity directly. However, if you are\r\n * trying to move this Body via a Tween, or have it follow a Path, then you\r\n * should enable this instead. This will allow it to still collide with other\r\n * bodies, something that isn't possible if you're just changing its position directly.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setDirectControl\r\n * @since 3.61.0\r\n *\r\n * @param {boolean} [value=true] - `true` if the Body calculate velocity based on changes in position, otherwise `false`.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 1921, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets whether this Body should calculate its velocity based on its change in\rposition every frame. The default, which is to not do this, means that you\rmake this Body move by setting the velocity directly. However, if you are\rtrying to move this Body via a Tween, or have it follow a Path, then you\rshould enable this instead. This will allow it to still collide with other\rbodies, something that isn't possible if you're just changing its position directly.", "kind": "function", "name": "setDirectControl", "since": "3.61.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if the Body calculate velocity based on changes in position, otherwise `false`.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setDirectControl", "scope": "instance", "___id": "T000002R028415", "___s": true }, { "comment": "/**\r\n * Sets whether this Body collides with the world boundary.\r\n *\r\n * Optionally also sets the World Bounce and `onWorldBounds` values.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setCollideWorldBounds\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [value=true] - `true` if the Body should collide with the world bounds, otherwise `false`.\r\n * @param {number} [bounceX] - If given this replaces the Body's `worldBounce.x` value.\r\n * @param {number} [bounceY] - If given this replaces the Body's `worldBounce.y` value.\r\n * @param {boolean} [onWorldBounds] - If given this replaces the Body's `onWorldBounds` value.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 1945, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets whether this Body collides with the world boundary.\r\rOptionally also sets the World Bounce and `onWorldBounds` values.", "kind": "function", "name": "setCollideWorldBounds", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if the Body should collide with the world bounds, otherwise `false`.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If given this replaces the Body's `worldBounce.x` value.", "name": "bounceX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If given this replaces the Body's `worldBounce.y` value.", "name": "bounceY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If given this replaces the Body's `onWorldBounds` value.", "name": "onWorldBounds" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setCollideWorldBounds", "scope": "instance", "___id": "T000002R028419", "___s": true }, { "comment": "/**\r\n * Sets the Body's velocity.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal velocity, in pixels per second.\r\n * @param {number} [y=x] - The vertical velocity, in pixels per second.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 1995, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's velocity.", "kind": "function", "name": "setVelocity", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal velocity, in pixels per second.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical velocity, in pixels per second.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setVelocity", "scope": "instance", "___id": "T000002R028429", "___s": true }, { "comment": "/**\r\n * Sets the Body's horizontal velocity.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setVelocityX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The velocity, in pixels per second.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2018, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's horizontal velocity.", "kind": "function", "name": "setVelocityX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The velocity, in pixels per second.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setVelocityX", "scope": "instance", "___id": "T000002R028434", "___s": true }, { "comment": "/**\r\n * Sets the Body's vertical velocity.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setVelocityY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The velocity, in pixels per second.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2033, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's vertical velocity.", "kind": "function", "name": "setVelocityY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The velocity, in pixels per second.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setVelocityY", "scope": "instance", "___id": "T000002R028436", "___s": true }, { "comment": "/**\r\n * Sets the Body's maximum velocity.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setMaxVelocity\r\n * @since 3.10.0\r\n *\r\n * @param {number} x - The horizontal velocity, in pixels per second.\r\n * @param {number} [y=x] - The vertical velocity, in pixels per second.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2048, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's maximum velocity.", "kind": "function", "name": "setMaxVelocity", "since": "3.10.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal velocity, in pixels per second.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical velocity, in pixels per second.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setMaxVelocity", "scope": "instance", "___id": "T000002R028438", "___s": true }, { "comment": "/**\r\n * Sets the Body's maximum horizontal velocity.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setMaxVelocityX\r\n * @since 3.50.0\r\n *\r\n * @param {number} value - The maximum horizontal velocity, in pixels per second.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2066, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's maximum horizontal velocity.", "kind": "function", "name": "setMaxVelocityX", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum horizontal velocity, in pixels per second.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setMaxVelocityX", "scope": "instance", "___id": "T000002R028440", "___s": true }, { "comment": "/**\r\n * Sets the Body's maximum vertical velocity.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setMaxVelocityY\r\n * @since 3.50.0\r\n *\r\n * @param {number} value - The maximum vertical velocity, in pixels per second.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2083, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's maximum vertical velocity.", "kind": "function", "name": "setMaxVelocityY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum vertical velocity, in pixels per second.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setMaxVelocityY", "scope": "instance", "___id": "T000002R028443", "___s": true }, { "comment": "/**\r\n * Sets the maximum speed the Body can move.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setMaxSpeed\r\n * @since 3.16.0\r\n *\r\n * @param {number} value - The maximum speed value, in pixels per second. Set to a negative value to disable.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the maximum speed the Body can move.", "kind": "function", "name": "setMaxSpeed", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum speed value, in pixels per second. Set to a negative value to disable.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setMaxSpeed", "scope": "instance", "___id": "T000002R028446", "___s": true }, { "comment": "/**\r\n * Sets the Slide Factor of this Body.\r\n *\r\n * The Slide Factor controls how much velocity is preserved when\r\n * this Body is pushed by another Body.\r\n *\r\n * The default value is 1, which means that it will take on all\r\n * velocity given in the push. You can adjust this value to control\r\n * how much velocity is retained by this Body when the push ends.\r\n *\r\n * A value of 0, for example, will allow this Body to be pushed\r\n * but then remain completely still after the push ends, such as\r\n * you see in a game like Sokoban.\r\n *\r\n * Or you can set a mid-point, such as 0.25 which will allow it\r\n * to keep 25% of the original velocity when the push ends. You\r\n * can combine this with the `setDrag()` method to create deceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setSlideFactor\r\n * @since 3.61.0\r\n *\r\n * @param {number} x - The horizontal slide factor. A value between 0 and 1.\r\n * @param {number} [y=x] - The vertical slide factor. A value between 0 and 1.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Slide Factor of this Body.\r\rThe Slide Factor controls how much velocity is preserved when\rthis Body is pushed by another Body.\r\rThe default value is 1, which means that it will take on all\rvelocity given in the push. You can adjust this value to control\rhow much velocity is retained by this Body when the push ends.\r\rA value of 0, for example, will allow this Body to be pushed\rbut then remain completely still after the push ends, such as\ryou see in a game like Sokoban.\r\rOr you can set a mid-point, such as 0.25 which will allow it\rto keep 25% of the original velocity when the push ends. You\rcan combine this with the `setDrag()` method to create deceleration.", "kind": "function", "name": "setSlideFactor", "since": "3.61.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal slide factor. A value between 0 and 1.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical slide factor. A value between 0 and 1.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setSlideFactor", "scope": "instance", "___id": "T000002R028449", "___s": true }, { "comment": "/**\r\n * Sets the Body's bounce.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setBounce\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal bounce, relative to 1.\r\n * @param {number} [y=x] - The vertical bounce, relative to 1.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2150, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's bounce.", "kind": "function", "name": "setBounce", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal bounce, relative to 1.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical bounce, relative to 1.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setBounce", "scope": "instance", "___id": "T000002R028451", "___s": true }, { "comment": "/**\r\n * Sets the Body's horizontal bounce.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setBounceX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The bounce, relative to 1.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2168, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's horizontal bounce.", "kind": "function", "name": "setBounceX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bounce, relative to 1.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setBounceX", "scope": "instance", "___id": "T000002R028453", "___s": true }, { "comment": "/**\r\n * Sets the Body's vertical bounce.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setBounceY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The bounce, relative to 1.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2185, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's vertical bounce.", "kind": "function", "name": "setBounceY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bounce, relative to 1.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setBounceY", "scope": "instance", "___id": "T000002R028456", "___s": true }, { "comment": "/**\r\n * Sets the Body's acceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setAcceleration\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal component, in pixels per second squared.\r\n * @param {number} [y=x] - The vertical component, in pixels per second squared.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2202, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's acceleration.", "kind": "function", "name": "setAcceleration", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal component, in pixels per second squared.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical component, in pixels per second squared.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setAcceleration", "scope": "instance", "___id": "T000002R028459", "___s": true }, { "comment": "/**\r\n * Sets the Body's horizontal acceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setAccelerationX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The acceleration, in pixels per second squared.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2220, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's horizontal acceleration.", "kind": "function", "name": "setAccelerationX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The acceleration, in pixels per second squared.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setAccelerationX", "scope": "instance", "___id": "T000002R028461", "___s": true }, { "comment": "/**\r\n * Sets the Body's vertical acceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setAccelerationY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The acceleration, in pixels per second squared.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's vertical acceleration.", "kind": "function", "name": "setAccelerationY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The acceleration, in pixels per second squared.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setAccelerationY", "scope": "instance", "___id": "T000002R028464", "___s": true }, { "comment": "/**\r\n * Enables or disables drag.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setAllowDrag\r\n * @since 3.9.0\r\n * @see Phaser.Physics.Arcade.Body#allowDrag\r\n *\r\n * @param {boolean} [value=true] - `true` to allow drag on this body, or `false` to disable it.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2254, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Enables or disables drag.", "kind": "function", "name": "setAllowDrag", "since": "3.9.0", "see": [ "Phaser.Physics.Arcade.Body#allowDrag" ], "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` to allow drag on this body, or `false` to disable it.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setAllowDrag", "scope": "instance", "___id": "T000002R028467", "___s": true }, { "comment": "/**\r\n * Enables or disables gravity's effect on this Body.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setAllowGravity\r\n * @since 3.9.0\r\n * @see Phaser.Physics.Arcade.Body#allowGravity\r\n *\r\n * @param {boolean} [value=true] - `true` to allow gravity on this body, or `false` to disable it.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2274, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Enables or disables gravity's effect on this Body.", "kind": "function", "name": "setAllowGravity", "since": "3.9.0", "see": [ "Phaser.Physics.Arcade.Body#allowGravity" ], "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` to allow gravity on this body, or `false` to disable it.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setAllowGravity", "scope": "instance", "___id": "T000002R028471", "___s": true }, { "comment": "/**\r\n * Enables or disables rotation.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setAllowRotation\r\n * @since 3.9.0\r\n * @see Phaser.Physics.Arcade.Body#allowRotation\r\n *\r\n * @param {boolean} [value=true] - `true` to allow rotation on this body, or `false` to disable it.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2294, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Enables or disables rotation.", "kind": "function", "name": "setAllowRotation", "since": "3.9.0", "see": [ "Phaser.Physics.Arcade.Body#allowRotation" ], "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` to allow rotation on this body, or `false` to disable it.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setAllowRotation", "scope": "instance", "___id": "T000002R028475", "___s": true }, { "comment": "/**\r\n * Sets the Body's drag.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setDrag\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal component, in pixels per second squared.\r\n * @param {number} [y=x] - The vertical component, in pixels per second squared.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2314, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's drag.", "kind": "function", "name": "setDrag", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal component, in pixels per second squared.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical component, in pixels per second squared.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setDrag", "scope": "instance", "___id": "T000002R028479", "___s": true }, { "comment": "/**\r\n * If this Body is using `drag` for deceleration this property controls how the drag is applied.\r\n * If set to `true` drag will use a damping effect rather than a linear approach. If you are\r\n * creating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\r\n * the game Asteroids) then you will get a far smoother and more visually correct deceleration\r\n * by using damping, avoiding the axis-drift that is prone with linear deceleration.\r\n *\r\n * If you enable this property then you should use far smaller `drag` values than with linear, as\r\n * they are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow\r\n * deceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setDamping\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} value - `true` to use damping, or `false` to use drag.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "If this Body is using `drag` for deceleration this property controls how the drag is applied.\rIf set to `true` drag will use a damping effect rather than a linear approach. If you are\rcreating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\rthe game Asteroids) then you will get a far smoother and more visually correct deceleration\rby using damping, avoiding the axis-drift that is prone with linear deceleration.\r\rIf you enable this property then you should use far smaller `drag` values than with linear, as\rthey are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow\rdeceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.", "kind": "function", "name": "setDamping", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to use damping, or `false` to use drag.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setDamping", "scope": "instance", "___id": "T000002R028481", "___s": true }, { "comment": "/**\r\n * Sets the Body's horizontal drag.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setDragX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The drag, in pixels per second squared.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's horizontal drag.", "kind": "function", "name": "setDragX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The drag, in pixels per second squared.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setDragX", "scope": "instance", "___id": "T000002R028484", "___s": true }, { "comment": "/**\r\n * Sets the Body's vertical drag.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setDragY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The drag, in pixels per second squared.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2374, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's vertical drag.", "kind": "function", "name": "setDragY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The drag, in pixels per second squared.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setDragY", "scope": "instance", "___id": "T000002R028487", "___s": true }, { "comment": "/**\r\n * Sets the Body's gravity.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setGravity\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal component, in pixels per second squared.\r\n * @param {number} [y=x] - The vertical component, in pixels per second squared.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2391, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's gravity.", "kind": "function", "name": "setGravity", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal component, in pixels per second squared.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical component, in pixels per second squared.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setGravity", "scope": "instance", "___id": "T000002R028490", "___s": true }, { "comment": "/**\r\n * Sets the Body's horizontal gravity.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setGravityX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The gravity, in pixels per second squared.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2409, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's horizontal gravity.", "kind": "function", "name": "setGravityX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The gravity, in pixels per second squared.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setGravityX", "scope": "instance", "___id": "T000002R028492", "___s": true }, { "comment": "/**\r\n * Sets the Body's vertical gravity.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setGravityY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The gravity, in pixels per second squared.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2426, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's vertical gravity.", "kind": "function", "name": "setGravityY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The gravity, in pixels per second squared.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setGravityY", "scope": "instance", "___id": "T000002R028495", "___s": true }, { "comment": "/**\r\n * Sets the Body's friction.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setFriction\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal component, relative to 1.\r\n * @param {number} [y=x] - The vertical component, relative to 1.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2443, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's friction.", "kind": "function", "name": "setFriction", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal component, relative to 1.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical component, relative to 1.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setFriction", "scope": "instance", "___id": "T000002R028498", "___s": true }, { "comment": "/**\r\n * Sets the Body's horizontal friction.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setFrictionX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The friction value, relative to 1.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2461, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's horizontal friction.", "kind": "function", "name": "setFrictionX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The friction value, relative to 1.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setFrictionX", "scope": "instance", "___id": "T000002R028500", "___s": true }, { "comment": "/**\r\n * Sets the Body's vertical friction.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setFrictionY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The friction value, relative to 1.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's vertical friction.", "kind": "function", "name": "setFrictionY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The friction value, relative to 1.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setFrictionY", "scope": "instance", "___id": "T000002R028503", "___s": true }, { "comment": "/**\r\n * Sets the Body's angular velocity.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setAngularVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The velocity, in degrees per second.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's angular velocity.", "kind": "function", "name": "setAngularVelocity", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The velocity, in degrees per second.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setAngularVelocity", "scope": "instance", "___id": "T000002R028506", "___s": true }, { "comment": "/**\r\n * Sets the Body's angular acceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setAngularAcceleration\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The acceleration, in degrees per second squared.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2512, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's angular acceleration.", "kind": "function", "name": "setAngularAcceleration", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The acceleration, in degrees per second squared.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setAngularAcceleration", "scope": "instance", "___id": "T000002R028509", "___s": true }, { "comment": "/**\r\n * Sets the Body's angular drag.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setAngularDrag\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The drag, in degrees per second squared.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2529, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's angular drag.", "kind": "function", "name": "setAngularDrag", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The drag, in degrees per second squared.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setAngularDrag", "scope": "instance", "___id": "T000002R028512", "___s": true }, { "comment": "/**\r\n * Sets the Body's mass.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setMass\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The mass value, relative to 1.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2546, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's mass.", "kind": "function", "name": "setMass", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The mass value, relative to 1.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setMass", "scope": "instance", "___id": "T000002R028515", "___s": true }, { "comment": "/**\r\n * Sets the Body's `immovable` property.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setImmovable\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [value=true] - The value to assign to `immovable`.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2563, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's `immovable` property.", "kind": "function", "name": "setImmovable", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "The value to assign to `immovable`.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setImmovable", "scope": "instance", "___id": "T000002R028518", "___s": true }, { "comment": "/**\r\n * Sets the Body's `enable` property.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#setEnable\r\n * @since 3.15.0\r\n *\r\n * @param {boolean} [value=true] - The value to assign to `enable`.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} This Body object.\r\n */", "meta": { "filename": "Body.js", "lineno": 2582, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Body's `enable` property.", "kind": "function", "name": "setEnable", "since": "3.15.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "The value to assign to `enable`.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "This Body object." } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#setEnable", "scope": "instance", "___id": "T000002R028522", "___s": true }, { "comment": "/**\r\n * This is an internal handler, called by the `ProcessX` function as part\r\n * of the collision step. You should almost never call this directly.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#processX\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The amount to add to the Body position.\r\n * @param {number} [vx] - The amount to add to the Body velocity.\r\n * @param {boolean} [left] - Set the blocked.left value?\r\n * @param {boolean} [right] - Set the blocked.right value?\r\n */", "meta": { "filename": "Body.js", "lineno": 2601, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "This is an internal handler, called by the `ProcessX` function as part\rof the collision step. You should almost never call this directly.", "kind": "function", "name": "processX", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to add to the Body position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount to add to the Body velocity.", "name": "vx" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Set the blocked.left value?", "name": "left" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Set the blocked.right value?", "name": "right" } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#processX", "scope": "instance", "___id": "T000002R028526", "___s": true }, { "comment": "/**\r\n * This is an internal handler, called by the `ProcessY` function as part\r\n * of the collision step. You should almost never call this directly.\r\n *\r\n * @method Phaser.Physics.Arcade.Body#processY\r\n * @since 3.50.0\r\n *\r\n * @param {number} y - The amount to add to the Body position.\r\n * @param {number} [vy] - The amount to add to the Body velocity.\r\n * @param {boolean} [up] - Set the blocked.up value?\r\n * @param {boolean} [down] - Set the blocked.down value?\r\n */", "meta": { "filename": "Body.js", "lineno": 2639, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "This is an internal handler, called by the `ProcessY` function as part\rof the collision step. You should almost never call this directly.", "kind": "function", "name": "processY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to add to the Body position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount to add to the Body velocity.", "name": "vy" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Set the blocked.up value?", "name": "up" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Set the blocked.down value?", "name": "down" } ], "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#processY", "scope": "instance", "___id": "T000002R028535", "___s": true }, { "comment": "/**\r\n * The Bodys horizontal position (left edge).\r\n *\r\n * @name Phaser.Physics.Arcade.Body#x\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 2677, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Bodys horizontal position (left edge).", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#x", "scope": "instance", "kind": "member", "___id": "T000002R028544", "___s": true }, { "comment": "/**\r\n * The Bodys vertical position (top edge).\r\n *\r\n * @name Phaser.Physics.Arcade.Body#y\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 2698, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Bodys vertical position (top edge).", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#y", "scope": "instance", "kind": "member", "___id": "T000002R028549", "___s": true }, { "comment": "/**\r\n * The left edge of the Body. Identical to x.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#left\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 2719, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The left edge of the Body. Identical to x.", "name": "left", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#left", "scope": "instance", "kind": "member", "___id": "T000002R028554", "___s": true }, { "comment": "/**\r\n * The right edge of the Body.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#right\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 2736, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The right edge of the Body.", "name": "right", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#right", "scope": "instance", "kind": "member", "___id": "T000002R028557", "___s": true }, { "comment": "/**\r\n * The top edge of the Body. Identical to y.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#top\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 2753, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The top edge of the Body. Identical to y.", "name": "top", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#top", "scope": "instance", "kind": "member", "___id": "T000002R028560", "___s": true }, { "comment": "/**\r\n * The bottom edge of this Body.\r\n *\r\n * @name Phaser.Physics.Arcade.Body#bottom\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Body.js", "lineno": 2770, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The bottom edge of this Body.", "name": "bottom", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Body", "longname": "Phaser.Physics.Arcade.Body#bottom", "scope": "instance", "kind": "member", "___id": "T000002R028563", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * An Arcade Physics Collider will automatically check for collision, or overlaps, between two objects\r\n * every step. If a collision, or overlap, occurs it will invoke the given callbacks.\r\n *\r\n * @class Collider\r\n * @memberof Phaser.Physics.Arcade\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.World} world - The Arcade physics World that will manage the collisions.\r\n * @param {boolean} overlapOnly - Whether to check for collisions or overlap.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} object1 - The first object to check for collision.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} object2 - The second object to check for collision.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} collideCallback - The callback to invoke when the two objects collide.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} processCallback - The callback to invoke when the two objects collide. Must return a boolean.\r\n * @param {any} callbackContext - The scope in which to call the callbacks.\r\n */", "meta": { "filename": "Collider.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "classdesc": "An Arcade Physics Collider will automatically check for collision, or overlaps, between two objects\revery step. If a collision, or overlap, occurs it will invoke the given callbacks.", "kind": "class", "name": "Collider", "memberof": "Phaser.Physics.Arcade", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "description": "The Arcade physics World that will manage the collisions.", "name": "world" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to check for collisions or overlap.", "name": "overlapOnly" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "description": "The first object to check for collision.", "name": "object1" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "description": "The second object to check for collision.", "name": "object2" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "description": "The callback to invoke when the two objects collide.", "name": "collideCallback" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "description": "The callback to invoke when the two objects collide. Must return a boolean.", "name": "processCallback" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The scope in which to call the callbacks.", "name": "callbackContext" } ], "scope": "static", "longname": "Phaser.Physics.Arcade.Collider", "___id": "T000002R028568", "___s": true }, { "comment": "/**\r\n * The world in which the bodies will collide.\r\n *\r\n * @name Phaser.Physics.Arcade.Collider#world\r\n * @type {Phaser.Physics.Arcade.World}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Collider.js", "lineno": 33, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The world in which the bodies will collide.", "name": "world", "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Collider", "longname": "Phaser.Physics.Arcade.Collider#world", "scope": "instance", "kind": "member", "___id": "T000002R028571", "___s": true }, { "comment": "/**\r\n * The name of the collider (unused by Phaser).\r\n *\r\n * @name Phaser.Physics.Arcade.Collider#name\r\n * @type {string}\r\n * @since 3.1.0\r\n */", "meta": { "filename": "Collider.js", "lineno": 42, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The name of the collider (unused by Phaser).", "name": "name", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.1.0", "memberof": "Phaser.Physics.Arcade.Collider", "longname": "Phaser.Physics.Arcade.Collider#name", "scope": "instance", "kind": "member", "___id": "T000002R028573", "___s": true }, { "comment": "/**\r\n * Whether the collider is active.\r\n *\r\n * @name Phaser.Physics.Arcade.Collider#active\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Collider.js", "lineno": 51, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether the collider is active.", "name": "active", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Collider", "longname": "Phaser.Physics.Arcade.Collider#active", "scope": "instance", "kind": "member", "___id": "T000002R028575", "___s": true }, { "comment": "/**\r\n * Whether to check for collisions or overlaps.\r\n *\r\n * @name Phaser.Physics.Arcade.Collider#overlapOnly\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Collider.js", "lineno": 61, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether to check for collisions or overlaps.", "name": "overlapOnly", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Collider", "longname": "Phaser.Physics.Arcade.Collider#overlapOnly", "scope": "instance", "kind": "member", "___id": "T000002R028577", "___s": true }, { "comment": "/**\r\n * The first object to check for collision.\r\n *\r\n * @name Phaser.Physics.Arcade.Collider#object1\r\n * @type {Phaser.Types.Physics.Arcade.ArcadeColliderType}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Collider.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The first object to check for collision.", "name": "object1", "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Collider", "longname": "Phaser.Physics.Arcade.Collider#object1", "scope": "instance", "kind": "member", "___id": "T000002R028579", "___s": true }, { "comment": "/**\r\n * The second object to check for collision.\r\n *\r\n * @name Phaser.Physics.Arcade.Collider#object2\r\n * @type {Phaser.Types.Physics.Arcade.ArcadeColliderType}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Collider.js", "lineno": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The second object to check for collision.", "name": "object2", "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Collider", "longname": "Phaser.Physics.Arcade.Collider#object2", "scope": "instance", "kind": "member", "___id": "T000002R028581", "___s": true }, { "comment": "/**\r\n * The callback to invoke when the two objects collide.\r\n *\r\n * @name Phaser.Physics.Arcade.Collider#collideCallback\r\n * @type {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Collider.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The callback to invoke when the two objects collide.", "name": "collideCallback", "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Collider", "longname": "Phaser.Physics.Arcade.Collider#collideCallback", "scope": "instance", "kind": "member", "___id": "T000002R028583", "___s": true }, { "comment": "/**\r\n * If a processCallback exists it must return true or collision checking will be skipped.\r\n *\r\n * @name Phaser.Physics.Arcade.Collider#processCallback\r\n * @type {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Collider.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "If a processCallback exists it must return true or collision checking will be skipped.", "name": "processCallback", "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Collider", "longname": "Phaser.Physics.Arcade.Collider#processCallback", "scope": "instance", "kind": "member", "___id": "T000002R028585", "___s": true }, { "comment": "/**\r\n * The context the collideCallback and processCallback will run in.\r\n *\r\n * @name Phaser.Physics.Arcade.Collider#callbackContext\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Collider.js", "lineno": 106, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The context the collideCallback and processCallback will run in.", "name": "callbackContext", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Collider", "longname": "Phaser.Physics.Arcade.Collider#callbackContext", "scope": "instance", "kind": "member", "___id": "T000002R028587", "___s": true }, { "comment": "/**\r\n * A name for the Collider.\r\n *\r\n * Phaser does not use this value, it's for your own reference.\r\n *\r\n * @method Phaser.Physics.Arcade.Collider#setName\r\n * @since 3.1.0\r\n *\r\n * @param {string} name - The name to assign to the Collider.\r\n *\r\n * @return {Phaser.Physics.Arcade.Collider} This Collider instance.\r\n */", "meta": { "filename": "Collider.js", "lineno": 116, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "A name for the Collider.\r\rPhaser does not use this value, it's for your own reference.", "kind": "function", "name": "setName", "since": "3.1.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to assign to the Collider.", "name": "name" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Collider" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Collider" } }, "description": "This Collider instance." } ], "memberof": "Phaser.Physics.Arcade.Collider", "longname": "Phaser.Physics.Arcade.Collider#setName", "scope": "instance", "___id": "T000002R028589", "___s": true }, { "comment": "/**\r\n * Called by World as part of its step processing, initial operation of collision checking.\r\n *\r\n * @method Phaser.Physics.Arcade.Collider#update\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Collider.js", "lineno": 135, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Called by World as part of its step processing, initial operation of collision checking.", "kind": "function", "name": "update", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Collider", "longname": "Phaser.Physics.Arcade.Collider#update", "scope": "instance", "___id": "T000002R028592", "___s": true }, { "comment": "/**\r\n * Removes Collider from World and disposes of its resources.\r\n *\r\n * @method Phaser.Physics.Arcade.Collider#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Collider.js", "lineno": 153, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Removes Collider from World and disposes of its resources.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Collider", "longname": "Phaser.Physics.Arcade.Collider#destroy", "scope": "instance", "___id": "T000002R028594", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the acceleration properties of an Arcade Physics Body.\r\n *\r\n * @namespace Phaser.Physics.Arcade.Components.Acceleration\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Acceleration.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Provides methods used for setting the acceleration properties of an Arcade Physics Body.", "kind": "namespace", "name": "Acceleration", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Components", "longname": "Phaser.Physics.Arcade.Components.Acceleration", "scope": "static", "___id": "T000002R028604", "___s": true }, { "comment": "/**\r\n * Sets the body's horizontal and vertical acceleration. If the vertical acceleration value is not provided, the vertical acceleration is set to the same value as the horizontal acceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Acceleration#setAcceleration\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal acceleration\r\n * @param {number} [y=x] - The vertical acceleration\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Acceleration.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the body's horizontal and vertical acceleration. If the vertical acceleration value is not provided, the vertical acceleration is set to the same value as the horizontal acceleration.", "kind": "function", "name": "setAcceleration", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal acceleration", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical acceleration", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Acceleration", "longname": "Phaser.Physics.Arcade.Components.Acceleration#setAcceleration", "scope": "instance", "___id": "T000002R028606", "___s": true }, { "comment": "/**\r\n * Sets the body's horizontal acceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Acceleration#setAccelerationX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The horizontal acceleration\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Acceleration.js", "lineno": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the body's horizontal acceleration.", "kind": "function", "name": "setAccelerationX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal acceleration", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Acceleration", "longname": "Phaser.Physics.Arcade.Components.Acceleration#setAccelerationX", "scope": "instance", "___id": "T000002R028608", "___s": true }, { "comment": "/**\r\n * Sets the body's vertical acceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Acceleration#setAccelerationY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The vertical acceleration\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Acceleration.js", "lineno": 50, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the body's vertical acceleration.", "kind": "function", "name": "setAccelerationY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical acceleration", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Acceleration", "longname": "Phaser.Physics.Arcade.Components.Acceleration#setAccelerationY", "scope": "instance", "___id": "T000002R028611", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the angular acceleration properties of an Arcade Physics Body.\r\n *\r\n * @namespace Phaser.Physics.Arcade.Components.Angular\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Angular.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Provides methods used for setting the angular acceleration properties of an Arcade Physics Body.", "kind": "namespace", "name": "Angular", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Components", "longname": "Phaser.Physics.Arcade.Components.Angular", "scope": "static", "___id": "T000002R028615", "___s": true }, { "comment": "/**\r\n * Sets the angular velocity of the body.\r\n *\r\n * In Arcade Physics, bodies cannot rotate. They are always axis-aligned.\r\n * However, they can have angular motion, which is passed on to the Game Object bound to the body,\r\n * causing them to visually rotate, even though the body remains axis-aligned.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Angular#setAngularVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of angular velocity.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Angular.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the angular velocity of the body.\r\rIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\rHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\rcausing them to visually rotate, even though the body remains axis-aligned.", "kind": "function", "name": "setAngularVelocity", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of angular velocity.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Angular", "longname": "Phaser.Physics.Arcade.Components.Angular#setAngularVelocity", "scope": "instance", "___id": "T000002R028617", "___s": true }, { "comment": "/**\r\n * Sets the angular acceleration of the body.\r\n *\r\n * In Arcade Physics, bodies cannot rotate. They are always axis-aligned.\r\n * However, they can have angular motion, which is passed on to the Game Object bound to the body,\r\n * causing them to visually rotate, even though the body remains axis-aligned.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Angular#setAngularAcceleration\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of angular acceleration.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Angular.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the angular acceleration of the body.\r\rIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\rHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\rcausing them to visually rotate, even though the body remains axis-aligned.", "kind": "function", "name": "setAngularAcceleration", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of angular acceleration.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Angular", "longname": "Phaser.Physics.Arcade.Components.Angular#setAngularAcceleration", "scope": "instance", "___id": "T000002R028620", "___s": true }, { "comment": "/**\r\n * Sets the angular drag of the body. Drag is applied to the current velocity, providing a form of deceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Angular#setAngularDrag\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of drag.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Angular.js", "lineno": 57, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the angular drag of the body. Drag is applied to the current velocity, providing a form of deceleration.", "kind": "function", "name": "setAngularDrag", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of drag.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Angular", "longname": "Phaser.Physics.Arcade.Components.Angular#setAngularDrag", "scope": "instance", "___id": "T000002R028623", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the bounce properties of an Arcade Physics Body.\r\n *\r\n * @namespace Phaser.Physics.Arcade.Components.Bounce\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Bounce.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Provides methods used for setting the bounce properties of an Arcade Physics Body.", "kind": "namespace", "name": "Bounce", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Components", "longname": "Phaser.Physics.Arcade.Components.Bounce", "scope": "static", "___id": "T000002R028627", "___s": true }, { "comment": "/**\r\n * Sets the bounce values of this body.\r\n *\r\n * Bounce is the amount of restitution, or elasticity, the body has when it collides with another object.\r\n * A value of 1 means that it will retain its full velocity after the rebound. A value of 0 means it will not rebound at all.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Bounce#setBounce\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.\r\n * @param {number} [y=x] - The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Bounce.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the bounce values of this body.\r\rBounce is the amount of restitution, or elasticity, the body has when it collides with another object.\rA value of 1 means that it will retain its full velocity after the rebound. A value of 0 means it will not rebound at all.", "kind": "function", "name": "setBounce", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Bounce", "longname": "Phaser.Physics.Arcade.Components.Bounce#setBounce", "scope": "instance", "___id": "T000002R028629", "___s": true }, { "comment": "/**\r\n * Sets the horizontal bounce value for this body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Bounce#setBounceX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Bounce.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the horizontal bounce value for this body.", "kind": "function", "name": "setBounceX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Bounce", "longname": "Phaser.Physics.Arcade.Components.Bounce#setBounceX", "scope": "instance", "___id": "T000002R028631", "___s": true }, { "comment": "/**\r\n * Sets the vertical bounce value for this body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Bounce#setBounceY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Bounce.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the vertical bounce value for this body.", "kind": "function", "name": "setBounceY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Bounce", "longname": "Phaser.Physics.Arcade.Components.Bounce#setBounceY", "scope": "instance", "___id": "T000002R028634", "___s": true }, { "comment": "/**\r\n * Sets whether this Body collides with the world boundary.\r\n *\r\n * Optionally also sets the World Bounce values. If the `Body.worldBounce` is null, it's set to a new Phaser.Math.Vector2 first.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Bounce#setCollideWorldBounds\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [value=true] - `true` if this body should collide with the world bounds, otherwise `false`.\r\n * @param {number} [bounceX] - If given this will be replace the `worldBounce.x` value.\r\n * @param {number} [bounceY] - If given this will be replace the `worldBounce.y` value.\r\n * @param {boolean} [onWorldBounds] - If given this replaces the Body's `onWorldBounds` value.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Bounce.js", "lineno": 70, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets whether this Body collides with the world boundary.\r\rOptionally also sets the World Bounce values. If the `Body.worldBounce` is null, it's set to a new Phaser.Math.Vector2 first.", "kind": "function", "name": "setCollideWorldBounds", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if this body should collide with the world bounds, otherwise `false`.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If given this will be replace the `worldBounce.x` value.", "name": "bounceX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If given this will be replace the `worldBounce.y` value.", "name": "bounceY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If given this replaces the Body's `onWorldBounds` value.", "name": "onWorldBounds" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Bounce", "longname": "Phaser.Physics.Arcade.Components.Bounce#setCollideWorldBounds", "scope": "instance", "___id": "T000002R028637", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the collision category and mask of an Arcade Physics Body.\r\n *\r\n * @namespace Phaser.Physics.Arcade.Components.Collision\r\n * @since 3.61.0\r\n */", "meta": { "filename": "Collision.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Provides methods used for setting the collision category and mask of an Arcade Physics Body.", "kind": "namespace", "name": "Collision", "since": "3.61.0", "memberof": "Phaser.Physics.Arcade.Components", "longname": "Phaser.Physics.Arcade.Components.Collision", "scope": "static", "___id": "T000002R028641", "___s": true }, { "comment": "/**\r\n * Sets the Collision Category that this Arcade Physics Body\r\n * will use in order to determine what it can collide with.\r\n *\r\n * It can only have one single category assigned to it.\r\n *\r\n * If you wish to reset the collision category and mask, call\r\n * the `resetCollisionCategory` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#setCollisionCategory\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the Collision Category that this Arcade Physics Body\rwill use in order to determine what it can collide with.\r\rIt can only have one single category assigned to it.\r\rIf you wish to reset the collision category and mask, call\rthe `resetCollisionCategory` method.", "kind": "function", "name": "setCollisionCategory", "since": "3.61.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category.", "name": "category" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Collision", "longname": "Phaser.Physics.Arcade.Components.Collision#setCollisionCategory", "scope": "instance", "___id": "T000002R028643", "___s": true }, { "comment": "/**\r\n * Checks to see if the given Collision Category will collide with\r\n * this Arcade Physics object or not.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#willCollideWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - Collision category value to test.\r\n *\r\n * @return {boolean} `true` if the given category will collide with this object, otherwise `false`.\r\n */", "meta": { "filename": "Collision.js", "lineno": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Checks to see if the given Collision Category will collide with\rthis Arcade Physics object or not.", "kind": "function", "name": "willCollideWith", "since": "3.61.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Collision category value to test.", "name": "category" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given category will collide with this object, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade.Components.Collision", "longname": "Phaser.Physics.Arcade.Components.Collision#willCollideWith", "scope": "instance", "___id": "T000002R028647", "___s": true }, { "comment": "/**\r\n * Adds the given Collision Category to the list of those that this\r\n * Arcade Physics Body will collide with.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#addCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category to add.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 60, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Adds the given Collision Category to the list of those that this\rArcade Physics Body will collide with.", "kind": "function", "name": "addCollidesWith", "since": "3.61.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category to add.", "name": "category" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Collision", "longname": "Phaser.Physics.Arcade.Components.Collision#addCollidesWith", "scope": "instance", "___id": "T000002R028650", "___s": true }, { "comment": "/**\r\n * Removes the given Collision Category from the list of those that this\r\n * Arcade Physics Body will collide with.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#removeCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category to add.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Removes the given Collision Category from the list of those that this\rArcade Physics Body will collide with.", "kind": "function", "name": "removeCollidesWith", "since": "3.61.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category to add.", "name": "category" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Collision", "longname": "Phaser.Physics.Arcade.Components.Collision#removeCollidesWith", "scope": "instance", "___id": "T000002R028654", "___s": true }, { "comment": "/**\r\n * Sets all of the Collision Categories that this Arcade Physics Body\r\n * will collide with. You can either pass a single category value, or\r\n * an array of them.\r\n *\r\n * Calling this method will reset all of the collision categories,\r\n * so only those passed to this method are enabled.\r\n *\r\n * If you wish to add a new category to the existing mask, call\r\n * the `addCollisionCategory` method.\r\n *\r\n * If you wish to reset the collision category and mask, call\r\n * the `resetCollisionCategory` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#setCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {(number|number[])} categories - The collision category to collide with, or an array of them.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets all of the Collision Categories that this Arcade Physics Body\rwill collide with. You can either pass a single category value, or\ran array of them.\r\rCalling this method will reset all of the collision categories,\rso only those passed to this method are enabled.\r\rIf you wish to add a new category to the existing mask, call\rthe `addCollisionCategory` method.\r\rIf you wish to reset the collision category and mask, call\rthe `resetCollisionCategory` method.", "kind": "function", "name": "setCollidesWith", "since": "3.61.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" } ] } ] } }, "description": "The collision category to collide with, or an array of them.", "name": "categories" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Collision", "longname": "Phaser.Physics.Arcade.Components.Collision#setCollidesWith", "scope": "instance", "___id": "T000002R028658", "___s": true }, { "comment": "/**\r\n * Resets the Collision Category and Mask back to the defaults,\r\n * which is to collide with everything.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#resetCollisionCategory\r\n * @since 3.61.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Resets the Collision Category and Mask back to the defaults,\rwhich is to collide with everything.", "kind": "function", "name": "resetCollisionCategory", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Collision", "longname": "Phaser.Physics.Arcade.Components.Collision#resetCollisionCategory", "scope": "instance", "___id": "T000002R028662", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the debug properties of an Arcade Physics Body.\r\n *\r\n * @namespace Phaser.Physics.Arcade.Components.Debug\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Debug.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Provides methods used for setting the debug properties of an Arcade Physics Body.", "kind": "namespace", "name": "Debug", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Components", "longname": "Phaser.Physics.Arcade.Components.Debug", "scope": "static", "___id": "T000002R028668", "___s": true }, { "comment": "/**\r\n * Sets the debug values of this body.\r\n *\r\n * Bodies will only draw their debug if debug has been enabled for Arcade Physics as a whole.\r\n * Note that there is a performance cost in drawing debug displays. It should never be used in production.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Debug#setDebug\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} showBody - Set to `true` to have this body render its outline to the debug display.\r\n * @param {boolean} showVelocity - Set to `true` to have this body render a velocity marker to the debug display.\r\n * @param {number} bodyColor - The color of the body outline when rendered to the debug display.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Debug.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the debug values of this body.\r\rBodies will only draw their debug if debug has been enabled for Arcade Physics as a whole.\rNote that there is a performance cost in drawing debug displays. It should never be used in production.", "kind": "function", "name": "setDebug", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to `true` to have this body render its outline to the debug display.", "name": "showBody" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to `true` to have this body render a velocity marker to the debug display.", "name": "showVelocity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The color of the body outline when rendered to the debug display.", "name": "bodyColor" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Debug", "longname": "Phaser.Physics.Arcade.Components.Debug#setDebug", "scope": "instance", "___id": "T000002R028670", "___s": true }, { "comment": "/**\r\n * Sets the color of the body outline when it renders to the debug display.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Debug#setDebugBodyColor\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The color of the body outline when rendered to the debug display.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Debug.js", "lineno": 39, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the color of the body outline when it renders to the debug display.", "kind": "function", "name": "setDebugBodyColor", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The color of the body outline when rendered to the debug display.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Debug", "longname": "Phaser.Physics.Arcade.Components.Debug#setDebugBodyColor", "scope": "instance", "___id": "T000002R028675", "___s": true }, { "comment": "/**\r\n * Set to `true` to have this body render its outline to the debug display.\r\n *\r\n * @name Phaser.Physics.Arcade.Components.Debug#debugShowBody\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Debug.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Set to `true` to have this body render its outline to the debug display.", "name": "debugShowBody", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Components.Debug", "longname": "Phaser.Physics.Arcade.Components.Debug#debugShowBody", "scope": "instance", "kind": "member", "___id": "T000002R028678", "___s": true }, { "comment": "/**\r\n * Set to `true` to have this body render a velocity marker to the debug display.\r\n *\r\n * @name Phaser.Physics.Arcade.Components.Debug#debugShowVelocity\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Debug.js", "lineno": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Set to `true` to have this body render a velocity marker to the debug display.", "name": "debugShowVelocity", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Components.Debug", "longname": "Phaser.Physics.Arcade.Components.Debug#debugShowVelocity", "scope": "instance", "kind": "member", "___id": "T000002R028683", "___s": true }, { "comment": "/**\r\n * The color of the body outline when it renders to the debug display.\r\n *\r\n * @name Phaser.Physics.Arcade.Components.Debug#debugBodyColor\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Debug.js", "lineno": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "The color of the body outline when it renders to the debug display.", "name": "debugBodyColor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Components.Debug", "longname": "Phaser.Physics.Arcade.Components.Debug#debugBodyColor", "scope": "instance", "kind": "member", "___id": "T000002R028688", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the drag properties of an Arcade Physics Body.\r\n *\r\n * @namespace Phaser.Physics.Arcade.Components.Drag\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Drag.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Provides methods used for setting the drag properties of an Arcade Physics Body.", "kind": "namespace", "name": "Drag", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Components", "longname": "Phaser.Physics.Arcade.Components.Drag", "scope": "static", "___id": "T000002R028694", "___s": true }, { "comment": "/**\r\n * Sets the body's horizontal and vertical drag. If the vertical drag value is not provided, the vertical drag is set to the same value as the horizontal drag.\r\n *\r\n * Drag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\r\n * It is the absolute loss of velocity due to movement, in pixels per second squared.\r\n * The x and y components are applied separately.\r\n *\r\n * When `useDamping` is true, this is 1 minus the damping factor.\r\n * A value of 1 means the Body loses no velocity.\r\n * A value of 0.95 means the Body loses 5% of its velocity per step.\r\n * A value of 0.5 means the Body loses 50% of its velocity per step.\r\n *\r\n * Drag is applied only when `acceleration` is zero.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Drag#setDrag\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The amount of horizontal drag to apply.\r\n * @param {number} [y=x] - The amount of vertical drag to apply.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Drag.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the body's horizontal and vertical drag. If the vertical drag value is not provided, the vertical drag is set to the same value as the horizontal drag.\r\rDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\rIt is the absolute loss of velocity due to movement, in pixels per second squared.\rThe x and y components are applied separately.\r\rWhen `useDamping` is true, this is 1 minus the damping factor.\rA value of 1 means the Body loses no velocity.\rA value of 0.95 means the Body loses 5% of its velocity per step.\rA value of 0.5 means the Body loses 50% of its velocity per step.\r\rDrag is applied only when `acceleration` is zero.", "kind": "function", "name": "setDrag", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of horizontal drag to apply.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The amount of vertical drag to apply.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Drag", "longname": "Phaser.Physics.Arcade.Components.Drag#setDrag", "scope": "instance", "___id": "T000002R028696", "___s": true }, { "comment": "/**\r\n * Sets the body's horizontal drag.\r\n *\r\n * Drag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\r\n * It is the absolute loss of velocity due to movement, in pixels per second squared.\r\n * The x and y components are applied separately.\r\n *\r\n * When `useDamping` is true, this is 1 minus the damping factor.\r\n * A value of 1 means the Body loses no velocity.\r\n * A value of 0.95 means the Body loses 5% of its velocity per step.\r\n * A value of 0.5 means the Body loses 50% of its velocity per step.\r\n *\r\n * Drag is applied only when `acceleration` is zero.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Drag#setDragX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of horizontal drag to apply.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Drag.js", "lineno": 44, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the body's horizontal drag.\r\rDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\rIt is the absolute loss of velocity due to movement, in pixels per second squared.\rThe x and y components are applied separately.\r\rWhen `useDamping` is true, this is 1 minus the damping factor.\rA value of 1 means the Body loses no velocity.\rA value of 0.95 means the Body loses 5% of its velocity per step.\rA value of 0.5 means the Body loses 50% of its velocity per step.\r\rDrag is applied only when `acceleration` is zero.", "kind": "function", "name": "setDragX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of horizontal drag to apply.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Drag", "longname": "Phaser.Physics.Arcade.Components.Drag#setDragX", "scope": "instance", "___id": "T000002R028698", "___s": true }, { "comment": "/**\r\n * Sets the body's vertical drag.\r\n *\r\n * Drag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\r\n * It is the absolute loss of velocity due to movement, in pixels per second squared.\r\n * The x and y components are applied separately.\r\n *\r\n * When `useDamping` is true, this is 1 minus the damping factor.\r\n * A value of 1 means the Body loses no velocity.\r\n * A value of 0.95 means the Body loses 5% of its velocity per step.\r\n * A value of 0.5 means the Body loses 50% of its velocity per step.\r\n *\r\n * Drag is applied only when `acceleration` is zero.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Drag#setDragY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of vertical drag to apply.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Drag.js", "lineno": 72, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the body's vertical drag.\r\rDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\rIt is the absolute loss of velocity due to movement, in pixels per second squared.\rThe x and y components are applied separately.\r\rWhen `useDamping` is true, this is 1 minus the damping factor.\rA value of 1 means the Body loses no velocity.\rA value of 0.95 means the Body loses 5% of its velocity per step.\rA value of 0.5 means the Body loses 50% of its velocity per step.\r\rDrag is applied only when `acceleration` is zero.", "kind": "function", "name": "setDragY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of vertical drag to apply.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Drag", "longname": "Phaser.Physics.Arcade.Components.Drag#setDragY", "scope": "instance", "___id": "T000002R028701", "___s": true }, { "comment": "/**\r\n * If this Body is using `drag` for deceleration this function controls how the drag is applied.\r\n * If set to `true` drag will use a damping effect rather than a linear approach. If you are\r\n * creating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\r\n * the game Asteroids) then you will get a far smoother and more visually correct deceleration\r\n * by using damping, avoiding the axis-drift that is prone with linear deceleration.\r\n *\r\n * If you enable this property then you should use far smaller `drag` values than with linear, as\r\n * they are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow\r\n * deceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Drag#setDamping\r\n * @since 3.10.0\r\n *\r\n * @param {boolean} value - `true` to use damping for deceleration, or `false` to use linear deceleration.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Drag.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "If this Body is using `drag` for deceleration this function controls how the drag is applied.\rIf set to `true` drag will use a damping effect rather than a linear approach. If you are\rcreating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\rthe game Asteroids) then you will get a far smoother and more visually correct deceleration\rby using damping, avoiding the axis-drift that is prone with linear deceleration.\r\rIf you enable this property then you should use far smaller `drag` values than with linear, as\rthey are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow\rdeceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.", "kind": "function", "name": "setDamping", "since": "3.10.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to use damping for deceleration, or `false` to use linear deceleration.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Drag", "longname": "Phaser.Physics.Arcade.Components.Drag#setDamping", "scope": "instance", "___id": "T000002R028704", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the enable properties of an Arcade Physics Body.\r\n *\r\n * @namespace Phaser.Physics.Arcade.Components.Enable\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Enable.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Provides methods used for setting the enable properties of an Arcade Physics Body.", "kind": "namespace", "name": "Enable", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Components", "longname": "Phaser.Physics.Arcade.Components.Enable", "scope": "static", "___id": "T000002R028708", "___s": true }, { "comment": "/**\r\n * Sets whether this Body should calculate its velocity based on its change in\r\n * position every frame. The default, which is to not do this, means that you\r\n * make this Body move by setting the velocity directly. However, if you are\r\n * trying to move this Body via a Tween, or have it follow a Path, then you\r\n * should enable this instead. This will allow it to still collide with other\r\n * bodies, something that isn't possible if you're just changing its position directly.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Enable#setDirectControl\r\n * @since 3.61.0\r\n *\r\n * @param {boolean} [value=true] - `true` if the Body calculate velocity based on changes in position, otherwise `false`.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Enable.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets whether this Body should calculate its velocity based on its change in\rposition every frame. The default, which is to not do this, means that you\rmake this Body move by setting the velocity directly. However, if you are\rtrying to move this Body via a Tween, or have it follow a Path, then you\rshould enable this instead. This will allow it to still collide with other\rbodies, something that isn't possible if you're just changing its position directly.", "kind": "function", "name": "setDirectControl", "since": "3.61.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if the Body calculate velocity based on changes in position, otherwise `false`.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Enable", "longname": "Phaser.Physics.Arcade.Components.Enable#setDirectControl", "scope": "instance", "___id": "T000002R028710", "___s": true }, { "comment": "/**\r\n * Enables this Game Object's Body.\r\n * If you reset the Body you must also pass `x` and `y`.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Enable#enableBody\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [reset] - Also reset the Body and place the Game Object at (x, y).\r\n * @param {number} [x] - The horizontal position to place the Game Object, if `reset` is true.\r\n * @param {number} [y] - The horizontal position to place the Game Object, if `reset` is true.\r\n * @param {boolean} [enableGameObject] - Also set this Game Object's `active` to true.\r\n * @param {boolean} [showGameObject] - Also set this Game Object's `visible` to true.\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.Body#enable\r\n * @see Phaser.Physics.Arcade.StaticBody#enable\r\n * @see Phaser.Physics.Arcade.Body#reset\r\n * @see Phaser.Physics.Arcade.StaticBody#reset\r\n * @see Phaser.GameObjects.GameObject#active\r\n * @see Phaser.GameObjects.GameObject#visible\r\n */", "meta": { "filename": "Enable.js", "lineno": 37, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Enables this Game Object's Body.\rIf you reset the Body you must also pass `x` and `y`.", "kind": "function", "name": "enableBody", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Also reset the Body and place the Game Object at (x, y).", "name": "reset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position to place the Game Object, if `reset` is true.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position to place the Game Object, if `reset` is true.", "name": "y" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Also set this Game Object's `active` to true.", "name": "enableGameObject" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Also set this Game Object's `visible` to true.", "name": "showGameObject" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.Body#enable", "Phaser.Physics.Arcade.StaticBody#enable", "Phaser.Physics.Arcade.Body#reset", "Phaser.Physics.Arcade.StaticBody#reset", "Phaser.GameObjects.GameObject#active", "Phaser.GameObjects.GameObject#visible" ], "memberof": "Phaser.Physics.Arcade.Components.Enable", "longname": "Phaser.Physics.Arcade.Components.Enable#enableBody", "scope": "instance", "___id": "T000002R028712", "___s": true }, { "comment": "/**\r\n * Stops and disables this Game Object's Body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Enable#disableBody\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [disableGameObject=false] - Also set this Game Object's `active` to false.\r\n * @param {boolean} [hideGameObject=false] - Also set this Game Object's `visible` to false.\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.Body#enable\r\n * @see Phaser.Physics.Arcade.StaticBody#enable\r\n * @see Phaser.GameObjects.GameObject#active\r\n * @see Phaser.GameObjects.GameObject#visible\r\n */", "meta": { "filename": "Enable.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Stops and disables this Game Object's Body.", "kind": "function", "name": "disableBody", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Also set this Game Object's `active` to false.", "name": "disableGameObject" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Also set this Game Object's `visible` to false.", "name": "hideGameObject" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.Body#enable", "Phaser.Physics.Arcade.StaticBody#enable", "Phaser.GameObjects.GameObject#active", "Phaser.GameObjects.GameObject#visible" ], "memberof": "Phaser.Physics.Arcade.Components.Enable", "longname": "Phaser.Physics.Arcade.Components.Enable#disableBody", "scope": "instance", "___id": "T000002R028717", "___s": true }, { "comment": "/**\r\n * Syncs the Body's position and size with its parent Game Object.\r\n * You don't need to call this for Dynamic Bodies, as it happens automatically.\r\n * But for Static bodies it's a useful way of modifying the position of a Static Body\r\n * in the Physics World, based on its Game Object.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Enable#refreshBody\r\n * @since 3.1.0\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.StaticBody#updateFromGameObject\r\n */", "meta": { "filename": "Enable.js", "lineno": 119, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Syncs the Body's position and size with its parent Game Object.\rYou don't need to call this for Dynamic Bodies, as it happens automatically.\rBut for Static bodies it's a useful way of modifying the position of a Static Body\rin the Physics World, based on its Game Object.", "kind": "function", "name": "refreshBody", "since": "3.1.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.StaticBody#updateFromGameObject" ], "memberof": "Phaser.Physics.Arcade.Components.Enable", "longname": "Phaser.Physics.Arcade.Components.Enable#refreshBody", "scope": "instance", "___id": "T000002R028724", "___s": true }, { "comment": "/**\r\n * Methods for setting the friction of an Arcade Physics Body.\r\n *\r\n * In Arcade Physics, friction is a special case of motion transfer from an \"immovable\" body to a riding body.\r\n *\r\n * @namespace Phaser.Physics.Arcade.Components.Friction\r\n * @since 3.0.0\r\n *\r\n * @see Phaser.Physics.Arcade.Body#friction\r\n */", "meta": { "filename": "Friction.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Methods for setting the friction of an Arcade Physics Body.\r\rIn Arcade Physics, friction is a special case of motion transfer from an \"immovable\" body to a riding body.", "kind": "namespace", "name": "Friction", "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#friction" ], "memberof": "Phaser.Physics.Arcade.Components", "longname": "Phaser.Physics.Arcade.Components.Friction", "scope": "static", "___id": "T000002R028727", "___s": true }, { "comment": "/**\r\n * Sets the friction of this game object's physics body.\r\n * In Arcade Physics, friction is a special case of motion transfer from an \"immovable\" body to a riding body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Friction#setFriction\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The amount of horizontal friction to apply, [0, 1].\r\n * @param {number} [y=x] - The amount of vertical friction to apply, [0, 1].\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.Body#friction\r\n */", "meta": { "filename": "Friction.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the friction of this game object's physics body.\rIn Arcade Physics, friction is a special case of motion transfer from an \"immovable\" body to a riding body.", "kind": "function", "name": "setFriction", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of horizontal friction to apply, [0, 1].", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The amount of vertical friction to apply, [0, 1].", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.Body#friction" ], "memberof": "Phaser.Physics.Arcade.Components.Friction", "longname": "Phaser.Physics.Arcade.Components.Friction#setFriction", "scope": "instance", "___id": "T000002R028729", "___s": true }, { "comment": "/**\r\n * Sets the horizontal friction of this game object's physics body.\r\n * This can move a riding body horizontally when it collides with this one on the vertical axis.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Friction#setFrictionX\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The amount of friction to apply, [0, 1].\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.Body#friction\r\n */", "meta": { "filename": "Friction.js", "lineno": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the horizontal friction of this game object's physics body.\rThis can move a riding body horizontally when it collides with this one on the vertical axis.", "kind": "function", "name": "setFrictionX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of friction to apply, [0, 1].", "name": "x" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.Body#friction" ], "memberof": "Phaser.Physics.Arcade.Components.Friction", "longname": "Phaser.Physics.Arcade.Components.Friction#setFrictionX", "scope": "instance", "___id": "T000002R028731", "___s": true }, { "comment": "/**\r\n * Sets the vertical friction of this game object's physics body.\r\n * This can move a riding body vertically when it collides with this one on the horizontal axis.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Friction#setFrictionY\r\n * @since 3.0.0\r\n *\r\n * @param {number} y - The amount of friction to apply, [0, 1].\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.Body#friction\r\n */", "meta": { "filename": "Friction.js", "lineno": 60, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the vertical friction of this game object's physics body.\rThis can move a riding body vertically when it collides with this one on the horizontal axis.", "kind": "function", "name": "setFrictionY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of friction to apply, [0, 1].", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.Body#friction" ], "memberof": "Phaser.Physics.Arcade.Components.Friction", "longname": "Phaser.Physics.Arcade.Components.Friction#setFrictionY", "scope": "instance", "___id": "T000002R028734", "___s": true }, { "comment": "/**\r\n * Provides methods for setting the gravity properties of an Arcade Physics Game Object.\r\n * Should be applied as a mixin and not used directly.\r\n *\r\n * @namespace Phaser.Physics.Arcade.Components.Gravity\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Gravity.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Provides methods for setting the gravity properties of an Arcade Physics Game Object.\rShould be applied as a mixin and not used directly.", "kind": "namespace", "name": "Gravity", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Components", "longname": "Phaser.Physics.Arcade.Components.Gravity", "scope": "static", "___id": "T000002R028738", "___s": true }, { "comment": "/**\r\n * Set the X and Y values of the gravitational pull to act upon this Arcade Physics Game Object. Values can be positive or negative. Larger values result in a stronger effect.\r\n *\r\n * If only one value is provided, this value will be used for both the X and Y axis.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Gravity#setGravity\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The gravitational force to be applied to the X-axis.\r\n * @param {number} [y=x] - The gravitational force to be applied to the Y-axis. If this is not specified, the X value will be used.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Gravity.js", "lineno": 16, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Set the X and Y values of the gravitational pull to act upon this Arcade Physics Game Object. Values can be positive or negative. Larger values result in a stronger effect.\r\rIf only one value is provided, this value will be used for both the X and Y axis.", "kind": "function", "name": "setGravity", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The gravitational force to be applied to the X-axis.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The gravitational force to be applied to the Y-axis. If this is not specified, the X value will be used.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Gravity", "longname": "Phaser.Physics.Arcade.Components.Gravity#setGravity", "scope": "instance", "___id": "T000002R028740", "___s": true }, { "comment": "/**\r\n * Set the gravitational force to be applied to the X axis. Value can be positive or negative. Larger values result in a stronger effect.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Gravity#setGravityX\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The gravitational force to be applied to the X-axis.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Gravity.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Set the gravitational force to be applied to the X axis. Value can be positive or negative. Larger values result in a stronger effect.", "kind": "function", "name": "setGravityX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The gravitational force to be applied to the X-axis.", "name": "x" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Gravity", "longname": "Phaser.Physics.Arcade.Components.Gravity#setGravityX", "scope": "instance", "___id": "T000002R028742", "___s": true }, { "comment": "/**\r\n * Set the gravitational force to be applied to the Y axis. Value can be positive or negative. Larger values result in a stronger effect.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Gravity#setGravityY\r\n * @since 3.0.0\r\n *\r\n * @param {number} y - The gravitational force to be applied to the Y-axis.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Gravity.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Set the gravitational force to be applied to the Y axis. Value can be positive or negative. Larger values result in a stronger effect.", "kind": "function", "name": "setGravityY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The gravitational force to be applied to the Y-axis.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Gravity", "longname": "Phaser.Physics.Arcade.Components.Gravity#setGravityY", "scope": "instance", "___id": "T000002R028745", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the immovable properties of an Arcade Physics Body.\r\n *\r\n * @namespace Phaser.Physics.Arcade.Components.Immovable\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Immovable.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Provides methods used for setting the immovable properties of an Arcade Physics Body.", "kind": "namespace", "name": "Immovable", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Components", "longname": "Phaser.Physics.Arcade.Components.Immovable", "scope": "static", "___id": "T000002R028749", "___s": true }, { "comment": "/**\r\n * Sets if this Body can be separated during collisions with other bodies.\r\n *\r\n * When a body is immovable it means it won't move at all, not even to separate it from collision\r\n * overlap. If you just wish to prevent a body from being knocked around by other bodies, see\r\n * the `setPushable` method instead.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Immovable#setImmovable\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [value=true] - Sets if this body will be separated during collisions with other bodies.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Immovable.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets if this Body can be separated during collisions with other bodies.\r\rWhen a body is immovable it means it won't move at all, not even to separate it from collision\roverlap. If you just wish to prevent a body from being knocked around by other bodies, see\rthe `setPushable` method instead.", "kind": "function", "name": "setImmovable", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Sets if this body will be separated during collisions with other bodies.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Immovable", "longname": "Phaser.Physics.Arcade.Components.Immovable#setImmovable", "scope": "instance", "___id": "T000002R028751", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Physics.Arcade.Components\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "kind": "namespace", "name": "Components", "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.Components", "scope": "static", "___id": "T000002R028756", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the mass properties of an Arcade Physics Body.\r\n *\r\n * @namespace Phaser.Physics.Arcade.Components.Mass\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mass.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Provides methods used for setting the mass properties of an Arcade Physics Body.", "kind": "namespace", "name": "Mass", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Components", "longname": "Phaser.Physics.Arcade.Components.Mass", "scope": "static", "___id": "T000002R028774", "___s": true }, { "comment": "/**\r\n * Sets the mass of the physics body\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Mass#setMass\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - New value for the mass of the body.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Mass.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the mass of the physics body", "kind": "function", "name": "setMass", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "New value for the mass of the body.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Mass", "longname": "Phaser.Physics.Arcade.Components.Mass#setMass", "scope": "instance", "___id": "T000002R028776", "___s": true }, { "comment": "/**\r\n * This method will search the given circular area and return an array of all physics bodies that\r\n * overlap with it. It can return either Dynamic, Static bodies or a mixture of both.\r\n *\r\n * A body only has to intersect with the search area to be considered, it doesn't have to be fully\r\n * contained within it.\r\n *\r\n * If Arcade Physics is set to use the RTree (which it is by default) then the search is rather fast,\r\n * otherwise the search is O(N) for Dynamic Bodies.\r\n *\r\n * @function Phaser.Physics.Arcade.Components.OverlapCirc\r\n * @since 3.21.0\r\n *\r\n * @param {number} x - The x coordinate of the center of the area to search within.\r\n * @param {number} y - The y coordinate of the center of the area to search within.\r\n * @param {number} radius - The radius of the area to search within.\r\n * @param {boolean} [includeDynamic=true] - Should the search include Dynamic Bodies?\r\n * @param {boolean} [includeStatic=false] - Should the search include Static Bodies?\r\n *\r\n * @return {(Phaser.Physics.Arcade.Body[]|Phaser.Physics.Arcade.StaticBody[])} An array of bodies that overlap with the given area.\r\n */", "meta": { "filename": "OverlapCirc.js", "lineno": 6, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "This method will search the given circular area and return an array of all physics bodies that\roverlap with it. It can return either Dynamic, Static bodies or a mixture of both.\r\rA body only has to intersect with the search area to be considered, it doesn't have to be fully\rcontained within it.\r\rIf Arcade Physics is set to use the RTree (which it is by default) then the search is rather fast,\rotherwise the search is O(N) for Dynamic Bodies.", "kind": "function", "name": "OverlapCirc", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the center of the area to search within.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the center of the area to search within.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the area to search within.", "name": "radius" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the search include Dynamic Bodies?", "name": "includeDynamic" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the search include Static Bodies?", "name": "includeStatic" } ], "returns": [ { "type": { "names": [ "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Physics.Arcade.Body", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Physics.Arcade.StaticBody", "type": "NameExpression" } ] } ] } }, "description": "An array of bodies that overlap with the given area." } ], "memberof": "Phaser.Physics.Arcade.Components", "longname": "Phaser.Physics.Arcade.Components.OverlapCirc", "scope": "static", "___id": "T000002R028784", "___s": true }, { "comment": "/**\r\n * This method will search the given rectangular area and return an array of all physics bodies that\r\n * overlap with it. It can return either Dynamic, Static bodies or a mixture of both.\r\n * \r\n * A body only has to intersect with the search area to be considered, it doesn't have to be fully\r\n * contained within it.\r\n * \r\n * If Arcade Physics is set to use the RTree (which it is by default) then the search for is extremely fast,\r\n * otherwise the search is O(N) for Dynamic Bodies.\r\n *\r\n * @function Phaser.Physics.Arcade.Components.OverlapRect\r\n * @since 3.17.0\r\n *\r\n * @param {number} x - The top-left x coordinate of the area to search within.\r\n * @param {number} y - The top-left y coordinate of the area to search within.\r\n * @param {number} width - The width of the area to search within.\r\n * @param {number} height - The height of the area to search within.\r\n * @param {boolean} [includeDynamic=true] - Should the search include Dynamic Bodies?\r\n * @param {boolean} [includeStatic=false] - Should the search include Static Bodies?\r\n *\r\n * @return {(Phaser.Physics.Arcade.Body[]|Phaser.Physics.Arcade.StaticBody[])} An array of bodies that overlap with the given area.\r\n */", "meta": { "filename": "OverlapRect.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "This method will search the given rectangular area and return an array of all physics bodies that\roverlap with it. It can return either Dynamic, Static bodies or a mixture of both.\r\rA body only has to intersect with the search area to be considered, it doesn't have to be fully\rcontained within it.\r\rIf Arcade Physics is set to use the RTree (which it is by default) then the search for is extremely fast,\rotherwise the search is O(N) for Dynamic Bodies.", "kind": "function", "name": "OverlapRect", "since": "3.17.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x coordinate of the area to search within.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y coordinate of the area to search within.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the area to search within.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the area to search within.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the search include Dynamic Bodies?", "name": "includeDynamic" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the search include Static Bodies?", "name": "includeStatic" } ], "returns": [ { "type": { "names": [ "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Physics.Arcade.Body", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Physics.Arcade.StaticBody", "type": "NameExpression" } ] } ] } }, "description": "An array of bodies that overlap with the given area." } ], "memberof": "Phaser.Physics.Arcade.Components", "longname": "Phaser.Physics.Arcade.Components.OverlapRect", "scope": "static", "___id": "T000002R028793", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the pushable property of an Arcade Physics Body.\r\n *\r\n * @namespace Phaser.Physics.Arcade.Components.Pushable\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pushable.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Provides methods used for setting the pushable property of an Arcade Physics Body.", "kind": "namespace", "name": "Pushable", "since": "3.50.0", "memberof": "Phaser.Physics.Arcade.Components", "longname": "Phaser.Physics.Arcade.Components.Pushable", "scope": "static", "___id": "T000002R028818", "___s": true }, { "comment": "/**\r\n * Sets if this Body can be pushed by another Body.\r\n *\r\n * A body that cannot be pushed will reflect back all of the velocity it is given to the\r\n * colliding body. If that body is also not pushable, then the separation will be split\r\n * between them evenly.\r\n *\r\n * If you want your body to never move or seperate at all, see the `setImmovable` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Pushable#setPushable\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [value=true] - Sets if this body can be pushed by collisions with another Body.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Pushable.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets if this Body can be pushed by another Body.\r\rA body that cannot be pushed will reflect back all of the velocity it is given to the\rcolliding body. If that body is also not pushable, then the separation will be split\rbetween them evenly.\r\rIf you want your body to never move or seperate at all, see the `setImmovable` method.", "kind": "function", "name": "setPushable", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Sets if this body can be pushed by collisions with another Body.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Pushable", "longname": "Phaser.Physics.Arcade.Components.Pushable#setPushable", "scope": "instance", "___id": "T000002R028820", "___s": true }, { "comment": "/**\n * Provides methods for setting the size of an Arcade Physics Game Object.\n * Should be applied as a mixin and not used directly.\n *\n * @namespace Phaser.Physics.Arcade.Components.Size\n * @since 3.0.0\n */", "meta": { "filename": "Size.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Provides methods for setting the size of an Arcade Physics Game Object.\nShould be applied as a mixin and not used directly.", "kind": "namespace", "name": "Size", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Components", "longname": "Phaser.Physics.Arcade.Components.Size", "scope": "static", "___id": "T000002R028825", "___s": true }, { "comment": "/**\n * Sets the body offset. This allows you to adjust the difference between the center of the body\n * and the x and y coordinates of the parent Game Object.\n *\n * @method Phaser.Physics.Arcade.Components.Size#setOffset\n * @since 3.0.0\n *\n * @param {number} x - The amount to offset the body from the parent Game Object along the x-axis.\n * @param {number} [y=x] - The amount to offset the body from the parent Game Object along the y-axis. Defaults to the value given for the x-axis.\n *\n * @return {this} This Game Object.\n */", "meta": { "filename": "Size.js", "lineno": 16, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the body offset. This allows you to adjust the difference between the center of the body\nand the x and y coordinates of the parent Game Object.", "kind": "function", "name": "setOffset", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to offset the body from the parent Game Object along the x-axis.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The amount to offset the body from the parent Game Object along the y-axis. Defaults to the value given for the x-axis.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Size", "longname": "Phaser.Physics.Arcade.Components.Size#setOffset", "scope": "instance", "___id": "T000002R028827", "___s": true }, { "comment": "/**\n * **DEPRECATED**: Please use `setBodySize` instead.\n *\n * Sets the size of this physics body. Setting the size does not adjust the dimensions of the parent Game Object.\n *\n * @method Phaser.Physics.Arcade.Components.Size#setSize\n * @since 3.0.0\n * @deprecated\n *\n * @param {number} width - The new width of the physics body, in pixels.\n * @param {number} height - The new height of the physics body, in pixels.\n * @param {boolean} [center=true] - Should the body be re-positioned so its center aligns with the parent Game Object?\n *\n * @return {this} This Game Object.\n */", "meta": { "filename": "Size.js", "lineno": 35, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "**DEPRECATED**: Please use `setBodySize` instead.\n\nSets the size of this physics body. Setting the size does not adjust the dimensions of the parent Game Object.", "kind": "function", "name": "setSize", "since": "3.0.0", "deprecated": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the physics body, in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of the physics body, in pixels.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the body be re-positioned so its center aligns with the parent Game Object?", "name": "center" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Size", "longname": "Phaser.Physics.Arcade.Components.Size#setSize", "scope": "instance", "___id": "T000002R028829", "___s": true }, { "comment": "/**\n * Sets the size of this physics body. Setting the size does not adjust the dimensions of the parent Game Object.\n *\n * @method Phaser.Physics.Arcade.Components.Size#setBodySize\n * @since 3.24.0\n *\n * @param {number} width - The new width of the physics body, in pixels.\n * @param {number} height - The new height of the physics body, in pixels.\n * @param {boolean} [center=true] - Should the body be re-positioned so its center aligns with the parent Game Object?\n *\n * @return {this} This Game Object.\n */", "meta": { "filename": "Size.js", "lineno": 57, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the size of this physics body. Setting the size does not adjust the dimensions of the parent Game Object.", "kind": "function", "name": "setBodySize", "since": "3.24.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the physics body, in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of the physics body, in pixels.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the body be re-positioned so its center aligns with the parent Game Object?", "name": "center" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Size", "longname": "Phaser.Physics.Arcade.Components.Size#setBodySize", "scope": "instance", "___id": "T000002R028831", "___s": true }, { "comment": "/**\n * Sets this physics body to use a circle for collision instead of a rectangle.\n *\n * @method Phaser.Physics.Arcade.Components.Size#setCircle\n * @since 3.0.0\n *\n * @param {number} radius - The radius of the physics body, in pixels.\n * @param {number} [offsetX] - The amount to offset the body from the parent Game Object along the x-axis.\n * @param {number} [offsetY] - The amount to offset the body from the parent Game Object along the y-axis.\n *\n * @return {this} This Game Object.\n */", "meta": { "filename": "Size.js", "lineno": 76, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets this physics body to use a circle for collision instead of a rectangle.", "kind": "function", "name": "setCircle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the physics body, in pixels.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount to offset the body from the parent Game Object along the x-axis.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount to offset the body from the parent Game Object along the y-axis.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Size", "longname": "Phaser.Physics.Arcade.Components.Size#setCircle", "scope": "instance", "___id": "T000002R028833", "___s": true }, { "comment": "/**\r\n * Provides methods for modifying the velocity of an Arcade Physics body.\r\n *\r\n * Should be applied as a mixin and not used directly.\r\n *\r\n * @namespace Phaser.Physics.Arcade.Components.Velocity\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Velocity.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Provides methods for modifying the velocity of an Arcade Physics body.\r\rShould be applied as a mixin and not used directly.", "kind": "namespace", "name": "Velocity", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Components", "longname": "Phaser.Physics.Arcade.Components.Velocity", "scope": "static", "___id": "T000002R028836", "___s": true }, { "comment": "/**\r\n * Sets the velocity of the Body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Velocity#setVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal velocity of the body. Positive values move the body to the right, while negative values move it to the left.\r\n * @param {number} [y=x] - The vertical velocity of the body. Positive values move the body down, while negative values move it up.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the velocity of the Body.", "kind": "function", "name": "setVelocity", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal velocity of the body. Positive values move the body to the right, while negative values move it to the left.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical velocity of the body. Positive values move the body down, while negative values move it up.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Velocity", "longname": "Phaser.Physics.Arcade.Components.Velocity#setVelocity", "scope": "instance", "___id": "T000002R028838", "___s": true }, { "comment": "/**\r\n * Sets the horizontal component of the body's velocity.\r\n *\r\n * Positive values move the body to the right, while negative values move it to the left.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Velocity#setVelocityX\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The new horizontal velocity.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 35, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the horizontal component of the body's velocity.\r\rPositive values move the body to the right, while negative values move it to the left.", "kind": "function", "name": "setVelocityX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new horizontal velocity.", "name": "x" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Velocity", "longname": "Phaser.Physics.Arcade.Components.Velocity#setVelocityX", "scope": "instance", "___id": "T000002R028840", "___s": true }, { "comment": "/**\r\n * Sets the vertical component of the body's velocity.\r\n *\r\n * Positive values move the body down, while negative values move it up.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Velocity#setVelocityY\r\n * @since 3.0.0\r\n *\r\n * @param {number} y - The new vertical velocity of the body.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the vertical component of the body's velocity.\r\rPositive values move the body down, while negative values move it up.", "kind": "function", "name": "setVelocityY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new vertical velocity of the body.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Velocity", "longname": "Phaser.Physics.Arcade.Components.Velocity#setVelocityY", "scope": "instance", "___id": "T000002R028842", "___s": true }, { "comment": "/**\r\n * Sets the maximum velocity of the body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Velocity#setMaxVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The new maximum horizontal velocity.\r\n * @param {number} [y=x] - The new maximum vertical velocity.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 73, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "description": "Sets the maximum velocity of the body.", "kind": "function", "name": "setMaxVelocity", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new maximum horizontal velocity.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The new maximum vertical velocity.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Components.Velocity", "longname": "Phaser.Physics.Arcade.Components.Velocity#setMaxVelocity", "scope": "instance", "___id": "T000002R028844", "___s": true }, { "comment": "/**\r\n * Dynamic Body.\r\n *\r\n * @name Phaser.Physics.Arcade.DYNAMIC_BODY\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n *\r\n * @see Phaser.Physics.Arcade.Body#physicsType\r\n * @see Phaser.Physics.Arcade.Group#physicsType\r\n */", "meta": { "filename": "const.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Dynamic Body.", "name": "DYNAMIC_BODY", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#physicsType", "Phaser.Physics.Arcade.Group#physicsType" ], "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.DYNAMIC_BODY", "scope": "static", "kind": "member", "___id": "T000002R028848", "___s": true }, { "comment": "/**\r\n * Static Body.\r\n *\r\n * @name Phaser.Physics.Arcade.STATIC_BODY\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n *\r\n * @see Phaser.Physics.Arcade.Body#physicsType\r\n * @see Phaser.Physics.Arcade.StaticBody#physicsType\r\n */", "meta": { "filename": "const.js", "lineno": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Static Body.", "name": "STATIC_BODY", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#physicsType", "Phaser.Physics.Arcade.StaticBody#physicsType" ], "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.STATIC_BODY", "scope": "static", "kind": "member", "___id": "T000002R028850", "___s": true }, { "comment": "/**\r\n * Arcade Physics Group containing Dynamic Bodies.\r\n *\r\n * @name Phaser.Physics.Arcade.GROUP\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 41, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Arcade Physics Group containing Dynamic Bodies.", "name": "GROUP", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.GROUP", "scope": "static", "kind": "member", "___id": "T000002R028852", "___s": true }, { "comment": "/**\r\n * A Tilemap Layer.\r\n *\r\n * @name Phaser.Physics.Arcade.TILEMAPLAYER\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 51, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "A Tilemap Layer.", "name": "TILEMAPLAYER", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.TILEMAPLAYER", "scope": "static", "kind": "member", "___id": "T000002R028854", "___s": true }, { "comment": "/**\r\n * Facing no direction (initial value).\r\n *\r\n * @name Phaser.Physics.Arcade.FACING_NONE\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n *\r\n * @see Phaser.Physics.Arcade.Body#facing\r\n */", "meta": { "filename": "const.js", "lineno": 61, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Facing no direction (initial value).", "name": "FACING_NONE", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#facing" ], "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.FACING_NONE", "scope": "static", "kind": "member", "___id": "T000002R028856", "___s": true }, { "comment": "/**\r\n * Facing up.\r\n *\r\n * @name Phaser.Physics.Arcade.FACING_UP\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n *\r\n * @see Phaser.Physics.Arcade.Body#facing\r\n */", "meta": { "filename": "const.js", "lineno": 73, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Facing up.", "name": "FACING_UP", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#facing" ], "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.FACING_UP", "scope": "static", "kind": "member", "___id": "T000002R028858", "___s": true }, { "comment": "/**\r\n * Facing down.\r\n *\r\n * @name Phaser.Physics.Arcade.FACING_DOWN\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n *\r\n * @see Phaser.Physics.Arcade.Body#facing\r\n */", "meta": { "filename": "const.js", "lineno": 85, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Facing down.", "name": "FACING_DOWN", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#facing" ], "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.FACING_DOWN", "scope": "static", "kind": "member", "___id": "T000002R028860", "___s": true }, { "comment": "/**\r\n * Facing left.\r\n *\r\n * @name Phaser.Physics.Arcade.FACING_LEFT\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n *\r\n * @see Phaser.Physics.Arcade.Body#facing\r\n */", "meta": { "filename": "const.js", "lineno": 97, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Facing left.", "name": "FACING_LEFT", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#facing" ], "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.FACING_LEFT", "scope": "static", "kind": "member", "___id": "T000002R028862", "___s": true }, { "comment": "/**\r\n * Facing right.\r\n *\r\n * @name Phaser.Physics.Arcade.FACING_RIGHT\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n *\r\n * @see Phaser.Physics.Arcade.Body#facing\r\n */", "meta": { "filename": "const.js", "lineno": 109, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Facing right.", "name": "FACING_RIGHT", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.Body#facing" ], "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.FACING_RIGHT", "scope": "static", "kind": "member", "___id": "T000002R028864", "___s": true }, { "comment": "/**\r\n * The Arcade Physics World Collide Event.\r\n *\r\n * This event is dispatched by an Arcade Physics World instance if two bodies collide _and_ at least\r\n * one of them has their [onCollide]{@link Phaser.Physics.Arcade.Body#onCollide} property set to `true`.\r\n *\r\n * It provides an alternative means to handling collide events rather than using the callback approach.\r\n *\r\n * Listen to it from a Scene using: `this.physics.world.on('collide', listener)`.\r\n *\r\n * Please note that 'collide' and 'overlap' are two different things in Arcade Physics.\r\n *\r\n * @event Phaser.Physics.Arcade.Events#COLLIDE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject1 - The first Game Object involved in the collision. This is the parent of `body1`.\r\n * @param {Phaser.GameObjects.GameObject} gameObject2 - The second Game Object involved in the collision. This is the parent of `body2`.\r\n * @param {Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody} body1 - The first Physics Body involved in the collision.\r\n * @param {Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody} body2 - The second Physics Body involved in the collision.\r\n */", "meta": { "filename": "COLLIDE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\events", "code": {} }, "description": "The Arcade Physics World Collide Event.\r\rThis event is dispatched by an Arcade Physics World instance if two bodies collide _and_ at least\rone of them has their [onCollide]{@link Phaser.Physics.Arcade.Body#onCollide} property set to `true`.\r\rIt provides an alternative means to handling collide events rather than using the callback approach.\r\rListen to it from a Scene using: `this.physics.world.on('collide', listener)`.\r\rPlease note that 'collide' and 'overlap' are two different things in Arcade Physics.", "kind": "event", "name": "COLLIDE", "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 first Game Object involved in the collision. This is the parent of `body1`.", "name": "gameObject1" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The second Game Object involved in the collision. This is the parent of `body2`.", "name": "gameObject2" }, { "type": { "names": [ "Phaser.Physics.Arcade.Body", "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } ] } }, "description": "The first Physics Body involved in the collision.", "name": "body1" }, { "type": { "names": [ "Phaser.Physics.Arcade.Body", "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } ] } }, "description": "The second Physics Body involved in the collision.", "name": "body2" } ], "memberof": "Phaser.Physics.Arcade.Events", "longname": "Phaser.Physics.Arcade.Events#event:COLLIDE", "scope": "instance", "___id": "T000002R028867", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Physics.Arcade.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.Events", "scope": "static", "___id": "T000002R028869", "___s": true }, { "comment": "/**\r\n * The Arcade Physics World Overlap Event.\r\n *\r\n * This event is dispatched by an Arcade Physics World instance if two bodies overlap _and_ at least\r\n * one of them has their [onOverlap]{@link Phaser.Physics.Arcade.Body#onOverlap} property set to `true`.\r\n *\r\n * It provides an alternative means to handling overlap events rather than using the callback approach.\r\n *\r\n * Listen to it from a Scene using: `this.physics.world.on('overlap', listener)`.\r\n *\r\n * Please note that 'collide' and 'overlap' are two different things in Arcade Physics.\r\n *\r\n * @event Phaser.Physics.Arcade.Events#OVERLAP\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject1 - The first Game Object involved in the overlap. This is the parent of `body1`.\r\n * @param {Phaser.GameObjects.GameObject} gameObject2 - The second Game Object involved in the overlap. This is the parent of `body2`.\r\n * @param {Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody} body1 - The first Physics Body involved in the overlap.\r\n * @param {Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody} body2 - The second Physics Body involved in the overlap.\r\n */", "meta": { "filename": "OVERLAP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\events", "code": {} }, "description": "The Arcade Physics World Overlap Event.\r\rThis event is dispatched by an Arcade Physics World instance if two bodies overlap _and_ at least\rone of them has their [onOverlap]{@link Phaser.Physics.Arcade.Body#onOverlap} property set to `true`.\r\rIt provides an alternative means to handling overlap events rather than using the callback approach.\r\rListen to it from a Scene using: `this.physics.world.on('overlap', listener)`.\r\rPlease note that 'collide' and 'overlap' are two different things in Arcade Physics.", "kind": "event", "name": "OVERLAP", "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 first Game Object involved in the overlap. This is the parent of `body1`.", "name": "gameObject1" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The second Game Object involved in the overlap. This is the parent of `body2`.", "name": "gameObject2" }, { "type": { "names": [ "Phaser.Physics.Arcade.Body", "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } ] } }, "description": "The first Physics Body involved in the overlap.", "name": "body1" }, { "type": { "names": [ "Phaser.Physics.Arcade.Body", "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } ] } }, "description": "The second Physics Body involved in the overlap.", "name": "body2" } ], "memberof": "Phaser.Physics.Arcade.Events", "longname": "Phaser.Physics.Arcade.Events#event:OVERLAP", "scope": "instance", "___id": "T000002R028879", "___s": true }, { "comment": "/**\r\n * The Arcade Physics World Pause Event.\r\n *\r\n * This event is dispatched by an Arcade Physics World instance when it is paused.\r\n *\r\n * Listen to it from a Scene using: `this.physics.world.on('pause', listener)`.\r\n *\r\n * @event Phaser.Physics.Arcade.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\\physics\\arcade\\events", "code": {} }, "description": "The Arcade Physics World Pause Event.\r\rThis event is dispatched by an Arcade Physics World instance when it is paused.\r\rListen to it from a Scene using: `this.physics.world.on('pause', listener)`.", "kind": "event", "name": "PAUSE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Events", "longname": "Phaser.Physics.Arcade.Events#event:PAUSE", "scope": "instance", "___id": "T000002R028881", "___s": true }, { "comment": "/**\r\n * The Arcade Physics World Resume Event.\r\n *\r\n * This event is dispatched by an Arcade Physics World instance when it resumes from a paused state.\r\n *\r\n * Listen to it from a Scene using: `this.physics.world.on('resume', listener)`.\r\n *\r\n * @event Phaser.Physics.Arcade.Events#RESUME\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "RESUME_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\events", "code": {} }, "description": "The Arcade Physics World Resume Event.\r\rThis event is dispatched by an Arcade Physics World instance when it resumes from a paused state.\r\rListen to it from a Scene using: `this.physics.world.on('resume', listener)`.", "kind": "event", "name": "RESUME", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Events", "longname": "Phaser.Physics.Arcade.Events#event:RESUME", "scope": "instance", "___id": "T000002R028883", "___s": true }, { "comment": "/**\r\n * The Arcade Physics Tile Collide Event.\r\n *\r\n * This event is dispatched by an Arcade Physics World instance if a body collides with a Tile _and_\r\n * has its [onCollide]{@link Phaser.Physics.Arcade.Body#onCollide} property set to `true`.\r\n *\r\n * It provides an alternative means to handling collide events rather than using the callback approach.\r\n *\r\n * Listen to it from a Scene using: `this.physics.world.on('tilecollide', listener)`.\r\n *\r\n * Please note that 'collide' and 'overlap' are two different things in Arcade Physics.\r\n *\r\n * @event Phaser.Physics.Arcade.Events#TILE_COLLIDE\r\n * @type {string}\r\n * @since 3.16.1\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object involved in the collision. This is the parent of `body`.\r\n * @param {Phaser.Tilemaps.Tile} tile - The tile the body collided with.\r\n * @param {Phaser.Physics.Arcade.Body} body - The Arcade Physics Body of the Game Object involved in the collision.\r\n */", "meta": { "filename": "TILE_COLLIDE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\events", "code": {} }, "description": "The Arcade Physics Tile Collide Event.\r\rThis event is dispatched by an Arcade Physics World instance if a body collides with a Tile _and_\rhas its [onCollide]{@link Phaser.Physics.Arcade.Body#onCollide} property set to `true`.\r\rIt provides an alternative means to handling collide events rather than using the callback approach.\r\rListen to it from a Scene using: `this.physics.world.on('tilecollide', listener)`.\r\rPlease note that 'collide' and 'overlap' are two different things in Arcade Physics.", "kind": "event", "name": "TILE_COLLIDE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.1", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object involved in the collision. This is the parent of `body`.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The tile the body collided with.", "name": "tile" }, { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The Arcade Physics Body of the Game Object involved in the collision.", "name": "body" } ], "memberof": "Phaser.Physics.Arcade.Events", "longname": "Phaser.Physics.Arcade.Events#event:TILE_COLLIDE", "scope": "instance", "___id": "T000002R028885", "___s": true }, { "comment": "/**\r\n * The Arcade Physics Tile Overlap Event.\r\n *\r\n * This event is dispatched by an Arcade Physics World instance if a body overlaps with a Tile _and_\r\n * has its [onOverlap]{@link Phaser.Physics.Arcade.Body#onOverlap} property set to `true`.\r\n *\r\n * It provides an alternative means to handling overlap events rather than using the callback approach.\r\n *\r\n * Listen to it from a Scene using: `this.physics.world.on('tileoverlap', listener)`.\r\n *\r\n * Please note that 'collide' and 'overlap' are two different things in Arcade Physics.\r\n *\r\n * @event Phaser.Physics.Arcade.Events#TILE_OVERLAP\r\n * @type {string}\r\n * @since 3.16.1\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object involved in the overlap. This is the parent of `body`.\r\n * @param {Phaser.Tilemaps.Tile} tile - The tile the body overlapped.\r\n * @param {Phaser.Physics.Arcade.Body} body - The Arcade Physics Body of the Game Object involved in the overlap.\r\n */", "meta": { "filename": "TILE_OVERLAP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\events", "code": {} }, "description": "The Arcade Physics Tile Overlap Event.\r\rThis event is dispatched by an Arcade Physics World instance if a body overlaps with a Tile _and_\rhas its [onOverlap]{@link Phaser.Physics.Arcade.Body#onOverlap} property set to `true`.\r\rIt provides an alternative means to handling overlap events rather than using the callback approach.\r\rListen to it from a Scene using: `this.physics.world.on('tileoverlap', listener)`.\r\rPlease note that 'collide' and 'overlap' are two different things in Arcade Physics.", "kind": "event", "name": "TILE_OVERLAP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.1", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object involved in the overlap. This is the parent of `body`.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The tile the body overlapped.", "name": "tile" }, { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The Arcade Physics Body of the Game Object involved in the overlap.", "name": "body" } ], "memberof": "Phaser.Physics.Arcade.Events", "longname": "Phaser.Physics.Arcade.Events#event:TILE_OVERLAP", "scope": "instance", "___id": "T000002R028887", "___s": true }, { "comment": "/**\r\n * The Arcade Physics World Bounds Event.\r\n *\r\n * This event is dispatched by an Arcade Physics World instance if a body makes contact with the world bounds _and_\r\n * it has its [onWorldBounds]{@link Phaser.Physics.Arcade.Body#onWorldBounds} property set to `true`.\r\n *\r\n * It provides an alternative means to handling collide events rather than using the callback approach.\r\n *\r\n * Listen to it from a Scene using: `this.physics.world.on('worldbounds', listener)`.\r\n *\r\n * @event Phaser.Physics.Arcade.Events#WORLD_BOUNDS\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Body} body - The Arcade Physics Body that hit the world bounds.\r\n * @param {boolean} up - Is the Body blocked up? I.e. collided with the top of the world bounds.\r\n * @param {boolean} down - Is the Body blocked down? I.e. collided with the bottom of the world bounds.\r\n * @param {boolean} left - Is the Body blocked left? I.e. collided with the left of the world bounds.\r\n * @param {boolean} right - Is the Body blocked right? I.e. collided with the right of the world bounds.\r\n */", "meta": { "filename": "WORLD_BOUNDS_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\events", "code": {} }, "description": "The Arcade Physics World Bounds Event.\r\rThis event is dispatched by an Arcade Physics World instance if a body makes contact with the world bounds _and_\rit has its [onWorldBounds]{@link Phaser.Physics.Arcade.Body#onWorldBounds} property set to `true`.\r\rIt provides an alternative means to handling collide events rather than using the callback approach.\r\rListen to it from a Scene using: `this.physics.world.on('worldbounds', listener)`.", "kind": "event", "name": "WORLD_BOUNDS", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The Arcade Physics Body that hit the world bounds.", "name": "body" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is the Body blocked up? I.e. collided with the top of the world bounds.", "name": "up" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is the Body blocked down? I.e. collided with the bottom of the world bounds.", "name": "down" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is the Body blocked left? I.e. collided with the left of the world bounds.", "name": "left" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is the Body blocked right? I.e. collided with the right of the world bounds.", "name": "right" } ], "memberof": "Phaser.Physics.Arcade.Events", "longname": "Phaser.Physics.Arcade.Events#event:WORLD_BOUNDS", "scope": "instance", "___id": "T000002R028889", "___s": true }, { "comment": "/**\r\n * The Arcade Physics World Step Event.\r\n *\r\n * This event is dispatched by an Arcade Physics World instance whenever a physics step is run.\r\n * It is emitted _after_ the bodies and colliders have been updated.\r\n *\r\n * In high framerate settings this can be multiple times per game frame.\r\n *\r\n * Listen to it from a Scene using: `this.physics.world.on('worldstep', listener)`.\r\n *\r\n * @event Phaser.Physics.Arcade.Events#WORLD_STEP\r\n * @type {string}\r\n * @since 3.18.0\r\n *\r\n * @param {number} delta - The delta time amount of this step, in seconds.\r\n */", "meta": { "filename": "WORLD_STEP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\events", "code": {} }, "description": "The Arcade Physics World Step Event.\r\rThis event is dispatched by an Arcade Physics World instance whenever a physics step is run.\rIt is emitted _after_ the bodies and colliders have been updated.\r\rIn high framerate settings this can be multiple times per game frame.\r\rListen to it from a Scene using: `this.physics.world.on('worldstep', listener)`.", "kind": "event", "name": "WORLD_STEP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.18.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time amount of this step, in seconds.", "name": "delta" } ], "memberof": "Phaser.Physics.Arcade.Events", "longname": "Phaser.Physics.Arcade.Events#event:WORLD_STEP", "scope": "instance", "___id": "T000002R028891", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Arcade Physics Factory allows you to easily create Arcade Physics enabled Game Objects.\r\n * Objects that are created by this Factory are automatically added to the physics world.\r\n *\r\n * @class Factory\r\n * @memberof Phaser.Physics.Arcade\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.World} world - The Arcade Physics World instance.\r\n */", "meta": { "filename": "Factory.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "classdesc": "The Arcade Physics Factory allows you to easily create Arcade Physics enabled Game Objects.\rObjects that are created by this Factory are automatically added to the physics world.", "kind": "class", "name": "Factory", "memberof": "Phaser.Physics.Arcade", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "description": "The Arcade Physics World instance.", "name": "world" } ], "scope": "static", "longname": "Phaser.Physics.Arcade.Factory", "___id": "T000002R028901", "___s": true }, { "comment": "/**\r\n * A reference to the Arcade Physics World.\r\n *\r\n * @name Phaser.Physics.Arcade.Factory#world\r\n * @type {Phaser.Physics.Arcade.World}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Factory.js", "lineno": 34, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "A reference to the Arcade Physics World.", "name": "world", "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Factory", "longname": "Phaser.Physics.Arcade.Factory#world", "scope": "instance", "kind": "member", "___id": "T000002R028904", "___s": true }, { "comment": "/**\r\n * A reference to the Scene this Arcade Physics instance belongs to.\r\n *\r\n * @name Phaser.Physics.Arcade.Factory#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Factory.js", "lineno": 43, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "A reference to the Scene this Arcade Physics instance belongs to.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Factory", "longname": "Phaser.Physics.Arcade.Factory#scene", "scope": "instance", "kind": "member", "___id": "T000002R028906", "___s": true }, { "comment": "/**\r\n * A reference to the Scene.Systems this Arcade Physics instance belongs to.\r\n *\r\n * @name Phaser.Physics.Arcade.Factory#sys\r\n * @type {Phaser.Scenes.Systems}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Factory.js", "lineno": 52, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "A reference to the Scene.Systems this Arcade Physics instance belongs to.", "name": "sys", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Factory", "longname": "Phaser.Physics.Arcade.Factory#sys", "scope": "instance", "kind": "member", "___id": "T000002R028908", "___s": true }, { "comment": "/**\r\n * Creates a new Arcade Physics Collider object.\r\n *\r\n * @method Phaser.Physics.Arcade.Factory#collider\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} object1 - The first object to check for collision.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} object2 - The second object to check for collision.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [collideCallback] - The callback to invoke when the two objects collide.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [processCallback] - The callback to invoke when the two objects collide. Must return a boolean.\r\n * @param {*} [callbackContext] - The scope in which to call the callbacks.\r\n *\r\n * @return {Phaser.Physics.Arcade.Collider} The Collider that was created.\r\n */", "meta": { "filename": "Factory.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Creates a new Arcade Physics Collider object.", "kind": "function", "name": "collider", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "description": "The first object to check for collision.", "name": "object1" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "description": "The second object to check for collision.", "name": "object2" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "The callback to invoke when the two objects collide.", "name": "collideCallback" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "The callback to invoke when the two objects collide. Must return a boolean.", "name": "processCallback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The scope in which to call the callbacks.", "name": "callbackContext" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Collider" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Collider" } }, "description": "The Collider that was created." } ], "memberof": "Phaser.Physics.Arcade.Factory", "longname": "Phaser.Physics.Arcade.Factory#collider", "scope": "instance", "___id": "T000002R028910", "___s": true }, { "comment": "/**\r\n * Creates a new Arcade Physics Collider Overlap object.\r\n *\r\n * @method Phaser.Physics.Arcade.Factory#overlap\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} object1 - The first object to check for overlap.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} object2 - The second object to check for overlap.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [collideCallback] - The callback to invoke when the two objects collide.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [processCallback] - The callback to invoke when the two objects collide. Must return a boolean.\r\n * @param {*} [callbackContext] - The scope in which to call the callbacks.\r\n *\r\n * @return {Phaser.Physics.Arcade.Collider} The Collider that was created.\r\n */", "meta": { "filename": "Factory.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Creates a new Arcade Physics Collider Overlap object.", "kind": "function", "name": "overlap", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "description": "The first object to check for overlap.", "name": "object1" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "description": "The second object to check for overlap.", "name": "object2" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "The callback to invoke when the two objects collide.", "name": "collideCallback" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "The callback to invoke when the two objects collide. Must return a boolean.", "name": "processCallback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The scope in which to call the callbacks.", "name": "callbackContext" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Collider" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Collider" } }, "description": "The Collider that was created." } ], "memberof": "Phaser.Physics.Arcade.Factory", "longname": "Phaser.Physics.Arcade.Factory#overlap", "scope": "instance", "___id": "T000002R028912", "___s": true }, { "comment": "/**\r\n * Adds an Arcade Physics Body to the given Game Object.\r\n *\r\n * @method Phaser.Physics.Arcade.Factory#existing\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 - A Game Object.\r\n * @param {boolean} [isStatic=false] - Create a Static body (true) or Dynamic body (false).\r\n *\r\n * @return {Phaser.Types.Physics.Arcade.GameObjectWithBody} The Game Object.\r\n */", "meta": { "filename": "Factory.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Adds an Arcade Physics Body to the given Game Object.", "kind": "function", "name": "existing", "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": "A Game Object.", "name": "gameObject" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Create a Static body (true) or Dynamic body (false).", "name": "isStatic" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.GameObjectWithBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.GameObjectWithBody" } }, "description": "The Game Object." } ], "memberof": "Phaser.Physics.Arcade.Factory", "longname": "Phaser.Physics.Arcade.Factory#existing", "scope": "instance", "___id": "T000002R028914", "___s": true }, { "comment": "/**\r\n * Creates a new Arcade Image object with a Static body.\r\n *\r\n * @method Phaser.Physics.Arcade.Factory#staticImage\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.Types.Physics.Arcade.ImageWithStaticBody} The Image object that was created.\r\n */", "meta": { "filename": "Factory.js", "lineno": 122, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Creates a new Arcade Image object with a Static body.", "kind": "function", "name": "staticImage", "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.Types.Physics.Arcade.ImageWithStaticBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ImageWithStaticBody" } }, "description": "The Image object that was created." } ], "memberof": "Phaser.Physics.Arcade.Factory", "longname": "Phaser.Physics.Arcade.Factory#staticImage", "scope": "instance", "___id": "T000002R028917", "___s": true }, { "comment": "/**\r\n * Creates a new Arcade Image object with a Dynamic body.\r\n *\r\n * @method Phaser.Physics.Arcade.Factory#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.Types.Physics.Arcade.ImageWithDynamicBody} The Image object that was created.\r\n */", "meta": { "filename": "Factory.js", "lineno": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Creates a new Arcade Image object with a Dynamic body.", "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.Types.Physics.Arcade.ImageWithDynamicBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ImageWithDynamicBody" } }, "description": "The Image object that was created." } ], "memberof": "Phaser.Physics.Arcade.Factory", "longname": "Phaser.Physics.Arcade.Factory#image", "scope": "instance", "___id": "T000002R028920", "___s": true }, { "comment": "/**\r\n * Creates a new Arcade Sprite object with a Static body.\r\n *\r\n * @method Phaser.Physics.Arcade.Factory#staticSprite\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.Types.Physics.Arcade.SpriteWithStaticBody} The Sprite object that was created.\r\n */", "meta": { "filename": "Factory.js", "lineno": 170, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Creates a new Arcade Sprite object with a Static body.", "kind": "function", "name": "staticSprite", "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.Types.Physics.Arcade.SpriteWithStaticBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.SpriteWithStaticBody" } }, "description": "The Sprite object that was created." } ], "memberof": "Phaser.Physics.Arcade.Factory", "longname": "Phaser.Physics.Arcade.Factory#staticSprite", "scope": "instance", "___id": "T000002R028923", "___s": true }, { "comment": "/**\r\n * Creates a new Arcade Sprite object with a Dynamic body.\r\n *\r\n * @method Phaser.Physics.Arcade.Factory#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} key - The key 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.Types.Physics.Arcade.SpriteWithDynamicBody} The Sprite object that was created.\r\n */", "meta": { "filename": "Factory.js", "lineno": 195, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Creates a new Arcade Sprite object with a Dynamic body.", "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" ], "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.", "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" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.SpriteWithDynamicBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.SpriteWithDynamicBody" } }, "description": "The Sprite object that was created." } ], "memberof": "Phaser.Physics.Arcade.Factory", "longname": "Phaser.Physics.Arcade.Factory#sprite", "scope": "instance", "___id": "T000002R028926", "___s": true }, { "comment": "/**\r\n * Creates a Static Physics Group object.\r\n * All Game Objects created by this Group will automatically be static Arcade Physics objects.\r\n *\r\n * @method Phaser.Physics.Arcade.Factory#staticGroup\r\n * @since 3.0.0\r\n *\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.\r\n *\r\n * @return {Phaser.Physics.Arcade.StaticGroup} The Static Group object that was created.\r\n */", "meta": { "filename": "Factory.js", "lineno": 220, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Creates a Static Physics Group object.\rAll Game Objects created by this Group will automatically be static Arcade Physics objects.", "kind": "function", "name": "staticGroup", "since": "3.0.0", "params": [ { "type": { "names": [ "Array.", "Phaser.Types.GameObjects.Group.GroupConfig", "Phaser.Types.GameObjects.Group.GroupCreateConfig" ], "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.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.StaticGroup" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticGroup" } }, "description": "The Static Group object that was created." } ], "memberof": "Phaser.Physics.Arcade.Factory", "longname": "Phaser.Physics.Arcade.Factory#staticGroup", "scope": "instance", "___id": "T000002R028929", "___s": true }, { "comment": "/**\r\n * Creates a Physics Group object.\r\n * All Game Objects created by this Group will automatically be dynamic Arcade Physics objects.\r\n *\r\n * @method Phaser.Physics.Arcade.Factory#group\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject[]|Phaser.Types.Physics.Arcade.PhysicsGroupConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig)} [children] - Game Objects to add to this group; or the `config` argument.\r\n * @param {Phaser.Types.Physics.Arcade.PhysicsGroupConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig} [config] - Settings for this group.\r\n *\r\n * @return {Phaser.Physics.Arcade.Group} The Group object that was created.\r\n */", "meta": { "filename": "Factory.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Creates a Physics Group object.\rAll Game Objects created by this Group will automatically be dynamic Arcade Physics objects.", "kind": "function", "name": "group", "since": "3.0.0", "params": [ { "type": { "names": [ "Array.", "Phaser.Types.Physics.Arcade.PhysicsGroupConfig", "Phaser.Types.GameObjects.Group.GroupCreateConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.PhysicsGroupConfig" }, { "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.Physics.Arcade.PhysicsGroupConfig", "Phaser.Types.GameObjects.Group.GroupCreateConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.PhysicsGroupConfig" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupCreateConfig" } ] } }, "optional": true, "description": "Settings for this group.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Group" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Group" } }, "description": "The Group object that was created." } ], "memberof": "Phaser.Physics.Arcade.Factory", "longname": "Phaser.Physics.Arcade.Factory#group", "scope": "instance", "___id": "T000002R028931", "___s": true }, { "comment": "/**\r\n * Creates a new physics Body with the given position and size.\r\n *\r\n * This Body is not associated with any Game Object, but still exists within the world\r\n * and can be tested for collision, have velocity, etc.\r\n *\r\n * @method Phaser.Physics.Arcade.Factory#body\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - The horizontal position of this Body in the physics world.\r\n * @param {number} y - The vertical position of this Body in the physics world.\r\n * @param {number} [width=64] - The width of the Body in pixels. Cannot be negative or zero.\r\n * @param {number} [height=64] - The height of the Body in pixels. Cannot be negative or zero.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} The Body that was created.\r\n */", "meta": { "filename": "Factory.js", "lineno": 254, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Creates a new physics Body with the given position and size.\r\rThis Body is not associated with any Game Object, but still exists within the world\rand can be tested for collision, have velocity, etc.", "kind": "function", "name": "body", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Body in the physics world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Body in the physics world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 64, "description": "The width of the Body in pixels. Cannot be negative or zero.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 64, "description": "The height of the Body in pixels. Cannot be negative or zero.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The Body that was created." } ], "memberof": "Phaser.Physics.Arcade.Factory", "longname": "Phaser.Physics.Arcade.Factory#body", "scope": "instance", "___id": "T000002R028933", "___s": true }, { "comment": "/**\r\n * Creates a new static physics Body with the given position and size.\r\n *\r\n * This Body is not associated with any Game Object, but still exists within the world\r\n * and can be tested for collision, etc.\r\n *\r\n * @method Phaser.Physics.Arcade.Factory#staticBody\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - The horizontal position of this Body in the physics world.\r\n * @param {number} y - The vertical position of this Body in the physics world.\r\n * @param {number} [width=64] - The width of the Body in pixels. Cannot be negative or zero.\r\n * @param {number} [height=64] - The height of the Body in pixels. Cannot be negative or zero.\r\n *\r\n * @return {Phaser.Physics.Arcade.Body} The Body that was created.\r\n */", "meta": { "filename": "Factory.js", "lineno": 286, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Creates a new static physics Body with the given position and size.\r\rThis Body is not associated with any Game Object, but still exists within the world\rand can be tested for collision, etc.", "kind": "function", "name": "staticBody", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Body in the physics world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Body in the physics world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 64, "description": "The width of the Body in pixels. Cannot be negative or zero.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 64, "description": "The height of the Body in pixels. Cannot be negative or zero.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The Body that was created." } ], "memberof": "Phaser.Physics.Arcade.Factory", "longname": "Phaser.Physics.Arcade.Factory#staticBody", "scope": "instance", "___id": "T000002R028936", "___s": true }, { "comment": "/**\r\n * Destroys this Factory.\r\n *\r\n * @method Phaser.Physics.Arcade.Factory#destroy\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Factory.js", "lineno": 318, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Destroys this Factory.", "kind": "function", "name": "destroy", "since": "3.5.0", "memberof": "Phaser.Physics.Arcade.Factory", "longname": "Phaser.Physics.Arcade.Factory#destroy", "scope": "instance", "___id": "T000002R028939", "___s": true }, { "comment": "/**\r\n * Calculates and returns the bitmask needed to determine if the given\r\n * categories will collide with each other or not.\r\n *\r\n * @function Phaser.Physics.Arcade.GetCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {(number|number[])} categories - A unique category bitfield, or an array of them.\r\n *\r\n * @return {number} The collision mask.\r\n */", "meta": { "filename": "GetCollidesWith.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Calculates and returns the bitmask needed to determine if the given\rcategories will collide with each other or not.", "kind": "function", "name": "GetCollidesWith", "since": "3.61.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" } ] } ] } }, "description": "A unique category bitfield, or an array of them.", "name": "categories" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision mask." } ], "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.GetCollidesWith", "scope": "static", "___id": "T000002R028945", "___s": true }, { "comment": "/**\r\n * Calculates and returns the horizontal overlap between two arcade physics bodies and sets their properties\r\n * accordingly, including: `touching.left`, `touching.right`, `touching.none` and `overlapX'.\r\n *\r\n * @function Phaser.Physics.Arcade.GetOverlapX\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Body} body1 - The first Body to separate.\r\n * @param {Phaser.Physics.Arcade.Body} body2 - The second Body to separate.\r\n * @param {boolean} overlapOnly - Is this an overlap only check, or part of separation?\r\n * @param {number} bias - A value added to the delta values during collision checks. Increase it to prevent sprite tunneling(sprites passing through another instead of colliding).\r\n *\r\n * @return {number} The amount of overlap.\r\n */", "meta": { "filename": "GetOverlapX.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Calculates and returns the horizontal overlap between two arcade physics bodies and sets their properties\raccordingly, including: `touching.left`, `touching.right`, `touching.none` and `overlapX'.", "kind": "function", "name": "GetOverlapX", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The first Body to separate.", "name": "body1" }, { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The second Body to separate.", "name": "body2" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this an overlap only check, or part of separation?", "name": "overlapOnly" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A value added to the delta values during collision checks. Increase it to prevent sprite tunneling(sprites passing through another instead of colliding).", "name": "bias" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of overlap." } ], "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.GetOverlapX", "scope": "static", "___id": "T000002R028953", "___s": true }, { "comment": "/**\r\n * Calculates and returns the vertical overlap between two arcade physics bodies and sets their properties\r\n * accordingly, including: `touching.up`, `touching.down`, `touching.none` and `overlapY'.\r\n *\r\n * @function Phaser.Physics.Arcade.GetOverlapY\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Body} body1 - The first Body to separate.\r\n * @param {Phaser.Physics.Arcade.Body} body2 - The second Body to separate.\r\n * @param {boolean} overlapOnly - Is this an overlap only check, or part of separation?\r\n * @param {number} bias - A value added to the delta values during collision checks. Increase it to prevent sprite tunneling(sprites passing through another instead of colliding).\r\n *\r\n * @return {number} The amount of overlap.\r\n */", "meta": { "filename": "GetOverlapY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Calculates and returns the vertical overlap between two arcade physics bodies and sets their properties\raccordingly, including: `touching.up`, `touching.down`, `touching.none` and `overlapY'.", "kind": "function", "name": "GetOverlapY", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The first Body to separate.", "name": "body1" }, { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The second Body to separate.", "name": "body2" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this an overlap only check, or part of separation?", "name": "overlapOnly" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A value added to the delta values during collision checks. Increase it to prevent sprite tunneling(sprites passing through another instead of colliding).", "name": "bias" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of overlap." } ], "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.GetOverlapY", "scope": "static", "___id": "T000002R028983", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Physics.Arcade\r\n */", "meta": { "filename": "index.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "kind": "namespace", "name": "Arcade", "memberof": "Phaser.Physics", "longname": "Phaser.Physics.Arcade", "scope": "static", "___id": "T000002R029014", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * An Arcade Physics Group object.\r\n *\r\n * The primary use of a Physics Group is a way to collect together physics enable objects\r\n * that share the same intrinsic structure into a single pool. They can they be easily\r\n * compared against other Groups, or Game Objects.\r\n *\r\n * All Game Objects created by, or added to this Group will automatically be given **dynamic**\r\n * Arcade Physics bodies (if they have no body already) and the bodies will receive the\r\n * Groups {@link Phaser.Physics.Arcade.Group#defaults default values}.\r\n *\r\n * You should not pass objects into this Group that should not receive a body. For example,\r\n * do not add basic Geometry or Tilemap Layers into a Group, as they will not behave in the\r\n * way you may expect. Groups should all ideally have objects of the same type in them.\r\n *\r\n * If you wish to create a Group filled with Static Bodies, please see {@link Phaser.Physics.Arcade.StaticGroup}.\r\n *\r\n * @class Group\r\n * @extends Phaser.GameObjects.Group\r\n * @memberof Phaser.Physics.Arcade\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.Physics.Arcade.Components.Collision\r\n *\r\n * @param {Phaser.Physics.Arcade.World} world - The physics simulation.\r\n * @param {Phaser.Scene} scene - The scene this group belongs to.\r\n * @param {(Phaser.GameObjects.GameObject[]|Phaser.Types.Physics.Arcade.PhysicsGroupConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig)} [children] - Game Objects to add to this group; or the `config` argument.\r\n * @param {Phaser.Types.Physics.Arcade.PhysicsGroupConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig} [config] - Settings for this group.\r\n */", "meta": { "filename": "PhysicsGroup.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "classdesc": "An Arcade Physics Group object.\r\rThe primary use of a Physics Group is a way to collect together physics enable objects\rthat share the same intrinsic structure into a single pool. They can they be easily\rcompared against other Groups, or Game Objects.\r\rAll Game Objects created by, or added to this Group will automatically be given **dynamic**\rArcade Physics bodies (if they have no body already) and the bodies will receive the\rGroups {@link Phaser.Physics.Arcade.Group#defaults default values}.\r\rYou should not pass objects into this Group that should not receive a body. For example,\rdo not add basic Geometry or Tilemap Layers into a Group, as they will not behave in the\rway you may expect. Groups should all ideally have objects of the same type in them.\r\rIf you wish to create a Group filled with Static Bodies, please see {@link Phaser.Physics.Arcade.StaticGroup}.", "kind": "class", "name": "Group", "augments": [ "Phaser.GameObjects.Group", "Phaser.Physics.Arcade.Components.Collision" ], "memberof": "Phaser.Physics.Arcade", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "description": "The physics simulation.", "name": "world" }, { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The scene this group belongs to.", "name": "scene" }, { "type": { "names": [ "Array.", "Phaser.Types.Physics.Arcade.PhysicsGroupConfig", "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.Physics.Arcade.PhysicsGroupConfig" }, { "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.Physics.Arcade.PhysicsGroupConfig", "Phaser.Types.GameObjects.Group.GroupCreateConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.PhysicsGroupConfig" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupCreateConfig" } ] } }, "optional": true, "description": "Settings for this group.", "name": "config" } ], "scope": "static", "longname": "Phaser.Physics.Arcade.Group", "___id": "T000002R029043", "___s": true }, { "comment": "/**\r\n * The physics simulation.\r\n *\r\n * @name Phaser.Physics.Arcade.Group#world\r\n * @type {Phaser.Physics.Arcade.World}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PhysicsGroup.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The physics simulation.", "name": "world", "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Group", "longname": "Phaser.Physics.Arcade.Group#world", "scope": "instance", "kind": "member", "___id": "T000002R029063", "___s": true }, { "comment": "/**\r\n * The class to create new Group members from.\r\n *\r\n * This should be either `Phaser.Physics.Arcade.Image`, `Phaser.Physics.Arcade.Sprite`, or a class extending one of those.\r\n *\r\n * @name Phaser.Physics.Arcade.Group#classType\r\n * @type {function}\r\n * @default ArcadeSprite\r\n * @since 3.0.0\r\n * @see Phaser.Types.GameObjects.Group.GroupClassTypeConstructor\r\n */", "meta": { "filename": "PhysicsGroup.js", "lineno": 106, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The class to create new Group members from.\r\rThis should be either `Phaser.Physics.Arcade.Image`, `Phaser.Physics.Arcade.Sprite`, or a class extending one of those.", "name": "classType", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "defaultvalue": "ArcadeSprite", "since": "3.0.0", "see": [ "Phaser.Types.GameObjects.Group.GroupClassTypeConstructor" ], "memberof": "Phaser.Physics.Arcade.Group", "longname": "Phaser.Physics.Arcade.Group#classType", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Group#classType", "___id": "T000002R029065", "___s": true }, { "comment": "/**\r\n * The physics type of the Group's members.\r\n *\r\n * @name Phaser.Physics.Arcade.Group#physicsType\r\n * @type {number}\r\n * @default Phaser.Physics.Arcade.DYNAMIC_BODY\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PhysicsGroup.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The physics type of the Group's members.", "name": "physicsType", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "Phaser.Physics.Arcade.DYNAMIC_BODY", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Group", "longname": "Phaser.Physics.Arcade.Group#physicsType", "scope": "instance", "kind": "member", "___id": "T000002R029067", "___s": true }, { "comment": "/**\r\n * The Arcade Physics Group Collision Category.\r\n *\r\n * This can be set to any valid collision bitfield value.\r\n *\r\n * See the `setCollisionCategory` method for more details.\r\n *\r\n * @name Phaser.Physics.Arcade.Group#collisionCategory\r\n * @type {number}\r\n * @since 3.61.0\r\n */", "meta": { "filename": "PhysicsGroup.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Arcade Physics Group Collision Category.\r\rThis can be set to any valid collision bitfield value.\r\rSee the `setCollisionCategory` method for more details.", "name": "collisionCategory", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.61.0", "memberof": "Phaser.Physics.Arcade.Group", "longname": "Phaser.Physics.Arcade.Group#collisionCategory", "scope": "instance", "kind": "member", "___id": "T000002R029069", "___s": true }, { "comment": "/**\r\n * The Arcade Physics Group Collision Mask.\r\n *\r\n * See the `setCollidesWith` method for more details.\r\n *\r\n * @name Phaser.Physics.Arcade.Group#collisionMask\r\n * @type {number}\r\n * @since 3.61.0\r\n */", "meta": { "filename": "PhysicsGroup.js", "lineno": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Arcade Physics Group Collision Mask.\r\rSee the `setCollidesWith` method for more details.", "name": "collisionMask", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.61.0", "memberof": "Phaser.Physics.Arcade.Group", "longname": "Phaser.Physics.Arcade.Group#collisionMask", "scope": "instance", "kind": "member", "___id": "T000002R029071", "___s": true }, { "comment": "/**\r\n * Default physics properties applied to Game Objects added to the Group or created by the Group. Derived from the `config` argument.\r\n *\r\n * You can remove the default values by setting this property to `{}`.\r\n *\r\n * @name Phaser.Physics.Arcade.Group#defaults\r\n * @type {Phaser.Types.Physics.Arcade.PhysicsGroupDefaults}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PhysicsGroup.js", "lineno": 156, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Default physics properties applied to Game Objects added to the Group or created by the Group. Derived from the `config` argument.\r\rYou can remove the default values by setting this property to `{}`.", "name": "defaults", "type": { "names": [ "Phaser.Types.Physics.Arcade.PhysicsGroupDefaults" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.PhysicsGroupDefaults" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Group", "longname": "Phaser.Physics.Arcade.Group#defaults", "scope": "instance", "kind": "member", "___id": "T000002R029073", "___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.Physics.Arcade.Group#type\r\n * @type {string}\r\n * @default 'PhysicsGroup'\r\n * @since 3.21.0\r\n */", "meta": { "filename": "PhysicsGroup.js", "lineno": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "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": "'PhysicsGroup'", "since": "3.21.0", "memberof": "Phaser.Physics.Arcade.Group", "longname": "Phaser.Physics.Arcade.Group#type", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Group#type", "___id": "T000002R029102", "___s": true }, { "comment": "/**\r\n * Enables a Game Object's Body and assigns `defaults`. Called when a Group member is added or created.\r\n *\r\n * @method Phaser.Physics.Arcade.Group#createCallbackHandler\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The Game Object being added.\r\n */", "meta": { "filename": "PhysicsGroup.js", "lineno": 209, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Enables a Game Object's Body and assigns `defaults`. Called when a Group member is added or created.", "kind": "function", "name": "createCallbackHandler", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being added.", "name": "child" } ], "memberof": "Phaser.Physics.Arcade.Group", "longname": "Phaser.Physics.Arcade.Group#createCallbackHandler", "scope": "instance", "___id": "T000002R029104", "___s": true }, { "comment": "/**\r\n * Disables a Game Object's Body. Called when a Group member is removed.\r\n *\r\n * @method Phaser.Physics.Arcade.Group#removeCallbackHandler\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The Game Object being removed.\r\n */", "meta": { "filename": "PhysicsGroup.js", "lineno": 232, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Disables a Game Object's Body. Called when a Group member is removed.", "kind": "function", "name": "removeCallbackHandler", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being removed.", "name": "child" } ], "memberof": "Phaser.Physics.Arcade.Group", "longname": "Phaser.Physics.Arcade.Group#removeCallbackHandler", "scope": "instance", "___id": "T000002R029108", "___s": true }, { "comment": "/**\r\n * Sets the velocity of each Group member.\r\n *\r\n * @method Phaser.Physics.Arcade.Group#setVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal velocity.\r\n * @param {number} y - The vertical velocity.\r\n * @param {number} [step=0] - The velocity increment. When set, the first member receives velocity (x, y), the second (x + step, y + step), and so on.\r\n *\r\n * @return {Phaser.Physics.Arcade.Group} This Physics Group object.\r\n */", "meta": { "filename": "PhysicsGroup.js", "lineno": 248, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the velocity of each Group member.", "kind": "function", "name": "setVelocity", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal velocity.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical velocity.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The velocity increment. When set, the first member receives velocity (x, y), the second (x + step, y + step), and so on.", "name": "step" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Group" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Group" } }, "description": "This Physics Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "longname": "Phaser.Physics.Arcade.Group#setVelocity", "scope": "instance", "___id": "T000002R029110", "___s": true }, { "comment": "/**\r\n * Sets the horizontal velocity of each Group member.\r\n *\r\n * @method Phaser.Physics.Arcade.Group#setVelocityX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The velocity value.\r\n * @param {number} [step=0] - The velocity increment. When set, the first member receives velocity (x), the second (x + step), and so on.\r\n *\r\n * @return {Phaser.Physics.Arcade.Group} This Physics Group object.\r\n */", "meta": { "filename": "PhysicsGroup.js", "lineno": 274, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the horizontal velocity of each Group member.", "kind": "function", "name": "setVelocityX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The velocity value.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The velocity increment. When set, the first member receives velocity (x), the second (x + step), and so on.", "name": "step" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Group" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Group" } }, "description": "This Physics Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "longname": "Phaser.Physics.Arcade.Group#setVelocityX", "scope": "instance", "___id": "T000002R029115", "___s": true }, { "comment": "/**\r\n * Sets the vertical velocity of each Group member.\r\n *\r\n * @method Phaser.Physics.Arcade.Group#setVelocityY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The velocity value.\r\n * @param {number} [step=0] - The velocity increment. When set, the first member receives velocity (y), the second (y + step), and so on.\r\n *\r\n * @return {Phaser.Physics.Arcade.Group} This Physics Group object.\r\n */", "meta": { "filename": "PhysicsGroup.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the vertical velocity of each Group member.", "kind": "function", "name": "setVelocityY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The velocity value.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The velocity increment. When set, the first member receives velocity (y), the second (y + step), and so on.", "name": "step" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Group" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Group" } }, "description": "This Physics Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "longname": "Phaser.Physics.Arcade.Group#setVelocityY", "scope": "instance", "___id": "T000002R029121", "___s": true }, { "comment": "/**\r\n * Separates two overlapping bodies on the X-axis (horizontally).\r\n *\r\n * Separation involves moving two overlapping bodies so they don't overlap anymore and adjusting their velocities based on their mass. This is a core part of collision detection.\r\n *\r\n * The bodies won't be separated if there is no horizontal overlap between them, if they are static, or if either one uses custom logic for its separation.\r\n *\r\n * @function Phaser.Physics.Arcade.SeparateX\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Body} body1 - The first Body to separate.\r\n * @param {Phaser.Physics.Arcade.Body} body2 - The second Body to separate.\r\n * @param {boolean} overlapOnly - If `true`, the bodies will only have their overlap data set and no separation will take place.\r\n * @param {number} bias - A value to add to the delta value during overlap checking. Used to prevent sprite tunneling.\r\n * @param {number} [overlap] - If given then this value will be used as the overlap and no check will be run.\r\n *\r\n * @return {boolean} `true` if the two bodies overlap vertically, otherwise `false`.\r\n */", "meta": { "filename": "SeparateX.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Separates two overlapping bodies on the X-axis (horizontally).\r\rSeparation involves moving two overlapping bodies so they don't overlap anymore and adjusting their velocities based on their mass. This is a core part of collision detection.\r\rThe bodies won't be separated if there is no horizontal overlap between them, if they are static, or if either one uses custom logic for its separation.", "kind": "function", "name": "SeparateX", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The first Body to separate.", "name": "body1" }, { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The second Body to separate.", "name": "body2" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If `true`, the bodies will only have their overlap data set and no separation will take place.", "name": "overlapOnly" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A value to add to the delta value during overlap checking. Used to prevent sprite tunneling.", "name": "bias" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If given then this value will be used as the overlap and no check will be run.", "name": "overlap" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the two bodies overlap vertically, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.SeparateX", "scope": "static", "___id": "T000002R029272", "___s": true }, { "comment": "/**\r\n * Separates two overlapping bodies on the Y-axis (vertically).\r\n *\r\n * Separation involves moving two overlapping bodies so they don't overlap anymore and adjusting their velocities based on their mass. This is a core part of collision detection.\r\n *\r\n * The bodies won't be separated if there is no vertical overlap between them, if they are static, or if either one uses custom logic for its separation.\r\n *\r\n * @function Phaser.Physics.Arcade.SeparateY\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Body} body1 - The first Body to separate.\r\n * @param {Phaser.Physics.Arcade.Body} body2 - The second Body to separate.\r\n * @param {boolean} overlapOnly - If `true`, the bodies will only have their overlap data set and no separation will take place.\r\n * @param {number} bias - A value to add to the delta value during overlap checking. Used to prevent sprite tunneling.\r\n * @param {number} [overlap] - If given then this value will be used as the overlap and no check will be run.\r\n *\r\n * @return {boolean} `true` if the two bodies overlap vertically, otherwise `false`.\r\n */", "meta": { "filename": "SeparateY.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Separates two overlapping bodies on the Y-axis (vertically).\r\rSeparation involves moving two overlapping bodies so they don't overlap anymore and adjusting their velocities based on their mass. This is a core part of collision detection.\r\rThe bodies won't be separated if there is no vertical overlap between them, if they are static, or if either one uses custom logic for its separation.", "kind": "function", "name": "SeparateY", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The first Body to separate.", "name": "body1" }, { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The second Body to separate.", "name": "body2" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If `true`, the bodies will only have their overlap data set and no separation will take place.", "name": "overlapOnly" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A value to add to the delta value during overlap checking. Used to prevent sprite tunneling.", "name": "bias" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If given then this value will be used as the overlap and no check will be run.", "name": "overlap" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the two bodies overlap vertically, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.SeparateY", "scope": "static", "___id": "T000002R029281", "___s": true }, { "comment": "/**\r\n * Either sets or creates the Arcade Body Collision object.\r\n *\r\n * Mostly only used internally.\r\n *\r\n * @function Phaser.Physics.Arcade.SetCollisionObject\r\n * @since 3.61.0\r\n *\r\n * @param {boolean} noneFlip - Is `none` true or false?\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeBodyCollision} [data] - The collision data object to populate, or create if not given.\r\n *\r\n * @return {Phaser.Types.Physics.Arcade.ArcadeBodyCollision} The collision data.\r\n */", "meta": { "filename": "SetCollisionObject.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Either sets or creates the Arcade Body Collision object.\r\rMostly only used internally.", "kind": "function", "name": "SetCollisionObject", "since": "3.61.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is `none` true or false?", "name": "noneFlip" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" } }, "optional": true, "description": "The collision data object to populate, or create if not given.", "name": "data" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" } }, "description": "The collision data." } ], "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.SetCollisionObject", "scope": "static", "___id": "T000002R029288", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Static Arcade Physics Body.\r\n *\r\n * A Static Body never moves, and isn't automatically synchronized with its parent Game Object.\r\n * That means if you make any change to the parent's origin, position, or scale after creating or adding the body, you'll need to update the Static Body manually.\r\n *\r\n * A Static Body can collide with other Bodies, but is never moved by collisions.\r\n *\r\n * Its dynamic counterpart is {@link Phaser.Physics.Arcade.Body}.\r\n *\r\n * @class StaticBody\r\n * @memberof Phaser.Physics.Arcade\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.Physics.Arcade.Components.Collision\r\n *\r\n * @param {Phaser.Physics.Arcade.World} world - The Arcade Physics simulation this Static Body belongs to.\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object this Body belongs to. As of Phaser 3.60 this is now optional.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "classdesc": "A Static Arcade Physics Body.\r\rA Static Body never moves, and isn't automatically synchronized with its parent Game Object.\rThat means if you make any change to the parent's origin, position, or scale after creating or adding the body, you'll need to update the Static Body manually.\r\rA Static Body can collide with other Bodies, but is never moved by collisions.\r\rIts dynamic counterpart is {@link Phaser.Physics.Arcade.Body}.", "kind": "class", "name": "StaticBody", "memberof": "Phaser.Physics.Arcade", "since": "3.0.0", "augments": [ "Phaser.Physics.Arcade.Components.Collision" ], "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "description": "The Arcade Physics simulation this Static Body belongs to.", "name": "world" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object this Body belongs to. As of Phaser 3.60 this is now optional.", "name": "gameObject" } ], "scope": "static", "longname": "Phaser.Physics.Arcade.StaticBody", "___id": "T000002R029308", "___s": true }, { "comment": "/**\r\n * The Arcade Physics simulation this Static Body belongs to.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#world\r\n * @type {Phaser.Physics.Arcade.World}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Arcade Physics simulation this Static Body belongs to.", "name": "world", "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#world", "scope": "instance", "kind": "member", "___id": "T000002R029327", "___s": true }, { "comment": "/**\r\n * The Game Object this Static Body belongs to.\r\n *\r\n * As of Phaser 3.60 this is now optional and can be undefined.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Game Object this Static Body belongs to.\r\rAs of Phaser 3.60 this is now optional and can be undefined.", "name": "gameObject", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#gameObject", "scope": "instance", "kind": "member", "___id": "T000002R029329", "___s": true }, { "comment": "/**\r\n * A quick-test flag that signifies this is a Body, used in the World collision handler.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#isBody\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "A quick-test flag that signifies this is a Body, used in the World collision handler.", "name": "isBody", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#isBody", "scope": "instance", "kind": "member", "___id": "T000002R029331", "___s": true }, { "comment": "/**\r\n * Whether the Static Body's boundary is drawn to the debug display.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#debugShowBody\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 103, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether the Static Body's boundary is drawn to the debug display.", "name": "debugShowBody", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#debugShowBody", "scope": "instance", "kind": "member", "___id": "T000002R029333", "___s": true }, { "comment": "/**\r\n * The color of this Static Body on the debug display.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#debugBodyColor\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The color of this Static Body on the debug display.", "name": "debugBodyColor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#debugBodyColor", "scope": "instance", "kind": "member", "___id": "T000002R029335", "___s": true }, { "comment": "/**\r\n * Whether this Static Body is updated by the physics simulation.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#enable\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 121, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Static Body is updated by the physics simulation.", "name": "enable", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#enable", "scope": "instance", "kind": "member", "___id": "T000002R029337", "___s": true }, { "comment": "/**\r\n * Whether this Static Body's boundary is circular (`true`) or rectangular (`false`).\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#isCircle\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this Static Body's boundary is circular (`true`) or rectangular (`false`).", "name": "isCircle", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#isCircle", "scope": "instance", "kind": "member", "___id": "T000002R029339", "___s": true }, { "comment": "/**\r\n * If this Static Body is circular, this is the radius of the boundary, as set by {@link Phaser.Physics.Arcade.StaticBody#setCircle}, in pixels.\r\n * Equal to `halfWidth`.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#radius\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "If this Static Body is circular, this is the radius of the boundary, as set by {@link Phaser.Physics.Arcade.StaticBody#setCircle}, in pixels.\rEqual to `halfWidth`.", "name": "radius", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#radius", "scope": "instance", "kind": "member", "___id": "T000002R029341", "___s": true }, { "comment": "/**\r\n * The offset set by {@link Phaser.Physics.Arcade.StaticBody#setCircle} or {@link Phaser.Physics.Arcade.StaticBody#setSize}.\r\n *\r\n * This doesn't affect the Static Body's position, because a Static Body does not follow its Game Object.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#offset\r\n * @type {Phaser.Math.Vector2}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The offset set by {@link Phaser.Physics.Arcade.StaticBody#setCircle} or {@link Phaser.Physics.Arcade.StaticBody#setSize}.\r\rThis doesn't affect the Static Body's position, because a Static Body does not follow its Game Object.", "name": "offset", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#offset", "scope": "instance", "kind": "member", "___id": "T000002R029343", "___s": true }, { "comment": "/**\r\n * The position of this Static Body within the simulation.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#position\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 164, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The position of this Static Body within the simulation.", "name": "position", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#position", "scope": "instance", "kind": "member", "___id": "T000002R029345", "___s": true }, { "comment": "/**\r\n * The width of the Static Body's boundary, in pixels.\r\n * If the Static Body is circular, this is also the Static Body's diameter.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 173, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The width of the Static Body's boundary, in pixels.\rIf the Static Body is circular, this is also the Static Body's diameter.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#width", "scope": "instance", "kind": "member", "___id": "T000002R029347", "___s": true }, { "comment": "/**\r\n * The height of the Static Body's boundary, in pixels.\r\n * If the Static Body is circular, this is also the Static Body's diameter.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 183, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The height of the Static Body's boundary, in pixels.\rIf the Static Body is circular, this is also the Static Body's diameter.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#height", "scope": "instance", "kind": "member", "___id": "T000002R029349", "___s": true }, { "comment": "/**\r\n * Half the Static Body's width, in pixels.\r\n * If the Static Body is circular, this is also the Static Body's radius.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#halfWidth\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 193, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Half the Static Body's width, in pixels.\rIf the Static Body is circular, this is also the Static Body's radius.", "name": "halfWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#halfWidth", "scope": "instance", "kind": "member", "___id": "T000002R029351", "___s": true }, { "comment": "/**\r\n * Half the Static Body's height, in pixels.\r\n * If the Static Body is circular, this is also the Static Body's radius.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#halfHeight\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 203, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Half the Static Body's height, in pixels.\rIf the Static Body is circular, this is also the Static Body's radius.", "name": "halfHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#halfHeight", "scope": "instance", "kind": "member", "___id": "T000002R029353", "___s": true }, { "comment": "/**\r\n * The center of the Static Body's boundary.\r\n * This is the midpoint of its `position` (top-left corner) and its bottom-right corner.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#center\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 213, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The center of the Static Body's boundary.\rThis is the midpoint of its `position` (top-left corner) and its bottom-right corner.", "name": "center", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#center", "scope": "instance", "kind": "member", "___id": "T000002R029355", "___s": true }, { "comment": "/**\r\n * A constant zero velocity used by the Arcade Physics simulation for calculations.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#velocity\r\n * @type {Phaser.Math.Vector2}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 223, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "A constant zero velocity used by the Arcade Physics simulation for calculations.", "name": "velocity", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#velocity", "scope": "instance", "kind": "member", "___id": "T000002R029357", "___s": true }, { "comment": "/**\r\n * A constant `false` value expected by the Arcade Physics simulation.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#allowGravity\r\n * @type {boolean}\r\n * @readonly\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 233, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "A constant `false` value expected by the Arcade Physics simulation.", "name": "allowGravity", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#allowGravity", "scope": "instance", "kind": "member", "___id": "T000002R029359", "___s": true }, { "comment": "/**\r\n * Gravitational force applied specifically to this Body. Values are in pixels per second squared. Always zero for a Static Body.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#gravity\r\n * @type {Phaser.Math.Vector2}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 244, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Gravitational force applied specifically to this Body. Values are in pixels per second squared. Always zero for a Static Body.", "name": "gravity", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#gravity", "scope": "instance", "kind": "member", "___id": "T000002R029361", "___s": true }, { "comment": "/**\r\n * Rebound, or restitution, following a collision, relative to 1. Always zero for a Static Body.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#bounce\r\n * @type {Phaser.Math.Vector2}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 254, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Rebound, or restitution, following a collision, relative to 1. Always zero for a Static Body.", "name": "bounce", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#bounce", "scope": "instance", "kind": "member", "___id": "T000002R029363", "___s": true }, { "comment": "/**\r\n * Whether the simulation emits a `worldbounds` event when this StaticBody collides with the world boundary.\r\n * Always false for a Static Body. (Static Bodies never collide with the world boundary and never trigger a `worldbounds` event.)\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#onWorldBounds\r\n * @type {boolean}\r\n * @readonly\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 266, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether the simulation emits a `worldbounds` event when this StaticBody collides with the world boundary.\rAlways false for a Static Body. (Static Bodies never collide with the world boundary and never trigger a `worldbounds` event.)", "name": "onWorldBounds", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#onWorldBounds", "scope": "instance", "kind": "member", "___id": "T000002R029365", "___s": true }, { "comment": "/**\r\n * Whether the simulation emits a `collide` event when this StaticBody collides with another.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#onCollide\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 278, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether the simulation emits a `collide` event when this StaticBody collides with another.", "name": "onCollide", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#onCollide", "scope": "instance", "kind": "member", "___id": "T000002R029367", "___s": true }, { "comment": "/**\r\n * Whether the simulation emits an `overlap` event when this StaticBody overlaps with another.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#onOverlap\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 288, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether the simulation emits an `overlap` event when this StaticBody overlaps with another.", "name": "onOverlap", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#onOverlap", "scope": "instance", "kind": "member", "___id": "T000002R029369", "___s": true }, { "comment": "/**\r\n * The StaticBody's inertia, relative to a default unit (1). With `bounce`, this affects the exchange of momentum (velocities) during collisions.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#mass\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The StaticBody's inertia, relative to a default unit (1). With `bounce`, this affects the exchange of momentum (velocities) during collisions.", "name": "mass", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#mass", "scope": "instance", "kind": "member", "___id": "T000002R029371", "___s": true }, { "comment": "/**\r\n * Whether this object can be moved by collisions with another body.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#immovable\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 308, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this object can be moved by collisions with another body.", "name": "immovable", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#immovable", "scope": "instance", "kind": "member", "___id": "T000002R029373", "___s": true }, { "comment": "/**\r\n * Sets if this Body can be pushed by another Body.\r\n *\r\n * A body that cannot be pushed will reflect back all of the velocity it is given to the\r\n * colliding body. If that body is also not pushable, then the separation will be split\r\n * between them evenly.\r\n *\r\n * If you want your body to never move or seperate at all, see the `setImmovable` method.\r\n *\r\n * By default, Static Bodies are not pushable.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#pushable\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.50.0\r\n * @see Phaser.GameObjects.Components.Pushable#setPushable\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 318, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets if this Body can be pushed by another Body.\r\rA body that cannot be pushed will reflect back all of the velocity it is given to the\rcolliding body. If that body is also not pushable, then the separation will be split\rbetween them evenly.\r\rIf you want your body to never move or seperate at all, see the `setImmovable` method.\r\rBy default, Static Bodies are not pushable.", "name": "pushable", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.50.0", "see": [ "Phaser.GameObjects.Components.Pushable#setPushable" ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#pushable", "scope": "instance", "kind": "member", "___id": "T000002R029375", "___s": true }, { "comment": "/**\r\n * A flag disabling the default horizontal separation of colliding bodies. Pass your own `collideHandler` to the collider.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#customSeparateX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 337, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "A flag disabling the default horizontal separation of colliding bodies. Pass your own `collideHandler` to the collider.", "name": "customSeparateX", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#customSeparateX", "scope": "instance", "kind": "member", "___id": "T000002R029377", "___s": true }, { "comment": "/**\r\n * A flag disabling the default vertical separation of colliding bodies. Pass your own `collideHandler` to the collider.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#customSeparateY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 347, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "A flag disabling the default vertical separation of colliding bodies. Pass your own `collideHandler` to the collider.", "name": "customSeparateY", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#customSeparateY", "scope": "instance", "kind": "member", "___id": "T000002R029379", "___s": true }, { "comment": "/**\r\n * The amount of horizontal overlap (before separation), if this Body is colliding with another.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#overlapX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 357, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The amount of horizontal overlap (before separation), if this Body is colliding with another.", "name": "overlapX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#overlapX", "scope": "instance", "kind": "member", "___id": "T000002R029381", "___s": true }, { "comment": "/**\r\n * The amount of vertical overlap (before separation), if this Body is colliding with another.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#overlapY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 367, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The amount of vertical overlap (before separation), if this Body is colliding with another.", "name": "overlapY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#overlapY", "scope": "instance", "kind": "member", "___id": "T000002R029383", "___s": true }, { "comment": "/**\r\n * The amount of overlap (before separation), if this StaticBody is circular and colliding with another circular body.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#overlapR\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 377, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The amount of overlap (before separation), if this StaticBody is circular and colliding with another circular body.", "name": "overlapR", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#overlapR", "scope": "instance", "kind": "member", "___id": "T000002R029385", "___s": true }, { "comment": "/**\r\n * Whether this StaticBody has ever overlapped with another while both were not moving.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#embedded\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this StaticBody has ever overlapped with another while both were not moving.", "name": "embedded", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#embedded", "scope": "instance", "kind": "member", "___id": "T000002R029387", "___s": true }, { "comment": "/**\r\n * Whether this StaticBody interacts with the world boundary.\r\n * Always false for a Static Body. (Static Bodies never collide with the world boundary.)\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#collideWorldBounds\r\n * @type {boolean}\r\n * @readonly\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 397, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this StaticBody interacts with the world boundary.\rAlways false for a Static Body. (Static Bodies never collide with the world boundary.)", "name": "collideWorldBounds", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#collideWorldBounds", "scope": "instance", "kind": "member", "___id": "T000002R029389", "___s": true }, { "comment": "/**\r\n * Whether this StaticBody is checked for collisions and for which directions. You can set `checkCollision.none = false` to disable collision checks.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#checkCollision\r\n * @type {Phaser.Types.Physics.Arcade.ArcadeBodyCollision}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 409, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether this StaticBody is checked for collisions and for which directions. You can set `checkCollision.none = false` to disable collision checks.", "name": "checkCollision", "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#checkCollision", "scope": "instance", "kind": "member", "___id": "T000002R029391", "___s": true }, { "comment": "/**\r\n * This property is kept for compatibility with Dynamic Bodies.\r\n * Avoid using it.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#touching\r\n * @type {Phaser.Types.Physics.Arcade.ArcadeBodyCollision}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 418, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "This property is kept for compatibility with Dynamic Bodies.\rAvoid using it.", "name": "touching", "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#touching", "scope": "instance", "kind": "member", "___id": "T000002R029393", "___s": true }, { "comment": "/**\r\n * This property is kept for compatibility with Dynamic Bodies.\r\n * Avoid using it.\r\n * The values are always false for a Static Body.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#wasTouching\r\n * @type {Phaser.Types.Physics.Arcade.ArcadeBodyCollision}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 428, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "This property is kept for compatibility with Dynamic Bodies.\rAvoid using it.\rThe values are always false for a Static Body.", "name": "wasTouching", "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#wasTouching", "scope": "instance", "kind": "member", "___id": "T000002R029395", "___s": true }, { "comment": "/**\r\n * This property is kept for compatibility with Dynamic Bodies.\r\n * Avoid using it.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#blocked\r\n * @type {Phaser.Types.Physics.Arcade.ArcadeBodyCollision}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 439, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "This property is kept for compatibility with Dynamic Bodies.\rAvoid using it.", "name": "blocked", "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeBodyCollision" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#blocked", "scope": "instance", "kind": "member", "___id": "T000002R029397", "___s": true }, { "comment": "/**\r\n * The StaticBody's physics type (static by default).\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#physicsType\r\n * @type {number}\r\n * @default Phaser.Physics.Arcade.STATIC_BODY\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 449, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The StaticBody's physics type (static by default).", "name": "physicsType", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "Phaser.Physics.Arcade.STATIC_BODY", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#physicsType", "scope": "instance", "kind": "member", "___id": "T000002R029399", "___s": true }, { "comment": "/**\r\n * The Arcade Physics Body Collision Category.\r\n *\r\n * This can be set to any valid collision bitfield value.\r\n *\r\n * See the `setCollisionCategory` method for more details.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#collisionCategory\r\n * @type {number}\r\n * @since 3.61.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 459, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Arcade Physics Body Collision Category.\r\rThis can be set to any valid collision bitfield value.\r\rSee the `setCollisionCategory` method for more details.", "name": "collisionCategory", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.61.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#collisionCategory", "scope": "instance", "kind": "member", "___id": "T000002R029401", "___s": true }, { "comment": "/**\r\n * The Arcade Physics Body Collision Mask.\r\n *\r\n * See the `setCollidesWith` method for more details.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#collisionMask\r\n * @type {number}\r\n * @since 3.61.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 472, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Arcade Physics Body Collision Mask.\r\rSee the `setCollidesWith` method for more details.", "name": "collisionMask", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.61.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#collisionMask", "scope": "instance", "kind": "member", "___id": "T000002R029403", "___s": true }, { "comment": "/**\r\n * Changes the Game Object this Body is bound to.\r\n * First it removes its reference from the old Game Object, then sets the new one.\r\n * You can optionally update the position and dimensions of this Body to reflect that of the new Game Object.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#setGameObject\r\n * @since 3.1.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The new Game Object that will own this Body.\r\n * @param {boolean} [update=true] - Reposition and resize this Body to match the new Game Object?\r\n *\r\n * @return {Phaser.Physics.Arcade.StaticBody} This Static Body object.\r\n *\r\n * @see Phaser.Physics.Arcade.StaticBody#updateFromGameObject\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 508, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Changes the Game Object this Body is bound to.\rFirst it removes its reference from the old Game Object, then sets the new one.\rYou can optionally update the position and dimensions of this Body to reflect that of the new Game Object.", "kind": "function", "name": "setGameObject", "since": "3.1.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The new Game Object that will own this Body.", "name": "gameObject" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Reposition and resize this Body to match the new Game Object?", "name": "update" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } }, "description": "This Static Body object." } ], "see": [ "Phaser.Physics.Arcade.StaticBody#updateFromGameObject" ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#setGameObject", "scope": "instance", "___id": "T000002R029409", "___s": true }, { "comment": "/**\r\n * Syncs the Static Body's position and size with its parent Game Object.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#updateFromGameObject\r\n * @since 3.1.0\r\n *\r\n * @return {Phaser.Physics.Arcade.StaticBody} This Static Body object.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 544, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Syncs the Static Body's position and size with its parent Game Object.", "kind": "function", "name": "updateFromGameObject", "since": "3.1.0", "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } }, "description": "This Static Body object." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#updateFromGameObject", "scope": "instance", "___id": "T000002R029414", "___s": true }, { "comment": "/**\r\n * Positions the Static Body at an offset from its Game Object.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#setOffset\r\n * @since 3.4.0\r\n *\r\n * @param {number} x - The horizontal offset of the Static Body from the Game Object's `x`.\r\n * @param {number} y - The vertical offset of the Static Body from the Game Object's `y`.\r\n *\r\n * @return {Phaser.Physics.Arcade.StaticBody} This Static Body object.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 573, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Positions the Static Body at an offset from its Game Object.", "kind": "function", "name": "setOffset", "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal offset of the Static Body from the Game Object's `x`.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical offset of the Static Body from the Game Object's `y`.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } }, "description": "This Static Body object." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#setOffset", "scope": "instance", "___id": "T000002R029421", "___s": true }, { "comment": "/**\r\n * Sets the size of the Static Body.\r\n * When `center` is true, also repositions it.\r\n * Resets the width and height to match current frame, if no width and height provided and a frame is found.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#setSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} [width] - The width of the Static Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame width.\r\n * @param {number} [height] - The height of the Static Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame height.\r\n * @param {boolean} [center=true] - Place the Static Body's center on its Game Object's center. Only works if the Game Object has the `getCenter` method.\r\n *\r\n * @return {Phaser.Physics.Arcade.StaticBody} This Static Body object.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 605, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the size of the Static Body.\rWhen `center` is true, also repositions it.\rResets the width and height to match current frame, if no width and height provided and a frame is found.", "kind": "function", "name": "setSize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the Static Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame width.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the Static Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame height.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Place the Static Body's center on its Game Object's center. Only works if the Game Object has the `getCenter` method.", "name": "center" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } }, "description": "This Static Body object." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#setSize", "scope": "instance", "___id": "T000002R029428", "___s": true }, { "comment": "/**\r\n * Sets this Static Body to have a circular body and sets its size and position.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#setCircle\r\n * @since 3.0.0\r\n *\r\n * @param {number} radius - The radius of the StaticBody, in pixels.\r\n * @param {number} [offsetX] - The horizontal offset of the StaticBody from its Game Object, in pixels.\r\n * @param {number} [offsetY] - The vertical offset of the StaticBody from its Game Object, in pixels.\r\n *\r\n * @return {Phaser.Physics.Arcade.StaticBody} This Static Body object.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 670, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets this Static Body to have a circular body and sets its size and position.", "kind": "function", "name": "setCircle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the StaticBody, in pixels.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal offset of the StaticBody from its Game Object, in pixels.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The vertical offset of the StaticBody from its Game Object, in pixels.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } }, "description": "This Static Body object." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#setCircle", "scope": "instance", "___id": "T000002R029446", "___s": true }, { "comment": "/**\r\n * Updates the StaticBody's `center` from its `position` and dimensions.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#updateCenter\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 715, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Updates the StaticBody's `center` from its `position` and dimensions.", "kind": "function", "name": "updateCenter", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#updateCenter", "scope": "instance", "___id": "T000002R029457", "___s": true }, { "comment": "/**\r\n * Resets this Static Body to its parent Game Object's position.\r\n *\r\n * If `x` and `y` are given, the parent Game Object is placed there and this Static Body is centered on it.\r\n * Otherwise this Static Body is centered on the Game Object's current position.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#reset\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x] - The x coordinate to reset the body to. If not given will use the parent Game Object's coordinate.\r\n * @param {number} [y] - The y coordinate to reset the body to. If not given will use the parent Game Object's coordinate.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 726, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Resets this Static Body to its parent Game Object's position.\r\rIf `x` and `y` are given, the parent Game Object is placed there and this Static Body is centered on it.\rOtherwise this Static Body is centered on the Game Object's current position.", "kind": "function", "name": "reset", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The x coordinate to reset the body to. If not given will use the parent Game Object's coordinate.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y coordinate to reset the body to. If not given will use the parent Game Object's coordinate.", "name": "y" } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#reset", "scope": "instance", "___id": "T000002R029459", "___s": true }, { "comment": "/**\r\n * NOOP function. A Static Body cannot be stopped.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#stop\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Physics.Arcade.StaticBody} This Static Body object.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 756, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "NOOP function. A Static Body cannot be stopped.", "kind": "function", "name": "stop", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } }, "description": "This Static Body object." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#stop", "scope": "instance", "___id": "T000002R029464", "___s": true }, { "comment": "/**\r\n * Returns the x and y coordinates of the top left and bottom right points of the StaticBody.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#getBounds\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeBodyBounds} obj - The object which will hold the coordinates of the bounds.\r\n *\r\n * @return {Phaser.Types.Physics.Arcade.ArcadeBodyBounds} The same object that was passed with `x`, `y`, `right` and `bottom` values matching the respective values of the StaticBody.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 769, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Returns the x and y coordinates of the top left and bottom right points of the StaticBody.", "kind": "function", "name": "getBounds", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeBodyBounds" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeBodyBounds" } }, "description": "The object which will hold the coordinates of the bounds.", "name": "obj" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeBodyBounds" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeBodyBounds" } }, "description": "The same object that was passed with `x`, `y`, `right` and `bottom` values matching the respective values of the StaticBody." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#getBounds", "scope": "instance", "___id": "T000002R029466", "___s": true }, { "comment": "/**\r\n * Checks to see if a given x,y coordinate is colliding with this Static Body.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#hitTest\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate to check against this body.\r\n * @param {number} y - The y coordinate to check against this body.\r\n *\r\n * @return {boolean} `true` if the given coordinate lies within this body, otherwise `false`.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 789, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Checks to see if a given x,y coordinate is colliding with this Static Body.", "kind": "function", "name": "hitTest", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to check against this body.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to check against this body.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given coordinate lies within this body, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#hitTest", "scope": "instance", "___id": "T000002R029472", "___s": true }, { "comment": "/**\r\n * NOOP\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#postUpdate\r\n * @since 3.12.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 805, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "NOOP", "kind": "function", "name": "postUpdate", "since": "3.12.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#postUpdate", "scope": "instance", "___id": "T000002R029474", "___s": true }, { "comment": "/**\r\n * The absolute (non-negative) change in this StaticBody's horizontal position from the previous step. Always zero.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#deltaAbsX\r\n * @since 3.0.0\r\n *\r\n * @return {number} Always zero for a Static Body.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 815, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The absolute (non-negative) change in this StaticBody's horizontal position from the previous step. Always zero.", "kind": "function", "name": "deltaAbsX", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Always zero for a Static Body." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#deltaAbsX", "scope": "instance", "___id": "T000002R029476", "___s": true }, { "comment": "/**\r\n * The absolute (non-negative) change in this StaticBody's vertical position from the previous step. Always zero.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#deltaAbsY\r\n * @since 3.0.0\r\n *\r\n * @return {number} Always zero for a Static Body.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 828, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The absolute (non-negative) change in this StaticBody's vertical position from the previous step. Always zero.", "kind": "function", "name": "deltaAbsY", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Always zero for a Static Body." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#deltaAbsY", "scope": "instance", "___id": "T000002R029478", "___s": true }, { "comment": "/**\r\n * The change in this StaticBody's horizontal position from the previous step. Always zero.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#deltaX\r\n * @since 3.0.0\r\n *\r\n * @return {number} The change in this StaticBody's velocity from the previous step. Always zero.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 841, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The change in this StaticBody's horizontal position from the previous step. Always zero.", "kind": "function", "name": "deltaX", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The change in this StaticBody's velocity from the previous step. Always zero." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#deltaX", "scope": "instance", "___id": "T000002R029480", "___s": true }, { "comment": "/**\r\n * The change in this StaticBody's vertical position from the previous step. Always zero.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#deltaY\r\n * @since 3.0.0\r\n *\r\n * @return {number} The change in this StaticBody's velocity from the previous step. Always zero.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 854, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The change in this StaticBody's vertical position from the previous step. Always zero.", "kind": "function", "name": "deltaY", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The change in this StaticBody's velocity from the previous step. Always zero." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#deltaY", "scope": "instance", "___id": "T000002R029482", "___s": true }, { "comment": "/**\r\n * The change in this StaticBody's rotation from the previous step. Always zero.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#deltaZ\r\n * @since 3.0.0\r\n *\r\n * @return {number} The change in this StaticBody's rotation from the previous step. Always zero.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The change in this StaticBody's rotation from the previous step. Always zero.", "kind": "function", "name": "deltaZ", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The change in this StaticBody's rotation from the previous step. Always zero." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#deltaZ", "scope": "instance", "___id": "T000002R029484", "___s": true }, { "comment": "/**\r\n * Disables this Body and marks it for destruction during the next step.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 880, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Disables this Body and marks it for destruction during the next step.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#destroy", "scope": "instance", "___id": "T000002R029486", "___s": true }, { "comment": "/**\r\n * Draws a graphical representation of the StaticBody for visual debugging purposes.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#drawDebug\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Graphics} graphic - The Graphics object to use for the debug drawing of the StaticBody.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 893, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Draws a graphical representation of the StaticBody for visual debugging purposes.", "kind": "function", "name": "drawDebug", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics object to use for the debug drawing of the StaticBody.", "name": "graphic" } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#drawDebug", "scope": "instance", "___id": "T000002R029489", "___s": true }, { "comment": "/**\r\n * Indicates whether the StaticBody is going to be showing a debug visualization during postUpdate.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#willDrawDebug\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} Whether or not the StaticBody is going to show the debug visualization during postUpdate.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 924, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Indicates whether the StaticBody is going to be showing a debug visualization during postUpdate.", "kind": "function", "name": "willDrawDebug", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether or not the StaticBody is going to show the debug visualization during postUpdate." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#willDrawDebug", "scope": "instance", "___id": "T000002R029494", "___s": true }, { "comment": "/**\r\n * Sets the Mass of the StaticBody. Will set the Mass to 0.1 if the value passed is less than or equal to zero.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticBody#setMass\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value to set the Mass to. Values of zero or less are changed to 0.1.\r\n *\r\n * @return {Phaser.Physics.Arcade.StaticBody} This Static Body object.\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 937, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the Mass of the StaticBody. Will set the Mass to 0.1 if the value passed is less than or equal to zero.", "kind": "function", "name": "setMass", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to set the Mass to. Values of zero or less are changed to 0.1.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } }, "description": "This Static Body object." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#setMass", "scope": "instance", "___id": "T000002R029496", "___s": true }, { "comment": "/**\r\n * The x coordinate of the StaticBody.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#x\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 960, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The x coordinate of the StaticBody.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#x", "scope": "instance", "kind": "member", "___id": "T000002R029500", "___s": true }, { "comment": "/**\r\n * The y coordinate of the StaticBody.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#y\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 985, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The y coordinate of the StaticBody.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#y", "scope": "instance", "kind": "member", "___id": "T000002R029505", "___s": true }, { "comment": "/**\r\n * Returns the left-most x coordinate of the area of the StaticBody.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#left\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 1010, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Returns the left-most x coordinate of the area of the StaticBody.", "name": "left", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#left", "scope": "instance", "kind": "member", "___id": "T000002R029510", "___s": true }, { "comment": "/**\r\n * The right-most x coordinate of the area of the StaticBody.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#right\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 1027, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The right-most x coordinate of the area of the StaticBody.", "name": "right", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#right", "scope": "instance", "kind": "member", "___id": "T000002R029513", "___s": true }, { "comment": "/**\r\n * The highest y coordinate of the area of the StaticBody.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#top\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 1044, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The highest y coordinate of the area of the StaticBody.", "name": "top", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#top", "scope": "instance", "kind": "member", "___id": "T000002R029516", "___s": true }, { "comment": "/**\r\n * The lowest y coordinate of the area of the StaticBody. (y + height)\r\n *\r\n * @name Phaser.Physics.Arcade.StaticBody#bottom\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticBody.js", "lineno": 1061, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The lowest y coordinate of the area of the StaticBody. (y + height)", "name": "bottom", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticBody", "longname": "Phaser.Physics.Arcade.StaticBody#bottom", "scope": "instance", "kind": "member", "___id": "T000002R029519", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * An Arcade Physics Static Group object.\r\n *\r\n * All Game Objects created by or added to this Group will automatically be given static Arcade Physics bodies, if they have no body.\r\n *\r\n * Its dynamic counterpart is {@link Phaser.Physics.Arcade.Group}.\r\n *\r\n * @class StaticGroup\r\n * @extends Phaser.GameObjects.Group\r\n * @memberof Phaser.Physics.Arcade\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.Physics.Arcade.Components.Collision\r\n *\r\n * @param {Phaser.Physics.Arcade.World} world - The physics simulation.\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.\r\n */", "meta": { "filename": "StaticPhysicsGroup.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "classdesc": "An Arcade Physics Static Group object.\r\rAll Game Objects created by or added to this Group will automatically be given static Arcade Physics bodies, if they have no body.\r\rIts dynamic counterpart is {@link Phaser.Physics.Arcade.Group}.", "kind": "class", "name": "StaticGroup", "augments": [ "Phaser.GameObjects.Group", "Phaser.Physics.Arcade.Components.Collision" ], "memberof": "Phaser.Physics.Arcade", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "description": "The physics simulation.", "name": "world" }, { "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.", "name": "config" } ], "scope": "static", "longname": "Phaser.Physics.Arcade.StaticGroup", "___id": "T000002R029530", "___s": true }, { "comment": "/**\r\n * The physics simulation.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticGroup#world\r\n * @type {Phaser.Physics.Arcade.World}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticPhysicsGroup.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The physics simulation.", "name": "world", "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "longname": "Phaser.Physics.Arcade.StaticGroup#world", "scope": "instance", "kind": "member", "___id": "T000002R029555", "___s": true }, { "comment": "/**\r\n * The scene this group belongs to.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticGroup#physicsType\r\n * @type {number}\r\n * @default Phaser.Physics.Arcade.STATIC_BODY\r\n * @since 3.0.0\r\n */", "meta": { "filename": "StaticPhysicsGroup.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The scene this group belongs to.", "name": "physicsType", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "Phaser.Physics.Arcade.STATIC_BODY", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "longname": "Phaser.Physics.Arcade.StaticGroup#physicsType", "scope": "instance", "kind": "member", "___id": "T000002R029557", "___s": true }, { "comment": "/**\r\n * The Arcade Physics Static Group Collision Category.\r\n *\r\n * This can be set to any valid collision bitfield value.\r\n *\r\n * See the `setCollisionCategory` method for more details.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticGroup#collisionCategory\r\n * @type {number}\r\n * @since 3.61.0\r\n */", "meta": { "filename": "StaticPhysicsGroup.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Arcade Physics Static Group Collision Category.\r\rThis can be set to any valid collision bitfield value.\r\rSee the `setCollisionCategory` method for more details.", "name": "collisionCategory", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.61.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "longname": "Phaser.Physics.Arcade.StaticGroup#collisionCategory", "scope": "instance", "kind": "member", "___id": "T000002R029559", "___s": true }, { "comment": "/**\r\n * The Arcade Physics Static Group Collision Mask.\r\n *\r\n * See the `setCollidesWith` method for more details.\r\n *\r\n * @name Phaser.Physics.Arcade.StaticGroup#collisionMask\r\n * @type {number}\r\n * @since 3.61.0\r\n */", "meta": { "filename": "StaticPhysicsGroup.js", "lineno": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Arcade Physics Static Group Collision Mask.\r\rSee the `setCollidesWith` method for more details.", "name": "collisionMask", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.61.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "longname": "Phaser.Physics.Arcade.StaticGroup#collisionMask", "scope": "instance", "kind": "member", "___id": "T000002R029561", "___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.Physics.Arcade.StaticGroup#type\r\n * @type {string}\r\n * @default 'StaticPhysicsGroup'\r\n * @since 3.21.0\r\n */", "meta": { "filename": "StaticPhysicsGroup.js", "lineno": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "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": "'StaticPhysicsGroup'", "since": "3.21.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "longname": "Phaser.Physics.Arcade.StaticGroup#type", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Group#type", "___id": "T000002R029563", "___s": true }, { "comment": "/**\r\n * Adds a static physics body to the new group member (if it lacks one) and adds it to the simulation.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticGroup#createCallbackHandler\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The new group member.\r\n *\r\n * @see Phaser.Physics.Arcade.World#enableBody\r\n */", "meta": { "filename": "StaticPhysicsGroup.js", "lineno": 148, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Adds a static physics body to the new group member (if it lacks one) and adds it to the simulation.", "kind": "function", "name": "createCallbackHandler", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The new group member.", "name": "child" } ], "see": [ "Phaser.Physics.Arcade.World#enableBody" ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "longname": "Phaser.Physics.Arcade.StaticGroup#createCallbackHandler", "scope": "instance", "___id": "T000002R029565", "___s": true }, { "comment": "/**\r\n * Disables the group member's physics body, removing it from the simulation.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticGroup#removeCallbackHandler\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The group member being removed.\r\n *\r\n * @see Phaser.Physics.Arcade.World#disableBody\r\n */", "meta": { "filename": "StaticPhysicsGroup.js", "lineno": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Disables the group member's physics body, removing it from the simulation.", "kind": "function", "name": "removeCallbackHandler", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The group member being removed.", "name": "child" } ], "see": [ "Phaser.Physics.Arcade.World#disableBody" ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "longname": "Phaser.Physics.Arcade.StaticGroup#removeCallbackHandler", "scope": "instance", "___id": "T000002R029567", "___s": true }, { "comment": "/**\r\n * Refreshes the group.\r\n *\r\n * @method Phaser.Physics.Arcade.StaticGroup#createMultipleCallbackHandler\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject[]} entries - The newly created group members.\r\n *\r\n * @see Phaser.Physics.Arcade.StaticGroup#refresh\r\n */", "meta": { "filename": "StaticPhysicsGroup.js", "lineno": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Refreshes the group.", "kind": "function", "name": "createMultipleCallbackHandler", "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": "entries" } ], "see": [ "Phaser.Physics.Arcade.StaticGroup#refresh" ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "longname": "Phaser.Physics.Arcade.StaticGroup#createMultipleCallbackHandler", "scope": "instance", "___id": "T000002R029569", "___s": true }, { "comment": "/**\r\n * Resets each Body to the position of its parent Game Object.\r\n * Body sizes aren't changed (use {@link Phaser.Physics.Arcade.Components.Enable#refreshBody} for that).\r\n *\r\n * @method Phaser.Physics.Arcade.StaticGroup#refresh\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Physics.Arcade.StaticGroup} This group.\r\n *\r\n * @see Phaser.Physics.Arcade.StaticBody#reset\r\n */", "meta": { "filename": "StaticPhysicsGroup.js", "lineno": 199, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Resets each Body to the position of its parent Game Object.\rBody sizes aren't changed (use {@link Phaser.Physics.Arcade.Components.Enable#refreshBody} for that).", "kind": "function", "name": "refresh", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.StaticGroup" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticGroup" } }, "description": "This group." } ], "see": [ "Phaser.Physics.Arcade.StaticBody#reset" ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "longname": "Phaser.Physics.Arcade.StaticGroup#refresh", "scope": "instance", "___id": "T000002R029571", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Physics.Arcade.Tilemap\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\tilemap", "code": {} }, "kind": "namespace", "name": "Tilemap", "memberof": "Phaser.Physics.Arcade", "longname": "Phaser.Physics.Arcade.Tilemap", "scope": "static", "___id": "T000002R029576", "___s": true }, { "comment": "/**\r\n * A function to process the collision callbacks between a single tile and an Arcade Physics enabled Game Object.\r\n *\r\n * @function Phaser.Physics.Arcade.Tilemap.ProcessTileCallbacks\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Tilemaps.Tile} tile - The Tile to process.\r\n * @param {Phaser.GameObjects.Sprite} sprite - The Game Object to process with the Tile.\r\n *\r\n * @return {boolean} The result of the callback, `true` for further processing, or `false` to skip this pair.\r\n */", "meta": { "filename": "ProcessTileCallbacks.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\tilemap", "code": {} }, "description": "A function to process the collision callbacks between a single tile and an Arcade Physics enabled Game Object.", "kind": "function", "name": "ProcessTileCallbacks", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The Tile to process.", "name": "tile" }, { "type": { "names": [ "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "The Game Object to process with the Tile.", "name": "sprite" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The result of the callback, `true` for further processing, or `false` to skip this pair." } ], "memberof": "Phaser.Physics.Arcade.Tilemap", "longname": "Phaser.Physics.Arcade.Tilemap.ProcessTileCallbacks", "scope": "static", "___id": "T000002R029586", "___s": true }, { "comment": "/**\r\n * Internal function to process the separation of a physics body from a tile.\r\n *\r\n * @function Phaser.Physics.Arcade.Tilemap.ProcessTileSeparationX\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Body} body - The Body object to separate.\r\n * @param {number} x - The x separation amount.\r\n */", "meta": { "filename": "ProcessTileSeparationX.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\tilemap", "code": {} }, "description": "Internal function to process the separation of a physics body from a tile.", "kind": "function", "name": "ProcessTileSeparationX", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The Body object to separate.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x separation amount.", "name": "x" } ], "memberof": "Phaser.Physics.Arcade.Tilemap", "longname": "Phaser.Physics.Arcade.Tilemap.ProcessTileSeparationX", "scope": "static", "___id": "T000002R029589", "___s": true }, { "comment": "/**\r\n * Internal function to process the separation of a physics body from a tile.\r\n *\r\n * @function Phaser.Physics.Arcade.Tilemap.ProcessTileSeparationY\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Body} body - The Body object to separate.\r\n * @param {number} y - The y separation amount.\r\n */", "meta": { "filename": "ProcessTileSeparationY.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\tilemap", "code": {} }, "description": "Internal function to process the separation of a physics body from a tile.", "kind": "function", "name": "ProcessTileSeparationY", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The Body object to separate.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y separation amount.", "name": "y" } ], "memberof": "Phaser.Physics.Arcade.Tilemap", "longname": "Phaser.Physics.Arcade.Tilemap.ProcessTileSeparationY", "scope": "static", "___id": "T000002R029599", "___s": true }, { "comment": "/**\r\n * The core separation function to separate a physics body and a tile.\r\n *\r\n * @function Phaser.Physics.Arcade.Tilemap.SeparateTile\r\n * @since 3.0.0\r\n *\r\n * @param {number} i - The index of the tile within the map data.\r\n * @param {Phaser.Physics.Arcade.Body} body - The Body object to separate.\r\n * @param {Phaser.Tilemaps.Tile} tile - The tile to collide against.\r\n * @param {Phaser.Geom.Rectangle} tileWorldRect - A rectangle-like object defining the dimensions of the tile.\r\n * @param {Phaser.Tilemaps.TilemapLayer} tilemapLayer - The tilemapLayer to collide against.\r\n * @param {number} tileBias - The tile bias value. Populated by the `World.TILE_BIAS` constant.\r\n * @param {boolean} isLayer - Is this check coming from a TilemapLayer or an array of tiles?\r\n *\r\n * @return {boolean} `true` if the body was separated, otherwise `false`.\r\n */", "meta": { "filename": "SeparateTile.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\tilemap", "code": {} }, "description": "The core separation function to separate a physics body and a tile.", "kind": "function", "name": "SeparateTile", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the tile within the map data.", "name": "i" }, { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The Body object to separate.", "name": "body" }, { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The tile to collide against.", "name": "tile" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "A rectangle-like object defining the dimensions of the tile.", "name": "tileWorldRect" }, { "type": { "names": [ "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } }, "description": "The tilemapLayer to collide against.", "name": "tilemapLayer" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tile bias value. Populated by the `World.TILE_BIAS` constant.", "name": "tileBias" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this check coming from a TilemapLayer or an array of tiles?", "name": "isLayer" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the body was separated, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade.Tilemap", "longname": "Phaser.Physics.Arcade.Tilemap.SeparateTile", "scope": "static", "___id": "T000002R029612", "___s": true }, { "comment": "/**\r\n * Check the body against the given tile on the X axis.\r\n * Used internally by the SeparateTile function.\r\n *\r\n * @function Phaser.Physics.Arcade.Tilemap.TileCheckX\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Body} body - The Body object to separate.\r\n * @param {Phaser.Tilemaps.Tile} tile - The tile to check.\r\n * @param {number} tileLeft - The left position of the tile within the tile world.\r\n * @param {number} tileRight - The right position of the tile within the tile world.\r\n * @param {number} tileBias - The tile bias value. Populated by the `World.TILE_BIAS` constant.\r\n * @param {boolean} isLayer - Is this check coming from a TilemapLayer or an array of tiles?\r\n *\r\n * @return {number} The amount of separation that occurred.\r\n */", "meta": { "filename": "TileCheckX.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\tilemap", "code": {} }, "description": "Check the body against the given tile on the X axis.\rUsed internally by the SeparateTile function.", "kind": "function", "name": "TileCheckX", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The Body object to separate.", "name": "body" }, { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The tile to check.", "name": "tile" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left position of the tile within the tile world.", "name": "tileLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The right position of the tile within the tile world.", "name": "tileRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tile bias value. Populated by the `World.TILE_BIAS` constant.", "name": "tileBias" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this check coming from a TilemapLayer or an array of tiles?", "name": "isLayer" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of separation that occurred." } ], "memberof": "Phaser.Physics.Arcade.Tilemap", "longname": "Phaser.Physics.Arcade.Tilemap.TileCheckX", "scope": "static", "___id": "T000002R029636", "___s": true }, { "comment": "/**\r\n * Check the body against the given tile on the Y axis.\r\n * Used internally by the SeparateTile function.\r\n *\r\n * @function Phaser.Physics.Arcade.Tilemap.TileCheckY\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Body} body - The Body object to separate.\r\n * @param {Phaser.Tilemaps.Tile} tile - The tile to check.\r\n * @param {number} tileTop - The top position of the tile within the tile world.\r\n * @param {number} tileBottom - The bottom position of the tile within the tile world.\r\n * @param {number} tileBias - The tile bias value. Populated by the `World.TILE_BIAS` constant.\r\n * @param {boolean} isLayer - Is this check coming from a TilemapLayer or an array of tiles?\r\n *\r\n * @return {number} The amount of separation that occurred.\r\n */", "meta": { "filename": "TileCheckY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\tilemap", "code": {} }, "description": "Check the body against the given tile on the Y axis.\rUsed internally by the SeparateTile function.", "kind": "function", "name": "TileCheckY", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The Body object to separate.", "name": "body" }, { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The tile to check.", "name": "tile" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top position of the tile within the tile world.", "name": "tileTop" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom position of the tile within the tile world.", "name": "tileBottom" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tile bias value. Populated by the `World.TILE_BIAS` constant.", "name": "tileBias" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this check coming from a TilemapLayer or an array of tiles?", "name": "isLayer" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of separation that occurred." } ], "memberof": "Phaser.Physics.Arcade.Tilemap", "longname": "Phaser.Physics.Arcade.Tilemap.TileCheckY", "scope": "static", "___id": "T000002R029654", "___s": true }, { "comment": "/**\r\n * Checks for intersection between the given tile rectangle-like object and an Arcade Physics body.\r\n *\r\n * @function Phaser.Physics.Arcade.Tilemap.TileIntersectsBody\r\n * @since 3.0.0\r\n *\r\n * @param {{ left: number, right: number, top: number, bottom: number }} tileWorldRect - A rectangle object that defines the tile placement in the world.\r\n * @param {Phaser.Physics.Arcade.Body} body - The body to check for intersection against.\r\n *\r\n * @return {boolean} Returns `true` of the tile intersects with the body, otherwise `false`.\r\n */", "meta": { "filename": "TileIntersectsBody.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\tilemap", "code": {} }, "description": "Checks for intersection between the given tile rectangle-like object and an Arcade Physics body.", "kind": "function", "name": "TileIntersectsBody", "since": "3.0.0", "params": [ { "type": { "names": [ "Object" ], "parsedType": { "type": "RecordType", "fields": [ { "type": "FieldType", "key": { "type": "NameExpression", "name": "left" }, "value": { "type": "NameExpression", "name": "number" } }, { "type": "FieldType", "key": { "type": "NameExpression", "name": "right" }, "value": { "type": "NameExpression", "name": "number" } }, { "type": "FieldType", "key": { "type": "NameExpression", "name": "top" }, "value": { "type": "NameExpression", "name": "number" } }, { "type": "FieldType", "key": { "type": "NameExpression", "name": "bottom" }, "value": { "type": "NameExpression", "name": "number" } } ] } }, "description": "A rectangle object that defines the tile placement in the world.", "name": "tileWorldRect" }, { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The body to check for intersection against.", "name": "body" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `true` of the tile intersects with the body, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade.Tilemap", "longname": "Phaser.Physics.Arcade.Tilemap.TileIntersectsBody", "scope": "static", "___id": "T000002R029671", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Arcade.ArcadeBodyBounds\r\n * @since 3.0.0\r\n *\r\n * @property {number} x - The left edge.\r\n * @property {number} y - The upper edge.\r\n * @property {number} right - The right edge.\r\n * @property {number} bottom - The lower edge.\r\n */", "meta": { "filename": "ArcadeBodyBounds.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "typedef", "name": "ArcadeBodyBounds", "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.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The upper edge.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The right edge.", "name": "right" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The lower edge.", "name": "bottom" } ], "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.ArcadeBodyBounds", "scope": "static", "___id": "T000002R029674", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Arcade.ArcadeBodyCollision\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} none - True if the Body is not colliding.\r\n * @property {boolean} up - True if the Body is colliding on its upper edge.\r\n * @property {boolean} down - True if the Body is colliding on its lower edge.\r\n * @property {boolean} left - True if the Body is colliding on its left edge.\r\n * @property {boolean} right - True if the Body is colliding on its right edge.\r\n */", "meta": { "filename": "ArcadeBodyCollision.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "typedef", "name": "ArcadeBodyCollision", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Body is not colliding.", "name": "none" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Body is colliding on its upper edge.", "name": "up" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Body is colliding on its lower edge.", "name": "down" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Body is colliding on its left edge.", "name": "left" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Body is colliding on its right edge.", "name": "right" } ], "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.ArcadeBodyCollision", "scope": "static", "___id": "T000002R029675", "___s": true }, { "comment": "/**\r\n * An Arcade Physics Collider Type.\r\n *\r\n * @typedef {(Phaser.Physics.Arcade.Sprite|Phaser.Physics.Arcade.Image|Phaser.Physics.Arcade.StaticGroup|Phaser.Physics.Arcade.Group|Phaser.Tilemaps.TilemapLayer)} Phaser.Types.Physics.Arcade.ArcadeCollider\r\n * @since 3.61.0\r\n */", "meta": { "filename": "ArcadeCollider.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "description": "An Arcade Physics Collider Type.", "kind": "typedef", "name": "ArcadeCollider", "type": { "names": [ "Phaser.Physics.Arcade.Sprite", "Phaser.Physics.Arcade.Image", "Phaser.Physics.Arcade.StaticGroup", "Phaser.Physics.Arcade.Group", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Sprite" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Image" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticGroup" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Group" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "since": "3.61.0", "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.ArcadeCollider", "scope": "static", "___id": "T000002R029676", "___s": true }, { "comment": "/**\r\n * An Arcade Physics Collider Type.\r\n *\r\n * @typedef {(Phaser.GameObjects.GameObject|Phaser.GameObjects.Group|Phaser.Physics.Arcade.Sprite|Phaser.Physics.Arcade.Image|Phaser.Physics.Arcade.StaticGroup|Phaser.Physics.Arcade.Group|Phaser.Tilemaps.TilemapLayer|Phaser.GameObjects.GameObject[]|Phaser.Physics.Arcade.Sprite[]|Phaser.Physics.Arcade.Image[]|Phaser.Physics.Arcade.StaticGroup[]|Phaser.Physics.Arcade.Group[]|Phaser.Tilemaps.TilemapLayer[])} Phaser.Types.Physics.Arcade.ArcadeColliderType\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ArcadeColliderType.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "description": "An Arcade Physics Collider Type.", "kind": "typedef", "name": "ArcadeColliderType", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Group", "Phaser.Physics.Arcade.Sprite", "Phaser.Physics.Arcade.Image", "Phaser.Physics.Arcade.StaticGroup", "Phaser.Physics.Arcade.Group", "Phaser.Tilemaps.TilemapLayer", "Array.", "Array.", "Array.", "Array.", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Group" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Sprite" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Image" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticGroup" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Group" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Physics.Arcade.Sprite", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Physics.Arcade.Image", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Physics.Arcade.StaticGroup", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Physics.Arcade.Group", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.TilemapLayer", "type": "NameExpression" } ] } ] } }, "since": "3.0.0", "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.ArcadeColliderType", "scope": "static", "___id": "T000002R029677", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Physics.Arcade.ArcadePhysicsCallback\r\n *\r\n * A callback receiving two Game Objects.\r\n *\r\n * When colliding a single sprite with a Group or TilemapLayer, `object1` is always the sprite.\r\n *\r\n * For all other cases, `object1` and `object2` match the same arguments in `collide()` or `overlap()`.\r\n *\r\n * @param {(Phaser.Types.Physics.Arcade.GameObjectWithBody|Phaser.Tilemaps.Tile)} object1 - The first Game Object.\r\n * @param {(Phaser.Types.Physics.Arcade.GameObjectWithBody|Phaser.Tilemaps.Tile)} object2 - The second Game Object.\r\n */", "meta": { "filename": "ArcadePhysicsCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "typedef", "name": "ArcadePhysicsCallback", "type": { "names": [ "function" ] }, "params": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.GameObjectWithBody", "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.GameObjectWithBody" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } ] } }, "description": "The first Game Object.", "name": "object1" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.GameObjectWithBody", "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.GameObjectWithBody" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } ] } }, "description": "The second Game Object.", "name": "object2" } ], "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback", "scope": "static", "___id": "T000002R029678", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Arcade.ArcadeWorldConfig\r\n * @since 3.0.0\r\n *\r\n * @property {number} [fps=60] - Sets {@link Phaser.Physics.Arcade.World#fps}.\r\n * @property {boolean} [fixedStep=true] - Sets {@link Phaser.Physics.Arcade.World#fixedStep}.\r\n * @property {number} [timeScale=1] - Sets {@link Phaser.Physics.Arcade.World#timeScale}.\r\n * @property {Phaser.Types.Math.Vector2Like} [gravity] - Sets {@link Phaser.Physics.Arcade.World#gravity}.\r\n * @property {number} [x=0] - Sets {@link Phaser.Physics.Arcade.World#bounds bounds.x}.\r\n * @property {number} [y=0] - Sets {@link Phaser.Physics.Arcade.World#bounds bounds.y}.\r\n * @property {number} [width=0] - Sets {@link Phaser.Physics.Arcade.World#bounds bounds.width}.\r\n * @property {number} [height=0] - Sets {@link Phaser.Physics.Arcade.World#bounds bounds.height}.\r\n * @property {Phaser.Types.Physics.Arcade.CheckCollisionObject} [checkCollision] - Sets {@link Phaser.Physics.Arcade.World#checkCollision}.\r\n * @property {number} [overlapBias=4] - Sets {@link Phaser.Physics.Arcade.World#OVERLAP_BIAS}.\r\n * @property {number} [tileBias=16] - Sets {@link Phaser.Physics.Arcade.World#TILE_BIAS}.\r\n * @property {boolean} [forceX=false] - Sets {@link Phaser.Physics.Arcade.World#forceX}.\r\n * @property {boolean} [isPaused=false] - Sets {@link Phaser.Physics.Arcade.World#isPaused}.\r\n * @property {boolean} [debug=false] - Sets {@link Phaser.Physics.Arcade.World#debug}.\r\n * @property {boolean} [debugShowBody=true] - Sets {@link Phaser.Physics.Arcade.World#defaults debugShowBody}.\r\n * @property {boolean} [debugShowStaticBody=true] - Sets {@link Phaser.Physics.Arcade.World#defaults debugShowStaticBody}.\r\n * @property {boolean} [debugShowVelocity=true] - Sets {@link Phaser.Physics.Arcade.World#defaults debugShowStaticBody}.\r\n * @property {number} [debugBodyColor=0xff00ff] - Sets {@link Phaser.Physics.Arcade.World#defaults bodyDebugColor}.\r\n * @property {number} [debugStaticBodyColor=0x0000ff] - Sets {@link Phaser.Physics.Arcade.World#defaults staticBodyDebugColor}.\r\n * @property {number} [debugVelocityColor=0x00ff00] - Sets {@link Phaser.Physics.Arcade.World#defaults velocityDebugColor}.\r\n * @property {number} [maxEntries=16] - Sets {@link Phaser.Physics.Arcade.World#maxEntries}.\r\n * @property {boolean} [useTree=true] - Sets {@link Phaser.Physics.Arcade.World#useTree}.\r\n * @property {boolean} [customUpdate=false] - If enabled, you need to call `World.update` yourself.\r\n */", "meta": { "filename": "ArcadeWorldConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "typedef", "name": "ArcadeWorldConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 60, "description": "Sets {@link Phaser.Physics.Arcade.World#fps}.", "name": "fps" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Sets {@link Phaser.Physics.Arcade.World#fixedStep}.", "name": "fixedStep" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Sets {@link Phaser.Physics.Arcade.World#timeScale}.", "name": "timeScale" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "Sets {@link Phaser.Physics.Arcade.World#gravity}.", "name": "gravity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.World#bounds bounds.x}.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.World#bounds bounds.y}.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.World#bounds bounds.width}.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.World#bounds bounds.height}.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.CheckCollisionObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.CheckCollisionObject" } }, "optional": true, "description": "Sets {@link Phaser.Physics.Arcade.World#checkCollision}.", "name": "checkCollision" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 4, "description": "Sets {@link Phaser.Physics.Arcade.World#OVERLAP_BIAS}.", "name": "overlapBias" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 16, "description": "Sets {@link Phaser.Physics.Arcade.World#TILE_BIAS}.", "name": "tileBias" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Sets {@link Phaser.Physics.Arcade.World#forceX}.", "name": "forceX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Sets {@link Phaser.Physics.Arcade.World#isPaused}.", "name": "isPaused" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Sets {@link Phaser.Physics.Arcade.World#debug}.", "name": "debug" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Sets {@link Phaser.Physics.Arcade.World#defaults debugShowBody}.", "name": "debugShowBody" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Sets {@link Phaser.Physics.Arcade.World#defaults debugShowStaticBody}.", "name": "debugShowStaticBody" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Sets {@link Phaser.Physics.Arcade.World#defaults debugShowStaticBody}.", "name": "debugShowVelocity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xff00ff", "description": "Sets {@link Phaser.Physics.Arcade.World#defaults bodyDebugColor}.", "name": "debugBodyColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x0000ff", "description": "Sets {@link Phaser.Physics.Arcade.World#defaults staticBodyDebugColor}.", "name": "debugStaticBodyColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x00ff00", "description": "Sets {@link Phaser.Physics.Arcade.World#defaults velocityDebugColor}.", "name": "debugVelocityColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 16, "description": "Sets {@link Phaser.Physics.Arcade.World#maxEntries}.", "name": "maxEntries" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Sets {@link Phaser.Physics.Arcade.World#useTree}.", "name": "useTree" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If enabled, you need to call `World.update` yourself.", "name": "customUpdate" } ], "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.ArcadeWorldConfig", "scope": "static", "___id": "T000002R029679", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Arcade.ArcadeWorldDefaults\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} debugShowBody - Set to `true` to render dynamic body outlines to the debug display.\r\n * @property {boolean} debugShowStaticBody - Set to `true` to render static body outlines to the debug display.\r\n * @property {boolean} debugShowVelocity - Set to `true` to render body velocity markers to the debug display.\r\n * @property {number} bodyDebugColor - The color of dynamic body outlines when rendered to the debug display.\r\n * @property {number} staticBodyDebugColor - The color of static body outlines when rendered to the debug display.\r\n * @property {number} velocityDebugColor - The color of the velocity markers when rendered to the debug display.\r\n */", "meta": { "filename": "ArcadeWorldDefaults.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "typedef", "name": "ArcadeWorldDefaults", "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` to render dynamic body outlines to the debug display.", "name": "debugShowBody" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to `true` to render static body outlines to the debug display.", "name": "debugShowStaticBody" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to `true` to render body velocity markers to the debug display.", "name": "debugShowVelocity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The color of dynamic body outlines when rendered to the debug display.", "name": "bodyDebugColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The color of static body outlines when rendered to the debug display.", "name": "staticBodyDebugColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The color of the velocity markers when rendered to the debug display.", "name": "velocityDebugColor" } ], "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.ArcadeWorldDefaults", "scope": "static", "___id": "T000002R029680", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Arcade.ArcadeWorldTreeMinMax\r\n * @since 3.0.0\r\n *\r\n * @property {number} minX - The minimum x value used in RTree searches.\r\n * @property {number} minY - The minimum y value used in RTree searches.\r\n * @property {number} maxX - The maximum x value used in RTree searches.\r\n * @property {number} maxY - The maximum y value used in RTree searches.\r\n */", "meta": { "filename": "ArcadeWorldTreeMinMax.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "typedef", "name": "ArcadeWorldTreeMinMax", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum x value used in RTree searches.", "name": "minX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum y value used in RTree searches.", "name": "minY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum x value used in RTree searches.", "name": "maxX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum y value used in RTree searches.", "name": "maxY" } ], "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.ArcadeWorldTreeMinMax", "scope": "static", "___id": "T000002R029681", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Arcade.CheckCollisionObject\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} up - Will bodies collide with the top side of the world bounds?\r\n * @property {boolean} down - Will bodies collide with the bottom side of the world bounds?\r\n * @property {boolean} left - Will bodies collide with the left side of the world bounds?\r\n * @property {boolean} right - Will bodies collide with the right side of the world bounds?\r\n */", "meta": { "filename": "CheckCollisionObject.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "typedef", "name": "CheckCollisionObject", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Will bodies collide with the top side of the world bounds?", "name": "up" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Will bodies collide with the bottom side of the world bounds?", "name": "down" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Will bodies collide with the left side of the world bounds?", "name": "left" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Will bodies collide with the right side of the world bounds?", "name": "right" } ], "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.CheckCollisionObject", "scope": "static", "___id": "T000002R029682", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Arcade.GameObjectWithBody\r\n * @extends Phaser.GameObjects.GameObject\r\n *\r\n * @property {(Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody)} body\r\n */", "meta": { "filename": "GameObjectWithBody.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "typedef", "name": "GameObjectWithBody", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.GameObjects.GameObject" ], "properties": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body", "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } ] } }, "name": "body" } ], "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.GameObjectWithBody", "scope": "static", "___id": "T000002R029683", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Arcade.GameObjectWithDynamicBody\r\n * @extends Phaser.GameObjects.GameObject\r\n *\r\n * @property {Phaser.Physics.Arcade.Body} body\r\n */", "meta": { "filename": "GameObjectWithDynamicBody.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "typedef", "name": "GameObjectWithDynamicBody", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.GameObjects.GameObject" ], "properties": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "name": "body" } ], "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.GameObjectWithDynamicBody", "scope": "static", "___id": "T000002R029684", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Arcade.GameObjectWithStaticBody\r\n * @extends Phaser.GameObjects.GameObject\r\n *\r\n * @property {Phaser.Physics.Arcade.StaticBody} body\r\n */", "meta": { "filename": "GameObjectWithStaticBody.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "typedef", "name": "GameObjectWithStaticBody", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.GameObjects.GameObject" ], "properties": [ { "type": { "names": [ "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } }, "name": "body" } ], "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.GameObjectWithStaticBody", "scope": "static", "___id": "T000002R029685", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Arcade.ImageWithDynamicBody\r\n * @extends Phaser.Physics.Arcade.Image\r\n *\r\n * @property {Phaser.Physics.Arcade.Body} body\r\n */", "meta": { "filename": "ImageWithDynamicBody.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "typedef", "name": "ImageWithDynamicBody", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Physics.Arcade.Image" ], "properties": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "name": "body" } ], "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.ImageWithDynamicBody", "scope": "static", "___id": "T000002R029686", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Arcade.ImageWithStaticBody\r\n * @extends Phaser.Physics.Arcade.Image\r\n *\r\n * @property {Phaser.Physics.Arcade.StaticBody} body\r\n */", "meta": { "filename": "ImageWithStaticBody.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "typedef", "name": "ImageWithStaticBody", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Physics.Arcade.Image" ], "properties": [ { "type": { "names": [ "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } }, "name": "body" } ], "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.ImageWithStaticBody", "scope": "static", "___id": "T000002R029687", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Physics.Arcade\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "namespace", "name": "Arcade", "memberof": "Phaser.Types.Physics", "longname": "Phaser.Types.Physics.Arcade", "scope": "static", "___id": "T000002R029688", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Arcade.PhysicsGroupConfig\r\n * @extends Phaser.Types.GameObjects.Group.GroupConfig\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} [collideWorldBounds=false] - Sets {@link Phaser.Physics.Arcade.Body#collideWorldBounds}.\r\n * @property {Phaser.Geom.Rectangle} [customBoundsRectangle=null] - Sets {@link Phaser.Physics.Arcade.Body#setBoundsRectangle setBoundsRectangle}.\r\n * @property {number} [accelerationX=0] - Sets {@link Phaser.Physics.Arcade.Body#acceleration acceleration.x}.\r\n * @property {number} [accelerationY=0] - Sets {@link Phaser.Physics.Arcade.Body#acceleration acceleration.y}.\r\n * @property {boolean} [allowDrag=true] - Sets {@link Phaser.Physics.Arcade.Body#allowDrag}.\r\n * @property {boolean} [allowGravity=true] - Sets {@link Phaser.Physics.Arcade.Body#allowGravity}.\r\n * @property {boolean} [allowRotation=true] - Sets {@link Phaser.Physics.Arcade.Body#allowRotation}.\r\n * @property {boolean} [useDamping=false] - Sets {@link Phaser.Physics.Arcade.Body#useDamping useDamping}.\r\n * @property {number} [bounceX=0] - Sets {@link Phaser.Physics.Arcade.Body#bounce bounce.x}.\r\n * @property {number} [bounceY=0] - Sets {@link Phaser.Physics.Arcade.Body#bounce bounce.y}.\r\n * @property {number} [dragX=0] - Sets {@link Phaser.Physics.Arcade.Body#drag drag.x}.\r\n * @property {number} [dragY=0] - Sets {@link Phaser.Physics.Arcade.Body#drag drag.y}.\r\n * @property {boolean} [enable=true] - Sets {@link Phaser.Physics.Arcade.Body#enable enable}.\r\n * @property {number} [gravityX=0] - Sets {@link Phaser.Physics.Arcade.Body#gravity gravity.x}.\r\n * @property {number} [gravityY=0] - Sets {@link Phaser.Physics.Arcade.Body#gravity gravity.y}.\r\n * @property {number} [frictionX=0] - Sets {@link Phaser.Physics.Arcade.Body#friction friction.x}.\r\n * @property {number} [frictionY=0] - Sets {@link Phaser.Physics.Arcade.Body#friction friction.y}.\r\n * @property {number} [maxSpeed=-1] - Sets {@link Phaser.Physics.Arcade.Body#maxSpeed maxSpeed}.\r\n * @property {number} [maxVelocityX=10000] - Sets {@link Phaser.Physics.Arcade.Body#maxVelocity maxVelocity.x}.\r\n * @property {number} [maxVelocityY=10000] - Sets {@link Phaser.Physics.Arcade.Body#maxVelocity maxVelocity.y}.\r\n * @property {number} [velocityX=0] - Sets {@link Phaser.Physics.Arcade.Body#velocity velocity.x}.\r\n * @property {number} [velocityY=0] - Sets {@link Phaser.Physics.Arcade.Body#velocity velocity.y}.\r\n * @property {number} [angularVelocity=0] - Sets {@link Phaser.Physics.Arcade.Body#angularVelocity}.\r\n * @property {number} [angularAcceleration=0] - Sets {@link Phaser.Physics.Arcade.Body#angularAcceleration}.\r\n * @property {number} [angularDrag=0] - Sets {@link Phaser.Physics.Arcade.Body#angularDrag}.\r\n * @property {number} [mass=0] - Sets {@link Phaser.Physics.Arcade.Body#mass}.\r\n * @property {boolean} [immovable=false] - Sets {@link Phaser.Physics.Arcade.Body#immovable}.\r\n */", "meta": { "filename": "PhysicsGroupConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "typedef", "name": "PhysicsGroupConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.Group.GroupConfig" ], "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Sets {@link Phaser.Physics.Arcade.Body#collideWorldBounds}.", "name": "collideWorldBounds" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "optional": true, "defaultvalue": null, "description": "Sets {@link Phaser.Physics.Arcade.Body#setBoundsRectangle setBoundsRectangle}.", "name": "customBoundsRectangle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.Body#acceleration acceleration.x}.", "name": "accelerationX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.Body#acceleration acceleration.y}.", "name": "accelerationY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Sets {@link Phaser.Physics.Arcade.Body#allowDrag}.", "name": "allowDrag" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Sets {@link Phaser.Physics.Arcade.Body#allowGravity}.", "name": "allowGravity" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Sets {@link Phaser.Physics.Arcade.Body#allowRotation}.", "name": "allowRotation" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Sets {@link Phaser.Physics.Arcade.Body#useDamping useDamping}.", "name": "useDamping" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.Body#bounce bounce.x}.", "name": "bounceX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.Body#bounce bounce.y}.", "name": "bounceY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.Body#drag drag.x}.", "name": "dragX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.Body#drag drag.y}.", "name": "dragY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Sets {@link Phaser.Physics.Arcade.Body#enable enable}.", "name": "enable" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.Body#gravity gravity.x}.", "name": "gravityX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.Body#gravity gravity.y}.", "name": "gravityY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.Body#friction friction.x}.", "name": "frictionX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.Body#friction friction.y}.", "name": "frictionY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": -1, "description": "Sets {@link Phaser.Physics.Arcade.Body#maxSpeed maxSpeed}.", "name": "maxSpeed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10000, "description": "Sets {@link Phaser.Physics.Arcade.Body#maxVelocity maxVelocity.x}.", "name": "maxVelocityX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10000, "description": "Sets {@link Phaser.Physics.Arcade.Body#maxVelocity maxVelocity.y}.", "name": "maxVelocityY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.Body#velocity velocity.x}.", "name": "velocityX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.Body#velocity velocity.y}.", "name": "velocityY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.Body#angularVelocity}.", "name": "angularVelocity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.Body#angularAcceleration}.", "name": "angularAcceleration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.Body#angularDrag}.", "name": "angularDrag" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sets {@link Phaser.Physics.Arcade.Body#mass}.", "name": "mass" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Sets {@link Phaser.Physics.Arcade.Body#immovable}.", "name": "immovable" } ], "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.PhysicsGroupConfig", "scope": "static", "___id": "T000002R029689", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Arcade.PhysicsGroupDefaults\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} setCollideWorldBounds - As {@link Phaser.Physics.Arcade.Body#setCollideWorldBounds}.\r\n * @property {Phaser.Geom.Rectangle} setBoundsRectangle - As {@link Phaser.Physics.Arcade.Body#setBoundsRectangle}.\r\n * @property {number} setAccelerationX - As {@link Phaser.Physics.Arcade.Body#setAccelerationX}.\r\n * @property {number} setAccelerationY - As {@link Phaser.Physics.Arcade.Body#setAccelerationY}.\r\n * @property {boolean} setAllowDrag - As {@link Phaser.Physics.Arcade.Body#setAllowDrag}.\r\n * @property {boolean} setAllowGravity - As {@link Phaser.Physics.Arcade.Body#setAllowGravity}.\r\n * @property {boolean} setAllowRotation - As {@link Phaser.Physics.Arcade.Body#setAllowRotation}.\r\n * @property {boolean} setDamping - As {@link Phaser.Physics.Arcade.Body#setDamping}.\r\n * @property {number} setBounceX - As {@link Phaser.Physics.Arcade.Body#setBounceX}.\r\n * @property {number} setBounceY - As {@link Phaser.Physics.Arcade.Body#setBounceY}.\r\n * @property {number} setDragX - As {@link Phaser.Physics.Arcade.Body#setDragX}.\r\n * @property {number} setDragY - As {@link Phaser.Physics.Arcade.Body#setDragY}.\r\n * @property {boolean} setEnable - As {@link Phaser.Physics.Arcade.Body#setEnable}.\r\n * @property {number} setGravityX - As {@link Phaser.Physics.Arcade.Body#setGravityX}.\r\n * @property {number} setGravityY - As {@link Phaser.Physics.Arcade.Body#setGravityY}.\r\n * @property {number} setFrictionX - As {@link Phaser.Physics.Arcade.Body#setFrictionX}.\r\n * @property {number} setFrictionY - As {@link Phaser.Physics.Arcade.Body#setFrictionY}.\r\n * @property {number} setMaxSpeed - As {@link Phaser.Physics.Arcade.Body#setMaxSpeed}.\r\n * @property {number} setVelocityX - As {@link Phaser.Physics.Arcade.Body#setVelocityX}.\r\n * @property {number} setVelocityY - As {@link Phaser.Physics.Arcade.Body#setVelocityY}.\r\n * @property {number} setAngularVelocity - As {@link Phaser.Physics.Arcade.Body#setAngularVelocity}.\r\n * @property {number} setAngularAcceleration - As {@link Phaser.Physics.Arcade.Body#setAngularAcceleration}.\r\n * @property {number} setAngularDrag - As {@link Phaser.Physics.Arcade.Body#setAngularDrag}.\r\n * @property {number} setMass - As {@link Phaser.Physics.Arcade.Body#setMass}.\r\n * @property {boolean} setImmovable - As {@link Phaser.Physics.Arcade.Body#setImmovable}.\r\n */", "meta": { "filename": "PhysicsGroupDefaults.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "typedef", "name": "PhysicsGroupDefaults", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setCollideWorldBounds}.", "name": "setCollideWorldBounds" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setBoundsRectangle}.", "name": "setBoundsRectangle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setAccelerationX}.", "name": "setAccelerationX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setAccelerationY}.", "name": "setAccelerationY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setAllowDrag}.", "name": "setAllowDrag" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setAllowGravity}.", "name": "setAllowGravity" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setAllowRotation}.", "name": "setAllowRotation" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setDamping}.", "name": "setDamping" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setBounceX}.", "name": "setBounceX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setBounceY}.", "name": "setBounceY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setDragX}.", "name": "setDragX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setDragY}.", "name": "setDragY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setEnable}.", "name": "setEnable" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setGravityX}.", "name": "setGravityX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setGravityY}.", "name": "setGravityY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setFrictionX}.", "name": "setFrictionX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setFrictionY}.", "name": "setFrictionY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setMaxSpeed}.", "name": "setMaxSpeed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setVelocityX}.", "name": "setVelocityX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setVelocityY}.", "name": "setVelocityY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setAngularVelocity}.", "name": "setAngularVelocity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setAngularAcceleration}.", "name": "setAngularAcceleration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setAngularDrag}.", "name": "setAngularDrag" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setMass}.", "name": "setMass" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "As {@link Phaser.Physics.Arcade.Body#setImmovable}.", "name": "setImmovable" } ], "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.PhysicsGroupDefaults", "scope": "static", "___id": "T000002R029690", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Arcade.SpriteWithDynamicBody\r\n * @extends Phaser.Physics.Arcade.Sprite\r\n *\r\n * @property {Phaser.Physics.Arcade.Body} body\r\n */", "meta": { "filename": "SpriteWithDynamicBody.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "typedef", "name": "SpriteWithDynamicBody", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Physics.Arcade.Sprite" ], "properties": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "name": "body" } ], "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.SpriteWithDynamicBody", "scope": "static", "___id": "T000002R029691", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Arcade.SpriteWithStaticBody\r\n * @extends Phaser.Physics.Arcade.Sprite\r\n *\r\n * @property {Phaser.Physics.Arcade.StaticBody} body\r\n */", "meta": { "filename": "SpriteWithStaticBody.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\typedefs", "code": {} }, "kind": "typedef", "name": "SpriteWithStaticBody", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Physics.Arcade.Sprite" ], "properties": [ { "type": { "names": [ "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } }, "name": "body" } ], "memberof": "Phaser.Types.Physics.Arcade", "longname": "Phaser.Types.Physics.Arcade.SpriteWithStaticBody", "scope": "static", "___id": "T000002R029692", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Arcade Physics World.\r\n *\r\n * The World is responsible for creating, managing, colliding and updating all of the bodies within it.\r\n *\r\n * An instance of the World belongs to a Phaser.Scene and is accessed via the property `physics.world`.\r\n *\r\n * @class World\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Physics.Arcade\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this World instance belongs.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeWorldConfig} config - An Arcade Physics Configuration object.\r\n */", "meta": { "filename": "World.js", "lineno": 39, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "classdesc": "The Arcade Physics World.\r\rThe World is responsible for creating, managing, colliding and updating all of the bodies within it.\r\rAn instance of the World belongs to a Phaser.Scene and is accessed via the property `physics.world`.", "kind": "class", "name": "World", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Physics.Arcade", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this World instance belongs.", "name": "scene" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeWorldConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeWorldConfig" } }, "description": "An Arcade Physics Configuration object.", "name": "config" } ], "scope": "static", "longname": "Phaser.Physics.Arcade.World", "___id": "T000002R029724", "___s": true }, { "comment": "/**\r\n * The Scene this simulation belongs to.\r\n *\r\n * @name Phaser.Physics.Arcade.World#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Scene this simulation belongs to.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#scene", "scope": "instance", "kind": "member", "___id": "T000002R029728", "___s": true }, { "comment": "/**\r\n * Dynamic Bodies in this simulation.\r\n *\r\n * @name Phaser.Physics.Arcade.World#bodies\r\n * @type {Phaser.Structs.Set.}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Dynamic Bodies in this simulation.", "name": "bodies", "type": { "names": [ "Phaser.Structs.Set." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.Set" }, "applications": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } ] } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#bodies", "scope": "instance", "kind": "member", "___id": "T000002R029730", "___s": true }, { "comment": "/**\r\n * Static Bodies in this simulation.\r\n *\r\n * @name Phaser.Physics.Arcade.World#staticBodies\r\n * @type {Phaser.Structs.Set.}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Static Bodies in this simulation.", "name": "staticBodies", "type": { "names": [ "Phaser.Structs.Set." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.Set" }, "applications": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } ] } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#staticBodies", "scope": "instance", "kind": "member", "___id": "T000002R029732", "___s": true }, { "comment": "/**\r\n * Static Bodies marked for deletion.\r\n *\r\n * @name Phaser.Physics.Arcade.World#pendingDestroy\r\n * @type {Phaser.Structs.Set.<(Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody)>}\r\n * @since 3.1.0\r\n */", "meta": { "filename": "World.js", "lineno": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Static Bodies marked for deletion.", "name": "pendingDestroy", "type": { "names": [ "Phaser.Structs.Set.<(Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody)>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.Set" }, "applications": [ { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } ] } ] } }, "since": "3.1.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#pendingDestroy", "scope": "instance", "kind": "member", "___id": "T000002R029734", "___s": true }, { "comment": "/**\r\n * This simulation's collision processors.\r\n *\r\n * @name Phaser.Physics.Arcade.World#colliders\r\n * @type {Phaser.Structs.ProcessQueue.}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "This simulation's collision processors.", "name": "colliders", "type": { "names": [ "Phaser.Structs.ProcessQueue." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.ProcessQueue" }, "applications": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Collider" } ] } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#colliders", "scope": "instance", "kind": "member", "___id": "T000002R029736", "___s": true }, { "comment": "/**\r\n * Acceleration of Bodies due to gravity, in pixels per second.\r\n *\r\n * @name Phaser.Physics.Arcade.World#gravity\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 111, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Acceleration of Bodies due to gravity, in pixels per second.", "name": "gravity", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#gravity", "scope": "instance", "kind": "member", "___id": "T000002R029738", "___s": true }, { "comment": "/**\r\n * A boundary constraining Bodies.\r\n *\r\n * @name Phaser.Physics.Arcade.World#bounds\r\n * @type {Phaser.Geom.Rectangle}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "A boundary constraining Bodies.", "name": "bounds", "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#bounds", "scope": "instance", "kind": "member", "___id": "T000002R029740", "___s": true }, { "comment": "/**\r\n * The boundary edges that Bodies can collide with.\r\n *\r\n * @name Phaser.Physics.Arcade.World#checkCollision\r\n * @type {Phaser.Types.Physics.Arcade.CheckCollisionObject}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 134, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The boundary edges that Bodies can collide with.", "name": "checkCollision", "type": { "names": [ "Phaser.Types.Physics.Arcade.CheckCollisionObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.CheckCollisionObject" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#checkCollision", "scope": "instance", "kind": "member", "___id": "T000002R029742", "___s": true }, { "comment": "/**\r\n * The number of physics steps to be taken per second.\r\n *\r\n * This property is read-only. Use the `setFPS` method to modify it at run-time.\r\n *\r\n * @name Phaser.Physics.Arcade.World#fps\r\n * @readonly\r\n * @type {number}\r\n * @default 60\r\n * @since 3.10.0\r\n */", "meta": { "filename": "World.js", "lineno": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The number of physics steps to be taken per second.\r\rThis property is read-only. Use the `setFPS` method to modify it at run-time.", "name": "fps", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "60", "since": "3.10.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#fps", "scope": "instance", "kind": "member", "___id": "T000002R029748", "___s": true }, { "comment": "/**\r\n * Should Physics use a fixed update time-step (true) or sync to the render fps (false)?.\r\n * False value of this property disables fps and timeScale properties.\r\n *\r\n * @name Phaser.Physics.Arcade.World#fixedStep\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.23.0\r\n */", "meta": { "filename": "World.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Should Physics use a fixed update time-step (true) or sync to the render fps (false)?.\rFalse value of this property disables fps and timeScale properties.", "name": "fixedStep", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.23.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#fixedStep", "scope": "instance", "kind": "member", "___id": "T000002R029750", "___s": true }, { "comment": "/**\r\n * The number of steps that took place in the last frame.\r\n *\r\n * @name Phaser.Physics.Arcade.World#stepsLastFrame\r\n * @readonly\r\n * @type {number}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "World.js", "lineno": 202, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The number of steps that took place in the last frame.", "name": "stepsLastFrame", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.10.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#stepsLastFrame", "scope": "instance", "kind": "member", "___id": "T000002R029758", "___s": true }, { "comment": "/**\r\n * Scaling factor applied to the frame rate.\r\n *\r\n * - 1.0 = normal speed\r\n * - 2.0 = half speed\r\n * - 0.5 = double speed\r\n *\r\n * @name Phaser.Physics.Arcade.World#timeScale\r\n * @type {number}\r\n * @default 1\r\n * @since 3.10.0\r\n */", "meta": { "filename": "World.js", "lineno": 212, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Scaling factor applied to the frame rate.\r\r- 1.0 = normal speed\r- 2.0 = half speed\r- 0.5 = double speed", "name": "timeScale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.10.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#timeScale", "scope": "instance", "kind": "member", "___id": "T000002R029760", "___s": true }, { "comment": "/**\r\n * The maximum absolute difference of a Body's per-step velocity and its overlap with another Body that will result in separation on *each axis*.\r\n * Larger values favor separation.\r\n * Smaller values favor no separation.\r\n *\r\n * @name Phaser.Physics.Arcade.World#OVERLAP_BIAS\r\n * @type {number}\r\n * @default 4\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 226, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The maximum absolute difference of a Body's per-step velocity and its overlap with another Body that will result in separation on *each axis*.\rLarger values favor separation.\rSmaller values favor no separation.", "name": "OVERLAP_BIAS", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "4", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#OVERLAP_BIAS", "scope": "instance", "kind": "member", "___id": "T000002R029762", "___s": true }, { "comment": "/**\r\n * The maximum absolute value of a Body's overlap with a tile that will result in separation on *each axis*.\r\n * Larger values favor separation.\r\n * Smaller values favor no separation.\r\n * The optimum value may be similar to the tile size.\r\n *\r\n * @name Phaser.Physics.Arcade.World#TILE_BIAS\r\n * @type {number}\r\n * @default 16\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 238, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The maximum absolute value of a Body's overlap with a tile that will result in separation on *each axis*.\rLarger values favor separation.\rSmaller values favor no separation.\rThe optimum value may be similar to the tile size.", "name": "TILE_BIAS", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "16", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#TILE_BIAS", "scope": "instance", "kind": "member", "___id": "T000002R029764", "___s": true }, { "comment": "/**\r\n * Always separate overlapping Bodies horizontally before vertically.\r\n * False (the default) means Bodies are first separated on the axis of greater gravity, or the vertical axis if neither is greater.\r\n *\r\n * @name Phaser.Physics.Arcade.World#forceX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 251, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Always separate overlapping Bodies horizontally before vertically.\rFalse (the default) means Bodies are first separated on the axis of greater gravity, or the vertical axis if neither is greater.", "name": "forceX", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#forceX", "scope": "instance", "kind": "member", "___id": "T000002R029766", "___s": true }, { "comment": "/**\r\n * Whether the simulation advances with the game loop.\r\n *\r\n * @name Phaser.Physics.Arcade.World#isPaused\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 262, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Whether the simulation advances with the game loop.", "name": "isPaused", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#isPaused", "scope": "instance", "kind": "member", "___id": "T000002R029768", "___s": true }, { "comment": "/**\r\n * Enables the debug display.\r\n *\r\n * @name Phaser.Physics.Arcade.World#drawDebug\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 283, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Enables the debug display.", "name": "drawDebug", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#drawDebug", "scope": "instance", "kind": "member", "___id": "T000002R029772", "___s": true }, { "comment": "/**\r\n * The graphics object drawing the debug display.\r\n *\r\n * @name Phaser.Physics.Arcade.World#debugGraphic\r\n * @type {Phaser.GameObjects.Graphics}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 293, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The graphics object drawing the debug display.", "name": "debugGraphic", "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#debugGraphic", "scope": "instance", "kind": "member", "___id": "T000002R029774", "___s": true }, { "comment": "/**\r\n * Default debug display settings for new Bodies.\r\n *\r\n * @name Phaser.Physics.Arcade.World#defaults\r\n * @type {Phaser.Types.Physics.Arcade.ArcadeWorldDefaults}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 302, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Default debug display settings for new Bodies.", "name": "defaults", "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeWorldDefaults" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeWorldDefaults" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#defaults", "scope": "instance", "kind": "member", "___id": "T000002R029776", "___s": true }, { "comment": "/**\r\n * The maximum number of items per node on the RTree.\r\n *\r\n * This is ignored if `useTree` is `false`. If you have a large number of bodies in\r\n * your world then you may find search performance improves by increasing this value,\r\n * to allow more items per node and less node division.\r\n *\r\n * @name Phaser.Physics.Arcade.World#maxEntries\r\n * @type {number}\r\n * @default 16\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 318, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The maximum number of items per node on the RTree.\r\rThis is ignored if `useTree` is `false`. If you have a large number of bodies in\ryour world then you may find search performance improves by increasing this value,\rto allow more items per node and less node division.", "name": "maxEntries", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "16", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#maxEntries", "scope": "instance", "kind": "member", "___id": "T000002R029784", "___s": true }, { "comment": "/**\r\n * Should this Arcade Physics World use an RTree for Dynamic bodies?\r\n *\r\n * An RTree is a fast way of spatially sorting of all the bodies in the world.\r\n * However, at certain limits, the cost of clearing and inserting the bodies into the\r\n * tree every frame becomes more expensive than the search speed gains it provides.\r\n *\r\n * If you have a large number of dynamic bodies in your world then it may be best to\r\n * disable the use of the RTree by setting this property to `false` in the physics config.\r\n *\r\n * The number it can cope with depends on browser and device, but a conservative estimate\r\n * of around 5,000 bodies should be considered the max before disabling it.\r\n *\r\n * This only applies to dynamic bodies. Static bodies are always kept in an RTree,\r\n * because they don't have to be cleared every frame, so you benefit from the\r\n * massive search speeds all the time.\r\n *\r\n * @name Phaser.Physics.Arcade.World#useTree\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.10.0\r\n */", "meta": { "filename": "World.js", "lineno": 332, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Should this Arcade Physics World use an RTree for Dynamic bodies?\r\rAn RTree is a fast way of spatially sorting of all the bodies in the world.\rHowever, at certain limits, the cost of clearing and inserting the bodies into the\rtree every frame becomes more expensive than the search speed gains it provides.\r\rIf you have a large number of dynamic bodies in your world then it may be best to\rdisable the use of the RTree by setting this property to `false` in the physics config.\r\rThe number it can cope with depends on browser and device, but a conservative estimate\rof around 5,000 bodies should be considered the max before disabling it.\r\rThis only applies to dynamic bodies. Static bodies are always kept in an RTree,\rbecause they don't have to be cleared every frame, so you benefit from the\rmassive search speeds all the time.", "name": "useTree", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.10.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#useTree", "scope": "instance", "kind": "member", "___id": "T000002R029786", "___s": true }, { "comment": "/**\r\n * The spatial index of Dynamic Bodies.\r\n *\r\n * @name Phaser.Physics.Arcade.World#tree\r\n * @type {Phaser.Structs.RTree}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 356, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The spatial index of Dynamic Bodies.", "name": "tree", "type": { "names": [ "Phaser.Structs.RTree" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.RTree" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#tree", "scope": "instance", "kind": "member", "___id": "T000002R029788", "___s": true }, { "comment": "/**\r\n * The spatial index of Static Bodies.\r\n *\r\n * @name Phaser.Physics.Arcade.World#staticTree\r\n * @type {Phaser.Structs.RTree}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 365, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The spatial index of Static Bodies.", "name": "staticTree", "type": { "names": [ "Phaser.Structs.RTree" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.RTree" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#staticTree", "scope": "instance", "kind": "member", "___id": "T000002R029790", "___s": true }, { "comment": "/**\r\n * Recycled input for tree searches.\r\n *\r\n * @name Phaser.Physics.Arcade.World#treeMinMax\r\n * @type {Phaser.Types.Physics.Arcade.ArcadeWorldTreeMinMax}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Recycled input for tree searches.", "name": "treeMinMax", "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeWorldTreeMinMax" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeWorldTreeMinMax" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#treeMinMax", "scope": "instance", "kind": "member", "___id": "T000002R029792", "___s": true }, { "comment": "/**\r\n * The Filtering Options passed to `GetTilesWithinWorldXY` as part of the `collideSpriteVsTilemapLayer` check.\r\n *\r\n * @name Phaser.Physics.Arcade.World#tileFilterOptions\r\n * @type {Phaser.Types.Tilemaps.FilteringOptions}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "World.js", "lineno": 403, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "The Filtering Options passed to `GetTilesWithinWorldXY` as part of the `collideSpriteVsTilemapLayer` check.", "name": "tileFilterOptions", "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#tileFilterOptions", "scope": "instance", "kind": "member", "___id": "T000002R029802", "___s": true }, { "comment": "/**\r\n * Adds an Arcade Physics Body to a Game Object, an array of Game Objects, or the children of a Group.\r\n *\r\n * The difference between this and the `enableBody` method is that you can pass arrays or Groups\r\n * to this method.\r\n *\r\n * You can specify if the bodies are to be Dynamic or Static. A dynamic body can move via velocity and\r\n * acceleration. A static body remains fixed in place and as such is able to use an optimized search\r\n * tree, making it ideal for static elements such as level objects. You can still collide and overlap\r\n * with static bodies.\r\n *\r\n * Normally, rather than calling this method directly, you'd use the helper methods available in the\r\n * Arcade Physics Factory, such as:\r\n *\r\n * ```javascript\r\n * this.physics.add.image(x, y, textureKey);\r\n * this.physics.add.sprite(x, y, textureKey);\r\n * ```\r\n *\r\n * Calling factory methods encapsulates the creation of a Game Object and the creation of its\r\n * body at the same time. If you are creating custom classes then you can pass them to this\r\n * method to have their bodies created.\r\n *\r\n * @method Phaser.Physics.Arcade.World#enable\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]|Phaser.GameObjects.Group|Phaser.GameObjects.Group[])} object - The object, or objects, on which to create the bodies.\r\n * @param {number} [bodyType] - The type of Body to create. Either `DYNAMIC_BODY` or `STATIC_BODY`.\r\n */", "meta": { "filename": "World.js", "lineno": 418, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Adds an Arcade Physics Body to a Game Object, an array of Game Objects, or the children of a Group.\r\rThe difference between this and the `enableBody` method is that you can pass arrays or Groups\rto this method.\r\rYou can specify if the bodies are to be Dynamic or Static. A dynamic body can move via velocity and\racceleration. A static body remains fixed in place and as such is able to use an optimized search\rtree, making it ideal for static elements such as level objects. You can still collide and overlap\rwith static bodies.\r\rNormally, rather than calling this method directly, you'd use the helper methods available in the\rArcade Physics Factory, such as:\r\r```javascript\rthis.physics.add.image(x, y, textureKey);\rthis.physics.add.sprite(x, y, textureKey);\r```\r\rCalling factory methods encapsulates the creation of a Game Object and the creation of its\rbody at the same time. If you are creating custom classes then you can pass them to this\rmethod to have their bodies created.", "kind": "function", "name": "enable", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Array.", "Phaser.GameObjects.Group", "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" } ] }, { "type": "NameExpression", "name": "Phaser.GameObjects.Group" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Group", "type": "NameExpression" } ] } ] } }, "description": "The object, or objects, on which to create the bodies.", "name": "object" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The type of Body to create. Either `DYNAMIC_BODY` or `STATIC_BODY`.", "name": "bodyType" } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#enable", "scope": "instance", "___id": "T000002R029807", "___s": true }, { "comment": "/**\r\n * Creates an Arcade Physics Body on a single Game Object.\r\n *\r\n * If the Game Object already has a body, this method will simply add it back into the simulation.\r\n *\r\n * You can specify if the body is Dynamic or Static. A dynamic body can move via velocity and\r\n * acceleration. A static body remains fixed in place and as such is able to use an optimized search\r\n * tree, making it ideal for static elements such as level objects. You can still collide and overlap\r\n * with static bodies.\r\n *\r\n * Normally, rather than calling this method directly, you'd use the helper methods available in the\r\n * Arcade Physics Factory, such as:\r\n *\r\n * ```javascript\r\n * this.physics.add.image(x, y, textureKey);\r\n * this.physics.add.sprite(x, y, textureKey);\r\n * ```\r\n *\r\n * Calling factory methods encapsulates the creation of a Game Object and the creation of its\r\n * body at the same time. If you are creating custom classes then you can pass them to this\r\n * method to have their bodies created.\r\n *\r\n * @method Phaser.Physics.Arcade.World#enableBody\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} object - The Game Object on which to create the body.\r\n * @param {number} [bodyType] - The type of Body to create. Either `DYNAMIC_BODY` or `STATIC_BODY`.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object on which the body was created.\r\n */", "meta": { "filename": "World.js", "lineno": 486, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Creates an Arcade Physics Body on a single Game Object.\r\rIf the Game Object already has a body, this method will simply add it back into the simulation.\r\rYou can specify if the body is Dynamic or Static. A dynamic body can move via velocity and\racceleration. A static body remains fixed in place and as such is able to use an optimized search\rtree, making it ideal for static elements such as level objects. You can still collide and overlap\rwith static bodies.\r\rNormally, rather than calling this method directly, you'd use the helper methods available in the\rArcade Physics Factory, such as:\r\r```javascript\rthis.physics.add.image(x, y, textureKey);\rthis.physics.add.sprite(x, y, textureKey);\r```\r\rCalling factory methods encapsulates the creation of a Game Object and the creation of its\rbody at the same time. If you are creating custom classes then you can pass them to this\rmethod to have their bodies created.", "kind": "function", "name": "enableBody", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object on which to create the body.", "name": "object" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The type of Body to create. Either `DYNAMIC_BODY` or `STATIC_BODY`.", "name": "bodyType" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object on which the body was created." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#enableBody", "scope": "instance", "___id": "T000002R029816", "___s": true }, { "comment": "/**\r\n * Adds an existing Arcade Physics Body or StaticBody to the simulation.\r\n *\r\n * The body is enabled and added to the local search trees.\r\n *\r\n * @method Phaser.Physics.Arcade.World#add\r\n * @since 3.10.0\r\n *\r\n * @param {(Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody)} body - The Body to be added to the simulation.\r\n *\r\n * @return {(Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody)} The Body that was added to the simulation.\r\n */", "meta": { "filename": "World.js", "lineno": 540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Adds an existing Arcade Physics Body or StaticBody to the simulation.\r\rThe body is enabled and added to the local search trees.", "kind": "function", "name": "add", "since": "3.10.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body", "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } ] } }, "description": "The Body to be added to the simulation.", "name": "body" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body", "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } ] } }, "description": "The Body that was added to the simulation." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#add", "scope": "instance", "___id": "T000002R029821", "___s": true }, { "comment": "/**\r\n * Disables the Arcade Physics Body of a Game Object, an array of Game Objects, or the children of a Group.\r\n *\r\n * The difference between this and the `disableBody` method is that you can pass arrays or Groups\r\n * to this method.\r\n *\r\n * The body itself is not deleted, it just has its `enable` property set to false, which\r\n * means you can re-enable it again at any point by passing it to enable `World.enable` or `World.add`.\r\n *\r\n * @method Phaser.Physics.Arcade.World#disable\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]|Phaser.GameObjects.Group|Phaser.GameObjects.Group[])} object - The object, or objects, on which to disable the bodies.\r\n */", "meta": { "filename": "World.js", "lineno": 570, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Disables the Arcade Physics Body of a Game Object, an array of Game Objects, or the children of a Group.\r\rThe difference between this and the `disableBody` method is that you can pass arrays or Groups\rto this method.\r\rThe body itself is not deleted, it just has its `enable` property set to false, which\rmeans you can re-enable it again at any point by passing it to enable `World.enable` or `World.add`.", "kind": "function", "name": "disable", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Array.", "Phaser.GameObjects.Group", "Array." ], "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" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Group", "type": "NameExpression" } ] } ] } }, "description": "The object, or objects, on which to disable the bodies.", "name": "object" } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#disable", "scope": "instance", "___id": "T000002R029824", "___s": true }, { "comment": "/**\r\n * Disables an existing Arcade Physics Body or StaticBody and removes it from the simulation.\r\n *\r\n * The body is disabled and removed from the local search trees.\r\n *\r\n * The body itself is not deleted, it just has its `enable` property set to false, which\r\n * means you can re-enable it again at any point by passing it to enable `World.enable` or `World.add`.\r\n *\r\n * @method Phaser.Physics.Arcade.World#disableBody\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody)} body - The Body to be disabled.\r\n */", "meta": { "filename": "World.js", "lineno": 621, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Disables an existing Arcade Physics Body or StaticBody and removes it from the simulation.\r\rThe body is disabled and removed from the local search trees.\r\rThe body itself is not deleted, it just has its `enable` property set to false, which\rmeans you can re-enable it again at any point by passing it to enable `World.enable` or `World.add`.", "kind": "function", "name": "disableBody", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body", "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } ] } }, "description": "The Body to be disabled.", "name": "body" } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#disableBody", "scope": "instance", "___id": "T000002R029832", "___s": true }, { "comment": "/**\r\n * Removes an existing Arcade Physics Body or StaticBody from the simulation.\r\n *\r\n * The body is disabled and removed from the local search trees.\r\n *\r\n * The body itself is not deleted, it just has its `enabled` property set to false, which\r\n * means you can re-enable it again at any point by passing it to enable `enable` or `add`.\r\n *\r\n * @method Phaser.Physics.Arcade.World#remove\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody)} body - The body to be removed from the simulation.\r\n */", "meta": { "filename": "World.js", "lineno": 641, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Removes an existing Arcade Physics Body or StaticBody from the simulation.\r\rThe body is disabled and removed from the local search trees.\r\rThe body itself is not deleted, it just has its `enabled` property set to false, which\rmeans you can re-enable it again at any point by passing it to enable `enable` or `add`.", "kind": "function", "name": "remove", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body", "Phaser.Physics.Arcade.StaticBody" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" } ] } }, "description": "The body to be removed from the simulation.", "name": "body" } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#remove", "scope": "instance", "___id": "T000002R029835", "___s": true }, { "comment": "/**\r\n * Creates a Graphics Game Object that the world will use to render the debug display to.\r\n *\r\n * This is called automatically when the World is instantiated if the `debug` config property\r\n * was set to `true`. However, you can call it at any point should you need to display the\r\n * debug Graphic from a fixed point.\r\n *\r\n * You can control which objects are drawn to the Graphics object, and the colors they use,\r\n * by setting the debug properties in the physics config.\r\n *\r\n * You should not typically use this in a production game. Use it to aid during debugging.\r\n *\r\n * @method Phaser.Physics.Arcade.World#createDebugGraphic\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.GameObjects.Graphics} The Graphics object that was created for use by the World.\r\n */", "meta": { "filename": "World.js", "lineno": 668, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Creates a Graphics Game Object that the world will use to render the debug display to.\r\rThis is called automatically when the World is instantiated if the `debug` config property\rwas set to `true`. However, you can call it at any point should you need to display the\rdebug Graphic from a fixed point.\r\rYou can control which objects are drawn to the Graphics object, and the colors they use,\rby setting the debug properties in the physics config.\r\rYou should not typically use this in a production game. Use it to aid during debugging.", "kind": "function", "name": "createDebugGraphic", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics object that was created for use by the World." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#createDebugGraphic", "scope": "instance", "___id": "T000002R029837", "___s": true }, { "comment": "/**\r\n * Sets the position, size and properties of the World boundary.\r\n *\r\n * The World boundary is an invisible rectangle that defines the edges of the World.\r\n * If a Body is set to collide with the world bounds then it will automatically stop\r\n * when it reaches any of the edges. You can optionally set which edges of the boundary\r\n * should be checked against.\r\n *\r\n * @method Phaser.Physics.Arcade.World#setBounds\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The top-left x coordinate of the boundary.\r\n * @param {number} y - The top-left y coordinate 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} [checkLeft] - Should bodies check against the left edge of the boundary?\r\n * @param {boolean} [checkRight] - Should bodies check against the right edge of the boundary?\r\n * @param {boolean} [checkUp] - Should bodies check against the top edge of the boundary?\r\n * @param {boolean} [checkDown] - Should bodies check against the bottom edge of the boundary?\r\n *\r\n * @return {Phaser.Physics.Arcade.World} This World object.\r\n */", "meta": { "filename": "World.js", "lineno": 698, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the position, size and properties of the World boundary.\r\rThe World boundary is an invisible rectangle that defines the edges of the World.\rIf a Body is set to collide with the world bounds then it will automatically stop\rwhen it reaches any of the edges. You can optionally set which edges of the boundary\rshould be checked against.", "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 boundary.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y coordinate of the boundary.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the boundary.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the boundary.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Should bodies check against the left edge of the boundary?", "name": "checkLeft" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Should bodies check against the right edge of the boundary?", "name": "checkRight" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Should bodies check against the top edge of the boundary?", "name": "checkUp" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Should bodies check against the bottom edge of the boundary?", "name": "checkDown" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "description": "This World object." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#setBounds", "scope": "instance", "___id": "T000002R029844", "___s": true }, { "comment": "/**\r\n * Enables or disables collisions on each edge of the World boundary.\r\n *\r\n * @method Phaser.Physics.Arcade.World#setBoundsCollision\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [left=true] - Should bodies check against the left edge of the boundary?\r\n * @param {boolean} [right=true] - Should bodies check against the right edge of the boundary?\r\n * @param {boolean} [up=true] - Should bodies check against the top edge of the boundary?\r\n * @param {boolean} [down=true] - Should bodies check against the bottom edge of the boundary?\r\n *\r\n * @return {Phaser.Physics.Arcade.World} This World object.\r\n */", "meta": { "filename": "World.js", "lineno": 732, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Enables or disables collisions on each edge of the World boundary.", "kind": "function", "name": "setBoundsCollision", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should bodies check against the left edge of the boundary?", "name": "left" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should bodies check against the right edge of the boundary?", "name": "right" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should bodies check against the top edge of the boundary?", "name": "up" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should bodies check against the bottom edge of the boundary?", "name": "down" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "description": "This World object." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#setBoundsCollision", "scope": "instance", "___id": "T000002R029846", "___s": true }, { "comment": "/**\r\n * Pauses the simulation.\r\n *\r\n * A paused simulation does not update any existing bodies, or run any Colliders.\r\n *\r\n * However, you can still enable and disable bodies within it, or manually run collide or overlap\r\n * checks.\r\n *\r\n * @method Phaser.Physics.Arcade.World#pause\r\n * @fires Phaser.Physics.Arcade.Events#PAUSE\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Physics.Arcade.World} This World object.\r\n */", "meta": { "filename": "World.js", "lineno": 760, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Pauses the simulation.\r\rA paused simulation does not update any existing bodies, or run any Colliders.\r\rHowever, you can still enable and disable bodies within it, or manually run collide or overlap\rchecks.", "kind": "function", "name": "pause", "fires": [ "Phaser.Physics.Arcade.Events#event:PAUSE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "description": "This World object." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#pause", "scope": "instance", "___id": "T000002R029856", "___s": true }, { "comment": "/**\r\n * Resumes the simulation, if paused.\r\n *\r\n * @method Phaser.Physics.Arcade.World#resume\r\n * @fires Phaser.Physics.Arcade.Events#RESUME\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Physics.Arcade.World} This World object.\r\n */", "meta": { "filename": "World.js", "lineno": 783, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Resumes the simulation, if paused.", "kind": "function", "name": "resume", "fires": [ "Phaser.Physics.Arcade.Events#event:RESUME" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "description": "This World object." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#resume", "scope": "instance", "___id": "T000002R029859", "___s": true }, { "comment": "/**\r\n * Creates a new Collider object and adds it to the simulation.\r\n *\r\n * A Collider is a way to automatically perform collision checks between two objects,\r\n * calling the collide and process callbacks if they occur.\r\n *\r\n * Colliders are run as part of the World update, after all of the Bodies have updated.\r\n *\r\n * By creating a Collider you don't need then call `World.collide` in your `update` loop,\r\n * as it will be handled for you automatically.\r\n *\r\n * @method Phaser.Physics.Arcade.World#addCollider\r\n * @since 3.0.0\r\n * @see Phaser.Physics.Arcade.World#collide\r\n *\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} object1 - The first object to check for collision.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} object2 - The second object to check for collision.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [collideCallback] - The callback to invoke when the two objects collide.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [processCallback] - The callback to invoke when the two objects collide. Must return a boolean.\r\n * @param {*} [callbackContext] - The scope in which to call the callbacks.\r\n *\r\n * @return {Phaser.Physics.Arcade.Collider} The Collider that was created.\r\n */", "meta": { "filename": "World.js", "lineno": 801, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Creates a new Collider object and adds it to the simulation.\r\rA Collider is a way to automatically perform collision checks between two objects,\rcalling the collide and process callbacks if they occur.\r\rColliders are run as part of the World update, after all of the Bodies have updated.\r\rBy creating a Collider you don't need then call `World.collide` in your `update` loop,\ras it will be handled for you automatically.", "kind": "function", "name": "addCollider", "since": "3.0.0", "see": [ "Phaser.Physics.Arcade.World#collide" ], "params": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "description": "The first object to check for collision.", "name": "object1" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "description": "The second object to check for collision.", "name": "object2" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "The callback to invoke when the two objects collide.", "name": "collideCallback" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "The callback to invoke when the two objects collide. Must return a boolean.", "name": "processCallback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The scope in which to call the callbacks.", "name": "callbackContext" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Collider" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Collider" } }, "description": "The Collider that was created." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#addCollider", "scope": "instance", "___id": "T000002R029862", "___s": true }, { "comment": "/**\r\n * Creates a new Overlap Collider object and adds it to the simulation.\r\n *\r\n * A Collider is a way to automatically perform overlap checks between two objects,\r\n * calling the collide and process callbacks if they occur.\r\n *\r\n * Colliders are run as part of the World update, after all of the Bodies have updated.\r\n *\r\n * By creating a Collider you don't need then call `World.overlap` in your `update` loop,\r\n * as it will be handled for you automatically.\r\n *\r\n * @method Phaser.Physics.Arcade.World#addOverlap\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} object1 - The first object to check for overlap.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} object2 - The second object to check for overlap.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [collideCallback] - The callback to invoke when the two objects overlap.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [processCallback] - The callback to invoke when the two objects overlap. Must return a boolean.\r\n * @param {*} [callbackContext] - The scope in which to call the callbacks.\r\n *\r\n * @return {Phaser.Physics.Arcade.Collider} The Collider that was created.\r\n */", "meta": { "filename": "World.js", "lineno": 837, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Creates a new Overlap Collider object and adds it to the simulation.\r\rA Collider is a way to automatically perform overlap checks between two objects,\rcalling the collide and process callbacks if they occur.\r\rColliders are run as part of the World update, after all of the Bodies have updated.\r\rBy creating a Collider you don't need then call `World.overlap` in your `update` loop,\ras it will be handled for you automatically.", "kind": "function", "name": "addOverlap", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "description": "The first object to check for overlap.", "name": "object1" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "description": "The second object to check for overlap.", "name": "object2" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "The callback to invoke when the two objects overlap.", "name": "collideCallback" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "The callback to invoke when the two objects overlap. Must return a boolean.", "name": "processCallback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The scope in which to call the callbacks.", "name": "callbackContext" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.Collider" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Collider" } }, "description": "The Collider that was created." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#addOverlap", "scope": "instance", "___id": "T000002R029868", "___s": true }, { "comment": "/**\r\n * Removes a Collider from the simulation so it is no longer processed.\r\n *\r\n * This method does not destroy the Collider. If you wish to add it back at a later stage you can call\r\n * `World.colliders.add(Collider)`.\r\n *\r\n * If you no longer need the Collider you can call the `Collider.destroy` method instead, which will\r\n * automatically clear all of its references and then remove it from the World. If you call destroy on\r\n * a Collider you _don't_ need to pass it to this method too.\r\n *\r\n * @method Phaser.Physics.Arcade.World#removeCollider\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Collider} collider - The Collider to remove from the simulation.\r\n *\r\n * @return {Phaser.Physics.Arcade.World} This World object.\r\n */", "meta": { "filename": "World.js", "lineno": 872, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Removes a Collider from the simulation so it is no longer processed.\r\rThis method does not destroy the Collider. If you wish to add it back at a later stage you can call\r`World.colliders.add(Collider)`.\r\rIf you no longer need the Collider you can call the `Collider.destroy` method instead, which will\rautomatically clear all of its references and then remove it from the World. If you call destroy on\ra Collider you _don't_ need to pass it to this method too.", "kind": "function", "name": "removeCollider", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Collider" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Collider" } }, "description": "The Collider to remove from the simulation.", "name": "collider" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Arcade.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.World" } }, "description": "This World object." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#removeCollider", "scope": "instance", "___id": "T000002R029874", "___s": true }, { "comment": "/**\r\n * Sets the frame rate to run the simulation at.\r\n *\r\n * The frame rate value is used to simulate a fixed update time step. This fixed\r\n * time step allows for a straightforward implementation of a deterministic game state.\r\n *\r\n * This frame rate is independent of the frequency at which the game is rendering. The\r\n * higher you set the fps, the more physics simulation steps will occur per game step.\r\n * Conversely, the lower you set it, the less will take place.\r\n *\r\n * You can optionally advance the simulation directly yourself by calling the `step` method.\r\n *\r\n * @method Phaser.Physics.Arcade.World#setFPS\r\n * @since 3.10.0\r\n *\r\n * @param {number} framerate - The frame rate to advance the simulation at.\r\n *\r\n * @return {this} This World object.\r\n */", "meta": { "filename": "World.js", "lineno": 896, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Sets the frame rate to run the simulation at.\r\rThe frame rate value is used to simulate a fixed update time step. This fixed\rtime step allows for a straightforward implementation of a deterministic game state.\r\rThis frame rate is independent of the frequency at which the game is rendering. The\rhigher you set the fps, the more physics simulation steps will occur per game step.\rConversely, the lower you set it, the less will take place.\r\rYou can optionally advance the simulation directly yourself by calling the `step` method.", "kind": "function", "name": "setFPS", "since": "3.10.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The frame rate to advance the simulation at.", "name": "framerate" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This World object." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#setFPS", "scope": "instance", "___id": "T000002R029876", "___s": true }, { "comment": "/**\r\n * Advances the simulation based on the elapsed time and fps rate.\r\n *\r\n * This is called automatically by your Scene and does not need to be invoked directly.\r\n *\r\n * @method Phaser.Physics.Arcade.World#update\r\n * @fires Phaser.Physics.Arcade.Events#WORLD_STEP\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": "World.js", "lineno": 924, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Advances the simulation based on the elapsed time and fps rate.\r\rThis is called automatically by your Scene and does not need to be invoked directly.", "kind": "function", "name": "update", "fires": [ "Phaser.Physics.Arcade.Events#event:WORLD_STEP" ], "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.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#update", "scope": "instance", "___id": "T000002R029881", "___s": true }, { "comment": "/**\r\n * Advances the simulation by a time increment.\r\n *\r\n * @method Phaser.Physics.Arcade.World#step\r\n * @fires Phaser.Physics.Arcade.Events#WORLD_STEP\r\n * @since 3.10.0\r\n *\r\n * @param {number} delta - The delta time amount, in seconds, by which to advance the simulation.\r\n */", "meta": { "filename": "World.js", "lineno": 1011, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Advances the simulation by a time increment.", "kind": "function", "name": "step", "fires": [ "Phaser.Physics.Arcade.Events#event:WORLD_STEP" ], "since": "3.10.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time amount, in seconds, by which to advance the simulation.", "name": "delta" } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#step", "scope": "instance", "___id": "T000002R029901", "___s": true }, { "comment": "/**\r\n * Advances the simulation by a single step.\r\n *\r\n * @method Phaser.Physics.Arcade.World#singleStep\r\n * @fires Phaser.Physics.Arcade.Events#WORLD_STEP\r\n * @since 3.61.0\r\n */", "meta": { "filename": "World.js", "lineno": 1063, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Advances the simulation by a single step.", "kind": "function", "name": "singleStep", "fires": [ "Phaser.Physics.Arcade.Events#event:WORLD_STEP" ], "since": "3.61.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#singleStep", "scope": "instance", "___id": "T000002R029912", "___s": true }, { "comment": "/**\r\n * Updates bodies, draws the debug display, and handles pending queue operations.\r\n *\r\n * @method Phaser.Physics.Arcade.World#postUpdate\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 1077, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Updates bodies, draws the debug display, and handles pending queue operations.", "kind": "function", "name": "postUpdate", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#postUpdate", "scope": "instance", "___id": "T000002R029914", "___s": true }, { "comment": "/**\r\n * Calculates a Body's velocity and updates its position.\r\n *\r\n * @method Phaser.Physics.Arcade.World#updateMotion\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Body} body - The Body to be updated.\r\n * @param {number} delta - The delta value to be used in the motion calculations, in seconds.\r\n */", "meta": { "filename": "World.js", "lineno": 1172, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Calculates a Body's velocity and updates its position.", "kind": "function", "name": "updateMotion", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The Body to be updated.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value to be used in the motion calculations, in seconds.", "name": "delta" } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#updateMotion", "scope": "instance", "___id": "T000002R029941", "___s": true }, { "comment": "/**\r\n * Calculates a Body's angular velocity.\r\n *\r\n * @method Phaser.Physics.Arcade.World#computeAngularVelocity\r\n * @since 3.10.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Body} body - The Body to compute the velocity for.\r\n * @param {number} delta - The delta value to be used in the calculation, in seconds.\r\n */", "meta": { "filename": "World.js", "lineno": 1191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Calculates a Body's angular velocity.", "kind": "function", "name": "computeAngularVelocity", "since": "3.10.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The Body to compute the velocity for.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value to be used in the calculation, in seconds.", "name": "delta" } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#computeAngularVelocity", "scope": "instance", "___id": "T000002R029943", "___s": true }, { "comment": "/**\r\n * Calculates a Body's per-axis velocity.\r\n *\r\n * @method Phaser.Physics.Arcade.World#computeVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Body} body - The Body to compute the velocity for.\r\n * @param {number} delta - The delta value to be used in the calculation, in seconds.\r\n */", "meta": { "filename": "World.js", "lineno": 1237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Calculates a Body's per-axis velocity.", "kind": "function", "name": "computeVelocity", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The Body to compute the velocity for.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value to be used in the calculation, in seconds.", "name": "delta" } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#computeVelocity", "scope": "instance", "___id": "T000002R029958", "___s": true }, { "comment": "/**\r\n * Separates two Bodies.\r\n *\r\n * @method Phaser.Physics.Arcade.World#separate\r\n * @fires Phaser.Physics.Arcade.Events#COLLIDE\r\n * @fires Phaser.Physics.Arcade.Events#OVERLAP\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Body} body1 - The first Body to be separated.\r\n * @param {Phaser.Physics.Arcade.Body} body2 - The second Body to be separated.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [processCallback] - The process callback.\r\n * @param {*} [callbackContext] - The context in which to invoke the callback.\r\n * @param {boolean} [overlapOnly] - If this a collide or overlap check?\r\n *\r\n * @return {boolean} True if separation occurred, otherwise false.\r\n */", "meta": { "filename": "World.js", "lineno": 1363, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Separates two Bodies.", "kind": "function", "name": "separate", "fires": [ "Phaser.Physics.Arcade.Events#event:COLLIDE", "Phaser.Physics.Arcade.Events#event:OVERLAP" ], "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The first Body to be separated.", "name": "body1" }, { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The second Body to be separated.", "name": "body2" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "The process callback.", "name": "processCallback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The context in which to invoke the callback.", "name": "callbackContext" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If this a collide or overlap check?", "name": "overlapOnly" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if separation occurred, otherwise false." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#separate", "scope": "instance", "___id": "T000002R029996", "___s": true }, { "comment": "/**\r\n * Separates two Bodies, when both are circular.\r\n *\r\n * @method Phaser.Physics.Arcade.World#separateCircle\r\n * @fires Phaser.Physics.Arcade.Events#COLLIDE\r\n * @fires Phaser.Physics.Arcade.Events#OVERLAP\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Body} body1 - The first Body to be separated.\r\n * @param {Phaser.Physics.Arcade.Body} body2 - The second Body to be separated.\r\n * @param {boolean} [overlapOnly] - If this a collide or overlap check?\r\n *\r\n * @return {boolean} True if separation occurred, otherwise false.\r\n */", "meta": { "filename": "World.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Separates two Bodies, when both are circular.", "kind": "function", "name": "separateCircle", "fires": [ "Phaser.Physics.Arcade.Events#event:COLLIDE", "Phaser.Physics.Arcade.Events#event:OVERLAP" ], "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The first Body to be separated.", "name": "body1" }, { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The second Body to be separated.", "name": "body2" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If this a collide or overlap check?", "name": "overlapOnly" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if separation occurred, otherwise false." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#separateCircle", "scope": "instance", "___id": "T000002R030018", "___s": true }, { "comment": "/**\r\n * Checks to see if two Bodies intersect at all.\r\n *\r\n * @method Phaser.Physics.Arcade.World#intersects\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Body} body1 - The first body to check.\r\n * @param {Phaser.Physics.Arcade.Body} body2 - The second body to check.\r\n *\r\n * @return {boolean} True if the two bodies intersect, otherwise false.\r\n */", "meta": { "filename": "World.js", "lineno": 1684, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Checks to see if two Bodies intersect at all.", "kind": "function", "name": "intersects", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The first body to check.", "name": "body1" }, { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The second body to check.", "name": "body2" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the two bodies intersect, otherwise false." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#intersects", "scope": "instance", "___id": "T000002R030089", "___s": true }, { "comment": "/**\r\n * Tests if a circular Body intersects with another Body.\r\n *\r\n * @method Phaser.Physics.Arcade.World#circleBodyIntersects\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Arcade.Body} circle - The circular body to test.\r\n * @param {Phaser.Physics.Arcade.Body} body - The rectangular body to test.\r\n *\r\n * @return {boolean} True if the two bodies intersect, otherwise false.\r\n */", "meta": { "filename": "World.js", "lineno": 1732, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Tests if a circular Body intersects with another Body.", "kind": "function", "name": "circleBodyIntersects", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The circular body to test.", "name": "circle" }, { "type": { "names": [ "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } }, "description": "The rectangular body to test.", "name": "body" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the two bodies intersect, otherwise false." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#circleBodyIntersects", "scope": "instance", "___id": "T000002R030091", "___s": true }, { "comment": "/**\r\n * Tests if Game Objects overlap.\r\n *\r\n * See details in {@link Phaser.Physics.Arcade.World#collide}.\r\n *\r\n * @method Phaser.Physics.Arcade.World#overlap\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} object1 - The first object or array of objects to check.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} [object2] - The second object or array of objects to check, or `undefined`.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [overlapCallback] - An optional callback function that is called if the objects overlap.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [processCallback] - An optional callback function that lets you perform additional checks against the two objects if they overlap. If this is set then `overlapCallback` will only be called if this callback returns `true`.\r\n * @param {*} [callbackContext] - The context in which to run the callbacks.\r\n *\r\n * @return {boolean} True if at least one Game Object overlaps another.\r\n *\r\n * @see Phaser.Physics.Arcade.World#collide\r\n */", "meta": { "filename": "World.js", "lineno": 1754, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Tests if Game Objects overlap.\r\rSee details in {@link Phaser.Physics.Arcade.World#collide}.", "kind": "function", "name": "overlap", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "description": "The first object or array of objects to check.", "name": "object1" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "optional": true, "description": "The second object or array of objects to check, or `undefined`.", "name": "object2" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that is called if the objects overlap.", "name": "overlapCallback" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that lets you perform additional checks against the two objects if they overlap. If this is set then `overlapCallback` will only be called if this callback returns `true`.", "name": "processCallback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The context in which to run the callbacks.", "name": "callbackContext" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if at least one Game Object overlaps another." } ], "see": [ "Phaser.Physics.Arcade.World#collide" ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#overlap", "scope": "instance", "___id": "T000002R030097", "___s": true }, { "comment": "/**\r\n * Performs a collision check and separation between the two physics enabled objects given, which can be single\r\n * Game Objects, arrays of Game Objects, Physics Groups, arrays of Physics Groups or normal Groups.\r\n *\r\n * If you don't require separation then use {@link Phaser.Physics.Arcade.World#overlap} instead.\r\n *\r\n * If two Groups or arrays are passed, each member of one will be tested against each member of the other.\r\n *\r\n * If **only** one Group is passed (as `object1`), each member of the Group will be collided against the other members.\r\n *\r\n * If **only** one Array is passed, the array is iterated and every element in it is tested against the others.\r\n *\r\n * Two callbacks can be provided; they receive the colliding game objects as arguments.\r\n * If an overlap is detected, the `processCallback` is called first. It can cancel the collision by returning false.\r\n * Next the objects are separated and `collideCallback` is invoked.\r\n *\r\n * Arcade Physics uses the Projection Method of collision resolution and separation. While it's fast and suitable\r\n * for 'arcade' style games it lacks stability when multiple objects are in close proximity or resting upon each other.\r\n * The separation that stops two objects penetrating may create a new penetration against a different object. If you\r\n * require a high level of stability please consider using an alternative physics system, such as Matter.js.\r\n *\r\n * @method Phaser.Physics.Arcade.World#collide\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} object1 - The first object or array of objects to check.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} [object2] - The second object or array of objects to check, or `undefined`.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [collideCallback] - An optional callback function that is called if the objects collide.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [processCallback] - An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.\r\n * @param {any} [callbackContext] - The context in which to run the callbacks.\r\n *\r\n * @return {boolean} `true` if any overlapping Game Objects were separated, otherwise `false`.\r\n */", "meta": { "filename": "World.js", "lineno": 1781, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Performs a collision check and separation between the two physics enabled objects given, which can be single\rGame Objects, arrays of Game Objects, Physics Groups, arrays of Physics Groups or normal Groups.\r\rIf you don't require separation then use {@link Phaser.Physics.Arcade.World#overlap} instead.\r\rIf two Groups or arrays are passed, each member of one will be tested against each member of the other.\r\rIf **only** one Group is passed (as `object1`), each member of the Group will be collided against the other members.\r\rIf **only** one Array is passed, the array is iterated and every element in it is tested against the others.\r\rTwo callbacks can be provided; they receive the colliding game objects as arguments.\rIf an overlap is detected, the `processCallback` is called first. It can cancel the collision by returning false.\rNext the objects are separated and `collideCallback` is invoked.\r\rArcade Physics uses the Projection Method of collision resolution and separation. While it's fast and suitable\rfor 'arcade' style games it lacks stability when multiple objects are in close proximity or resting upon each other.\rThe separation that stops two objects penetrating may create a new penetration against a different object. If you\rrequire a high level of stability please consider using an alternative physics system, such as Matter.js.", "kind": "function", "name": "collide", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "description": "The first object or array of objects to check.", "name": "object1" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeColliderType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeColliderType" } }, "optional": true, "description": "The second object or array of objects to check, or `undefined`.", "name": "object2" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that is called if the objects collide.", "name": "collideCallback" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.", "name": "processCallback" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The context in which to run the callbacks.", "name": "callbackContext" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if any overlapping Game Objects were separated, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#collide", "scope": "instance", "___id": "T000002R030102", "___s": true }, { "comment": "/**\r\n * Checks if the two given Arcade Physics bodies will collide, or not,\r\n * based on their collision mask and collision categories.\r\n *\r\n * @method Phaser.Physics.Arcade.World#canCollide\r\n * @since 3.61.0\r\n *\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeCollider} body1 - The first body to check.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadeCollider} body2 - The second body to check.\r\n *\r\n * @return {boolean} True if the two bodies will collide, otherwise false.\r\n */", "meta": { "filename": "World.js", "lineno": 1994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Checks if the two given Arcade Physics bodies will collide, or not,\rbased on their collision mask and collision categories.", "kind": "function", "name": "canCollide", "since": "3.61.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeCollider" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeCollider" } }, "description": "The first body to check.", "name": "body1" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadeCollider" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeCollider" } }, "description": "The second body to check.", "name": "body2" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the two bodies will collide, otherwise false." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#canCollide", "scope": "instance", "___id": "T000002R030125", "___s": true }, { "comment": "/**\r\n * This advanced method is specifically for testing for collision between a single Sprite and an array of Tile objects.\r\n *\r\n * You should generally use the `collide` method instead, with a Sprite vs. a Tilemap Layer, as that will perform\r\n * tile filtering and culling for you, as well as handle the interesting face collision automatically.\r\n *\r\n * This method is offered for those who would like to check for collision with specific Tiles in a layer, without\r\n * having to set any collision attributes on the tiles in question. This allows you to perform quick dynamic collisions\r\n * on small sets of Tiles. As such, no culling or checks are made to the array of Tiles given to this method,\r\n * you should filter them before passing them to this method.\r\n *\r\n * Important: Use of this method skips the `interesting faces` system that Tilemap Layers use. This means if you have\r\n * say a row or column of tiles, and you jump into, or walk over them, it's possible to get stuck on the edges of the\r\n * tiles as the interesting face calculations are skipped. However, for quick-fire small collision set tests on\r\n * dynamic maps, this method can prove very useful.\r\n *\r\n * This method does not factor in the Collision Mask or Category.\r\n *\r\n * @method Phaser.Physics.Arcade.World#collideTiles\r\n * @fires Phaser.Physics.Arcade.Events#TILE_COLLIDE\r\n * @since 3.17.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} sprite - The first object to check for collision.\r\n * @param {Phaser.Tilemaps.Tile[]} tiles - An array of Tiles to check for collision against.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [collideCallback] - An optional callback function that is called if the objects collide.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [processCallback] - An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.\r\n * @param {any} [callbackContext] - The context in which to run the callbacks.\r\n *\r\n * @return {boolean} True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated.\r\n */", "meta": { "filename": "World.js", "lineno": 2201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "This advanced method is specifically for testing for collision between a single Sprite and an array of Tile objects.\r\rYou should generally use the `collide` method instead, with a Sprite vs. a Tilemap Layer, as that will perform\rtile filtering and culling for you, as well as handle the interesting face collision automatically.\r\rThis method is offered for those who would like to check for collision with specific Tiles in a layer, without\rhaving to set any collision attributes on the tiles in question. This allows you to perform quick dynamic collisions\ron small sets of Tiles. As such, no culling or checks are made to the array of Tiles given to this method,\ryou should filter them before passing them to this method.\r\rImportant: Use of this method skips the `interesting faces` system that Tilemap Layers use. This means if you have\rsay a row or column of tiles, and you jump into, or walk over them, it's possible to get stuck on the edges of the\rtiles as the interesting face calculations are skipped. However, for quick-fire small collision set tests on\rdynamic maps, this method can prove very useful.\r\rThis method does not factor in the Collision Mask or Category.", "kind": "function", "name": "collideTiles", "fires": [ "Phaser.Physics.Arcade.Events#event:TILE_COLLIDE" ], "since": "3.17.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The first object to check for collision.", "name": "sprite" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of Tiles to check for collision against.", "name": "tiles" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that is called if the objects collide.", "name": "collideCallback" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.", "name": "processCallback" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The context in which to run the callbacks.", "name": "callbackContext" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#collideTiles", "scope": "instance", "___id": "T000002R030157", "___s": true }, { "comment": "/**\r\n * This advanced method is specifically for testing for overlaps between a single Sprite and an array of Tile objects.\r\n *\r\n * You should generally use the `overlap` method instead, with a Sprite vs. a Tilemap Layer, as that will perform\r\n * tile filtering and culling for you, as well as handle the interesting face collision automatically.\r\n *\r\n * This method is offered for those who would like to check for overlaps with specific Tiles in a layer, without\r\n * having to set any collision attributes on the tiles in question. This allows you to perform quick dynamic overlap\r\n * tests on small sets of Tiles. As such, no culling or checks are made to the array of Tiles given to this method,\r\n * you should filter them before passing them to this method.\r\n *\r\n * This method does not factor in the Collision Mask or Category.\r\n *\r\n * @method Phaser.Physics.Arcade.World#overlapTiles\r\n * @fires Phaser.Physics.Arcade.Events#TILE_OVERLAP\r\n * @since 3.17.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} sprite - The first object to check for collision.\r\n * @param {Phaser.Tilemaps.Tile[]} tiles - An array of Tiles to check for collision against.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [collideCallback] - An optional callback function that is called if the objects overlap.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [processCallback] - An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.\r\n * @param {any} [callbackContext] - The context in which to run the callbacks.\r\n *\r\n * @return {boolean} True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated.\r\n */", "meta": { "filename": "World.js", "lineno": 2243, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "This advanced method is specifically for testing for overlaps between a single Sprite and an array of Tile objects.\r\rYou should generally use the `overlap` method instead, with a Sprite vs. a Tilemap Layer, as that will perform\rtile filtering and culling for you, as well as handle the interesting face collision automatically.\r\rThis method is offered for those who would like to check for overlaps with specific Tiles in a layer, without\rhaving to set any collision attributes on the tiles in question. This allows you to perform quick dynamic overlap\rtests on small sets of Tiles. As such, no culling or checks are made to the array of Tiles given to this method,\ryou should filter them before passing them to this method.\r\rThis method does not factor in the Collision Mask or Category.", "kind": "function", "name": "overlapTiles", "fires": [ "Phaser.Physics.Arcade.Events#event:TILE_OVERLAP" ], "since": "3.17.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The first object to check for collision.", "name": "sprite" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of Tiles to check for collision against.", "name": "tiles" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that is called if the objects overlap.", "name": "collideCallback" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.", "name": "processCallback" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The context in which to run the callbacks.", "name": "callbackContext" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#overlapTiles", "scope": "instance", "___id": "T000002R030159", "___s": true }, { "comment": "/**\r\n * Internal handler for Sprite vs. Tilemap collisions.\r\n * Please use Phaser.Physics.Arcade.World#collide instead.\r\n *\r\n * @method Phaser.Physics.Arcade.World#collideSpriteVsTilemapLayer\r\n * @fires Phaser.Physics.Arcade.Events#TILE_COLLIDE\r\n * @fires Phaser.Physics.Arcade.Events#TILE_OVERLAP\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} sprite - The first object to check for collision.\r\n * @param {Phaser.Tilemaps.TilemapLayer} tilemapLayer - The second object to check for collision.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [collideCallback] - An optional callback function that is called if the objects collide.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [processCallback] - An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.\r\n * @param {any} [callbackContext] - The context in which to run the callbacks.\r\n * @param {boolean} [overlapOnly] - Whether this is a collision or overlap check.\r\n *\r\n * @return {boolean} True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated.\r\n */", "meta": { "filename": "World.js", "lineno": 2280, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Internal handler for Sprite vs. Tilemap collisions.\rPlease use Phaser.Physics.Arcade.World#collide instead.", "kind": "function", "name": "collideSpriteVsTilemapLayer", "fires": [ "Phaser.Physics.Arcade.Events#event:TILE_COLLIDE", "Phaser.Physics.Arcade.Events#event:TILE_OVERLAP" ], "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The first object to check for collision.", "name": "sprite" }, { "type": { "names": [ "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } }, "description": "The second object to check for collision.", "name": "tilemapLayer" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that is called if the objects collide.", "name": "collideCallback" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.", "name": "processCallback" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The context in which to run the callbacks.", "name": "callbackContext" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether this is a collision or overlap check.", "name": "overlapOnly" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated." } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#collideSpriteVsTilemapLayer", "scope": "instance", "___id": "T000002R030161", "___s": true }, { "comment": "/**\r\n * Wrap an object's coordinates (or several objects' coordinates) within {@link Phaser.Physics.Arcade.World#bounds}.\r\n *\r\n * If the object is outside any boundary edge (left, top, right, bottom), it will be moved to the same offset from the opposite edge (the interior).\r\n *\r\n * @method Phaser.Physics.Arcade.World#wrap\r\n * @since 3.3.0\r\n *\r\n * @param {any} object - A Game Object, a Group, an object with `x` and `y` coordinates, or an array of such objects.\r\n * @param {number} [padding=0] - An amount added to each boundary edge during the operation.\r\n */", "meta": { "filename": "World.js", "lineno": 2453, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Wrap an object's coordinates (or several objects' coordinates) within {@link Phaser.Physics.Arcade.World#bounds}.\r\rIf the object is outside any boundary edge (left, top, right, bottom), it will be moved to the same offset from the opposite edge (the interior).", "kind": "function", "name": "wrap", "since": "3.3.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "A Game Object, a Group, an object with `x` and `y` coordinates, or an array of such objects.", "name": "object" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An amount added to each boundary edge during the operation.", "name": "padding" } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#wrap", "scope": "instance", "___id": "T000002R030201", "___s": true }, { "comment": "/**\r\n * Wrap each object's coordinates within {@link Phaser.Physics.Arcade.World#bounds}.\r\n *\r\n * @method Phaser.Physics.Arcade.World#wrapArray\r\n * @since 3.3.0\r\n *\r\n * @param {Array.<*>} objects - An array of objects to be wrapped.\r\n * @param {number} [padding=0] - An amount added to the boundary.\r\n */", "meta": { "filename": "World.js", "lineno": 2484, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Wrap each object's coordinates within {@link Phaser.Physics.Arcade.World#bounds}.", "kind": "function", "name": "wrapArray", "since": "3.3.0", "params": [ { "type": { "names": [ "Array.<*>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "AllLiteral" } ] } }, "description": "An array of objects to be wrapped.", "name": "objects" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An amount added to the boundary.", "name": "padding" } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#wrapArray", "scope": "instance", "___id": "T000002R030203", "___s": true }, { "comment": "/**\r\n * Wrap an object's coordinates within {@link Phaser.Physics.Arcade.World#bounds}.\r\n *\r\n * @method Phaser.Physics.Arcade.World#wrapObject\r\n * @since 3.3.0\r\n *\r\n * @param {*} object - A Game Object, a Physics Body, or any object with `x` and `y` coordinates\r\n * @param {number} [padding=0] - An amount added to the boundary.\r\n */", "meta": { "filename": "World.js", "lineno": 2501, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Wrap an object's coordinates within {@link Phaser.Physics.Arcade.World#bounds}.", "kind": "function", "name": "wrapObject", "since": "3.3.0", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "A Game Object, a Physics Body, or any object with `x` and `y` coordinates", "name": "object" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An amount added to the boundary.", "name": "padding" } ], "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#wrapObject", "scope": "instance", "___id": "T000002R030206", "___s": true }, { "comment": "/**\r\n * Shuts down the simulation, clearing physics data and removing listeners.\r\n *\r\n * @method Phaser.Physics.Arcade.World#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 2518, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Shuts down the simulation, clearing physics data and removing listeners.", "kind": "function", "name": "shutdown", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#shutdown", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#shutdown", "___id": "T000002R030211", "___s": true }, { "comment": "/**\r\n * Shuts down the simulation and disconnects it from the current scene.\r\n *\r\n * @method Phaser.Physics.Arcade.World#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 2535, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade", "code": {} }, "description": "Shuts down the simulation and disconnects it from the current scene.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.World", "longname": "Phaser.Physics.Arcade.World#destroy", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#destroy", "___id": "T000002R030213", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Physics\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics", "code": {} }, "kind": "namespace", "name": "Physics", "memberof": "Phaser", "longname": "Phaser.Physics", "scope": "static", "___id": "T000002R030218", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Physics\r\n */", "meta": { "filename": "index.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics", "code": {} }, "kind": "namespace", "name": "Physics", "memberof": "Phaser.Types", "longname": "Phaser.Types.Physics", "scope": "static", "___id": "T000002R030219", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n *\r\n * The Body Bounds class contains methods to help you extract the world coordinates from various points around\r\n * the bounds of a Matter Body. Because Matter bodies are positioned based on their center of mass, and not a\r\n * dimension based center, you often need to get the bounds coordinates in order to properly align them in the world.\r\n *\r\n * You can access this class via the MatterPhysics class from a Scene, i.e.:\r\n *\r\n * ```javascript\r\n * this.matter.bodyBounds.getTopLeft(body);\r\n * ```\r\n *\r\n * See also the `MatterPhysics.alignBody` method.\r\n *\r\n * @class BodyBounds\r\n * @memberof Phaser.Physics.Matter\r\n * @constructor\r\n * @since 3.22.0\r\n */", "meta": { "filename": "BodyBounds.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "classdesc": "The Body Bounds class contains methods to help you extract the world coordinates from various points around\rthe bounds of a Matter Body. Because Matter bodies are positioned based on their center of mass, and not a\rdimension based center, you often need to get the bounds coordinates in order to properly align them in the world.\r\rYou can access this class via the MatterPhysics class from a Scene, i.e.:\r\r```javascript\rthis.matter.bodyBounds.getTopLeft(body);\r```\r\rSee also the `MatterPhysics.alignBody` method.", "kind": "class", "name": "BodyBounds", "memberof": "Phaser.Physics.Matter", "since": "3.22.0", "scope": "static", "longname": "Phaser.Physics.Matter.BodyBounds", "___id": "T000002R030225", "___s": true }, { "comment": "/**\r\n * A Vector2 that stores the temporary bounds center value during calculations by methods in this class.\r\n *\r\n * @name Phaser.Physics.Matter.BodyBounds#boundsCenter\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "BodyBounds.js", "lineno": 36, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A Vector2 that stores the temporary bounds center value during calculations by methods in this class.", "name": "boundsCenter", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.BodyBounds", "longname": "Phaser.Physics.Matter.BodyBounds#boundsCenter", "scope": "instance", "kind": "member", "___id": "T000002R030228", "___s": true }, { "comment": "/**\r\n * A Vector2 that stores the temporary center diff values during calculations by methods in this class.\r\n *\r\n * @name Phaser.Physics.Matter.BodyBounds#centerDiff\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "BodyBounds.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A Vector2 that stores the temporary center diff values during calculations by methods in this class.", "name": "centerDiff", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.BodyBounds", "longname": "Phaser.Physics.Matter.BodyBounds#centerDiff", "scope": "instance", "kind": "member", "___id": "T000002R030230", "___s": true }, { "comment": "/**\r\n * Parses the given body to get the bounds diff values from it.\r\n *\r\n * They're stored in this class in the temporary properties `boundsCenter` and `centerDiff`.\r\n *\r\n * This method is called automatically by all other methods in this class.\r\n *\r\n * @method Phaser.Physics.Matter.BodyBounds#parseBody\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBody} body - The Body to get the bounds position from.\r\n *\r\n * @return {boolean} `true` if it was able to get the bounds, otherwise `false`.\r\n */", "meta": { "filename": "BodyBounds.js", "lineno": 55, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Parses the given body to get the bounds diff values from it.\r\rThey're stored in this class in the temporary properties `boundsCenter` and `centerDiff`.\r\rThis method is called automatically by all other methods in this class.", "kind": "function", "name": "parseBody", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" } }, "description": "The Body to get the bounds position from.", "name": "body" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if it was able to get the bounds, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.BodyBounds", "longname": "Phaser.Physics.Matter.BodyBounds#parseBody", "scope": "instance", "___id": "T000002R030232", "___s": true }, { "comment": "/**\r\n * Takes a Body and returns the world coordinates of the top-left of its _bounds_.\r\n *\r\n * Body bounds are updated by Matter each step and factor in scale and rotation.\r\n * This will return the world coordinate based on the bodies _current_ position and bounds.\r\n *\r\n * @method Phaser.Physics.Matter.BodyBounds#getTopLeft\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBody} body - The Body to get the position from.\r\n * @param {number} [x=0] - Optional horizontal offset to add to the returned coordinates.\r\n * @param {number} [y=0] - Optional vertical offset to add to the returned coordinates.\r\n *\r\n * @return {(Phaser.Math.Vector2|false)} A Vector2 containing the coordinates, or `false` if it was unable to parse the body.\r\n */", "meta": { "filename": "BodyBounds.js", "lineno": 93, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Takes a Body and returns the world coordinates of the top-left of its _bounds_.\r\rBody bounds are updated by Matter each step and factor in scale and rotation.\rThis will return the world coordinate based on the bodies _current_ position and bounds.", "kind": "function", "name": "getTopLeft", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" } }, "description": "The Body to get the position from.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset to add to the returned coordinates.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset to add to the returned coordinates.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2", "false" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "false", "reservedWord": true } ] } }, "description": "A Vector2 containing the coordinates, or `false` if it was unable to parse the body." } ], "memberof": "Phaser.Physics.Matter.BodyBounds", "longname": "Phaser.Physics.Matter.BodyBounds#getTopLeft", "scope": "instance", "___id": "T000002R030241", "___s": true }, { "comment": "/**\r\n * Takes a Body and returns the world coordinates of the top-center of its _bounds_.\r\n *\r\n * Body bounds are updated by Matter each step and factor in scale and rotation.\r\n * This will return the world coordinate based on the bodies _current_ position and bounds.\r\n *\r\n * @method Phaser.Physics.Matter.BodyBounds#getTopCenter\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBody} body - The Body to get the position from.\r\n * @param {number} [x=0] - Optional horizontal offset to add to the returned coordinates.\r\n * @param {number} [y=0] - Optional vertical offset to add to the returned coordinates.\r\n *\r\n * @return {(Phaser.Math.Vector2|false)} A Vector2 containing the coordinates, or `false` if it was unable to parse the body.\r\n */", "meta": { "filename": "BodyBounds.js", "lineno": 127, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Takes a Body and returns the world coordinates of the top-center of its _bounds_.\r\rBody bounds are updated by Matter each step and factor in scale and rotation.\rThis will return the world coordinate based on the bodies _current_ position and bounds.", "kind": "function", "name": "getTopCenter", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" } }, "description": "The Body to get the position from.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset to add to the returned coordinates.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset to add to the returned coordinates.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2", "false" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "false", "reservedWord": true } ] } }, "description": "A Vector2 containing the coordinates, or `false` if it was unable to parse the body." } ], "memberof": "Phaser.Physics.Matter.BodyBounds", "longname": "Phaser.Physics.Matter.BodyBounds#getTopCenter", "scope": "instance", "___id": "T000002R030247", "___s": true }, { "comment": "/**\r\n * Takes a Body and returns the world coordinates of the top-right of its _bounds_.\r\n *\r\n * Body bounds are updated by Matter each step and factor in scale and rotation.\r\n * This will return the world coordinate based on the bodies _current_ position and bounds.\r\n *\r\n * @method Phaser.Physics.Matter.BodyBounds#getTopRight\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBody} body - The Body to get the position from.\r\n * @param {number} [x=0] - Optional horizontal offset to add to the returned coordinates.\r\n * @param {number} [y=0] - Optional vertical offset to add to the returned coordinates.\r\n *\r\n * @return {(Phaser.Math.Vector2|false)} A Vector2 containing the coordinates, or `false` if it was unable to parse the body.\r\n */", "meta": { "filename": "BodyBounds.js", "lineno": 161, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Takes a Body and returns the world coordinates of the top-right of its _bounds_.\r\rBody bounds are updated by Matter each step and factor in scale and rotation.\rThis will return the world coordinate based on the bodies _current_ position and bounds.", "kind": "function", "name": "getTopRight", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" } }, "description": "The Body to get the position from.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset to add to the returned coordinates.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset to add to the returned coordinates.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2", "false" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "false", "reservedWord": true } ] } }, "description": "A Vector2 containing the coordinates, or `false` if it was unable to parse the body." } ], "memberof": "Phaser.Physics.Matter.BodyBounds", "longname": "Phaser.Physics.Matter.BodyBounds#getTopRight", "scope": "instance", "___id": "T000002R030253", "___s": true }, { "comment": "/**\r\n * Takes a Body and returns the world coordinates of the left-center of its _bounds_.\r\n *\r\n * Body bounds are updated by Matter each step and factor in scale and rotation.\r\n * This will return the world coordinate based on the bodies _current_ position and bounds.\r\n *\r\n * @method Phaser.Physics.Matter.BodyBounds#getLeftCenter\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBody} body - The Body to get the position from.\r\n * @param {number} [x=0] - Optional horizontal offset to add to the returned coordinates.\r\n * @param {number} [y=0] - Optional vertical offset to add to the returned coordinates.\r\n *\r\n * @return {(Phaser.Math.Vector2|false)} A Vector2 containing the coordinates, or `false` if it was unable to parse the body.\r\n */", "meta": { "filename": "BodyBounds.js", "lineno": 195, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Takes a Body and returns the world coordinates of the left-center of its _bounds_.\r\rBody bounds are updated by Matter each step and factor in scale and rotation.\rThis will return the world coordinate based on the bodies _current_ position and bounds.", "kind": "function", "name": "getLeftCenter", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" } }, "description": "The Body to get the position from.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset to add to the returned coordinates.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset to add to the returned coordinates.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2", "false" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "false", "reservedWord": true } ] } }, "description": "A Vector2 containing the coordinates, or `false` if it was unable to parse the body." } ], "memberof": "Phaser.Physics.Matter.BodyBounds", "longname": "Phaser.Physics.Matter.BodyBounds#getLeftCenter", "scope": "instance", "___id": "T000002R030259", "___s": true }, { "comment": "/**\r\n * Takes a Body and returns the world coordinates of the center of its _bounds_.\r\n *\r\n * Body bounds are updated by Matter each step and factor in scale and rotation.\r\n * This will return the world coordinate based on the bodies _current_ position and bounds.\r\n *\r\n * @method Phaser.Physics.Matter.BodyBounds#getCenter\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBody} body - The Body to get the position from.\r\n * @param {number} [x=0] - Optional horizontal offset to add to the returned coordinates.\r\n * @param {number} [y=0] - Optional vertical offset to add to the returned coordinates.\r\n *\r\n * @return {(Phaser.Math.Vector2|false)} A Vector2 containing the coordinates, or `false` if it was unable to parse the body.\r\n */", "meta": { "filename": "BodyBounds.js", "lineno": 229, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Takes a Body and returns the world coordinates of the center of its _bounds_.\r\rBody bounds are updated by Matter each step and factor in scale and rotation.\rThis will return the world coordinate based on the bodies _current_ position and bounds.", "kind": "function", "name": "getCenter", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" } }, "description": "The Body to get the position from.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset to add to the returned coordinates.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset to add to the returned coordinates.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2", "false" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "false", "reservedWord": true } ] } }, "description": "A Vector2 containing the coordinates, or `false` if it was unable to parse the body." } ], "memberof": "Phaser.Physics.Matter.BodyBounds", "longname": "Phaser.Physics.Matter.BodyBounds#getCenter", "scope": "instance", "___id": "T000002R030265", "___s": true }, { "comment": "/**\r\n * Takes a Body and returns the world coordinates of the right-center of its _bounds_.\r\n *\r\n * Body bounds are updated by Matter each step and factor in scale and rotation.\r\n * This will return the world coordinate based on the bodies _current_ position and bounds.\r\n *\r\n * @method Phaser.Physics.Matter.BodyBounds#getRightCenter\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBody} body - The Body to get the position from.\r\n * @param {number} [x=0] - Optional horizontal offset to add to the returned coordinates.\r\n * @param {number} [y=0] - Optional vertical offset to add to the returned coordinates.\r\n *\r\n * @return {(Phaser.Math.Vector2|false)} A Vector2 containing the coordinates, or `false` if it was unable to parse the body.\r\n */", "meta": { "filename": "BodyBounds.js", "lineno": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Takes a Body and returns the world coordinates of the right-center of its _bounds_.\r\rBody bounds are updated by Matter each step and factor in scale and rotation.\rThis will return the world coordinate based on the bodies _current_ position and bounds.", "kind": "function", "name": "getRightCenter", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" } }, "description": "The Body to get the position from.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset to add to the returned coordinates.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset to add to the returned coordinates.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2", "false" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "false", "reservedWord": true } ] } }, "description": "A Vector2 containing the coordinates, or `false` if it was unable to parse the body." } ], "memberof": "Phaser.Physics.Matter.BodyBounds", "longname": "Phaser.Physics.Matter.BodyBounds#getRightCenter", "scope": "instance", "___id": "T000002R030270", "___s": true }, { "comment": "/**\r\n * Takes a Body and returns the world coordinates of the bottom-left of its _bounds_.\r\n *\r\n * Body bounds are updated by Matter each step and factor in scale and rotation.\r\n * This will return the world coordinate based on the bodies _current_ position and bounds.\r\n *\r\n * @method Phaser.Physics.Matter.BodyBounds#getBottomLeft\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBody} body - The Body to get the position from.\r\n * @param {number} [x=0] - Optional horizontal offset to add to the returned coordinates.\r\n * @param {number} [y=0] - Optional vertical offset to add to the returned coordinates.\r\n *\r\n * @return {(Phaser.Math.Vector2|false)} A Vector2 containing the coordinates, or `false` if it was unable to parse the body.\r\n */", "meta": { "filename": "BodyBounds.js", "lineno": 296, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Takes a Body and returns the world coordinates of the bottom-left of its _bounds_.\r\rBody bounds are updated by Matter each step and factor in scale and rotation.\rThis will return the world coordinate based on the bodies _current_ position and bounds.", "kind": "function", "name": "getBottomLeft", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" } }, "description": "The Body to get the position from.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset to add to the returned coordinates.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset to add to the returned coordinates.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2", "false" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "false", "reservedWord": true } ] } }, "description": "A Vector2 containing the coordinates, or `false` if it was unable to parse the body." } ], "memberof": "Phaser.Physics.Matter.BodyBounds", "longname": "Phaser.Physics.Matter.BodyBounds#getBottomLeft", "scope": "instance", "___id": "T000002R030276", "___s": true }, { "comment": "/**\r\n * Takes a Body and returns the world coordinates of the bottom-center of its _bounds_.\r\n *\r\n * Body bounds are updated by Matter each step and factor in scale and rotation.\r\n * This will return the world coordinate based on the bodies _current_ position and bounds.\r\n *\r\n * @method Phaser.Physics.Matter.BodyBounds#getBottomCenter\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBody} body - The Body to get the position from.\r\n * @param {number} [x=0] - Optional horizontal offset to add to the returned coordinates.\r\n * @param {number} [y=0] - Optional vertical offset to add to the returned coordinates.\r\n *\r\n * @return {(Phaser.Math.Vector2|false)} A Vector2 containing the coordinates, or `false` if it was unable to parse the body.\r\n */", "meta": { "filename": "BodyBounds.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Takes a Body and returns the world coordinates of the bottom-center of its _bounds_.\r\rBody bounds are updated by Matter each step and factor in scale and rotation.\rThis will return the world coordinate based on the bodies _current_ position and bounds.", "kind": "function", "name": "getBottomCenter", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" } }, "description": "The Body to get the position from.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset to add to the returned coordinates.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset to add to the returned coordinates.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2", "false" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "false", "reservedWord": true } ] } }, "description": "A Vector2 containing the coordinates, or `false` if it was unable to parse the body." } ], "memberof": "Phaser.Physics.Matter.BodyBounds", "longname": "Phaser.Physics.Matter.BodyBounds#getBottomCenter", "scope": "instance", "___id": "T000002R030282", "___s": true }, { "comment": "/**\r\n * Takes a Body and returns the world coordinates of the bottom-right of its _bounds_.\r\n *\r\n * Body bounds are updated by Matter each step and factor in scale and rotation.\r\n * This will return the world coordinate based on the bodies _current_ position and bounds.\r\n *\r\n * @method Phaser.Physics.Matter.BodyBounds#getBottomRight\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBody} body - The Body to get the position from.\r\n * @param {number} [x=0] - Optional horizontal offset to add to the returned coordinates.\r\n * @param {number} [y=0] - Optional vertical offset to add to the returned coordinates.\r\n *\r\n * @return {(Phaser.Math.Vector2|false)} A Vector2 containing the coordinates, or `false` if it was unable to parse the body.\r\n */", "meta": { "filename": "BodyBounds.js", "lineno": 364, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Takes a Body and returns the world coordinates of the bottom-right of its _bounds_.\r\rBody bounds are updated by Matter each step and factor in scale and rotation.\rThis will return the world coordinate based on the bodies _current_ position and bounds.", "kind": "function", "name": "getBottomRight", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" } }, "description": "The Body to get the position from.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset to add to the returned coordinates.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset to add to the returned coordinates.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2", "false" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "false", "reservedWord": true } ] } }, "description": "A Vector2 containing the coordinates, or `false` if it was unable to parse the body." } ], "memberof": "Phaser.Physics.Matter.BodyBounds", "longname": "Phaser.Physics.Matter.BodyBounds#getBottomRight", "scope": "instance", "___id": "T000002R030288", "___s": true }, { "comment": "/**\r\n * A component to set restitution on objects.\r\n *\r\n * @namespace Phaser.Physics.Matter.Components.Bounce\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Bounce.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "A component to set restitution on objects.", "kind": "namespace", "name": "Bounce", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components", "longname": "Phaser.Physics.Matter.Components.Bounce", "scope": "static", "___id": "T000002R030295", "___s": true }, { "comment": "/**\r\n * Sets the restitution on the physics object.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Bounce#setBounce\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - A Number that defines the restitution (elasticity) of the body. The value is always positive and is in the range (0, 1). A value of 0 means collisions may be perfectly inelastic and no bouncing may occur. A value of 0.8 means the body may bounce back with approximately 80% of its kinetic energy. Note that collision response is based on pairs of bodies, and that restitution values are combined with the following formula: `Math.max(bodyA.restitution, bodyB.restitution)`\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Bounce.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets the restitution on the physics object.", "kind": "function", "name": "setBounce", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A Number that defines the restitution (elasticity) of the body. The value is always positive and is in the range (0, 1). A value of 0 means collisions may be perfectly inelastic and no bouncing may occur. A value of 0.8 means the body may bounce back with approximately 80% of its kinetic energy. Note that collision response is based on pairs of bodies, and that restitution values are combined with the following formula: `Math.max(bodyA.restitution, bodyB.restitution)`", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Bounce", "longname": "Phaser.Physics.Matter.Components.Bounce#setBounce", "scope": "instance", "___id": "T000002R030297", "___s": true }, { "comment": "/**\r\n * Contains methods for changing the collision filter of a Matter Body. Should be used as a mixin and not called directly.\r\n *\r\n * @namespace Phaser.Physics.Matter.Components.Collision\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Collision.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Contains methods for changing the collision filter of a Matter Body. Should be used as a mixin and not called directly.", "kind": "namespace", "name": "Collision", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components", "longname": "Phaser.Physics.Matter.Components.Collision", "scope": "static", "___id": "T000002R030301", "___s": true }, { "comment": "/**\r\n * Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31.\r\n * Two bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\r\n * categories are included in their collision masks (see {@link #setCollidesWith}).\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setCollisionCategory\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - Unique category bitfield.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31.\rTwo bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\rcategories are included in their collision masks (see {@link #setCollidesWith}).", "kind": "function", "name": "setCollisionCategory", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Unique category bitfield.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Collision", "longname": "Phaser.Physics.Matter.Components.Collision#setCollisionCategory", "scope": "instance", "___id": "T000002R030303", "___s": true }, { "comment": "/**\r\n * Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values,\r\n * they will collide according to the usual rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\r\n * If two Matter Bodies have the same positive value, they will always collide; if they have the same negative value,\r\n * they will never collide.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setCollisionGroup\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - Unique group index.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values,\rthey will collide according to the usual rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\rIf two Matter Bodies have the same positive value, they will always collide; if they have the same negative value,\rthey will never collide.", "kind": "function", "name": "setCollisionGroup", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Unique group index.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Collision", "longname": "Phaser.Physics.Matter.Components.Collision#setCollisionGroup", "scope": "instance", "___id": "T000002R030306", "___s": true }, { "comment": "/**\r\n * Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only\r\n * collide if each one includes the other's category in its mask based on a bitwise AND, i.e. `(categoryA & maskB) !== 0`\r\n * and `(categoryB & maskA) !== 0` are both true.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setCollidesWith\r\n * @since 3.0.0\r\n *\r\n * @param {(number|number[])} categories - A unique category bitfield, or an array of them.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only\rcollide if each one includes the other's category in its mask based on a bitwise AND, i.e. `(categoryA & maskB) !== 0`\rand `(categoryB & maskA) !== 0` are both true.", "kind": "function", "name": "setCollidesWith", "since": "3.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" } ] } ] } }, "description": "A unique category bitfield, or an array of them.", "name": "categories" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Collision", "longname": "Phaser.Physics.Matter.Components.Collision#setCollidesWith", "scope": "instance", "___id": "T000002R030309", "___s": true }, { "comment": "/**\r\n * The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\n *\r\n * This does not change the bodies collision category, group or filter. Those must be set in addition\r\n * to the callback.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setOnCollide\r\n * @since 3.22.0\r\n *\r\n * @param {function} callback - The callback to invoke when this body starts colliding with another.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 87, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\rThis does not change the bodies collision category, group or filter. Those must be set in addition\rto the callback.", "kind": "function", "name": "setOnCollide", "since": "3.22.0", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke when this body starts colliding with another.", "name": "callback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Collision", "longname": "Phaser.Physics.Matter.Components.Collision#setOnCollide", "scope": "instance", "___id": "T000002R030316", "___s": true }, { "comment": "/**\r\n * The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\n *\r\n * This does not change the bodies collision category, group or filter. Those must be set in addition\r\n * to the callback.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setOnCollideEnd\r\n * @since 3.22.0\r\n *\r\n * @param {function} callback - The callback to invoke when this body stops colliding with another.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\rThis does not change the bodies collision category, group or filter. Those must be set in addition\rto the callback.", "kind": "function", "name": "setOnCollideEnd", "since": "3.22.0", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke when this body stops colliding with another.", "name": "callback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Collision", "longname": "Phaser.Physics.Matter.Components.Collision#setOnCollideEnd", "scope": "instance", "___id": "T000002R030319", "___s": true }, { "comment": "/**\r\n * The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\n *\r\n * This does not change the bodies collision category, group or filter. Those must be set in addition\r\n * to the callback.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setOnCollideActive\r\n * @since 3.22.0\r\n *\r\n * @param {function} callback - The callback to invoke for the duration of this body colliding with another.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 127, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\rThis does not change the bodies collision category, group or filter. Those must be set in addition\rto the callback.", "kind": "function", "name": "setOnCollideActive", "since": "3.22.0", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke for the duration of this body colliding with another.", "name": "callback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Collision", "longname": "Phaser.Physics.Matter.Components.Collision#setOnCollideActive", "scope": "instance", "___id": "T000002R030322", "___s": true }, { "comment": "/**\r\n * The callback is sent a reference to the other body, along with a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\n *\r\n * This does not change the bodies collision category, group or filter. Those must be set in addition\r\n * to the callback.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setOnCollideWith\r\n * @since 3.22.0\r\n *\r\n * @param {(MatterJS.Body|MatterJS.Body[])} body - The body, or an array of bodies, to test for collisions with.\r\n * @param {function} callback - The callback to invoke when this body collides with the given body or bodies.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 147, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "The callback is sent a reference to the other body, along with a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\rThis does not change the bodies collision category, group or filter. Those must be set in addition\rto the callback.", "kind": "function", "name": "setOnCollideWith", "since": "3.22.0", "params": [ { "type": { "names": [ "MatterJS.Body", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "MatterJS.Body" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.Body", "type": "NameExpression" } ] } ] } }, "description": "The body, or an array of bodies, to test for collisions with.", "name": "body" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke when this body collides with the given body or bodies.", "name": "callback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Collision", "longname": "Phaser.Physics.Matter.Components.Collision#setOnCollideWith", "scope": "instance", "___id": "T000002R030325", "___s": true }, { "comment": "/**\r\n * A component to apply force to Matter.js bodies.\r\n *\r\n * @namespace Phaser.Physics.Matter.Components.Force\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Force.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "A component to apply force to Matter.js bodies.", "kind": "namespace", "name": "Force", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components", "longname": "Phaser.Physics.Matter.Components.Force", "scope": "static", "___id": "T000002R030332", "___s": true }, { "comment": "/**\r\n * Applies a force to a body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#applyForce\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector2} force - A Vector that specifies the force to apply.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Applies a force to a body.", "kind": "function", "name": "applyForce", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector that specifies the force to apply.", "name": "force" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Force", "longname": "Phaser.Physics.Matter.Components.Force#applyForce", "scope": "instance", "___id": "T000002R030334", "___s": true }, { "comment": "/**\r\n * Applies a force to a body from a given position.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#applyForceFrom\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector2} position - The position in which the force comes from.\r\n * @param {Phaser.Math.Vector2} force - A Vector that specifies the force to apply.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 38, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Applies a force to a body from a given position.", "kind": "function", "name": "applyForceFrom", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The position in which the force comes from.", "name": "position" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector that specifies the force to apply.", "name": "force" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Force", "longname": "Phaser.Physics.Matter.Components.Force#applyForceFrom", "scope": "instance", "___id": "T000002R030336", "___s": true }, { "comment": "/**\r\n * Apply thrust to the forward position of the body.\r\n *\r\n * Use very small values, such as 0.1, depending on the mass and required speed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#thrust\r\n * @since 3.0.0\r\n *\r\n * @param {number} speed - A speed value to be applied to a directional force.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Apply thrust to the forward position of the body.\r\rUse very small values, such as 0.1, depending on the mass and required speed.", "kind": "function", "name": "thrust", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A speed value to be applied to a directional force.", "name": "speed" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Force", "longname": "Phaser.Physics.Matter.Components.Force#thrust", "scope": "instance", "___id": "T000002R030338", "___s": true }, { "comment": "/**\r\n * Apply thrust to the left position of the body.\r\n *\r\n * Use very small values, such as 0.1, depending on the mass and required speed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#thrustLeft\r\n * @since 3.0.0\r\n *\r\n * @param {number} speed - A speed value to be applied to a directional force.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Apply thrust to the left position of the body.\r\rUse very small values, such as 0.1, depending on the mass and required speed.", "kind": "function", "name": "thrustLeft", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A speed value to be applied to a directional force.", "name": "speed" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Force", "longname": "Phaser.Physics.Matter.Components.Force#thrustLeft", "scope": "instance", "___id": "T000002R030343", "___s": true }, { "comment": "/**\r\n * Apply thrust to the right position of the body.\r\n *\r\n * Use very small values, such as 0.1, depending on the mass and required speed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#thrustRight\r\n * @since 3.0.0\r\n *\r\n * @param {number} speed - A speed value to be applied to a directional force.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 102, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Apply thrust to the right position of the body.\r\rUse very small values, such as 0.1, depending on the mass and required speed.", "kind": "function", "name": "thrustRight", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A speed value to be applied to a directional force.", "name": "speed" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Force", "longname": "Phaser.Physics.Matter.Components.Force#thrustRight", "scope": "instance", "___id": "T000002R030348", "___s": true }, { "comment": "/**\r\n * Apply thrust to the back position of the body.\r\n *\r\n * Use very small values, such as 0.1, depending on the mass and required speed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#thrustBack\r\n * @since 3.0.0\r\n *\r\n * @param {number} speed - A speed value to be applied to a directional force.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 125, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Apply thrust to the back position of the body.\r\rUse very small values, such as 0.1, depending on the mass and required speed.", "kind": "function", "name": "thrustBack", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A speed value to be applied to a directional force.", "name": "speed" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Force", "longname": "Phaser.Physics.Matter.Components.Force#thrustBack", "scope": "instance", "___id": "T000002R030353", "___s": true }, { "comment": "/**\r\n * Contains methods for changing the friction of a Game Object's Matter Body. Should be used a mixin, not called directly.\r\n *\r\n * @namespace Phaser.Physics.Matter.Components.Friction\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Friction.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Contains methods for changing the friction of a Game Object's Matter Body. Should be used a mixin, not called directly.", "kind": "namespace", "name": "Friction", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components", "longname": "Phaser.Physics.Matter.Components.Friction", "scope": "static", "___id": "T000002R030359", "___s": true }, { "comment": "/**\r\n * Sets new friction values for this Game Object's Matter Body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Friction#setFriction\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.\r\n * @param {number} [air] - If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.\r\n * @param {number} [fstatic] - If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never \"stick\" when it is nearly stationary.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Friction.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets new friction values for this Game Object's Matter Body.", "kind": "function", "name": "setFriction", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.", "name": "air" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never \"stick\" when it is nearly stationary.", "name": "fstatic" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Friction", "longname": "Phaser.Physics.Matter.Components.Friction#setFriction", "scope": "instance", "___id": "T000002R030361", "___s": true }, { "comment": "/**\r\n * Sets a new air resistance for this Game Object's Matter Body.\r\n * A value of 0 means the Body will never slow as it moves through space.\r\n * The higher the value, the faster a Body slows when moving through space.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Friction#setFrictionAir\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new air resistance for the Body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Friction.js", "lineno": 44, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets a new air resistance for this Game Object's Matter Body.\rA value of 0 means the Body will never slow as it moves through space.\rThe higher the value, the faster a Body slows when moving through space.", "kind": "function", "name": "setFrictionAir", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new air resistance for the Body.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Friction", "longname": "Phaser.Physics.Matter.Components.Friction#setFrictionAir", "scope": "instance", "___id": "T000002R030366", "___s": true }, { "comment": "/**\r\n * Sets a new static friction for this Game Object's Matter Body.\r\n * A value of 0 means the Body will never \"stick\" when it is nearly stationary.\r\n * The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Friction#setFrictionStatic\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new static friction for the Body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Friction.js", "lineno": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets a new static friction for this Game Object's Matter Body.\rA value of 0 means the Body will never \"stick\" when it is nearly stationary.\rThe higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.", "kind": "function", "name": "setFrictionStatic", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new static friction for the Body.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Friction", "longname": "Phaser.Physics.Matter.Components.Friction#setFrictionStatic", "scope": "instance", "___id": "T000002R030369", "___s": true }, { "comment": "/**\r\n * A component to manipulate world gravity for Matter.js bodies.\r\n *\r\n * @namespace Phaser.Physics.Matter.Components.Gravity\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Gravity.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "A component to manipulate world gravity for Matter.js bodies.", "kind": "namespace", "name": "Gravity", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components", "longname": "Phaser.Physics.Matter.Components.Gravity", "scope": "static", "___id": "T000002R030373", "___s": true }, { "comment": "/**\r\n * A togglable function for ignoring world gravity in real-time on the current body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - Set to true to ignore the effect of world gravity, or false to not ignore it.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Gravity.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "A togglable function for ignoring world gravity in real-time on the current body.", "kind": "function", "name": "setIgnoreGravity", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true to ignore the effect of world gravity, or false to not ignore it.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Gravity", "longname": "Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity", "scope": "instance", "___id": "T000002R030375", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Physics.Matter.Components\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "kind": "namespace", "name": "Components", "memberof": "Phaser.Physics.Matter", "longname": "Phaser.Physics.Matter.Components", "scope": "static", "___id": "T000002R030379", "___s": true }, { "comment": "/**\r\n * Allows accessing the mass, density, and center of mass of a Matter-enabled Game Object. Should be used as a mixin and not directly.\r\n *\r\n * @namespace Phaser.Physics.Matter.Components.Mass\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mass.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Allows accessing the mass, density, and center of mass of a Matter-enabled Game Object. Should be used as a mixin and not directly.", "kind": "namespace", "name": "Mass", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components", "longname": "Phaser.Physics.Matter.Components.Mass", "scope": "static", "___id": "T000002R030395", "___s": true }, { "comment": "/**\r\n * Sets the mass of the Game Object's Matter Body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Mass#setMass\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new mass of the body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mass.js", "lineno": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets the mass of the Game Object's Matter Body.", "kind": "function", "name": "setMass", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new mass of the body.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Mass", "longname": "Phaser.Physics.Matter.Components.Mass#setMass", "scope": "instance", "___id": "T000002R030397", "___s": true }, { "comment": "/**\r\n * Sets density of the body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Mass#setDensity\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new density of the body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mass.js", "lineno": 35, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets density of the body.", "kind": "function", "name": "setDensity", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new density of the body.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Mass", "longname": "Phaser.Physics.Matter.Components.Mass#setDensity", "scope": "instance", "___id": "T000002R030399", "___s": true }, { "comment": "/**\r\n * The body's center of mass.\r\n *\r\n * Calling this creates a new `Vector2 each time to avoid mutation.\r\n *\r\n * If you only need to read the value and won't change it, you can get it from `GameObject.body.centerOfMass`.\r\n *\r\n * @name Phaser.Physics.Matter.Components.Mass#centerOfMass\r\n * @type {Phaser.Math.Vector2}\r\n * @readonly\r\n * @since 3.10.0\r\n *\r\n * @return {Phaser.Math.Vector2} The center of mass.\r\n */", "meta": { "filename": "Mass.js", "lineno": 52, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "The body's center of mass.\r\rCalling this creates a new `Vector2 each time to avoid mutation.\r\rIf you only need to read the value and won't change it, you can get it from `GameObject.body.centerOfMass`.", "name": "centerOfMass", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "readonly": true, "since": "3.10.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The center of mass." } ], "memberof": "Phaser.Physics.Matter.Components.Mass", "longname": "Phaser.Physics.Matter.Components.Mass#centerOfMass", "scope": "instance", "kind": "member", "___id": "T000002R030401", "___s": true }, { "comment": "/**\r\n * Enables a Matter-enabled Game Object to be a sensor. Should be used as a mixin and not directly.\r\n *\r\n * @namespace Phaser.Physics.Matter.Components.Sensor\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sensor.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Enables a Matter-enabled Game Object to be a sensor. Should be used as a mixin and not directly.", "kind": "namespace", "name": "Sensor", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components", "longname": "Phaser.Physics.Matter.Components.Sensor", "scope": "static", "___id": "T000002R030405", "___s": true }, { "comment": "/**\r\n * Set the body belonging to this Game Object to be a sensor.\r\n * Sensors trigger collision events, but don't react with colliding body physically.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sensor#setSensor\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to set the body as a sensor, or `false` to disable it.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sensor.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Set the body belonging to this Game Object to be a sensor.\rSensors trigger collision events, but don't react with colliding body physically.", "kind": "function", "name": "setSensor", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to set the body as a sensor, or `false` to disable it.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Sensor", "longname": "Phaser.Physics.Matter.Components.Sensor#setSensor", "scope": "instance", "___id": "T000002R030407", "___s": true }, { "comment": "/**\r\n * Is the body belonging to this Game Object a sensor or not?\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sensor#isSensor\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if the body is a sensor, otherwise `false`.\r\n */", "meta": { "filename": "Sensor.js", "lineno": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Is the body belonging to this Game Object a sensor or not?", "kind": "function", "name": "isSensor", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the body is a sensor, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.Components.Sensor", "longname": "Phaser.Physics.Matter.Components.Sensor#isSensor", "scope": "instance", "___id": "T000002R030410", "___s": true }, { "comment": "/**\r\n * Enables a Matter-enabled Game Object to set its Body. Should be used as a mixin and not directly.\r\n *\r\n * @namespace Phaser.Physics.Matter.Components.SetBody\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SetBody.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Enables a Matter-enabled Game Object to set its Body. Should be used as a mixin and not directly.", "kind": "namespace", "name": "SetBody", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components", "longname": "Phaser.Physics.Matter.Components.SetBody", "scope": "static", "___id": "T000002R030420", "___s": true }, { "comment": "/**\r\n * Set this Game Objects Matter physics body to be a rectangle shape.\r\n *\r\n * Calling this methods resets all previous properties you may have set on the body, including\r\n * plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setRectangle\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 23, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Set this Game Objects Matter physics body to be a rectangle shape.\r\rCalling this methods resets all previous properties you may have set on the body, including\rplugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.", "kind": "function", "name": "setRectangle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.SetBody", "longname": "Phaser.Physics.Matter.Components.SetBody#setRectangle", "scope": "instance", "___id": "T000002R030422", "___s": true }, { "comment": "/**\r\n * Set this Game Objects Matter physics body to be a circle shape.\r\n *\r\n * Calling this methods resets all previous properties you may have set on the body, including\r\n * plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setCircle\r\n * @since 3.0.0\r\n *\r\n * @param {number} radius - The radius of the circle.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Set this Game Objects Matter physics body to be a circle shape.\r\rCalling this methods resets all previous properties you may have set on the body, including\rplugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.", "kind": "function", "name": "setCircle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the circle.", "name": "radius" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.SetBody", "longname": "Phaser.Physics.Matter.Components.SetBody#setCircle", "scope": "instance", "___id": "T000002R030427", "___s": true }, { "comment": "/**\r\n * Set this Game Objects Matter physics body to be a polygon shape.\r\n *\r\n * Calling this methods resets all previous properties you may have set on the body, including\r\n * plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setPolygon\r\n * @since 3.0.0\r\n *\r\n * @param {number} radius - The \"radius\" of the polygon, i.e. the distance from its center to any vertex. This is also the radius of its circumcircle.\r\n * @param {number} sides - The number of sides the polygon will have.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Set this Game Objects Matter physics body to be a polygon shape.\r\rCalling this methods resets all previous properties you may have set on the body, including\rplugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.", "kind": "function", "name": "setPolygon", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The \"radius\" of the polygon, i.e. the distance from its center to any vertex. This is also the radius of its circumcircle.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of sides the polygon will have.", "name": "sides" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.SetBody", "longname": "Phaser.Physics.Matter.Components.SetBody#setPolygon", "scope": "instance", "___id": "T000002R030431", "___s": true }, { "comment": "/**\r\n * Set this Game Objects Matter physics body to be a trapezoid shape.\r\n *\r\n * Calling this methods resets all previous properties you may have set on the body, including\r\n * plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setTrapezoid\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The width of the trapezoid Body.\r\n * @param {number} height - The height of the trapezoid Body.\r\n * @param {number} slope - The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 82, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Set this Game Objects Matter physics body to be a trapezoid shape.\r\rCalling this methods resets all previous properties you may have set on the body, including\rplugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.", "kind": "function", "name": "setTrapezoid", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the trapezoid Body.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the trapezoid Body.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.", "name": "slope" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.SetBody", "longname": "Phaser.Physics.Matter.Components.SetBody#setTrapezoid", "scope": "instance", "___id": "T000002R030436", "___s": true }, { "comment": "/**\r\n * Set this Game Object to use the given existing Matter Body.\r\n *\r\n * The body is first removed from the world before being added to this Game Object.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setExistingBody\r\n * @since 3.0.0\r\n *\r\n * @param {MatterJS.BodyType} body - The Body this Game Object should use.\r\n * @param {boolean} [addToWorld=true] - Should the body be immediately added to the World?\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Set this Game Object to use the given existing Matter Body.\r\rThe body is first removed from the world before being added to this Game Object.", "kind": "function", "name": "setExistingBody", "since": "3.0.0", "params": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The Body this Game Object should use.", "name": "body" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the body be immediately added to the World?", "name": "addToWorld" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.SetBody", "longname": "Phaser.Physics.Matter.Components.SetBody#setExistingBody", "scope": "instance", "___id": "T000002R030442", "___s": true }, { "comment": "/**\r\n * Set this Game Object to create and use a new Body based on the configuration object given.\r\n *\r\n * Calling this methods resets all previous properties you may have set on the body, including\r\n * plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setBody\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Physics.Matter.MatterSetBodyConfig)} config - Either a string, such as `circle`, or a Matter Set Body Configuration object.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 175, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Set this Game Object to create and use a new Body based on the configuration object given.\r\rCalling this methods resets all previous properties you may have set on the body, including\rplugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.", "kind": "function", "name": "setBody", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Physics.Matter.MatterSetBodyConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterSetBodyConfig" } ] } }, "description": "Either a string, such as `circle`, or a Matter Set Body Configuration object.", "name": "config" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.SetBody", "longname": "Phaser.Physics.Matter.Components.SetBody#setBody", "scope": "instance", "___id": "T000002R030457", "___s": true }, { "comment": "/**\r\n * Enables a Matter-enabled Game Object to be able to go to sleep. Should be used as a mixin and not directly.\r\n *\r\n * @namespace Phaser.Physics.Matter.Components.Sleep\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sleep.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Enables a Matter-enabled Game Object to be able to go to sleep. Should be used as a mixin and not directly.", "kind": "namespace", "name": "Sleep", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components", "longname": "Phaser.Physics.Matter.Components.Sleep", "scope": "static", "___id": "T000002R030489", "___s": true }, { "comment": "/**\r\n * Sets this Body to sleep.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setToSleep\r\n * @since 3.22.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets this Body to sleep.", "kind": "function", "name": "setToSleep", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Sleep", "longname": "Phaser.Physics.Matter.Components.Sleep#setToSleep", "scope": "instance", "___id": "T000002R030491", "___s": true }, { "comment": "/**\r\n * Wakes this Body if asleep.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setAwake\r\n * @since 3.22.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Wakes this Body if asleep.", "kind": "function", "name": "setAwake", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Sleep", "longname": "Phaser.Physics.Matter.Components.Sleep#setAwake", "scope": "instance", "___id": "T000002R030493", "___s": true }, { "comment": "/**\r\n * Sets the number of updates in which this body must have near-zero velocity before it is set as sleeping (if sleeping is enabled by the engine).\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setSleepThreshold\r\n * @since 3.0.0\r\n *\r\n * @param {number} [value=60] - A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets the number of updates in which this body must have near-zero velocity before it is set as sleeping (if sleeping is enabled by the engine).", "kind": "function", "name": "setSleepThreshold", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 60, "description": "A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Sleep", "longname": "Phaser.Physics.Matter.Components.Sleep#setSleepThreshold", "scope": "instance", "___id": "T000002R030495", "___s": true }, { "comment": "/**\r\n * Enable sleep and wake events for this body.\r\n *\r\n * By default when a body goes to sleep, or wakes up, it will not emit any events.\r\n *\r\n * The events are emitted by the Matter World instance and can be listened to via\r\n * the `SLEEP_START` and `SLEEP_END` events.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setSleepEvents\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} start - `true` if you want the sleep start event to be emitted for this body.\r\n * @param {boolean} end - `true` if you want the sleep end event to be emitted for this body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Enable sleep and wake events for this body.\r\rBy default when a body goes to sleep, or wakes up, it will not emit any events.\r\rThe events are emitted by the Matter World instance and can be listened to via\rthe `SLEEP_START` and `SLEEP_END` events.", "kind": "function", "name": "setSleepEvents", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if you want the sleep start event to be emitted for this body.", "name": "start" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if you want the sleep end event to be emitted for this body.", "name": "end" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Sleep", "longname": "Phaser.Physics.Matter.Components.Sleep#setSleepEvents", "scope": "instance", "___id": "T000002R030499", "___s": true }, { "comment": "/**\r\n * Enables or disables the Sleep Start event for this body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setSleepStartEvent\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to enable the sleep event, or `false` to disable it.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Enables or disables the Sleep Start event for this body.", "kind": "function", "name": "setSleepStartEvent", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable the sleep event, or `false` to disable it.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Sleep", "longname": "Phaser.Physics.Matter.Components.Sleep#setSleepStartEvent", "scope": "instance", "___id": "T000002R030501", "___s": true }, { "comment": "/**\r\n * Enables or disables the Sleep End event for this body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setSleepEndEvent\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to enable the sleep event, or `false` to disable it.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 121, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Enables or disables the Sleep End event for this body.", "kind": "function", "name": "setSleepEndEvent", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable the sleep event, or `false` to disable it.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Sleep", "longname": "Phaser.Physics.Matter.Components.Sleep#setSleepEndEvent", "scope": "instance", "___id": "T000002R030504", "___s": true }, { "comment": "/**\r\n * Provides methods used for getting and setting the static state of a physics body.\r\n *\r\n * @namespace Phaser.Physics.Matter.Components.Static\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Static.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Provides methods used for getting and setting the static state of a physics body.", "kind": "namespace", "name": "Static", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components", "longname": "Phaser.Physics.Matter.Components.Static", "scope": "static", "___id": "T000002R030509", "___s": true }, { "comment": "/**\r\n * Changes the physics body to be either static `true` or dynamic `false`.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Static#setStatic\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to set the body as being static, or `false` to make it dynamic.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Static.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Changes the physics body to be either static `true` or dynamic `false`.", "kind": "function", "name": "setStatic", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to set the body as being static, or `false` to make it dynamic.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Static", "longname": "Phaser.Physics.Matter.Components.Static#setStatic", "scope": "instance", "___id": "T000002R030511", "___s": true }, { "comment": "/**\r\n * Returns `true` if the body is static, otherwise `false` for a dynamic body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Static#isStatic\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if the body is static, otherwise `false`.\r\n */", "meta": { "filename": "Static.js", "lineno": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Returns `true` if the body is static, otherwise `false` for a dynamic body.", "kind": "function", "name": "isStatic", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the body is static, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.Components.Static", "longname": "Phaser.Physics.Matter.Components.Static#isStatic", "scope": "instance", "___id": "T000002R030513", "___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.Physics.Matter.Components.Transform\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\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.Physics.Matter.Components", "longname": "Phaser.Physics.Matter.Components.Transform", "scope": "static", "___id": "T000002R030521", "___s": true }, { "comment": "/**\r\n * The x position of this Game Object.\r\n *\r\n * @name Phaser.Physics.Matter.Components.Transform#x\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 25, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "The x position of this Game Object.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components.Transform", "longname": "Phaser.Physics.Matter.Components.Transform#x", "scope": "instance", "kind": "member", "___id": "T000002R030523", "___s": true }, { "comment": "/**\r\n * The y position of this Game Object.\r\n *\r\n * @name Phaser.Physics.Matter.Components.Transform#y\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "The y position of this Game Object.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components.Transform", "longname": "Phaser.Physics.Matter.Components.Transform#y", "scope": "instance", "kind": "member", "___id": "T000002R030527", "___s": true }, { "comment": "/**\r\n * The horizontal scale of this Game Object.\r\n *\r\n * @name Phaser.Physics.Matter.Components.Transform#scaleX\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 71, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "The horizontal scale of this Game Object.", "name": "scaleX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components.Transform", "longname": "Phaser.Physics.Matter.Components.Transform#scaleX", "scope": "instance", "kind": "member", "___id": "T000002R030531", "___s": true }, { "comment": "/**\r\n * The vertical scale of this Game Object.\r\n *\r\n * @name Phaser.Physics.Matter.Components.Transform#scaleY\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 109, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "The vertical scale of this Game Object.", "name": "scaleY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components.Transform", "longname": "Phaser.Physics.Matter.Components.Transform#scaleY", "scope": "instance", "kind": "member", "___id": "T000002R030540", "___s": true }, { "comment": "/**\r\n * Use `angle` to set or get rotation of the physics body associated to this GameObject.\r\n * Unlike rotation, when using set the value can be in degrees, which will be converted to radians internally.\r\n *\r\n * @name Phaser.Physics.Matter.Components.Transform#angle\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Use `angle` to set or get rotation of the physics body associated to this GameObject.\rUnlike rotation, when using set the value can be in degrees, which will be converted to radians internally.", "name": "angle", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components.Transform", "longname": "Phaser.Physics.Matter.Components.Transform#angle", "scope": "instance", "kind": "member", "___id": "T000002R030549", "___s": true }, { "comment": "/**\r\n * Use `rotation` to set or get the rotation of the physics body associated with this GameObject.\r\n * The value when set must be in radians.\r\n *\r\n * @name Phaser.Physics.Matter.Components.Transform#rotation\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 168, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Use `rotation` to set or get the rotation of the physics body associated with this GameObject.\rThe value when set must be in radians.", "name": "rotation", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components.Transform", "longname": "Phaser.Physics.Matter.Components.Transform#rotation", "scope": "instance", "kind": "member", "___id": "T000002R030554", "___s": true }, { "comment": "/**\r\n * Sets the position of the physics body along x and y axes.\r\n * Both the parameters to this function are optional and if not passed any they default to 0.\r\n * Velocity, angle, force etc. are unchanged.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Transform#setPosition\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of the body.\r\n * @param {number} [y=x] - The vertical position of the body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 192, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets the position of the physics body along x and y axes.\rBoth the parameters to this function are optional and if not passed any they default to 0.\rVelocity, angle, force etc. are unchanged.", "kind": "function", "name": "setPosition", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the body.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical position of the body.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Transform", "longname": "Phaser.Physics.Matter.Components.Transform#setPosition", "scope": "instance", "___id": "T000002R030559", "___s": true }, { "comment": "/**\r\n * Immediately sets the angle of the Body.\r\n * Angular velocity, position, force etc. are unchanged.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Transform#setRotation\r\n * @since 3.0.0\r\n *\r\n * @param {number} [radians=0] - The angle of the body, in radians.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 217, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Immediately sets the angle of the Body.\rAngular velocity, position, force etc. are unchanged.", "kind": "function", "name": "setRotation", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The angle of the body, in radians.", "name": "radians" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Transform", "longname": "Phaser.Physics.Matter.Components.Transform#setRotation", "scope": "instance", "___id": "T000002R030563", "___s": true }, { "comment": "/**\r\n * Setting fixed rotation sets the Body inertia to Infinity, which stops it\r\n * from being able to rotate when forces are applied to it.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Transform#setFixedRotation\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 239, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Setting fixed rotation sets the Body inertia to Infinity, which stops it\rfrom being able to rotate when forces are applied to it.", "kind": "function", "name": "setFixedRotation", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Transform", "longname": "Phaser.Physics.Matter.Components.Transform#setFixedRotation", "scope": "instance", "___id": "T000002R030567", "___s": true }, { "comment": "/**\r\n * Immediately sets the angle of the Body.\r\n * Angular velocity, position, force etc. are unchanged.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Transform#setAngle\r\n * @since 3.0.0\r\n *\r\n * @param {number} [degrees=0] - The angle to set, in degrees.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Immediately sets the angle of the Body.\rAngular velocity, position, force etc. are unchanged.", "kind": "function", "name": "setAngle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The angle to set, in degrees.", "name": "degrees" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Transform", "longname": "Phaser.Physics.Matter.Components.Transform#setAngle", "scope": "instance", "___id": "T000002R030569", "___s": true }, { "comment": "/**\r\n * Sets the scale of this Game Object.\r\n *\r\n * @method Phaser.Physics.Matter.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 * @param {Phaser.Math.Vector2} [point] - The point (Vector2) from which scaling will occur.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 277, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\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" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "The point (Vector2) from which scaling will occur.", "name": "point" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Transform", "longname": "Phaser.Physics.Matter.Components.Transform#setScale", "scope": "instance", "___id": "T000002R030573", "___s": true }, { "comment": "/**\r\n * Contains methods for changing the velocity of a Matter Body. Should be used as a mixin and not called directly.\r\n *\r\n * @namespace Phaser.Physics.Matter.Components.Velocity\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Velocity.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Contains methods for changing the velocity of a Matter Body. Should be used as a mixin and not called directly.", "kind": "namespace", "name": "Velocity", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Components", "longname": "Phaser.Physics.Matter.Components.Velocity", "scope": "static", "___id": "T000002R030583", "___s": true }, { "comment": "/**\r\n * Sets the horizontal velocity of the physics body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#setVelocityX\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal velocity value.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets the horizontal velocity of the physics body.", "kind": "function", "name": "setVelocityX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal velocity value.", "name": "x" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Velocity", "longname": "Phaser.Physics.Matter.Components.Velocity#setVelocityX", "scope": "instance", "___id": "T000002R030585", "___s": true }, { "comment": "/**\r\n * Sets vertical velocity of the physics body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#setVelocityY\r\n * @since 3.0.0\r\n *\r\n * @param {number} y - The vertical velocity value.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets vertical velocity of the physics body.", "kind": "function", "name": "setVelocityY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical velocity value.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Velocity", "longname": "Phaser.Physics.Matter.Components.Velocity#setVelocityY", "scope": "instance", "___id": "T000002R030587", "___s": true }, { "comment": "/**\r\n * Sets both the horizontal and vertical velocity of the physics body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#setVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal velocity value.\r\n * @param {number} [y=x] - The vertical velocity value, it can be either positive or negative. If not given, it will be the same as the `x` value.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 55, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets both the horizontal and vertical velocity of the physics body.", "kind": "function", "name": "setVelocity", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal velocity value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical velocity value, it can be either positive or negative. If not given, it will be the same as the `x` value.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Velocity", "longname": "Phaser.Physics.Matter.Components.Velocity#setVelocity", "scope": "instance", "___id": "T000002R030589", "___s": true }, { "comment": "/**\r\n * Gets the current linear velocity of the physics body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#getVelocity\r\n * @since 3.60.0\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The current linear velocity of the body.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 75, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Gets the current linear velocity of the physics body.", "kind": "function", "name": "getVelocity", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The current linear velocity of the body." } ], "memberof": "Phaser.Physics.Matter.Components.Velocity", "longname": "Phaser.Physics.Matter.Components.Velocity#getVelocity", "scope": "instance", "___id": "T000002R030591", "___s": true }, { "comment": "/**\r\n * Sets the angular velocity of the body instantly.\r\n * Position, angle, force etc. are unchanged.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#setAngularVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} velocity - The angular velocity.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets the angular velocity of the body instantly.\rPosition, angle, force etc. are unchanged.", "kind": "function", "name": "setAngularVelocity", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angular velocity.", "name": "velocity" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Velocity", "longname": "Phaser.Physics.Matter.Components.Velocity#setAngularVelocity", "scope": "instance", "___id": "T000002R030593", "___s": true }, { "comment": "/**\r\n * Gets the current rotational velocity of the body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#getAngularVelocity\r\n * @since 3.60.0\r\n *\r\n * @return {number} The current angular velocity of the body.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Gets the current rotational velocity of the body.", "kind": "function", "name": "getAngularVelocity", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current angular velocity of the body." } ], "memberof": "Phaser.Physics.Matter.Components.Velocity", "longname": "Phaser.Physics.Matter.Components.Velocity#getAngularVelocity", "scope": "instance", "___id": "T000002R030595", "___s": true }, { "comment": "/**\r\n * Sets the current rotational speed of the body.\r\n * Direction is maintained. Affects body angular velocity.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#setAngularSpeed\r\n * @since 3.60.0\r\n *\r\n * @param {number} speed - The angular speed.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 119, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Sets the current rotational speed of the body.\rDirection is maintained. Affects body angular velocity.", "kind": "function", "name": "setAngularSpeed", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angular speed.", "name": "speed" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Components.Velocity", "longname": "Phaser.Physics.Matter.Components.Velocity#setAngularSpeed", "scope": "instance", "___id": "T000002R030597", "___s": true }, { "comment": "/**\r\n * Gets the current rotational speed of the body.\r\n * Equivalent to the magnitude of its angular velocity.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#getAngularSpeed\r\n * @since 3.60.0\r\n *\r\n * @return {number} The current angular velocity of the body.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "description": "Gets the current rotational speed of the body.\rEquivalent to the magnitude of its angular velocity.", "kind": "function", "name": "getAngularSpeed", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current angular velocity of the body." } ], "memberof": "Phaser.Physics.Matter.Components.Velocity", "longname": "Phaser.Physics.Matter.Components.Velocity#getAngularSpeed", "scope": "instance", "___id": "T000002R030599", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Physics.Matter.Matter\r\n */", "meta": { "filename": "CustomMain.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "kind": "namespace", "name": "Matter", "memberof": "Phaser.Physics.Matter", "longname": "Phaser.Physics.Matter.Matter", "scope": "static", "___id": "T000002R030602", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Physics.Matter.Events.AfterAddEvent\r\n *\r\n * @property {any[]} object - An array of the object(s) that have been added. May be a single body, constraint, composite or a mixture of these.\r\n * @property {any} source - The source object of the event.\r\n * @property {string} name - The name of the event.\r\n */", "meta": { "filename": "AFTER_ADD_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "kind": "typedef", "name": "AfterAddEvent", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } }, "description": "An array of the object(s) that have been added. May be a single body, constraint, composite or a mixture of these.", "name": "object" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The source object of the event.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the event.", "name": "name" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events.AfterAddEvent", "scope": "static", "___id": "T000002R030633", "___s": true }, { "comment": "/**\r\n * The Matter Physics After Add Event.\r\n *\r\n * This event is dispatched by a Matter Physics World instance at the end of the process when a new Body\r\n * or Constraint has just been added to the world.\r\n *\r\n * Listen to it from a Scene using: `this.matter.world.on('afteradd', listener)`.\r\n *\r\n * @event Phaser.Physics.Matter.Events#AFTER_ADD\r\n * @type {string}\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Physics.Matter.Events.AfterAddEvent} event - The Add Event object.\r\n */", "meta": { "filename": "AFTER_ADD_EVENT.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "description": "The Matter Physics After Add Event.\r\rThis event is dispatched by a Matter Physics World instance at the end of the process when a new Body\ror Constraint has just been added to the world.\r\rListen to it from a Scene using: `this.matter.world.on('afteradd', listener)`.", "kind": "event", "name": "AFTER_ADD", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Physics.Matter.Events.AfterAddEvent" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.Events.AfterAddEvent" } }, "description": "The Add Event object.", "name": "event" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events#event:AFTER_ADD", "scope": "instance", "___id": "T000002R030634", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Physics.Matter.Events.AfterRemoveEvent\r\n *\r\n * @property {any[]} object - An array of the object(s) that were removed. May be a single body, constraint, composite or a mixture of these.\r\n * @property {any} source - The source object of the event.\r\n * @property {string} name - The name of the event.\r\n */", "meta": { "filename": "AFTER_REMOVE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "kind": "typedef", "name": "AfterRemoveEvent", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } }, "description": "An array of the object(s) that were removed. May be a single body, constraint, composite or a mixture of these.", "name": "object" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The source object of the event.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the event.", "name": "name" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events.AfterRemoveEvent", "scope": "static", "___id": "T000002R030636", "___s": true }, { "comment": "/**\r\n * The Matter Physics After Remove Event.\r\n *\r\n * This event is dispatched by a Matter Physics World instance at the end of the process when a\r\n * Body or Constraint was removed from the world.\r\n *\r\n * Listen to it from a Scene using: `this.matter.world.on('afterremove', listener)`.\r\n *\r\n * @event Phaser.Physics.Matter.Events#AFTER_REMOVE\r\n * @type {string}\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Physics.Matter.Events.AfterRemoveEvent} event - The Remove Event object.\r\n */", "meta": { "filename": "AFTER_REMOVE_EVENT.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "description": "The Matter Physics After Remove Event.\r\rThis event is dispatched by a Matter Physics World instance at the end of the process when a\rBody or Constraint was removed from the world.\r\rListen to it from a Scene using: `this.matter.world.on('afterremove', listener)`.", "kind": "event", "name": "AFTER_REMOVE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Physics.Matter.Events.AfterRemoveEvent" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.Events.AfterRemoveEvent" } }, "description": "The Remove Event object.", "name": "event" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events#event:AFTER_REMOVE", "scope": "instance", "___id": "T000002R030637", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Physics.Matter.Events.AfterUpdateEvent\r\n *\r\n * @property {number} timestamp - The Matter Engine `timing.timestamp` value for the event.\r\n * @property {any} source - The source object of the event.\r\n * @property {string} name - The name of the event.\r\n */", "meta": { "filename": "AFTER_UPDATE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "kind": "typedef", "name": "AfterUpdateEvent", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Matter Engine `timing.timestamp` value for the event.", "name": "timestamp" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The source object of the event.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the event.", "name": "name" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events.AfterUpdateEvent", "scope": "static", "___id": "T000002R030639", "___s": true }, { "comment": "/**\r\n * The Matter Physics After Update Event.\r\n *\r\n * This event is dispatched by a Matter Physics World instance after the engine has updated and all collision events have resolved.\r\n *\r\n * Listen to it from a Scene using: `this.matter.world.on('afterupdate', listener)`.\r\n *\r\n * @event Phaser.Physics.Matter.Events#AFTER_UPDATE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Matter.Events.AfterUpdateEvent} event - The Update Event object.\r\n */", "meta": { "filename": "AFTER_UPDATE_EVENT.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "description": "The Matter Physics After Update Event.\r\rThis event is dispatched by a Matter Physics World instance after the engine has updated and all collision events have resolved.\r\rListen to it from a Scene using: `this.matter.world.on('afterupdate', listener)`.", "kind": "event", "name": "AFTER_UPDATE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Matter.Events.AfterUpdateEvent" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.Events.AfterUpdateEvent" } }, "description": "The Update Event object.", "name": "event" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events#event:AFTER_UPDATE", "scope": "instance", "___id": "T000002R030640", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Physics.Matter.Events.BeforeAddEvent\r\n *\r\n * @property {any[]} object - An array of the object(s) to be added. May be a single body, constraint, composite or a mixture of these.\r\n * @property {any} source - The source object of the event.\r\n * @property {string} name - The name of the event.\r\n */", "meta": { "filename": "BEFORE_ADD_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "kind": "typedef", "name": "BeforeAddEvent", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } }, "description": "An array of the object(s) to be added. May be a single body, constraint, composite or a mixture of these.", "name": "object" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The source object of the event.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the event.", "name": "name" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events.BeforeAddEvent", "scope": "static", "___id": "T000002R030642", "___s": true }, { "comment": "/**\r\n * The Matter Physics Before Add Event.\r\n *\r\n * This event is dispatched by a Matter Physics World instance at the start of the process when a new Body\r\n * or Constraint is being added to the world.\r\n *\r\n * Listen to it from a Scene using: `this.matter.world.on('beforeadd', listener)`.\r\n *\r\n * @event Phaser.Physics.Matter.Events#BEFORE_ADD\r\n * @type {string}\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Physics.Matter.Events.BeforeAddEvent} event - The Add Event object.\r\n */", "meta": { "filename": "BEFORE_ADD_EVENT.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "description": "The Matter Physics Before Add Event.\r\rThis event is dispatched by a Matter Physics World instance at the start of the process when a new Body\ror Constraint is being added to the world.\r\rListen to it from a Scene using: `this.matter.world.on('beforeadd', listener)`.", "kind": "event", "name": "BEFORE_ADD", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Physics.Matter.Events.BeforeAddEvent" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.Events.BeforeAddEvent" } }, "description": "The Add Event object.", "name": "event" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events#event:BEFORE_ADD", "scope": "instance", "___id": "T000002R030643", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Physics.Matter.Events.BeforeRemoveEvent\r\n *\r\n * @property {any[]} object - An array of the object(s) to be removed. May be a single body, constraint, composite or a mixture of these.\r\n * @property {any} source - The source object of the event.\r\n * @property {string} name - The name of the event.\r\n */", "meta": { "filename": "BEFORE_REMOVE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "kind": "typedef", "name": "BeforeRemoveEvent", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } }, "description": "An array of the object(s) to be removed. May be a single body, constraint, composite or a mixture of these.", "name": "object" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The source object of the event.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the event.", "name": "name" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events.BeforeRemoveEvent", "scope": "static", "___id": "T000002R030645", "___s": true }, { "comment": "/**\r\n * The Matter Physics Before Remove Event.\r\n *\r\n * This event is dispatched by a Matter Physics World instance at the start of the process when a\r\n * Body or Constraint is being removed from the world.\r\n *\r\n * Listen to it from a Scene using: `this.matter.world.on('beforeremove', listener)`.\r\n *\r\n * @event Phaser.Physics.Matter.Events#BEFORE_REMOVE\r\n * @type {string}\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Physics.Matter.Events.BeforeRemoveEvent} event - The Remove Event object.\r\n */", "meta": { "filename": "BEFORE_REMOVE_EVENT.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "description": "The Matter Physics Before Remove Event.\r\rThis event is dispatched by a Matter Physics World instance at the start of the process when a\rBody or Constraint is being removed from the world.\r\rListen to it from a Scene using: `this.matter.world.on('beforeremove', listener)`.", "kind": "event", "name": "BEFORE_REMOVE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Physics.Matter.Events.BeforeRemoveEvent" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.Events.BeforeRemoveEvent" } }, "description": "The Remove Event object.", "name": "event" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events#event:BEFORE_REMOVE", "scope": "instance", "___id": "T000002R030646", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Physics.Matter.Events.BeforeUpdateEvent\r\n *\r\n * @property {number} timestamp - The Matter Engine `timing.timestamp` value for the event.\r\n * @property {any} source - The source object of the event.\r\n * @property {string} name - The name of the event.\r\n */", "meta": { "filename": "BEFORE_UPDATE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "kind": "typedef", "name": "BeforeUpdateEvent", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Matter Engine `timing.timestamp` value for the event.", "name": "timestamp" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The source object of the event.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the event.", "name": "name" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events.BeforeUpdateEvent", "scope": "static", "___id": "T000002R030648", "___s": true }, { "comment": "/**\r\n * The Matter Physics Before Update Event.\r\n *\r\n * This event is dispatched by a Matter Physics World instance right before all the collision processing takes place.\r\n *\r\n * Listen to it from a Scene using: `this.matter.world.on('beforeupdate', listener)`.\r\n *\r\n * @event Phaser.Physics.Matter.Events#BEFORE_UPDATE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Matter.Events.BeforeUpdateEvent} event - The Update Event object.\r\n */", "meta": { "filename": "BEFORE_UPDATE_EVENT.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "description": "The Matter Physics Before Update Event.\r\rThis event is dispatched by a Matter Physics World instance right before all the collision processing takes place.\r\rListen to it from a Scene using: `this.matter.world.on('beforeupdate', listener)`.", "kind": "event", "name": "BEFORE_UPDATE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Matter.Events.BeforeUpdateEvent" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.Events.BeforeUpdateEvent" } }, "description": "The Update Event object.", "name": "event" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events#event:BEFORE_UPDATE", "scope": "instance", "___id": "T000002R030649", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Physics.Matter.Events.CollisionActiveEvent\r\n *\r\n * @property {Phaser.Types.Physics.Matter.MatterCollisionData[]} pairs - A list of all affected pairs in the collision.\r\n * @property {number} timestamp - The Matter Engine `timing.timestamp` value for the event.\r\n * @property {any} source - The source object of the event.\r\n * @property {string} name - The name of the event.\r\n */", "meta": { "filename": "COLLISION_ACTIVE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "kind": "typedef", "name": "CollisionActiveEvent", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterCollisionData", "type": "NameExpression" } ] } }, "description": "A list of all affected pairs in the collision.", "name": "pairs" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Matter Engine `timing.timestamp` value for the event.", "name": "timestamp" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The source object of the event.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the event.", "name": "name" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events.CollisionActiveEvent", "scope": "static", "___id": "T000002R030651", "___s": true }, { "comment": "/**\r\n * The Matter Physics Collision Active Event.\r\n *\r\n * This event is dispatched by a Matter Physics World instance after the engine has updated.\r\n * It provides a list of all pairs that are colliding in the current tick (if any).\r\n *\r\n * Listen to it from a Scene using: `this.matter.world.on('collisionactive', listener)`.\r\n *\r\n * @event Phaser.Physics.Matter.Events#COLLISION_ACTIVE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Matter.Events.CollisionActiveEvent} event - The Collision Event object.\r\n * @param {MatterJS.BodyType} bodyA - The first body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.\r\n * @param {MatterJS.BodyType} bodyB - The second body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.\r\n */", "meta": { "filename": "COLLISION_ACTIVE_EVENT.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "description": "The Matter Physics Collision Active Event.\r\rThis event is dispatched by a Matter Physics World instance after the engine has updated.\rIt provides a list of all pairs that are colliding in the current tick (if any).\r\rListen to it from a Scene using: `this.matter.world.on('collisionactive', listener)`.", "kind": "event", "name": "COLLISION_ACTIVE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Matter.Events.CollisionActiveEvent" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.Events.CollisionActiveEvent" } }, "description": "The Collision Event object.", "name": "event" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The first body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.", "name": "bodyA" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The second body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.", "name": "bodyB" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events#event:COLLISION_ACTIVE", "scope": "instance", "___id": "T000002R030652", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Physics.Matter.Events.CollisionEndEvent\r\n *\r\n * @property {Phaser.Types.Physics.Matter.MatterCollisionData[]} pairs - A list of all affected pairs in the collision.\r\n * @property {number} timestamp - The Matter Engine `timing.timestamp` value for the event.\r\n * @property {any} source - The source object of the event.\r\n * @property {string} name - The name of the event.\r\n */", "meta": { "filename": "COLLISION_END_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "kind": "typedef", "name": "CollisionEndEvent", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterCollisionData", "type": "NameExpression" } ] } }, "description": "A list of all affected pairs in the collision.", "name": "pairs" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Matter Engine `timing.timestamp` value for the event.", "name": "timestamp" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The source object of the event.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the event.", "name": "name" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events.CollisionEndEvent", "scope": "static", "___id": "T000002R030654", "___s": true }, { "comment": "/**\r\n * The Matter Physics Collision End Event.\r\n *\r\n * This event is dispatched by a Matter Physics World instance after the engine has updated.\r\n * It provides a list of all pairs that have finished colliding in the current tick (if any).\r\n *\r\n * Listen to it from a Scene using: `this.matter.world.on('collisionend', listener)`.\r\n *\r\n * @event Phaser.Physics.Matter.Events#COLLISION_END\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Matter.Events.CollisionEndEvent} event - The Collision Event object.\r\n * @param {MatterJS.BodyType} bodyA - The first body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.\r\n * @param {MatterJS.BodyType} bodyB - The second body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.\r\n */", "meta": { "filename": "COLLISION_END_EVENT.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "description": "The Matter Physics Collision End Event.\r\rThis event is dispatched by a Matter Physics World instance after the engine has updated.\rIt provides a list of all pairs that have finished colliding in the current tick (if any).\r\rListen to it from a Scene using: `this.matter.world.on('collisionend', listener)`.", "kind": "event", "name": "COLLISION_END", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Matter.Events.CollisionEndEvent" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.Events.CollisionEndEvent" } }, "description": "The Collision Event object.", "name": "event" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The first body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.", "name": "bodyA" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The second body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.", "name": "bodyB" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events#event:COLLISION_END", "scope": "instance", "___id": "T000002R030655", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Physics.Matter.Events.CollisionStartEvent\r\n *\r\n * @property {Phaser.Types.Physics.Matter.MatterCollisionData[]} pairs - A list of all affected pairs in the collision.\r\n * @property {number} timestamp - The Matter Engine `timing.timestamp` value for the event.\r\n * @property {any} source - The source object of the event.\r\n * @property {string} name - The name of the event.\r\n */", "meta": { "filename": "COLLISION_START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "kind": "typedef", "name": "CollisionStartEvent", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterCollisionData", "type": "NameExpression" } ] } }, "description": "A list of all affected pairs in the collision.", "name": "pairs" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Matter Engine `timing.timestamp` value for the event.", "name": "timestamp" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The source object of the event.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the event.", "name": "name" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events.CollisionStartEvent", "scope": "static", "___id": "T000002R030657", "___s": true }, { "comment": "/**\r\n * The Matter Physics Collision Start Event.\r\n *\r\n * This event is dispatched by a Matter Physics World instance after the engine has updated.\r\n * It provides a list of all pairs that have started to collide in the current tick (if any).\r\n *\r\n * Listen to it from a Scene using: `this.matter.world.on('collisionstart', listener)`.\r\n *\r\n * @event Phaser.Physics.Matter.Events#COLLISION_START\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Matter.Events.CollisionStartEvent} event - The Collision Event object.\r\n * @param {MatterJS.BodyType} bodyA - The first body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.\r\n * @param {MatterJS.BodyType} bodyB - The second body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.\r\n */", "meta": { "filename": "COLLISION_START_EVENT.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "description": "The Matter Physics Collision Start Event.\r\rThis event is dispatched by a Matter Physics World instance after the engine has updated.\rIt provides a list of all pairs that have started to collide in the current tick (if any).\r\rListen to it from a Scene using: `this.matter.world.on('collisionstart', listener)`.", "kind": "event", "name": "COLLISION_START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Matter.Events.CollisionStartEvent" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.Events.CollisionStartEvent" } }, "description": "The Collision Event object.", "name": "event" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The first body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.", "name": "bodyA" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The second body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.", "name": "bodyB" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events#event:COLLISION_START", "scope": "instance", "___id": "T000002R030658", "___s": true }, { "comment": "/**\r\n * The Matter Physics Drag End Event.\r\n *\r\n * This event is dispatched by a Matter Physics World instance when a Pointer Constraint\r\n * stops dragging a body.\r\n *\r\n * Listen to it from a Scene using: `this.matter.world.on('dragend', listener)`.\r\n *\r\n * @event Phaser.Physics.Matter.Events#DRAG_END\r\n * @type {string}\r\n * @since 3.16.2\r\n *\r\n * @param {MatterJS.BodyType} body - The Body that has stopped being dragged. This is a Matter Body, not a Phaser Game Object.\r\n * @param {Phaser.Physics.Matter.PointerConstraint} constraint - The Pointer Constraint that was dragging the body.\r\n */", "meta": { "filename": "DRAG_END_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "description": "The Matter Physics Drag End Event.\r\rThis event is dispatched by a Matter Physics World instance when a Pointer Constraint\rstops dragging a body.\r\rListen to it from a Scene using: `this.matter.world.on('dragend', listener)`.", "kind": "event", "name": "DRAG_END", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.2", "params": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The Body that has stopped being dragged. This is a Matter Body, not a Phaser Game Object.", "name": "body" }, { "type": { "names": [ "Phaser.Physics.Matter.PointerConstraint" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.PointerConstraint" } }, "description": "The Pointer Constraint that was dragging the body.", "name": "constraint" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events#event:DRAG_END", "scope": "instance", "___id": "T000002R030660", "___s": true }, { "comment": "/**\r\n * The Matter Physics Drag Event.\r\n *\r\n * This event is dispatched by a Matter Physics World instance when a Pointer Constraint\r\n * is actively dragging a body. It is emitted each time the pointer moves.\r\n *\r\n * Listen to it from a Scene using: `this.matter.world.on('drag', listener)`.\r\n *\r\n * @event Phaser.Physics.Matter.Events#DRAG\r\n * @type {string}\r\n * @since 3.16.2\r\n *\r\n * @param {MatterJS.BodyType} body - The Body that is being dragged. This is a Matter Body, not a Phaser Game Object.\r\n * @param {Phaser.Physics.Matter.PointerConstraint} constraint - The Pointer Constraint that is dragging the body.\r\n */", "meta": { "filename": "DRAG_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "description": "The Matter Physics Drag Event.\r\rThis event is dispatched by a Matter Physics World instance when a Pointer Constraint\ris actively dragging a body. It is emitted each time the pointer moves.\r\rListen to it from a Scene using: `this.matter.world.on('drag', listener)`.", "kind": "event", "name": "DRAG", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.2", "params": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The Body that is being dragged. This is a Matter Body, not a Phaser Game Object.", "name": "body" }, { "type": { "names": [ "Phaser.Physics.Matter.PointerConstraint" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.PointerConstraint" } }, "description": "The Pointer Constraint that is dragging the body.", "name": "constraint" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events#event:DRAG", "scope": "instance", "___id": "T000002R030662", "___s": true }, { "comment": "/**\r\n * The Matter Physics Drag Start Event.\r\n *\r\n * This event is dispatched by a Matter Physics World instance when a Pointer Constraint\r\n * starts dragging a body.\r\n *\r\n * Listen to it from a Scene using: `this.matter.world.on('dragstart', listener)`.\r\n *\r\n * @event Phaser.Physics.Matter.Events#DRAG_START\r\n * @type {string}\r\n * @since 3.16.2\r\n *\r\n * @param {MatterJS.BodyType} body - The Body that has started being dragged. This is a Matter Body, not a Phaser Game Object.\r\n * @param {MatterJS.BodyType} part - The part of the body that was clicked on.\r\n * @param {Phaser.Physics.Matter.PointerConstraint} constraint - The Pointer Constraint that is dragging the body.\r\n */", "meta": { "filename": "DRAG_START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "description": "The Matter Physics Drag Start Event.\r\rThis event is dispatched by a Matter Physics World instance when a Pointer Constraint\rstarts dragging a body.\r\rListen to it from a Scene using: `this.matter.world.on('dragstart', listener)`.", "kind": "event", "name": "DRAG_START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.2", "params": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The Body that has started being dragged. This is a Matter Body, not a Phaser Game Object.", "name": "body" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The part of the body that was clicked on.", "name": "part" }, { "type": { "names": [ "Phaser.Physics.Matter.PointerConstraint" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.PointerConstraint" } }, "description": "The Pointer Constraint that is dragging the body.", "name": "constraint" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events#event:DRAG_START", "scope": "instance", "___id": "T000002R030664", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Physics.Matter.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Physics.Matter", "longname": "Phaser.Physics.Matter.Events", "scope": "static", "___id": "T000002R030666", "___s": true }, { "comment": "/**\r\n * The Matter Physics World Pause Event.\r\n *\r\n * This event is dispatched by an Matter Physics World instance when it is paused.\r\n *\r\n * Listen to it from a Scene using: `this.matter.world.on('pause', listener)`.\r\n *\r\n * @event Phaser.Physics.Matter.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\\physics\\matter-js\\events", "code": {} }, "description": "The Matter Physics World Pause Event.\r\rThis event is dispatched by an Matter Physics World instance when it is paused.\r\rListen to it from a Scene using: `this.matter.world.on('pause', listener)`.", "kind": "event", "name": "PAUSE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events#event:PAUSE", "scope": "instance", "___id": "T000002R030684", "___s": true }, { "comment": "/**\r\n * The Matter Physics World Resume Event.\r\n *\r\n * This event is dispatched by an Matter Physics World instance when it resumes from a paused state.\r\n *\r\n * Listen to it from a Scene using: `this.matter.world.on('resume', listener)`.\r\n *\r\n * @event Phaser.Physics.Matter.Events#RESUME\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "RESUME_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "description": "The Matter Physics World Resume Event.\r\rThis event is dispatched by an Matter Physics World instance when it resumes from a paused state.\r\rListen to it from a Scene using: `this.matter.world.on('resume', listener)`.", "kind": "event", "name": "RESUME", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events#event:RESUME", "scope": "instance", "___id": "T000002R030686", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Physics.Matter.Events.SleepEndEvent\r\n *\r\n * @property {any} source - The source object of the event.\r\n * @property {string} name - The name of the event.\r\n */", "meta": { "filename": "SLEEP_END_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "kind": "typedef", "name": "SleepEndEvent", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The source object of the event.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the event.", "name": "name" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events.SleepEndEvent", "scope": "static", "___id": "T000002R030688", "___s": true }, { "comment": "/**\r\n * The Matter Physics Sleep End Event.\r\n *\r\n * This event is dispatched by a Matter Physics World instance when a Body stop sleeping.\r\n *\r\n * Listen to it from a Scene using: `this.matter.world.on('sleepend', listener)`.\r\n *\r\n * @event Phaser.Physics.Matter.Events#SLEEP_END\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Matter.Events.SleepEndEvent} event - The Sleep Event object.\r\n * @param {MatterJS.BodyType} body - The body that has stopped sleeping.\r\n */", "meta": { "filename": "SLEEP_END_EVENT.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "description": "The Matter Physics Sleep End Event.\r\rThis event is dispatched by a Matter Physics World instance when a Body stop sleeping.\r\rListen to it from a Scene using: `this.matter.world.on('sleepend', listener)`.", "kind": "event", "name": "SLEEP_END", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Matter.Events.SleepEndEvent" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.Events.SleepEndEvent" } }, "description": "The Sleep Event object.", "name": "event" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The body that has stopped sleeping.", "name": "body" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events#event:SLEEP_END", "scope": "instance", "___id": "T000002R030689", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Physics.Matter.Events.SleepStartEvent\r\n *\r\n * @property {any} source - The source object of the event.\r\n * @property {string} name - The name of the event.\r\n */", "meta": { "filename": "SLEEP_START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "kind": "typedef", "name": "SleepStartEvent", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The source object of the event.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the event.", "name": "name" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events.SleepStartEvent", "scope": "static", "___id": "T000002R030691", "___s": true }, { "comment": "/**\r\n * The Matter Physics Sleep Start Event.\r\n *\r\n * This event is dispatched by a Matter Physics World instance when a Body goes to sleep.\r\n *\r\n * Listen to it from a Scene using: `this.matter.world.on('sleepstart', listener)`.\r\n *\r\n * @event Phaser.Physics.Matter.Events#SLEEP_START\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Physics.Matter.Events.SleepStartEvent} event - The Sleep Event object.\r\n * @param {MatterJS.BodyType} body - The body that has gone to sleep.\r\n */", "meta": { "filename": "SLEEP_START_EVENT.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\events", "code": {} }, "description": "The Matter Physics Sleep Start Event.\r\rThis event is dispatched by a Matter Physics World instance when a Body goes to sleep.\r\rListen to it from a Scene using: `this.matter.world.on('sleepstart', listener)`.", "kind": "event", "name": "SLEEP_START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Matter.Events.SleepStartEvent" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.Events.SleepStartEvent" } }, "description": "The Sleep Event object.", "name": "event" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The body that has gone to sleep.", "name": "body" } ], "memberof": "Phaser.Physics.Matter.Events", "longname": "Phaser.Physics.Matter.Events#event:SLEEP_START", "scope": "instance", "___id": "T000002R030692", "___s": true }, { "comment": "/**\n * @classdesc\n * The Matter Factory is responsible for quickly creating a variety of different types of\n * bodies, constraints and Game Objects and adding them into the physics world.\n *\n * You access the factory from within a Scene using `add`:\n *\n * ```javascript\n * this.matter.add.rectangle(x, y, width, height);\n * ```\n *\n * Use of the Factory is optional. All of the objects it creates can also be created\n * directly via your own code or constructors. It is provided as a means to keep your\n * code concise.\n *\n * @class Factory\n * @memberof Phaser.Physics.Matter\n * @constructor\n * @since 3.0.0\n *\n * @param {Phaser.Physics.Matter.World} world - The Matter World which this Factory adds to.\n */", "meta": { "filename": "Factory.js", "lineno": 21, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "classdesc": "The Matter Factory is responsible for quickly creating a variety of different types of\nbodies, constraints and Game Objects and adding them into the physics world.\n\nYou access the factory from within a Scene using `add`:\n\n```javascript\nthis.matter.add.rectangle(x, y, width, height);\n```\n\nUse of the Factory is optional. All of the objects it creates can also be created\ndirectly via your own code or constructors. It is provided as a means to keep your\ncode concise.", "kind": "class", "name": "Factory", "memberof": "Phaser.Physics.Matter", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Matter.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.World" } }, "description": "The Matter World which this Factory adds to.", "name": "world" } ], "scope": "static", "longname": "Phaser.Physics.Matter.Factory", "___id": "T000002R030707", "___s": true }, { "comment": "/**\n * The Matter World which this Factory adds to.\n *\n * @name Phaser.Physics.Matter.Factory#world\n * @type {Phaser.Physics.Matter.World}\n * @since 3.0.0\n */", "meta": { "filename": "Factory.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "The Matter World which this Factory adds to.", "name": "world", "type": { "names": [ "Phaser.Physics.Matter.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.World" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#world", "scope": "instance", "kind": "member", "___id": "T000002R030710", "___s": true }, { "comment": "/**\n * The Scene which this Factory's Matter World belongs to.\n *\n * @name Phaser.Physics.Matter.Factory#scene\n * @type {Phaser.Scene}\n * @since 3.0.0\n */", "meta": { "filename": "Factory.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "The Scene which this Factory's Matter World belongs to.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#scene", "scope": "instance", "kind": "member", "___id": "T000002R030712", "___s": true }, { "comment": "/**\n * A reference to the Scene.Systems this Matter Physics instance belongs to.\n *\n * @name Phaser.Physics.Matter.Factory#sys\n * @type {Phaser.Scenes.Systems}\n * @since 3.0.0\n */", "meta": { "filename": "Factory.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the Scene.Systems this Matter Physics instance belongs to.", "name": "sys", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#sys", "scope": "instance", "kind": "member", "___id": "T000002R030714", "___s": true }, { "comment": "/**\n * Creates a new rigid rectangular Body and adds it to the World.\n *\n * @method Phaser.Physics.Matter.Factory#rectangle\n * @since 3.0.0\n *\n * @param {number} x - The X coordinate of the center of the Body.\n * @param {number} y - The Y coordinate of the center of the Body.\n * @param {number} width - The width of the Body.\n * @param {number} height - The height of the Body.\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\n *\n * @return {MatterJS.BodyType} A Matter JS Body.\n */", "meta": { "filename": "Factory.js", "lineno": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a new rigid rectangular Body and adds it to the World.", "kind": "function", "name": "rectangle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the center of the Body.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the center of the Body.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the Body.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the Body.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A Matter JS Body." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#rectangle", "scope": "instance", "___id": "T000002R030716", "___s": true }, { "comment": "/**\n * Creates a new rigid trapezoidal Body and adds it to the World.\n *\n * @method Phaser.Physics.Matter.Factory#trapezoid\n * @since 3.0.0\n *\n * @param {number} x - The X coordinate of the center of the Body.\n * @param {number} y - The Y coordinate of the center of the Body.\n * @param {number} width - The width of the trapezoid Body.\n * @param {number} height - The height of the trapezoid Body.\n * @param {number} slope - The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\n *\n * @return {MatterJS.BodyType} A Matter JS Body.\n */", "meta": { "filename": "Factory.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a new rigid trapezoidal Body and adds it to the World.", "kind": "function", "name": "trapezoid", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the center of the Body.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the center of the Body.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the trapezoid Body.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the trapezoid Body.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.", "name": "slope" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A Matter JS Body." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#trapezoid", "scope": "instance", "___id": "T000002R030719", "___s": true }, { "comment": "/**\n * Creates a new rigid circular Body and adds it to the World.\n *\n * @method Phaser.Physics.Matter.Factory#circle\n * @since 3.0.0\n *\n * @param {number} x - The X coordinate of the center of the Body.\n * @param {number} y - The Y coordinate of the center of the Body.\n * @param {number} radius - The radius of the circle.\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\n * @param {number} [maxSides] - The maximum amount of sides to use for the polygon which will approximate this circle.\n *\n * @return {MatterJS.BodyType} A Matter JS Body.\n */", "meta": { "filename": "Factory.js", "lineno": 124, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a new rigid circular Body and adds it to the World.", "kind": "function", "name": "circle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the center of the Body.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the center of the Body.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the circle.", "name": "radius" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The maximum amount of sides to use for the polygon which will approximate this circle.", "name": "maxSides" } ], "returns": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A Matter JS Body." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#circle", "scope": "instance", "___id": "T000002R030722", "___s": true }, { "comment": "/**\n * Creates a new rigid polygonal Body and adds it to the World.\n *\n * @method Phaser.Physics.Matter.Factory#polygon\n * @since 3.0.0\n *\n * @param {number} x - The X coordinate of the center of the Body.\n * @param {number} y - The Y coordinate of the center of the Body.\n * @param {number} sides - The number of sides the polygon will have.\n * @param {number} radius - The \"radius\" of the polygon, i.e. the distance from its center to any vertex. This is also the radius of its circumcircle.\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\n *\n * @return {MatterJS.BodyType} A Matter JS Body.\n */", "meta": { "filename": "Factory.js", "lineno": 147, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a new rigid polygonal Body and adds it to the World.", "kind": "function", "name": "polygon", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the center of the Body.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the center of the Body.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of sides the polygon will have.", "name": "sides" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The \"radius\" of the polygon, i.e. the distance from its center to any vertex. This is also the radius of its circumcircle.", "name": "radius" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A Matter JS Body." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#polygon", "scope": "instance", "___id": "T000002R030725", "___s": true }, { "comment": "/**\n * Creates a body using the supplied vertices (or an array containing multiple sets of vertices) and adds it to the World.\n * If the vertices are convex, they will pass through as supplied. Otherwise, if the vertices are concave, they will be decomposed. Note that this process is not guaranteed to support complex sets of vertices, e.g. ones with holes.\n *\n * @method Phaser.Physics.Matter.Factory#fromVertices\n * @since 3.0.0\n *\n * @param {number} x - The X coordinate of the center of the Body.\n * @param {number} y - The Y coordinate of the center of the Body.\n * @param {(string|array)} vertexSets - The vertices data. Either a path string or an array of vertices.\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\n * @param {boolean} [flagInternal=false] - Flag internal edges (coincident part edges)\n * @param {number} [removeCollinear=0.01] - Whether Matter.js will discard collinear edges (to improve performance).\n * @param {number} [minimumArea=10] - During decomposition discard parts that have an area less than this.\n *\n * @return {MatterJS.BodyType} A Matter JS Body.\n */", "meta": { "filename": "Factory.js", "lineno": 170, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a body using the supplied vertices (or an array containing multiple sets of vertices) and adds it to the World.\nIf the vertices are convex, they will pass through as supplied. Otherwise, if the vertices are concave, they will be decomposed. Note that this process is not guaranteed to support complex sets of vertices, e.g. ones with holes.", "kind": "function", "name": "fromVertices", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the center of the Body.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the center of the Body.", "name": "y" }, { "type": { "names": [ "string", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "array" } ] } }, "description": "The vertices data. Either a path string or an array of vertices.", "name": "vertexSets" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Flag internal edges (coincident part edges)", "name": "flagInternal" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.01, "description": "Whether Matter.js will discard collinear edges (to improve performance).", "name": "removeCollinear" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "During decomposition discard parts that have an area less than this.", "name": "minimumArea" } ], "returns": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A Matter JS Body." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#fromVertices", "scope": "instance", "___id": "T000002R030728", "___s": true }, { "comment": "/**\n * Creates a body using data exported from the application PhysicsEditor (https://www.codeandweb.com/physicseditor)\n *\n * The PhysicsEditor file should be loaded as JSON:\n *\n * ```javascript\n * preload ()\n * {\n * this.load.json('vehicles', 'assets/vehicles.json);\n * }\n *\n * create ()\n * {\n * const vehicleShapes = this.cache.json.get('vehicles');\n * this.matter.add.fromPhysicsEditor(400, 300, vehicleShapes.truck);\n * }\n * ```\n *\n * Do not pass the entire JSON file to this method, but instead pass one of the shapes contained within it.\n *\n * If you pas in an `options` object, any settings in there will override those in the PhysicsEditor config object.\n *\n * @method Phaser.Physics.Matter.Factory#fromPhysicsEditor\n * @since 3.22.0\n *\n * @param {number} x - The horizontal world location of the body.\n * @param {number} y - The vertical world location of the body.\n * @param {any} config - The JSON data exported from PhysicsEditor.\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\n * @param {boolean} [addToWorld=true] - Should the newly created body be immediately added to the World?\n *\n * @return {MatterJS.BodyType} A Matter JS Body.\n */", "meta": { "filename": "Factory.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a body using data exported from the application PhysicsEditor (https://www.codeandweb.com/physicseditor)\n\nThe PhysicsEditor file should be loaded as JSON:\n\n```javascript\npreload ()\n{\n this.load.json('vehicles', 'assets/vehicles.json);\n}\n\ncreate ()\n{\n const vehicleShapes = this.cache.json.get('vehicles');\n this.matter.add.fromPhysicsEditor(400, 300, vehicleShapes.truck);\n}\n```\n\nDo not pass the entire JSON file to this method, but instead pass one of the shapes contained within it.\n\nIf you pas in an `options` object, any settings in there will override those in the PhysicsEditor config object.", "kind": "function", "name": "fromPhysicsEditor", "since": "3.22.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal world location of the body.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical world location of the body.", "name": "y" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The JSON data exported from PhysicsEditor.", "name": "config" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the newly created body be immediately added to the World?", "name": "addToWorld" } ], "returns": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A Matter JS Body." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#fromPhysicsEditor", "scope": "instance", "___id": "T000002R030732", "___s": true }, { "comment": "/**\n * Creates a body using the path data from an SVG file.\n *\n * SVG Parsing requires the pathseg polyfill from https://github.com/progers/pathseg\n *\n * The SVG file should be loaded as XML, as this method requires the ability to extract\n * the path data from it. I.e.:\n *\n * ```javascript\n * preload ()\n * {\n * this.load.xml('face', 'assets/face.svg);\n * }\n *\n * create ()\n * {\n * this.matter.add.fromSVG(400, 300, this.cache.xml.get('face'));\n * }\n * ```\n *\n * @method Phaser.Physics.Matter.Factory#fromSVG\n * @since 3.22.0\n *\n * @param {number} x - The X coordinate of the body.\n * @param {number} y - The Y coordinate of the body.\n * @param {object} xml - The SVG Path data.\n * @param {number} [scale=1] - Scale the vertices by this amount after creation.\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\n * @param {boolean} [addToWorld=true] - Should the newly created body be immediately added to the World?\n *\n * @return {MatterJS.BodyType} A Matter JS Body.\n */", "meta": { "filename": "Factory.js", "lineno": 248, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a body using the path data from an SVG file.\n\nSVG Parsing requires the pathseg polyfill from https://github.com/progers/pathseg\n\nThe SVG file should be loaded as XML, as this method requires the ability to extract\nthe path data from it. I.e.:\n\n```javascript\npreload ()\n{\n this.load.xml('face', 'assets/face.svg);\n}\n\ncreate ()\n{\n this.matter.add.fromSVG(400, 300, this.cache.xml.get('face'));\n}\n```", "kind": "function", "name": "fromSVG", "since": "3.22.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the body.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the body.", "name": "y" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The SVG Path data.", "name": "xml" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Scale the vertices by this amount after creation.", "name": "scale" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the newly created body be immediately added to the World?", "name": "addToWorld" } ], "returns": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A Matter JS Body." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#fromSVG", "scope": "instance", "___id": "T000002R030736", "___s": true }, { "comment": "/**\n * Creates a body using the supplied physics data, as provided by a JSON file.\n *\n * The data file should be loaded as JSON:\n *\n * ```javascript\n * preload ()\n * {\n * this.load.json('ninjas', 'assets/ninjas.json);\n * }\n *\n * create ()\n * {\n * const ninjaShapes = this.cache.json.get('ninjas');\n *\n * this.matter.add.fromJSON(400, 300, ninjaShapes.shinobi);\n * }\n * ```\n *\n * Do not pass the entire JSON file to this method, but instead pass one of the shapes contained within it.\n *\n * If you pas in an `options` object, any settings in there will override those in the config object.\n *\n * The structure of the JSON file is as follows:\n *\n * ```text\n * {\n * 'generator_info': // The name of the application that created the JSON data\n * 'shapeName': {\n * 'type': // The type of body\n * 'label': // Optional body label\n * 'vertices': // An array, or an array of arrays, containing the vertex data in x/y object pairs\n * }\n * }\n * ```\n *\n * At the time of writing, only the Phaser Physics Tracer App exports in this format.\n *\n * @method Phaser.Physics.Matter.Factory#fromJSON\n * @since 3.22.0\n *\n * @param {number} x - The X coordinate of the body.\n * @param {number} y - The Y coordinate of the body.\n * @param {any} config - The JSON physics data.\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\n * @param {boolean} [addToWorld=true] - Should the newly created body be immediately added to the World?\n *\n * @return {MatterJS.BodyType} A Matter JS Body.\n */", "meta": { "filename": "Factory.js", "lineno": 311, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a body using the supplied physics data, as provided by a JSON file.\n\nThe data file should be loaded as JSON:\n\n```javascript\npreload ()\n{\n this.load.json('ninjas', 'assets/ninjas.json);\n}\n\ncreate ()\n{\n const ninjaShapes = this.cache.json.get('ninjas');\n\n this.matter.add.fromJSON(400, 300, ninjaShapes.shinobi);\n}\n```\n\nDo not pass the entire JSON file to this method, but instead pass one of the shapes contained within it.\n\nIf you pas in an `options` object, any settings in there will override those in the config object.\n\nThe structure of the JSON file is as follows:\n\n```text\n{\n 'generator_info': // The name of the application that created the JSON data\n 'shapeName': {\n 'type': // The type of body\n 'label': // Optional body label\n 'vertices': // An array, or an array of arrays, containing the vertex data in x/y object pairs\n }\n}\n```\n\nAt the time of writing, only the Phaser Physics Tracer App exports in this format.", "kind": "function", "name": "fromJSON", "since": "3.22.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the body.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the body.", "name": "y" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The JSON physics data.", "name": "config" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the newly created body be immediately added to the World?", "name": "addToWorld" } ], "returns": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A Matter JS Body." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#fromJSON", "scope": "instance", "___id": "T000002R030746", "___s": true }, { "comment": "/**\n * Create a new composite containing Matter Image objects created in a grid arrangement.\n * This function uses the body bounds to prevent overlaps.\n *\n * @method Phaser.Physics.Matter.Factory#imageStack\n * @since 3.0.0\n *\n * @param {string} key - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.\n * @param {(string|number)} frame - An optional frame from the Texture this Game Object is rendering with. Set to `null` to skip this value.\n * @param {number} x - The horizontal position of this composite in the world.\n * @param {number} y - The vertical position of this composite in the world.\n * @param {number} columns - The number of columns in the grid.\n * @param {number} rows - The number of rows in the grid.\n * @param {number} [columnGap=0] - The distance between each column.\n * @param {number} [rowGap=0] - The distance between each row.\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\n *\n * @return {MatterJS.CompositeType} A Matter JS Composite Stack.\n */", "meta": { "filename": "Factory.js", "lineno": 375, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Create a new composite containing Matter Image objects created in a grid arrangement.\nThis function uses the body bounds to prevent overlaps.", "kind": "function", "name": "imageStack", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "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.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "An optional frame from the Texture this Game Object is rendering with. Set to `null` to skip this value.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this composite in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this composite in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of columns in the grid.", "name": "columns" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of rows in the grid.", "name": "rows" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The distance between each column.", "name": "columnGap" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The distance between each row.", "name": "rowGap" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "MatterJS.CompositeType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.CompositeType" } }, "description": "A Matter JS Composite Stack." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#imageStack", "scope": "instance", "___id": "T000002R030751", "___s": true }, { "comment": "/**\n * Create a new composite containing bodies created in the callback in a grid arrangement.\n *\n * This function uses the body bounds to prevent overlaps.\n *\n * @method Phaser.Physics.Matter.Factory#stack\n * @since 3.0.0\n *\n * @param {number} x - The horizontal position of this composite in the world.\n * @param {number} y - The vertical position of this composite in the world.\n * @param {number} columns - The number of columns in the grid.\n * @param {number} rows - The number of rows in the grid.\n * @param {number} columnGap - The distance between each column.\n * @param {number} rowGap - The distance between each row.\n * @param {function} callback - The callback that creates the stack.\n *\n * @return {MatterJS.CompositeType} A new composite containing objects created in the callback.\n */", "meta": { "filename": "Factory.js", "lineno": 419, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Create a new composite containing bodies created in the callback in a grid arrangement.\n\nThis function uses the body bounds to prevent overlaps.", "kind": "function", "name": "stack", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this composite in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this composite in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of columns in the grid.", "name": "columns" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of rows in the grid.", "name": "rows" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance between each column.", "name": "columnGap" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance between each row.", "name": "rowGap" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback that creates the stack.", "name": "callback" } ], "returns": [ { "type": { "names": [ "MatterJS.CompositeType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.CompositeType" } }, "description": "A new composite containing objects created in the callback." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#stack", "scope": "instance", "___id": "T000002R030761", "___s": true }, { "comment": "/**\n * Create a new composite containing bodies created in the callback in a pyramid arrangement.\n * This function uses the body bounds to prevent overlaps.\n *\n * @method Phaser.Physics.Matter.Factory#pyramid\n * @since 3.0.0\n *\n * @param {number} x - The horizontal position of this composite in the world.\n * @param {number} y - The vertical position of this composite in the world.\n * @param {number} columns - The number of columns in the pyramid.\n * @param {number} rows - The number of rows in the pyramid.\n * @param {number} columnGap - The distance between each column.\n * @param {number} rowGap - The distance between each row.\n * @param {function} callback - The callback function to be invoked.\n *\n * @return {MatterJS.CompositeType} A Matter JS Composite pyramid.\n */", "meta": { "filename": "Factory.js", "lineno": 446, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Create a new composite containing bodies created in the callback in a pyramid arrangement.\nThis function uses the body bounds to prevent overlaps.", "kind": "function", "name": "pyramid", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this composite in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this composite in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of columns in the pyramid.", "name": "columns" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of rows in the pyramid.", "name": "rows" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance between each column.", "name": "columnGap" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance between each row.", "name": "rowGap" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback function to be invoked.", "name": "callback" } ], "returns": [ { "type": { "names": [ "MatterJS.CompositeType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.CompositeType" } }, "description": "A Matter JS Composite pyramid." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#pyramid", "scope": "instance", "___id": "T000002R030764", "___s": true }, { "comment": "/**\n * Chains all bodies in the given composite together using constraints.\n *\n * @method Phaser.Physics.Matter.Factory#chain\n * @since 3.0.0\n *\n * @param {MatterJS.CompositeType} composite - The composite in which all bodies will be chained together sequentially.\n * @param {number} xOffsetA - The horizontal offset of the BodyA constraint. This is a percentage based on the body size, not a world position.\n * @param {number} yOffsetA - The vertical offset of the BodyA constraint. This is a percentage based on the body size, not a world position.\n * @param {number} xOffsetB - The horizontal offset of the BodyB constraint. This is a percentage based on the body size, not a world position.\n * @param {number} yOffsetB - The vertical offset of the BodyB constraint. This is a percentage based on the body size, not a world position.\n * @param {Phaser.Types.Physics.Matter.MatterConstraintConfig} [options] - An optional Constraint configuration object that is used to set initial Constraint properties on creation.\n *\n * @return {MatterJS.CompositeType} The original composite that was passed to this method.\n */", "meta": { "filename": "Factory.js", "lineno": 472, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Chains all bodies in the given composite together using constraints.", "kind": "function", "name": "chain", "since": "3.0.0", "params": [ { "type": { "names": [ "MatterJS.CompositeType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.CompositeType" } }, "description": "The composite in which all bodies will be chained together sequentially.", "name": "composite" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal offset of the BodyA constraint. This is a percentage based on the body size, not a world position.", "name": "xOffsetA" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical offset of the BodyA constraint. This is a percentage based on the body size, not a world position.", "name": "yOffsetA" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal offset of the BodyB constraint. This is a percentage based on the body size, not a world position.", "name": "xOffsetB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical offset of the BodyB constraint. This is a percentage based on the body size, not a world position.", "name": "yOffsetB" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterConstraintConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterConstraintConfig" } }, "optional": true, "description": "An optional Constraint configuration object that is used to set initial Constraint properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "MatterJS.CompositeType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.CompositeType" } }, "description": "The original composite that was passed to this method." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#chain", "scope": "instance", "___id": "T000002R030767", "___s": true }, { "comment": "/**\n * Connects bodies in the composite with constraints in a grid pattern, with optional cross braces.\n *\n * @method Phaser.Physics.Matter.Factory#mesh\n * @since 3.0.0\n *\n * @param {MatterJS.CompositeType} composite - The composite in which all bodies will be chained together.\n * @param {number} columns - The number of columns in the mesh.\n * @param {number} rows - The number of rows in the mesh.\n * @param {boolean} crossBrace - Create cross braces for the mesh as well?\n * @param {Phaser.Types.Physics.Matter.MatterConstraintConfig} [options] - An optional Constraint configuration object that is used to set initial Constraint properties on creation.\n *\n * @return {MatterJS.CompositeType} The original composite that was passed to this method.\n */", "meta": { "filename": "Factory.js", "lineno": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Connects bodies in the composite with constraints in a grid pattern, with optional cross braces.", "kind": "function", "name": "mesh", "since": "3.0.0", "params": [ { "type": { "names": [ "MatterJS.CompositeType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.CompositeType" } }, "description": "The composite in which all bodies will be chained together.", "name": "composite" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of columns in the mesh.", "name": "columns" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of rows in the mesh.", "name": "rows" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Create cross braces for the mesh as well?", "name": "crossBrace" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterConstraintConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterConstraintConfig" } }, "optional": true, "description": "An optional Constraint configuration object that is used to set initial Constraint properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "MatterJS.CompositeType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.CompositeType" } }, "description": "The original composite that was passed to this method." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#mesh", "scope": "instance", "___id": "T000002R030769", "___s": true }, { "comment": "/**\n * Creates a composite with a Newton's Cradle setup of bodies and constraints.\n *\n * @method Phaser.Physics.Matter.Factory#newtonsCradle\n * @since 3.0.0\n *\n * @param {number} x - The horizontal position of the start of the cradle.\n * @param {number} y - The vertical position of the start of the cradle.\n * @param {number} number - The number of balls in the cradle.\n * @param {number} size - The radius of each ball in the cradle.\n * @param {number} length - The length of the 'string' the balls hang from.\n *\n * @return {MatterJS.CompositeType} A Newton's cradle composite.\n */", "meta": { "filename": "Factory.js", "lineno": 511, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a composite with a Newton's Cradle setup of bodies and constraints.", "kind": "function", "name": "newtonsCradle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of the start of the cradle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of the start of the cradle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of balls in the cradle.", "name": "number" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of each ball in the cradle.", "name": "size" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length of the 'string' the balls hang from.", "name": "length" } ], "returns": [ { "type": { "names": [ "MatterJS.CompositeType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.CompositeType" } }, "description": "A Newton's cradle composite." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#newtonsCradle", "scope": "instance", "___id": "T000002R030771", "___s": true }, { "comment": "/**\n * Creates a composite with simple car setup of bodies and constraints.\n *\n * @method Phaser.Physics.Matter.Factory#car\n * @since 3.0.0\n *\n * @param {number} x - The horizontal position of the car in the world.\n * @param {number} y - The vertical position of the car in the world.\n * @param {number} width - The width of the car chasis.\n * @param {number} height - The height of the car chasis.\n * @param {number} wheelSize - The radius of the car wheels.\n *\n * @return {MatterJS.CompositeType} A new composite car body.\n */", "meta": { "filename": "Factory.js", "lineno": 534, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a composite with simple car setup of bodies and constraints.", "kind": "function", "name": "car", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of the car in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of the car in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the car chasis.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the car chasis.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the car wheels.", "name": "wheelSize" } ], "returns": [ { "type": { "names": [ "MatterJS.CompositeType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.CompositeType" } }, "description": "A new composite car body." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#car", "scope": "instance", "___id": "T000002R030774", "___s": true }, { "comment": "/**\n * Creates a simple soft body like object.\n *\n * @method Phaser.Physics.Matter.Factory#softBody\n * @since 3.0.0\n *\n * @param {number} x - The horizontal position of this composite in the world.\n * @param {number} y - The vertical position of this composite in the world.\n * @param {number} columns - The number of columns in the Composite.\n * @param {number} rows - The number of rows in the Composite.\n * @param {number} columnGap - The distance between each column.\n * @param {number} rowGap - The distance between each row.\n * @param {boolean} crossBrace - `true` to create cross braces between the bodies, or `false` to create just straight braces.\n * @param {number} particleRadius - The radius of this circlular composite.\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [particleOptions] - An optional Body configuration object that is used to set initial Body properties on creation.\n * @param {Phaser.Types.Physics.Matter.MatterConstraintConfig} [constraintOptions] - An optional Constraint configuration object that is used to set initial Constraint properties on creation.\n *\n * @return {MatterJS.CompositeType} A new composite simple soft body.\n */", "meta": { "filename": "Factory.js", "lineno": 557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a simple soft body like object.", "kind": "function", "name": "softBody", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this composite in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this composite in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of columns in the Composite.", "name": "columns" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of rows in the Composite.", "name": "rows" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance between each column.", "name": "columnGap" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance between each row.", "name": "rowGap" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to create cross braces between the bodies, or `false` to create just straight braces.", "name": "crossBrace" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of this circlular composite.", "name": "particleRadius" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "particleOptions" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterConstraintConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterConstraintConfig" } }, "optional": true, "description": "An optional Constraint configuration object that is used to set initial Constraint properties on creation.", "name": "constraintOptions" } ], "returns": [ { "type": { "names": [ "MatterJS.CompositeType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.CompositeType" } }, "description": "A new composite simple soft body." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#softBody", "scope": "instance", "___id": "T000002R030777", "___s": true }, { "comment": "/**\n * This method is an alias for `Factory.constraint`.\n *\n * Constraints (or joints) are used for specifying that a fixed distance must be maintained\n * between two bodies, or a body and a fixed world-space position.\n *\n * The stiffness of constraints can be modified to create springs or elastic.\n *\n * To simulate a revolute constraint (or pin joint) set `length: 0` and a high `stiffness`\n * value (e.g. `0.7` or above).\n *\n * If the constraint is unstable, try lowering the `stiffness` value and / or increasing\n * `constraintIterations` within the Matter Config.\n *\n * For compound bodies, constraints must be applied to the parent body and not one of its parts.\n *\n * @method Phaser.Physics.Matter.Factory#joint\n * @since 3.0.0\n *\n * @param {MatterJS.BodyType} bodyA - The first possible `Body` that this constraint is attached to.\n * @param {MatterJS.BodyType} bodyB - The second possible `Body` that this constraint is attached to.\n * @param {number} [length] - A Number that specifies the target resting length of the constraint. If not given it is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.\n * @param {number} [stiffness=1] - A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts as a soft spring.\n * @param {Phaser.Types.Physics.Matter.MatterConstraintConfig} [options] - An optional Constraint configuration object that is used to set initial Constraint properties on creation.\n *\n * @return {MatterJS.ConstraintType} A Matter JS Constraint.\n */", "meta": { "filename": "Factory.js", "lineno": 585, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "This method is an alias for `Factory.constraint`.\n\nConstraints (or joints) are used for specifying that a fixed distance must be maintained\nbetween two bodies, or a body and a fixed world-space position.\n\nThe stiffness of constraints can be modified to create springs or elastic.\n\nTo simulate a revolute constraint (or pin joint) set `length: 0` and a high `stiffness`\nvalue (e.g. `0.7` or above).\n\nIf the constraint is unstable, try lowering the `stiffness` value and / or increasing\n`constraintIterations` within the Matter Config.\n\nFor compound bodies, constraints must be applied to the parent body and not one of its parts.", "kind": "function", "name": "joint", "since": "3.0.0", "params": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The first possible `Body` that this constraint is attached to.", "name": "bodyA" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The second possible `Body` that this constraint is attached to.", "name": "bodyB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "A Number that specifies the target resting length of the constraint. If not given it is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.", "name": "length" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts as a soft spring.", "name": "stiffness" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterConstraintConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterConstraintConfig" } }, "optional": true, "description": "An optional Constraint configuration object that is used to set initial Constraint properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "MatterJS.ConstraintType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.ConstraintType" } }, "description": "A Matter JS Constraint." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#joint", "scope": "instance", "___id": "T000002R030780", "___s": true }, { "comment": "/**\n * This method is an alias for `Factory.constraint`.\n *\n * Constraints (or joints) are used for specifying that a fixed distance must be maintained\n * between two bodies, or a body and a fixed world-space position.\n *\n * The stiffness of constraints can be modified to create springs or elastic.\n *\n * To simulate a revolute constraint (or pin joint) set `length: 0` and a high `stiffness`\n * value (e.g. `0.7` or above).\n *\n * If the constraint is unstable, try lowering the `stiffness` value and / or increasing\n * `constraintIterations` within the Matter Config.\n *\n * For compound bodies, constraints must be applied to the parent body and not one of its parts.\n *\n * @method Phaser.Physics.Matter.Factory#spring\n * @since 3.0.0\n *\n * @param {MatterJS.BodyType} bodyA - The first possible `Body` that this constraint is attached to.\n * @param {MatterJS.BodyType} bodyB - The second possible `Body` that this constraint is attached to.\n * @param {number} [length] - A Number that specifies the target resting length of the constraint. If not given it is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.\n * @param {number} [stiffness=1] - A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts as a soft spring.\n * @param {Phaser.Types.Physics.Matter.MatterConstraintConfig} [options] - An optional Constraint configuration object that is used to set initial Constraint properties on creation.\n *\n * @return {MatterJS.ConstraintType} A Matter JS Constraint.\n */", "meta": { "filename": "Factory.js", "lineno": 617, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "This method is an alias for `Factory.constraint`.\n\nConstraints (or joints) are used for specifying that a fixed distance must be maintained\nbetween two bodies, or a body and a fixed world-space position.\n\nThe stiffness of constraints can be modified to create springs or elastic.\n\nTo simulate a revolute constraint (or pin joint) set `length: 0` and a high `stiffness`\nvalue (e.g. `0.7` or above).\n\nIf the constraint is unstable, try lowering the `stiffness` value and / or increasing\n`constraintIterations` within the Matter Config.\n\nFor compound bodies, constraints must be applied to the parent body and not one of its parts.", "kind": "function", "name": "spring", "since": "3.0.0", "params": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The first possible `Body` that this constraint is attached to.", "name": "bodyA" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The second possible `Body` that this constraint is attached to.", "name": "bodyB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "A Number that specifies the target resting length of the constraint. If not given it is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.", "name": "length" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts as a soft spring.", "name": "stiffness" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterConstraintConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterConstraintConfig" } }, "optional": true, "description": "An optional Constraint configuration object that is used to set initial Constraint properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "MatterJS.ConstraintType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.ConstraintType" } }, "description": "A Matter JS Constraint." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#spring", "scope": "instance", "___id": "T000002R030782", "___s": true }, { "comment": "/**\n * Constraints (or joints) are used for specifying that a fixed distance must be maintained\n * between two bodies, or a body and a fixed world-space position.\n *\n * The stiffness of constraints can be modified to create springs or elastic.\n *\n * To simulate a revolute constraint (or pin joint) set `length: 0` and a high `stiffness`\n * value (e.g. `0.7` or above).\n *\n * If the constraint is unstable, try lowering the `stiffness` value and / or increasing\n * `constraintIterations` within the Matter Config.\n *\n * For compound bodies, constraints must be applied to the parent body and not one of its parts.\n *\n * @method Phaser.Physics.Matter.Factory#constraint\n * @since 3.0.0\n *\n * @param {MatterJS.BodyType} bodyA - The first possible `Body` that this constraint is attached to.\n * @param {MatterJS.BodyType} bodyB - The second possible `Body` that this constraint is attached to.\n * @param {number} [length] - A Number that specifies the target resting length of the constraint. If not given it is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.\n * @param {number} [stiffness=1] - A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts as a soft spring.\n * @param {Phaser.Types.Physics.Matter.MatterConstraintConfig} [options] - An optional Constraint configuration object that is used to set initial Constraint properties on creation.\n *\n * @return {MatterJS.ConstraintType} A Matter JS Constraint.\n */", "meta": { "filename": "Factory.js", "lineno": 649, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Constraints (or joints) are used for specifying that a fixed distance must be maintained\nbetween two bodies, or a body and a fixed world-space position.\n\nThe stiffness of constraints can be modified to create springs or elastic.\n\nTo simulate a revolute constraint (or pin joint) set `length: 0` and a high `stiffness`\nvalue (e.g. `0.7` or above).\n\nIf the constraint is unstable, try lowering the `stiffness` value and / or increasing\n`constraintIterations` within the Matter Config.\n\nFor compound bodies, constraints must be applied to the parent body and not one of its parts.", "kind": "function", "name": "constraint", "since": "3.0.0", "params": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The first possible `Body` that this constraint is attached to.", "name": "bodyA" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The second possible `Body` that this constraint is attached to.", "name": "bodyB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "A Number that specifies the target resting length of the constraint. If not given it is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.", "name": "length" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts as a soft spring.", "name": "stiffness" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterConstraintConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterConstraintConfig" } }, "optional": true, "description": "An optional Constraint configuration object that is used to set initial Constraint properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "MatterJS.ConstraintType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.ConstraintType" } }, "description": "A Matter JS Constraint." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#constraint", "scope": "instance", "___id": "T000002R030784", "___s": true }, { "comment": "/**\n * Constraints (or joints) are used for specifying that a fixed distance must be maintained\n * between two bodies, or a body and a fixed world-space position.\n *\n * A world constraint has only one body, you should specify a `pointA` position in\n * the constraint options parameter to attach the constraint to the world.\n *\n * The stiffness of constraints can be modified to create springs or elastic.\n *\n * To simulate a revolute constraint (or pin joint) set `length: 0` and a high `stiffness`\n * value (e.g. `0.7` or above).\n *\n * If the constraint is unstable, try lowering the `stiffness` value and / or increasing\n * `constraintIterations` within the Matter Config.\n *\n * For compound bodies, constraints must be applied to the parent body and not one of its parts.\n *\n * @method Phaser.Physics.Matter.Factory#worldConstraint\n * @since 3.0.0\n *\n * @param {MatterJS.BodyType} body - The Matter `Body` that this constraint is attached to.\n * @param {number} [length] - A number that specifies the target resting length of the constraint. If not given it is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.\n * @param {number} [stiffness=1] - A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts as a soft spring.\n * @param {Phaser.Types.Physics.Matter.MatterConstraintConfig} [options] - An optional Constraint configuration object that is used to set initial Constraint properties on creation.\n *\n * @return {MatterJS.ConstraintType} A Matter JS Constraint.\n */", "meta": { "filename": "Factory.js", "lineno": 696, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Constraints (or joints) are used for specifying that a fixed distance must be maintained\nbetween two bodies, or a body and a fixed world-space position.\n\nA world constraint has only one body, you should specify a `pointA` position in\nthe constraint options parameter to attach the constraint to the world.\n\nThe stiffness of constraints can be modified to create springs or elastic.\n\nTo simulate a revolute constraint (or pin joint) set `length: 0` and a high `stiffness`\nvalue (e.g. `0.7` or above).\n\nIf the constraint is unstable, try lowering the `stiffness` value and / or increasing\n`constraintIterations` within the Matter Config.\n\nFor compound bodies, constraints must be applied to the parent body and not one of its parts.", "kind": "function", "name": "worldConstraint", "since": "3.0.0", "params": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The Matter `Body` that this constraint is attached to.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "A number that specifies the target resting length of the constraint. If not given it is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.", "name": "length" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts as a soft spring.", "name": "stiffness" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterConstraintConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterConstraintConfig" } }, "optional": true, "description": "An optional Constraint configuration object that is used to set initial Constraint properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "MatterJS.ConstraintType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.ConstraintType" } }, "description": "A Matter JS Constraint." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#worldConstraint", "scope": "instance", "___id": "T000002R030793", "___s": true }, { "comment": "/**\n * This method is an alias for `Factory.pointerConstraint`.\n *\n * A Pointer Constraint is a special type of constraint that allows you to click\n * and drag bodies in a Matter World. It monitors the active Pointers in a Scene,\n * and when one is pressed down it checks to see if that hit any part of any active\n * body in the world. If it did, and the body has input enabled, it will begin to\n * drag it until either released, or you stop it via the `stopDrag` method.\n *\n * You can adjust the stiffness, length and other properties of the constraint via\n * the `options` object on creation.\n *\n * @method Phaser.Physics.Matter.Factory#mouseSpring\n * @since 3.0.0\n *\n * @param {Phaser.Types.Physics.Matter.MatterConstraintConfig} [options] - An optional Constraint configuration object that is used to set initial Constraint properties on creation.\n *\n * @return {MatterJS.ConstraintType} A Matter JS Constraint.\n */", "meta": { "filename": "Factory.js", "lineno": 744, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "This method is an alias for `Factory.pointerConstraint`.\n\nA Pointer Constraint is a special type of constraint that allows you to click\nand drag bodies in a Matter World. It monitors the active Pointers in a Scene,\nand when one is pressed down it checks to see if that hit any part of any active\nbody in the world. If it did, and the body has input enabled, it will begin to\ndrag it until either released, or you stop it via the `stopDrag` method.\n\nYou can adjust the stiffness, length and other properties of the constraint via\nthe `options` object on creation.", "kind": "function", "name": "mouseSpring", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterConstraintConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterConstraintConfig" } }, "optional": true, "description": "An optional Constraint configuration object that is used to set initial Constraint properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "MatterJS.ConstraintType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.ConstraintType" } }, "description": "A Matter JS Constraint." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#mouseSpring", "scope": "instance", "___id": "T000002R030801", "___s": true }, { "comment": "/**\n * A Pointer Constraint is a special type of constraint that allows you to click\n * and drag bodies in a Matter World. It monitors the active Pointers in a Scene,\n * and when one is pressed down it checks to see if that hit any part of any active\n * body in the world. If it did, and the body has input enabled, it will begin to\n * drag it until either released, or you stop it via the `stopDrag` method.\n *\n * You can adjust the stiffness, length and other properties of the constraint via\n * the `options` object on creation.\n *\n * @method Phaser.Physics.Matter.Factory#pointerConstraint\n * @since 3.0.0\n *\n * @param {Phaser.Types.Physics.Matter.MatterConstraintConfig} [options] - An optional Constraint configuration object that is used to set initial Constraint properties on creation.\n *\n * @return {MatterJS.ConstraintType} A Matter JS Constraint.\n */", "meta": { "filename": "Factory.js", "lineno": 768, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A Pointer Constraint is a special type of constraint that allows you to click\nand drag bodies in a Matter World. It monitors the active Pointers in a Scene,\nand when one is pressed down it checks to see if that hit any part of any active\nbody in the world. If it did, and the body has input enabled, it will begin to\ndrag it until either released, or you stop it via the `stopDrag` method.\n\nYou can adjust the stiffness, length and other properties of the constraint via\nthe `options` object on creation.", "kind": "function", "name": "pointerConstraint", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterConstraintConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterConstraintConfig" } }, "optional": true, "description": "An optional Constraint configuration object that is used to set initial Constraint properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "MatterJS.ConstraintType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.ConstraintType" } }, "description": "A Matter JS Constraint." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#pointerConstraint", "scope": "instance", "___id": "T000002R030803", "___s": true }, { "comment": "/**\n * Creates a Matter Physics Image Game Object.\n *\n * An Image is a light-weight Game Object useful for the display of static images in your game,\n * such as logos, backgrounds, scenery or other non-animated elements. Images can have input\n * events and physics bodies, or be tweened, tinted or scrolled. The main difference between an\n * Image and a Sprite is that you cannot animate an Image as they do not have the Animation component.\n *\n * @method Phaser.Physics.Matter.Factory#image\n * @since 3.0.0\n *\n * @param {number} x - The horizontal position of this Game Object in the world.\n * @param {number} y - The vertical position of this Game Object in the world.\n * @param {string} key - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with. Set to `null` to skip this value.\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\n *\n * @return {Phaser.Physics.Matter.Image} The Matter Image Game Object.\n */", "meta": { "filename": "Factory.js", "lineno": 801, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a Matter Physics Image Game Object.\n\nAn Image is a light-weight Game Object useful for the display of static images in your game,\nsuch as logos, backgrounds, scenery or other non-animated elements. Images can have input\nevents and physics bodies, or be tweened, tinted or scrolled. The main difference between an\nImage and a Sprite is that you cannot animate an Image as they do not have the Animation component.", "kind": "function", "name": "image", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "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" } }, "description": "The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "key" }, { "type": { "names": [ "string", "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. Set to `null` to skip this value.", "name": "frame" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Matter.Image" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.Image" } }, "description": "The Matter Image Game Object." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#image", "scope": "instance", "___id": "T000002R030809", "___s": true }, { "comment": "/**\n * Creates a wrapper around a Tile that provides access to a corresponding Matter body. A tile can only\n * have one Matter body associated with it. You can either pass in an existing Matter body for\n * the tile or allow the constructor to create the corresponding body for you. If the Tile has a\n * collision group (defined in Tiled), those shapes will be used to create the body. If not, the\n * tile's rectangle bounding box will be used.\n *\n * The corresponding body will be accessible on the Tile itself via Tile.physics.matterBody.\n *\n * Note: not all Tiled collision shapes are supported. See\n * Phaser.Physics.Matter.TileBody#setFromTileCollision for more information.\n *\n * @method Phaser.Physics.Matter.Factory#tileBody\n * @since 3.0.0\n *\n * @param {Phaser.Tilemaps.Tile} tile - The target tile that should have a Matter body.\n * @param {Phaser.Types.Physics.Matter.MatterTileOptions} [options] - Options to be used when creating the Matter body.\n *\n * @return {Phaser.Physics.Matter.TileBody} The Matter Tile Body Game Object.\n */", "meta": { "filename": "Factory.js", "lineno": 829, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a wrapper around a Tile that provides access to a corresponding Matter body. A tile can only\nhave one Matter body associated with it. You can either pass in an existing Matter body for\nthe tile or allow the constructor to create the corresponding body for you. If the Tile has a\ncollision group (defined in Tiled), those shapes will be used to create the body. If not, the\ntile's rectangle bounding box will be used.\n\nThe corresponding body will be accessible on the Tile itself via Tile.physics.matterBody.\n\nNote: not all Tiled collision shapes are supported. See\nPhaser.Physics.Matter.TileBody#setFromTileCollision for more information.", "kind": "function", "name": "tileBody", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The target tile that should have a Matter body.", "name": "tile" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterTileOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterTileOptions" } }, "optional": true, "description": "Options to be used when creating the Matter body.", "name": "options" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Matter.TileBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.TileBody" } }, "description": "The Matter Tile Body Game Object." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#tileBody", "scope": "instance", "___id": "T000002R030812", "___s": true }, { "comment": "/**\n * Creates a Matter Physics Sprite Game Object.\n *\n * A Sprite Game Object is used for the display of both static and animated images in your game.\n * Sprites can have input events and physics bodies. They can also be tweened, tinted, scrolled\n * and animated.\n *\n * The main difference between a Sprite and an Image Game Object is that you cannot animate Images.\n * As such, Sprites take a fraction longer to process and have a larger API footprint due to the Animation\n * Component. If you do not require animation then you can safely use Images to replace Sprites in all cases.\n *\n * @method Phaser.Physics.Matter.Factory#sprite\n * @since 3.0.0\n *\n * @param {number} x - The horizontal position of this Game Object in the world.\n * @param {number} y - The vertical position of this Game Object in the world.\n * @param {string} key - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with. Set to `null` to skip this value.\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\n *\n * @return {Phaser.Physics.Matter.Sprite} The Matter Sprite Game Object.\n */", "meta": { "filename": "Factory.js", "lineno": 854, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a Matter Physics Sprite Game Object.\n\nA Sprite Game Object is used for the display of both static and animated images in your game.\nSprites can have input events and physics bodies. They can also be tweened, tinted, scrolled\nand animated.\n\nThe main difference between a Sprite and an Image Game Object is that you cannot animate Images.\nAs such, Sprites take a fraction longer to process and have a larger API footprint due to the Animation\nComponent. If you do not require animation then you can safely use Images to replace Sprites in all cases.", "kind": "function", "name": "sprite", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "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" } }, "description": "The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "key" }, { "type": { "names": [ "string", "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. Set to `null` to skip this value.", "name": "frame" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Matter.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.Sprite" } }, "description": "The Matter Sprite Game Object." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#sprite", "scope": "instance", "___id": "T000002R030814", "___s": true }, { "comment": "/**\n * Takes an existing Game Object and injects all of the Matter Components into it.\n *\n * This enables you to use component methods such as `setVelocity` or `isSensor` directly from\n * this Game Object.\n *\n * You can also pass in either a Matter Body Configuration object, or a Matter Body instance\n * to link with this Game Object.\n *\n * @method Phaser.Physics.Matter.Factory#gameObject\n * @since 3.3.0\n *\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to inject the Matter Components in to.\n * @param {(Phaser.Types.Physics.Matter.MatterBodyConfig|MatterJS.Body)} [options] - A Matter Body configuration object, or an instance of a Matter Body.\n * @param {boolean} [addToWorld=true] - Add this Matter Body to the World?\n *\n * @return {(Phaser.Physics.Matter.Image|Phaser.Physics.Matter.Sprite|Phaser.GameObjects.GameObject)} The Game Object that had the Matter Components injected into it.\n */", "meta": { "filename": "Factory.js", "lineno": 886, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Takes an existing Game Object and injects all of the Matter Components into it.\n\nThis enables you to use component methods such as `setVelocity` or `isSensor` directly from\nthis Game Object.\n\nYou can also pass in either a Matter Body Configuration object, or a Matter Body instance\nto link with this Game Object.", "kind": "function", "name": "gameObject", "since": "3.3.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to inject the Matter Components in to.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig", "MatterJS.Body" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" }, { "type": "NameExpression", "name": "MatterJS.Body" } ] } }, "optional": true, "description": "A Matter Body configuration object, or an instance of a Matter Body.", "name": "options" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Add this Matter Body to the World?", "name": "addToWorld" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Matter.Image", "Phaser.Physics.Matter.Sprite", "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Physics.Matter.Image" }, { "type": "NameExpression", "name": "Phaser.Physics.Matter.Sprite" }, { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } }, "description": "The Game Object that had the Matter Components injected into it." } ], "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#gameObject", "scope": "instance", "___id": "T000002R030817", "___s": true }, { "comment": "/**\n * Destroys this Factory.\n *\n * @method Phaser.Physics.Matter.Factory#destroy\n * @since 3.5.0\n */", "meta": { "filename": "Factory.js", "lineno": 909, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Destroys this Factory.", "kind": "function", "name": "destroy", "since": "3.5.0", "memberof": "Phaser.Physics.Matter.Factory", "longname": "Phaser.Physics.Matter.Factory#destroy", "scope": "instance", "___id": "T000002R030819", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Physics.Matter\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "kind": "namespace", "name": "Matter", "memberof": "Phaser.Physics", "longname": "Phaser.Physics.Matter", "scope": "static", "___id": "T000002R030825", "___s": true }, { "comment": "/**\r\n * A Matter Game Object is a generic object that allows you to combine any Phaser Game Object,\r\n * including those you have extended or created yourself, with all of the Matter Components.\r\n *\r\n * This enables you to use component methods such as `setVelocity` or `isSensor` directly from\r\n * this Game Object.\r\n *\r\n * @function Phaser.Physics.Matter.MatterGameObject\r\n * @since 3.3.0\r\n *\r\n * @param {Phaser.Physics.Matter.World} world - The Matter world to add the body to.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will have the Matter body applied to it.\r\n * @param {(Phaser.Types.Physics.Matter.MatterBodyConfig|MatterJS.Body)} [options] - A Matter Body configuration object, or an instance of a Matter Body.\r\n * @param {boolean} [addToWorld=true] - Should the newly created body be immediately added to the World?\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was created with the Matter body.\r\n */", "meta": { "filename": "MatterGameObject.js", "lineno": 26, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A Matter Game Object is a generic object that allows you to combine any Phaser Game Object,\rincluding those you have extended or created yourself, with all of the Matter Components.\r\rThis enables you to use component methods such as `setVelocity` or `isSensor` directly from\rthis Game Object.", "kind": "function", "name": "MatterGameObject", "since": "3.3.0", "params": [ { "type": { "names": [ "Phaser.Physics.Matter.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.World" } }, "description": "The Matter world to add the body to.", "name": "world" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will have the Matter body applied to it.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig", "MatterJS.Body" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" }, { "type": "NameExpression", "name": "MatterJS.Body" } ] } }, "optional": true, "description": "A Matter Body configuration object, or an instance of a Matter Body.", "name": "options" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the newly created body be immediately added to the World?", "name": "addToWorld" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was created with the Matter body." } ], "memberof": "Phaser.Physics.Matter", "longname": "Phaser.Physics.Matter.MatterGameObject", "scope": "static", "___id": "T000002R030847", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Matter Physics 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.Image\r\n * @memberof Phaser.Physics.Matter\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.Physics.Matter.Components.Bounce\r\n * @extends Phaser.Physics.Matter.Components.Collision\r\n * @extends Phaser.Physics.Matter.Components.Force\r\n * @extends Phaser.Physics.Matter.Components.Friction\r\n * @extends Phaser.Physics.Matter.Components.Gravity\r\n * @extends Phaser.Physics.Matter.Components.Mass\r\n * @extends Phaser.Physics.Matter.Components.Sensor\r\n * @extends Phaser.Physics.Matter.Components.SetBody\r\n * @extends Phaser.Physics.Matter.Components.Sleep\r\n * @extends Phaser.Physics.Matter.Components.Static\r\n * @extends Phaser.Physics.Matter.Components.Transform\r\n * @extends Phaser.Physics.Matter.Components.Velocity\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.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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.Physics.Matter.World} world - A reference to the Matter.World instance that this body belongs 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 * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n */", "meta": { "filename": "MatterImage.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "classdesc": "A Matter Physics 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.Image", "Phaser.Physics.Matter.Components.Bounce", "Phaser.Physics.Matter.Components.Collision", "Phaser.Physics.Matter.Components.Force", "Phaser.Physics.Matter.Components.Friction", "Phaser.Physics.Matter.Components.Gravity", "Phaser.Physics.Matter.Components.Mass", "Phaser.Physics.Matter.Components.Sensor", "Phaser.Physics.Matter.Components.SetBody", "Phaser.Physics.Matter.Components.Sleep", "Phaser.Physics.Matter.Components.Static", "Phaser.Physics.Matter.Components.Transform", "Phaser.Physics.Matter.Components.Velocity", "Phaser.GameObjects.Components.Alpha", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.Flip", "Phaser.GameObjects.Components.GetBounds", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "Phaser.GameObjects.Components.ScrollFactor", "Phaser.GameObjects.Components.Size", "Phaser.GameObjects.Components.Texture", "Phaser.GameObjects.Components.Tint", "Phaser.GameObjects.Components.Transform", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.Physics.Matter", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Matter.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.World" } }, "description": "A reference to the Matter.World instance that this body belongs to.", "name": "world" }, { "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": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "scope": "static", "longname": "Phaser.Physics.Matter.Image", "___id": "T000002R030876", "___s": true }, { "comment": "/**\r\n * A reference to the Matter.World instance that this body belongs to.\r\n *\r\n * @name Phaser.Physics.Matter.Image#world\r\n * @type {Phaser.Physics.Matter.World}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MatterImage.js", "lineno": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the Matter.World instance that this body belongs to.", "name": "world", "type": { "names": [ "Phaser.Physics.Matter.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.World" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "longname": "Phaser.Physics.Matter.Image#world", "scope": "instance", "kind": "member", "___id": "T000002R030883", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Phaser Matter plugin provides the ability to use the Matter JS Physics Engine within your Phaser games.\r\n *\r\n * Unlike Arcade Physics, the other physics system provided with Phaser, Matter JS is a full-body physics system.\r\n * It features:\r\n *\r\n * * Rigid bodies\r\n * * Compound bodies\r\n * * Composite bodies\r\n * * Concave and convex hulls\r\n * * Physical properties (mass, area, density etc.)\r\n * * Restitution (elastic and inelastic collisions)\r\n * * Collisions (broad-phase, mid-phase and narrow-phase)\r\n * * Stable stacking and resting\r\n * * Conservation of momentum\r\n * * Friction and resistance\r\n * * Constraints\r\n * * Gravity\r\n * * Sleeping and static bodies\r\n * * Rounded corners (chamfering)\r\n * * Views (translate, zoom)\r\n * * Collision queries (raycasting, region tests)\r\n * * Time scaling (slow-mo, speed-up)\r\n *\r\n * Configuration of Matter is handled via the Matter World Config object, which can be passed in either the\r\n * Phaser Game Config, or Phaser Scene Config. Here is a basic example:\r\n *\r\n * ```js\r\n * physics: {\r\n * default: 'matter',\r\n * matter: {\r\n * enableSleeping: true,\r\n * gravity: {\r\n * y: 0\r\n * },\r\n * debug: {\r\n * showBody: true,\r\n * showStaticBody: true\r\n * }\r\n * }\r\n * }\r\n * ```\r\n *\r\n * This class acts as an interface between a Phaser Scene and a single instance of the Matter Engine.\r\n *\r\n * Use it to access the most common Matter features and helper functions.\r\n *\r\n * You can find details, documentation and examples on the Matter JS website: https://brm.io/matter-js/\r\n *\r\n * @class MatterPhysics\r\n * @memberof Phaser.Physics.Matter\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Phaser Scene that owns this Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 43, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "classdesc": "The Phaser Matter plugin provides the ability to use the Matter JS Physics Engine within your Phaser games.\r\rUnlike Arcade Physics, the other physics system provided with Phaser, Matter JS is a full-body physics system.\rIt features:\r\r* Rigid bodies\r* Compound bodies\r* Composite bodies\r* Concave and convex hulls\r* Physical properties (mass, area, density etc.)\r* Restitution (elastic and inelastic collisions)\r* Collisions (broad-phase, mid-phase and narrow-phase)\r* Stable stacking and resting\r* Conservation of momentum\r* Friction and resistance\r* Constraints\r* Gravity\r* Sleeping and static bodies\r* Rounded corners (chamfering)\r* Views (translate, zoom)\r* Collision queries (raycasting, region tests)\r* Time scaling (slow-mo, speed-up)\r\rConfiguration of Matter is handled via the Matter World Config object, which can be passed in either the\rPhaser Game Config, or Phaser Scene Config. Here is a basic example:\r\r```js\rphysics: {\r default: 'matter',\r matter: {\r enableSleeping: true,\r gravity: {\r y: 0\r },\r debug: {\r showBody: true,\r showStaticBody: true\r }\r }\r}\r```\r\rThis class acts as an interface between a Phaser Scene and a single instance of the Matter Engine.\r\rUse it to access the most common Matter features and helper functions.\r\rYou can find details, documentation and examples on the Matter JS website: https://brm.io/matter-js/", "kind": "class", "name": "MatterPhysics", "memberof": "Phaser.Physics.Matter", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Phaser Scene that owns this Matter Physics instance.", "name": "scene" } ], "scope": "static", "longname": "Phaser.Physics.Matter.MatterPhysics", "___id": "T000002R030922", "___s": true }, { "comment": "/**\r\n * The Phaser Scene that owns this Matter Physics instance\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 106, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "The Phaser Scene that owns this Matter Physics instance", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#scene", "scope": "instance", "kind": "member", "___id": "T000002R030925", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Systems that belong to the Scene owning this Matter Physics instance.\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#systems\r\n * @type {Phaser.Scenes.Systems}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 115, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the Scene Systems that belong to the Scene owning this Matter Physics instance.", "name": "systems", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#systems", "scope": "instance", "kind": "member", "___id": "T000002R030927", "___s": true }, { "comment": "/**\r\n * The parsed Matter Configuration object.\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#config\r\n * @type {Phaser.Types.Physics.Matter.MatterWorldConfig}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 124, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "The parsed Matter Configuration object.", "name": "config", "type": { "names": [ "Phaser.Types.Physics.Matter.MatterWorldConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterWorldConfig" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#config", "scope": "instance", "kind": "member", "___id": "T000002R030929", "___s": true }, { "comment": "/**\r\n * An instance of the Matter World class. This class is responsible for the updating of the\r\n * Matter Physics world, as well as handling debug drawing functions.\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#world\r\n * @type {Phaser.Physics.Matter.World}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 133, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "An instance of the Matter World class. This class is responsible for the updating of the\rMatter Physics world, as well as handling debug drawing functions.", "name": "world", "type": { "names": [ "Phaser.Physics.Matter.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.World" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#world", "scope": "instance", "kind": "member", "___id": "T000002R030931", "___s": true }, { "comment": "/**\r\n * An instance of the Matter Factory. This class provides lots of functions for creating a\r\n * wide variety of physics objects and adds them automatically to the Matter World.\r\n *\r\n * You can use this class to cut-down on the amount of code required in your game, however,\r\n * use of the Factory is entirely optional and should be seen as a development aid. It's\r\n * perfectly possible to create and add components to the Matter world without using it.\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#add\r\n * @type {Phaser.Physics.Matter.Factory}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 143, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "An instance of the Matter Factory. This class provides lots of functions for creating a\rwide variety of physics objects and adds them automatically to the Matter World.\r\rYou can use this class to cut-down on the amount of code required in your game, however,\ruse of the Factory is entirely optional and should be seen as a development aid. It's\rperfectly possible to create and add components to the Matter world without using it.", "name": "add", "type": { "names": [ "Phaser.Physics.Matter.Factory" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.Factory" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#add", "scope": "instance", "kind": "member", "___id": "T000002R030933", "___s": true }, { "comment": "/**\r\n * An instance of the Body Bounds class. This class contains functions used for getting the\r\n * world position from various points around the bounds of a physics body.\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#bodyBounds\r\n * @type {Phaser.Physics.Matter.BodyBounds}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 157, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "An instance of the Body Bounds class. This class contains functions used for getting the\rworld position from various points around the bounds of a physics body.", "name": "bodyBounds", "type": { "names": [ "Phaser.Physics.Matter.BodyBounds" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.BodyBounds" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#bodyBounds", "scope": "instance", "kind": "member", "___id": "T000002R030935", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Body` module.\r\n *\r\n * The `Matter.Body` module contains methods for creating and manipulating body models.\r\n * A `Matter.Body` is a rigid body that can be simulated by a `Matter.Engine`.\r\n * Factories for commonly used body configurations (such as rectangles, circles and other polygons) can be found in the `Bodies` module.\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#body\r\n * @type {MatterJS.BodyFactory}\r\n * @since 3.18.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 169, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Body` module.\r\rThe `Matter.Body` module contains methods for creating and manipulating body models.\rA `Matter.Body` is a rigid body that can be simulated by a `Matter.Engine`.\rFactories for commonly used body configurations (such as rectangles, circles and other polygons) can be found in the `Bodies` module.", "name": "body", "type": { "names": [ "MatterJS.BodyFactory" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyFactory" } }, "since": "3.18.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#body", "scope": "instance", "kind": "member", "___id": "T000002R030937", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Composite` module.\r\n *\r\n * The `Matter.Composite` module contains methods for creating and manipulating composite bodies.\r\n * A composite body is a collection of `Matter.Body`, `Matter.Constraint` and other `Matter.Composite`, therefore composites form a tree structure.\r\n * It is important to use the functions in this module to modify composites, rather than directly modifying their properties.\r\n * Note that the `Matter.World` object is also a type of `Matter.Composite` and as such all composite methods here can also operate on a `Matter.World`.\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#composite\r\n * @type {MatterJS.CompositeFactory}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Composite` module.\r\rThe `Matter.Composite` module contains methods for creating and manipulating composite bodies.\rA composite body is a collection of `Matter.Body`, `Matter.Constraint` and other `Matter.Composite`, therefore composites form a tree structure.\rIt is important to use the functions in this module to modify composites, rather than directly modifying their properties.\rNote that the `Matter.World` object is also a type of `Matter.Composite` and as such all composite methods here can also operate on a `Matter.World`.", "name": "composite", "type": { "names": [ "MatterJS.CompositeFactory" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.CompositeFactory" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#composite", "scope": "instance", "kind": "member", "___id": "T000002R030939", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Collision` module.\r\n *\r\n * The `Matter.Collision` module contains methods for detecting collisions between a given pair of bodies.\r\n *\r\n * For efficient detection between a list of bodies, see `Matter.Detector` and `Matter.Query`.\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#collision\r\n * @type {MatterJS.Collision}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 198, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Collision` module.\r\rThe `Matter.Collision` module contains methods for detecting collisions between a given pair of bodies.\r\rFor efficient detection between a list of bodies, see `Matter.Detector` and `Matter.Query`.", "name": "collision", "type": { "names": [ "MatterJS.Collision" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.Collision" } }, "since": "3.60.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#collision", "scope": "instance", "kind": "member", "___id": "T000002R030941", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Detector` module.\r\n *\r\n * The `Matter.Detector` module contains methods for detecting collisions given a set of pairs.\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#detector\r\n * @type {MatterJS.DetectorFactory}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Detector` module.\r\rThe `Matter.Detector` module contains methods for detecting collisions given a set of pairs.", "name": "detector", "type": { "names": [ "MatterJS.DetectorFactory" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.DetectorFactory" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#detector", "scope": "instance", "kind": "member", "___id": "T000002R030943", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Pair` module.\r\n *\r\n * The `Matter.Pair` module contains methods for creating and manipulating collision pairs.\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#pair\r\n * @type {MatterJS.PairFactory}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 222, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Pair` module.\r\rThe `Matter.Pair` module contains methods for creating and manipulating collision pairs.", "name": "pair", "type": { "names": [ "MatterJS.PairFactory" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.PairFactory" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#pair", "scope": "instance", "kind": "member", "___id": "T000002R030945", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Pairs` module.\r\n *\r\n * The `Matter.Pairs` module contains methods for creating and manipulating collision pair sets.\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#pairs\r\n * @type {MatterJS.PairsFactory}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 233, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Pairs` module.\r\rThe `Matter.Pairs` module contains methods for creating and manipulating collision pair sets.", "name": "pairs", "type": { "names": [ "MatterJS.PairsFactory" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.PairsFactory" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#pairs", "scope": "instance", "kind": "member", "___id": "T000002R030947", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Query` module.\r\n *\r\n * The `Matter.Query` module contains methods for performing collision queries.\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#query\r\n * @type {MatterJS.QueryFactory}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 244, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Query` module.\r\rThe `Matter.Query` module contains methods for performing collision queries.", "name": "query", "type": { "names": [ "MatterJS.QueryFactory" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.QueryFactory" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#query", "scope": "instance", "kind": "member", "___id": "T000002R030949", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Resolver` module.\r\n *\r\n * The `Matter.Resolver` module contains methods for resolving collision pairs.\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#resolver\r\n * @type {MatterJS.ResolverFactory}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 255, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Resolver` module.\r\rThe `Matter.Resolver` module contains methods for resolving collision pairs.", "name": "resolver", "type": { "names": [ "MatterJS.ResolverFactory" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.ResolverFactory" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#resolver", "scope": "instance", "kind": "member", "___id": "T000002R030951", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Constraint` module.\r\n *\r\n * The `Matter.Constraint` module contains methods for creating and manipulating constraints.\r\n * Constraints are used for specifying that a fixed distance must be maintained between two bodies (or a body and a fixed world-space position).\r\n * The stiffness of constraints can be modified to create springs or elastic.\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#constraint\r\n * @type {MatterJS.ConstraintFactory}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 268, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Constraint` module.\r\rThe `Matter.Constraint` module contains methods for creating and manipulating constraints.\rConstraints are used for specifying that a fixed distance must be maintained between two bodies (or a body and a fixed world-space position).\rThe stiffness of constraints can be modified to create springs or elastic.", "name": "constraint", "type": { "names": [ "MatterJS.ConstraintFactory" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.ConstraintFactory" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#constraint", "scope": "instance", "kind": "member", "___id": "T000002R030953", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Bodies` module.\r\n *\r\n * The `Matter.Bodies` module contains factory methods for creating rigid bodies\r\n * with commonly used body configurations (such as rectangles, circles and other polygons).\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#bodies\r\n * @type {MatterJS.BodiesFactory}\r\n * @since 3.18.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 283, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Bodies` module.\r\rThe `Matter.Bodies` module contains factory methods for creating rigid bodies\rwith commonly used body configurations (such as rectangles, circles and other polygons).", "name": "bodies", "type": { "names": [ "MatterJS.BodiesFactory" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodiesFactory" } }, "since": "3.18.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#bodies", "scope": "instance", "kind": "member", "___id": "T000002R030955", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Composites` module.\r\n *\r\n * The `Matter.Composites` module contains factory methods for creating composite bodies\r\n * with commonly used configurations (such as stacks and chains).\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#composites\r\n * @type {MatterJS.CompositesFactory}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 295, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Composites` module.\r\rThe `Matter.Composites` module contains factory methods for creating composite bodies\rwith commonly used configurations (such as stacks and chains).", "name": "composites", "type": { "names": [ "MatterJS.CompositesFactory" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.CompositesFactory" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#composites", "scope": "instance", "kind": "member", "___id": "T000002R030957", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Axes` module.\r\n *\r\n * The `Matter.Axes` module contains methods for creating and manipulating sets of axes.\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#axes\r\n * @type {MatterJS.AxesFactory}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 309, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Axes` module.\r\rThe `Matter.Axes` module contains methods for creating and manipulating sets of axes.", "name": "axes", "type": { "names": [ "MatterJS.AxesFactory" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.AxesFactory" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#axes", "scope": "instance", "kind": "member", "___id": "T000002R030959", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Bounds` module.\r\n *\r\n * The `Matter.Bounds` module contains methods for creating and manipulating axis-aligned bounding boxes (AABB).\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#bounds\r\n * @type {MatterJS.BoundsFactory}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 320, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Bounds` module.\r\rThe `Matter.Bounds` module contains methods for creating and manipulating axis-aligned bounding boxes (AABB).", "name": "bounds", "type": { "names": [ "MatterJS.BoundsFactory" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BoundsFactory" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#bounds", "scope": "instance", "kind": "member", "___id": "T000002R030961", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Svg` module.\r\n *\r\n * The `Matter.Svg` module contains methods for converting SVG images into an array of vector points.\r\n *\r\n * To use this module you also need the SVGPathSeg polyfill: https://github.com/progers/pathseg\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#svg\r\n * @type {MatterJS.SvgFactory}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 331, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Svg` module.\r\rThe `Matter.Svg` module contains methods for converting SVG images into an array of vector points.\r\rTo use this module you also need the SVGPathSeg polyfill: https://github.com/progers/pathseg", "name": "svg", "type": { "names": [ "MatterJS.SvgFactory" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.SvgFactory" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#svg", "scope": "instance", "kind": "member", "___id": "T000002R030963", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Vector` module.\r\n *\r\n * The `Matter.Vector` module contains methods for creating and manipulating vectors.\r\n * Vectors are the basis of all the geometry related operations in the engine.\r\n * A `Matter.Vector` object is of the form `{ x: 0, y: 0 }`.\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#vector\r\n * @type {MatterJS.VectorFactory}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 344, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Vector` module.\r\rThe `Matter.Vector` module contains methods for creating and manipulating vectors.\rVectors are the basis of all the geometry related operations in the engine.\rA `Matter.Vector` object is of the form `{ x: 0, y: 0 }`.", "name": "vector", "type": { "names": [ "MatterJS.VectorFactory" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.VectorFactory" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#vector", "scope": "instance", "kind": "member", "___id": "T000002R030965", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Vertices` module.\r\n *\r\n * The `Matter.Vertices` module contains methods for creating and manipulating sets of vertices.\r\n * A set of vertices is an array of `Matter.Vector` with additional indexing properties inserted by `Vertices.create`.\r\n * A `Matter.Body` maintains a set of vertices to represent the shape of the object (its convex hull).\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#vertices\r\n * @type {MatterJS.VerticesFactory}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 357, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Vertices` module.\r\rThe `Matter.Vertices` module contains methods for creating and manipulating sets of vertices.\rA set of vertices is an array of `Matter.Vector` with additional indexing properties inserted by `Vertices.create`.\rA `Matter.Body` maintains a set of vertices to represent the shape of the object (its convex hull).", "name": "vertices", "type": { "names": [ "MatterJS.VerticesFactory" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.VerticesFactory" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#vertices", "scope": "instance", "kind": "member", "___id": "T000002R030967", "___s": true }, { "comment": "/**\r\n * A reference to the `Matter.Vertices` module.\r\n *\r\n * The `Matter.Vertices` module contains methods for creating and manipulating sets of vertices.\r\n * A set of vertices is an array of `Matter.Vector` with additional indexing properties inserted by `Vertices.create`.\r\n * A `Matter.Body` maintains a set of vertices to represent the shape of the object (its convex hull).\r\n *\r\n * @name Phaser.Physics.Matter.MatterPhysics#verts\r\n * @type {MatterJS.VerticesFactory}\r\n * @since 3.14.0\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 370, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the `Matter.Vertices` module.\r\rThe `Matter.Vertices` module contains methods for creating and manipulating sets of vertices.\rA set of vertices is an array of `Matter.Vector` with additional indexing properties inserted by `Vertices.create`.\rA `Matter.Body` maintains a set of vertices to represent the shape of the object (its convex hull).", "name": "verts", "type": { "names": [ "MatterJS.VerticesFactory" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.VerticesFactory" } }, "since": "3.14.0", "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#verts", "scope": "instance", "kind": "member", "___id": "T000002R030969", "___s": true }, { "comment": "/**\r\n * This internal method is called when this class starts and retrieves the final Matter World Config.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#getConfig\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.Physics.Matter.MatterWorldConfig} The Matter World Config.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 461, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "This internal method is called when this class starts and retrieves the final Matter World Config.", "kind": "function", "name": "getConfig", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterWorldConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterWorldConfig" } }, "description": "The Matter World Config." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#getConfig", "scope": "instance", "___id": "T000002R030988", "___s": true }, { "comment": "/**\r\n * Enables the Matter Attractors Plugin.\r\n *\r\n * The attractors plugin that makes it easy to apply continual forces on bodies.\r\n * It's possible to simulate effects such as wind, gravity and magnetism.\r\n *\r\n * https://github.com/liabru/matter-attractors\r\n *\r\n * This method is called automatically if `plugins.attractors` is set in the Matter World Config.\r\n * However, you can also call it directly from within your game.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#enableAttractorPlugin\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 482, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Enables the Matter Attractors Plugin.\r\rThe attractors plugin that makes it easy to apply continual forces on bodies.\rIt's possible to simulate effects such as wind, gravity and magnetism.\r\rhttps://github.com/liabru/matter-attractors\r\rThis method is called automatically if `plugins.attractors` is set in the Matter World Config.\rHowever, you can also call it directly from within your game.", "kind": "function", "name": "enableAttractorPlugin", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter Physics instance." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#enableAttractorPlugin", "scope": "instance", "___id": "T000002R030993", "___s": true }, { "comment": "/**\r\n * Enables the Matter Wrap Plugin.\r\n *\r\n * The coordinate wrapping plugin that automatically wraps the position of bodies such that they always stay\r\n * within the given bounds. Upon crossing a boundary the body will appear on the opposite side of the bounds,\r\n * while maintaining its velocity.\r\n *\r\n * https://github.com/liabru/matter-wrap\r\n *\r\n * This method is called automatically if `plugins.wrap` is set in the Matter World Config.\r\n * However, you can also call it directly from within your game.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#enableWrapPlugin\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 506, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Enables the Matter Wrap Plugin.\r\rThe coordinate wrapping plugin that automatically wraps the position of bodies such that they always stay\rwithin the given bounds. Upon crossing a boundary the body will appear on the opposite side of the bounds,\rwhile maintaining its velocity.\r\rhttps://github.com/liabru/matter-wrap\r\rThis method is called automatically if `plugins.wrap` is set in the Matter World Config.\rHowever, you can also call it directly from within your game.", "kind": "function", "name": "enableWrapPlugin", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter Physics instance." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#enableWrapPlugin", "scope": "instance", "___id": "T000002R030995", "___s": true }, { "comment": "/**\r\n * Enables the Matter Collision Events Plugin.\r\n *\r\n * Note that this plugin is enabled by default. So you should only ever need to call this\r\n * method if you have specifically disabled the plugin in your Matter World Config.\r\n * You can disable it by setting `plugins.collisionevents: false` in your Matter World Config.\r\n *\r\n * This plugin triggers three new events on Matter.Body:\r\n *\r\n * 1. `onCollide`\r\n * 2. `onCollideEnd`\r\n * 3. `onCollideActive`\r\n *\r\n * These events correspond to the Matter.js events `collisionStart`, `collisionActive` and `collisionEnd`, respectively.\r\n * You can listen to these events via Matter.Events or they will also be emitted from the Matter World.\r\n *\r\n * This plugin also extends Matter.Body with three convenience functions:\r\n *\r\n * `Matter.Body.setOnCollide(callback)`\r\n * `Matter.Body.setOnCollideEnd(callback)`\r\n * `Matter.Body.setOnCollideActive(callback)`\r\n *\r\n * You can register event callbacks by providing a function of type (pair: Matter.Pair) => void\r\n *\r\n * https://github.com/dxu/matter-collision-events\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#enableCollisionEventsPlugin\r\n * @since 3.22.0\r\n *\r\n * @return {this} This Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 531, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Enables the Matter Collision Events Plugin.\r\rNote that this plugin is enabled by default. So you should only ever need to call this\rmethod if you have specifically disabled the plugin in your Matter World Config.\rYou can disable it by setting `plugins.collisionevents: false` in your Matter World Config.\r\rThis plugin triggers three new events on Matter.Body:\r\r1. `onCollide`\r2. `onCollideEnd`\r3. `onCollideActive`\r\rThese events correspond to the Matter.js events `collisionStart`, `collisionActive` and `collisionEnd`, respectively.\rYou can listen to these events via Matter.Events or they will also be emitted from the Matter World.\r\rThis plugin also extends Matter.Body with three convenience functions:\r\r`Matter.Body.setOnCollide(callback)`\r`Matter.Body.setOnCollideEnd(callback)`\r`Matter.Body.setOnCollideActive(callback)`\r\rYou can register event callbacks by providing a function of type (pair: Matter.Pair) => void\r\rhttps://github.com/dxu/matter-collision-events", "kind": "function", "name": "enableCollisionEventsPlugin", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter Physics instance." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#enableCollisionEventsPlugin", "scope": "instance", "___id": "T000002R030997", "___s": true }, { "comment": "/**\r\n * Pauses the Matter World instance and sets `enabled` to `false`.\r\n *\r\n * A paused world will not run any simulations for the duration it is paused.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#pause\r\n * @fires Phaser.Physics.Matter.Events#PAUSE\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Physics.Matter.World} The Matter World object.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 570, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Pauses the Matter World instance and sets `enabled` to `false`.\r\rA paused world will not run any simulations for the duration it is paused.", "kind": "function", "name": "pause", "fires": [ "Phaser.Physics.Matter.Events#event:PAUSE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Physics.Matter.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.World" } }, "description": "The Matter World object." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#pause", "scope": "instance", "___id": "T000002R030999", "___s": true }, { "comment": "/**\r\n * Resumes this Matter World instance from a paused state and sets `enabled` to `true`.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#resume\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Physics.Matter.World} The Matter World object.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 586, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Resumes this Matter World instance from a paused state and sets `enabled` to `true`.", "kind": "function", "name": "resume", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Physics.Matter.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.World" } }, "description": "The Matter World object." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#resume", "scope": "instance", "___id": "T000002R031001", "___s": true }, { "comment": "/**\r\n * Sets the Matter Engine to run at fixed timestep of 60Hz and enables `autoUpdate`.\r\n * If you have set a custom `getDelta` function then this will override it.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#set60Hz\r\n * @since 3.4.0\r\n *\r\n * @return {this} This Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets the Matter Engine to run at fixed timestep of 60Hz and enables `autoUpdate`.\rIf you have set a custom `getDelta` function then this will override it.", "kind": "function", "name": "set60Hz", "since": "3.4.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter Physics instance." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#set60Hz", "scope": "instance", "___id": "T000002R031003", "___s": true }, { "comment": "/**\r\n * Sets the Matter Engine to run at fixed timestep of 30Hz and enables `autoUpdate`.\r\n * If you have set a custom `getDelta` function then this will override it.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#set30Hz\r\n * @since 3.4.0\r\n *\r\n * @return {this} This Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 616, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets the Matter Engine to run at fixed timestep of 30Hz and enables `autoUpdate`.\rIf you have set a custom `getDelta` function then this will override it.", "kind": "function", "name": "set30Hz", "since": "3.4.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter Physics instance." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#set30Hz", "scope": "instance", "___id": "T000002R031007", "___s": true }, { "comment": "/**\r\n * Manually advances the physics simulation by one iteration.\r\n *\r\n * You can optionally pass in the `delta` and `correction` values to be used by Engine.update.\r\n * If undefined they use the Matter defaults of 60Hz and no correction.\r\n *\r\n * Calling `step` directly bypasses any checks of `enabled` or `autoUpdate`.\r\n *\r\n * It also ignores any custom `getDelta` functions, as you should be passing the delta\r\n * value in to this call.\r\n *\r\n * You can adjust the number of iterations that Engine.update performs internally.\r\n * Use the Scene Matter Physics config object to set the following properties:\r\n *\r\n * positionIterations (defaults to 6)\r\n * velocityIterations (defaults to 4)\r\n * constraintIterations (defaults to 2)\r\n *\r\n * Adjusting these values can help performance in certain situations, depending on the physics requirements\r\n * of your game.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#step\r\n * @since 3.4.0\r\n *\r\n * @param {number} [delta=16.666] - The delta value.\r\n * @param {number} [correction=1] - Optional delta correction value.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 633, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Manually advances the physics simulation by one iteration.\r\rYou can optionally pass in the `delta` and `correction` values to be used by Engine.update.\rIf undefined they use the Matter defaults of 60Hz and no correction.\r\rCalling `step` directly bypasses any checks of `enabled` or `autoUpdate`.\r\rIt also ignores any custom `getDelta` functions, as you should be passing the delta\rvalue in to this call.\r\rYou can adjust the number of iterations that Engine.update performs internally.\rUse the Scene Matter Physics config object to set the following properties:\r\rpositionIterations (defaults to 6)\rvelocityIterations (defaults to 4)\rconstraintIterations (defaults to 2)\r\rAdjusting these values can help performance in certain situations, depending on the physics requirements\rof your game.", "kind": "function", "name": "step", "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 16.666, "description": "The delta value.", "name": "delta" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Optional delta correction value.", "name": "correction" } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#step", "scope": "instance", "___id": "T000002R031011", "___s": true }, { "comment": "/**\r\n * Checks if the vertices of the given body, or an array of bodies, contains the given point, or not.\r\n *\r\n * You can pass in either a single body, or an array of bodies to be checked. This method will\r\n * return `true` if _any_ of the bodies in the array contain the point. See the `intersectPoint` method if you need\r\n * to get a list of intersecting bodies.\r\n *\r\n * The point should be transformed into the Matter World coordinate system in advance. This happens by\r\n * default with Input Pointers, but if you wish to use points from another system you may need to\r\n * transform them before passing them.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#containsPoint\r\n * @since 3.22.0\r\n *\r\n * @param {(Phaser.Types.Physics.Matter.MatterBody|Phaser.Types.Physics.Matter.MatterBody[])} body - The body, or an array of bodies, to check against the point.\r\n * @param {number} x - The horizontal coordinate of the point.\r\n * @param {number} y - The vertical coordinate of the point.\r\n *\r\n * @return {boolean} `true` if the point is within one of the bodies given, otherwise `false`.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 665, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Checks if the vertices of the given body, or an array of bodies, contains the given point, or not.\r\rYou can pass in either a single body, or an array of bodies to be checked. This method will\rreturn `true` if _any_ of the bodies in the array contain the point. See the `intersectPoint` method if you need\rto get a list of intersecting bodies.\r\rThe point should be transformed into the Matter World coordinate system in advance. This happens by\rdefault with Input Pointers, but if you wish to use points from another system you may need to\rtransform them before passing them.", "kind": "function", "name": "containsPoint", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } ] } }, "description": "The body, or an array of bodies, to check against the point.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate of the point.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate of the point.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the point is within one of the bodies given, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#containsPoint", "scope": "instance", "___id": "T000002R031013", "___s": true }, { "comment": "/**\r\n * Checks the given coordinates to see if any vertices of the given bodies contain it.\r\n *\r\n * If no bodies are provided it will search all bodies in the Matter World, including within Composites.\r\n *\r\n * The coordinates should be transformed into the Matter World coordinate system in advance. This happens by\r\n * default with Input Pointers, but if you wish to use coordinates from another system you may need to\r\n * transform them before passing them.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#intersectPoint\r\n * @since 3.22.0\r\n *\r\n * @param {number} x - The horizontal coordinate of the point.\r\n * @param {number} y - The vertical coordinate of the point.\r\n * @param {Phaser.Types.Physics.Matter.MatterBody[]} [bodies] - An array of bodies to check. If not provided it will search all bodies in the world.\r\n *\r\n * @return {Phaser.Types.Physics.Matter.MatterBody[]} An array of bodies which contain the given point.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 696, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Checks the given coordinates to see if any vertices of the given bodies contain it.\r\rIf no bodies are provided it will search all bodies in the Matter World, including within Composites.\r\rThe coordinates should be transformed into the Matter World coordinate system in advance. This happens by\rdefault with Input Pointers, but if you wish to use coordinates from another system you may need to\rtransform them before passing them.", "kind": "function", "name": "intersectPoint", "since": "3.22.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate of the point.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate of the point.", "name": "y" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of bodies to check. If not provided it will search all bodies in the world.", "name": "bodies" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } }, "description": "An array of bodies which contain the given point." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#intersectPoint", "scope": "instance", "___id": "T000002R031018", "___s": true }, { "comment": "/**\r\n * Checks the given rectangular area to see if any vertices of the given bodies intersect with it.\r\n * Or, if the `outside` parameter is set to `true`, it checks to see which bodies do not\r\n * intersect with it.\r\n *\r\n * If no bodies are provided it will search all bodies in the Matter World, including within Composites.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#intersectRect\r\n * @since 3.22.0\r\n *\r\n * @param {number} x - The horizontal coordinate of the top-left of the area.\r\n * @param {number} y - The vertical coordinate of the top-left of the area.\r\n * @param {number} width - The width of the area.\r\n * @param {number} height - The height of the area.\r\n * @param {boolean} [outside=false] - If `false` it checks for vertices inside the area, if `true` it checks for vertices outside the area.\r\n * @param {Phaser.Types.Physics.Matter.MatterBody[]} [bodies] - An array of bodies to check. If not provided it will search all bodies in the world.\r\n *\r\n * @return {Phaser.Types.Physics.Matter.MatterBody[]} An array of bodies that intersect with the given area.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 735, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Checks the given rectangular area to see if any vertices of the given bodies intersect with it.\rOr, if the `outside` parameter is set to `true`, it checks to see which bodies do not\rintersect with it.\r\rIf no bodies are provided it will search all bodies in the Matter World, including within Composites.", "kind": "function", "name": "intersectRect", "since": "3.22.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate of the top-left of the area.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate of the top-left of the area.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the area.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the area.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `false` it checks for vertices inside the area, if `true` it checks for vertices outside the area.", "name": "outside" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of bodies to check. If not provided it will search all bodies in the world.", "name": "bodies" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } }, "description": "An array of bodies that intersect with the given area." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#intersectRect", "scope": "instance", "___id": "T000002R031024", "___s": true }, { "comment": "/**\r\n * Checks the given ray segment to see if any vertices of the given bodies intersect with it.\r\n *\r\n * If no bodies are provided it will search all bodies in the Matter World.\r\n *\r\n * The width of the ray can be specified via the `rayWidth` parameter.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#intersectRay\r\n * @since 3.22.0\r\n *\r\n * @param {number} x1 - The horizontal coordinate of the start of the ray segment.\r\n * @param {number} y1 - The vertical coordinate of the start of the ray segment.\r\n * @param {number} x2 - The horizontal coordinate of the end of the ray segment.\r\n * @param {number} y2 - The vertical coordinate of the end of the ray segment.\r\n * @param {number} [rayWidth=1] - The width of the ray segment.\r\n * @param {Phaser.Types.Physics.Matter.MatterBody[]} [bodies] - An array of bodies to check. If not provided it will search all bodies in the world.\r\n *\r\n * @return {Phaser.Types.Physics.Matter.MatterBody[]} An array of bodies whos vertices intersect with the ray segment.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 780, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Checks the given ray segment to see if any vertices of the given bodies intersect with it.\r\rIf no bodies are provided it will search all bodies in the Matter World.\r\rThe width of the ray can be specified via the `rayWidth` parameter.", "kind": "function", "name": "intersectRay", "since": "3.22.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate of the start of the ray segment.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate of the start of the ray segment.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate of the end of the ray segment.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate of the end of the ray segment.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The width of the ray segment.", "name": "rayWidth" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of bodies to check. If not provided it will search all bodies in the world.", "name": "bodies" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } }, "description": "An array of bodies whos vertices intersect with the ray segment." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#intersectRay", "scope": "instance", "___id": "T000002R031037", "___s": true }, { "comment": "/**\r\n * Checks the given Matter Body to see if it intersects with any of the given bodies.\r\n *\r\n * If no bodies are provided it will check against all bodies in the Matter World.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#intersectBody\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBody} body - The target body.\r\n * @param {Phaser.Types.Physics.Matter.MatterBody[]} [bodies] - An array of bodies to check the target body against. If not provided it will search all bodies in the world.\r\n *\r\n * @return {Phaser.Types.Physics.Matter.MatterBody[]} An array of bodies whos vertices intersect with target body.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 816, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Checks the given Matter Body to see if it intersects with any of the given bodies.\r\rIf no bodies are provided it will check against all bodies in the Matter World.", "kind": "function", "name": "intersectBody", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" } }, "description": "The target body.", "name": "body" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of bodies to check the target body against. If not provided it will search all bodies in the world.", "name": "bodies" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } }, "description": "An array of bodies whos vertices intersect with target body." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#intersectBody", "scope": "instance", "___id": "T000002R031044", "___s": true }, { "comment": "/**\r\n * Checks to see if the target body, or an array of target bodies, intersects with any of the given bodies.\r\n *\r\n * If intersection occurs this method will return `true` and, if provided, invoke the callbacks.\r\n *\r\n * If no bodies are provided for the second parameter the target will check against all bodies in the Matter World.\r\n *\r\n * **Note that bodies can only overlap if they are in non-colliding collision groups or categories.**\r\n *\r\n * If you provide a `processCallback` then the two bodies that overlap are sent to it. This callback\r\n * must return a boolean and is used to allow you to perform additional processing tests before a final\r\n * outcome is decided. If it returns `true` then the bodies are finally passed to the `overlapCallback`, if set.\r\n *\r\n * If you provide an `overlapCallback` then the matching pairs of overlapping bodies will be sent to it.\r\n *\r\n * Both callbacks have the following signature: `function (bodyA, bodyB, collisionInfo)` where `bodyA` is always\r\n * the target body. The `collisionInfo` object contains additional data, such as the angle and depth of penetration.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#overlap\r\n * @since 3.22.0\r\n *\r\n * @param {(Phaser.Types.Physics.Matter.MatterBody|Phaser.Types.Physics.Matter.MatterBody[])} target - The target body, or array of target bodies, to check.\r\n * @param {Phaser.Types.Physics.Matter.MatterBody[]} [bodies] - The second body, or array of bodies, to check. If falsey it will check against all bodies in the world.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [overlapCallback] - An optional callback function that is called if the bodies overlap.\r\n * @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} [processCallback] - An optional callback function that lets you perform additional checks against the two bodies if they overlap. If this is set then `overlapCallback` will only be invoked if this callback returns `true`.\r\n * @param {*} [callbackContext] - The context, or scope, in which to run the callbacks.\r\n *\r\n * @return {boolean} `true` if the target body intersects with _any_ of the bodies given, otherwise `false`.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 853, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Checks to see if the target body, or an array of target bodies, intersects with any of the given bodies.\r\rIf intersection occurs this method will return `true` and, if provided, invoke the callbacks.\r\rIf no bodies are provided for the second parameter the target will check against all bodies in the Matter World.\r\r**Note that bodies can only overlap if they are in non-colliding collision groups or categories.**\r\rIf you provide a `processCallback` then the two bodies that overlap are sent to it. This callback\rmust return a boolean and is used to allow you to perform additional processing tests before a final\routcome is decided. If it returns `true` then the bodies are finally passed to the `overlapCallback`, if set.\r\rIf you provide an `overlapCallback` then the matching pairs of overlapping bodies will be sent to it.\r\rBoth callbacks have the following signature: `function (bodyA, bodyB, collisionInfo)` where `bodyA` is always\rthe target body. The `collisionInfo` object contains additional data, such as the angle and depth of penetration.", "kind": "function", "name": "overlap", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } ] } }, "description": "The target body, or array of target bodies, to check.", "name": "target" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } }, "optional": true, "description": "The second body, or array of bodies, to check. If falsey it will check against all bodies in the world.", "name": "bodies" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that is called if the bodies overlap.", "name": "overlapCallback" }, { "type": { "names": [ "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadePhysicsCallback" } }, "optional": true, "description": "An optional callback function that lets you perform additional checks against the two bodies if they overlap. If this is set then `overlapCallback` will only be invoked if this callback returns `true`.", "name": "processCallback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The context, or scope, in which to run the callbacks.", "name": "callbackContext" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the target body intersects with _any_ of the bodies given, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#overlap", "scope": "instance", "___id": "T000002R031051", "___s": true }, { "comment": "/**\r\n * Sets the collision filter category of all given Matter Bodies to the given value.\r\n *\r\n * This number must be a power of two between 2^0 (= 1) and 2^31.\r\n *\r\n * Bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\r\n * categories are included in their collision masks (see {@link #setCollidesWith}).\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#setCollisionCategory\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBody[]} bodies - An array of bodies to update. If falsey it will use all bodies in the world.\r\n * @param {number} value - Unique category bitfield.\r\n *\r\n * @return {this} This Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 929, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets the collision filter category of all given Matter Bodies to the given value.\r\rThis number must be a power of two between 2^0 (= 1) and 2^31.\r\rBodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\rcategories are included in their collision masks (see {@link #setCollidesWith}).", "kind": "function", "name": "setCollisionCategory", "since": "3.22.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } }, "description": "An array of bodies to update. If falsey it will use all bodies in the world.", "name": "bodies" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Unique category bitfield.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter Physics instance." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#setCollisionCategory", "scope": "instance", "___id": "T000002R031067", "___s": true }, { "comment": "/**\r\n * Sets the collision filter group of all given Matter Bodies to the given value.\r\n *\r\n * If the group value is zero, or if two Matter Bodies have different group values,\r\n * they will collide according to the usual collision filter rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\r\n *\r\n * If two Matter Bodies have the same positive group value, they will always collide;\r\n * if they have the same negative group value they will never collide.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#setCollisionGroup\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBody[]} bodies - An array of bodies to update. If falsey it will use all bodies in the world.\r\n * @param {number} value - Unique group index.\r\n *\r\n * @return {this} This Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 957, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets the collision filter group of all given Matter Bodies to the given value.\r\rIf the group value is zero, or if two Matter Bodies have different group values,\rthey will collide according to the usual collision filter rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\r\rIf two Matter Bodies have the same positive group value, they will always collide;\rif they have the same negative group value they will never collide.", "kind": "function", "name": "setCollisionGroup", "since": "3.22.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } }, "description": "An array of bodies to update. If falsey it will use all bodies in the world.", "name": "bodies" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Unique group index.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter Physics instance." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#setCollisionGroup", "scope": "instance", "___id": "T000002R031071", "___s": true }, { "comment": "/**\r\n * Sets the collision filter mask of all given Matter Bodies to the given value.\r\n *\r\n * Two Matter Bodies with different collision groups will only collide if each one includes the others\r\n * category in its mask based on a bitwise AND operation: `(categoryA & maskB) !== 0` and\r\n * `(categoryB & maskA) !== 0` are both true.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#setCollidesWith\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBody[]} bodies - An array of bodies to update. If falsey it will use all bodies in the world.\r\n * @param {(number|number[])} categories - A unique category bitfield, or an array of them.\r\n *\r\n * @return {this} This Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 986, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets the collision filter mask of all given Matter Bodies to the given value.\r\rTwo Matter Bodies with different collision groups will only collide if each one includes the others\rcategory in its mask based on a bitwise AND operation: `(categoryA & maskB) !== 0` and\r`(categoryB & maskA) !== 0` are both true.", "kind": "function", "name": "setCollidesWith", "since": "3.22.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } }, "description": "An array of bodies to update. If falsey it will use all bodies in the world.", "name": "bodies" }, { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "description": "A unique category bitfield, or an array of them.", "name": "categories" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter Physics instance." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#setCollidesWith", "scope": "instance", "___id": "T000002R031075", "___s": true }, { "comment": "/**\r\n * Takes an array and returns a new array made from all of the Matter Bodies found in the original array.\r\n *\r\n * For example, passing in Matter Game Objects, such as a bunch of Matter Sprites, to this method, would\r\n * return an array containing all of their native Matter Body objects.\r\n *\r\n * If the `bodies` argument is falsey, it will return all bodies in the world.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#getMatterBodies\r\n * @since 3.22.0\r\n *\r\n * @param {array} [bodies] - An array of objects to extract the bodies from. If falsey, it will return all bodies in the world.\r\n *\r\n * @return {MatterJS.BodyType[]} An array of native Matter Body objects.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 1027, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Takes an array and returns a new array made from all of the Matter Bodies found in the original array.\r\rFor example, passing in Matter Game Objects, such as a bunch of Matter Sprites, to this method, would\rreturn an array containing all of their native Matter Body objects.\r\rIf the `bodies` argument is falsey, it will return all bodies in the world.", "kind": "function", "name": "getMatterBodies", "since": "3.22.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "An array of objects to extract the bodies from. If falsey, it will return all bodies in the world.", "name": "bodies" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.BodyType", "type": "NameExpression" } ] } }, "description": "An array of native Matter Body objects." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#getMatterBodies", "scope": "instance", "___id": "T000002R031083", "___s": true }, { "comment": "/**\r\n * Sets both the horizontal and vertical linear velocity of the physics bodies.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#setVelocity\r\n * @since 3.22.0\r\n *\r\n * @param {(Phaser.Types.Physics.Matter.MatterBody|Phaser.Types.Physics.Matter.MatterBody[])} bodies - Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.\r\n * @param {number} x - The horizontal linear velocity value.\r\n * @param {number} y - The vertical linear velocity value.\r\n *\r\n * @return {this} This Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 1066, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets both the horizontal and vertical linear velocity of the physics bodies.", "kind": "function", "name": "setVelocity", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } ] } }, "description": "Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.", "name": "bodies" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal linear velocity value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical linear velocity value.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter Physics instance." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#setVelocity", "scope": "instance", "___id": "T000002R031089", "___s": true }, { "comment": "/**\r\n * Sets just the horizontal linear velocity of the physics bodies.\r\n * The vertical velocity of the body is unchanged.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#setVelocityX\r\n * @since 3.22.0\r\n *\r\n * @param {(Phaser.Types.Physics.Matter.MatterBody|Phaser.Types.Physics.Matter.MatterBody[])} bodies - Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.\r\n * @param {number} x - The horizontal linear velocity value.\r\n *\r\n * @return {this} This Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 1095, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets just the horizontal linear velocity of the physics bodies.\rThe vertical velocity of the body is unchanged.", "kind": "function", "name": "setVelocityX", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } ] } }, "description": "Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.", "name": "bodies" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal linear velocity value.", "name": "x" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter Physics instance." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#setVelocityX", "scope": "instance", "___id": "T000002R031095", "___s": true }, { "comment": "/**\r\n * Sets just the vertical linear velocity of the physics bodies.\r\n * The horizontal velocity of the body is unchanged.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#setVelocityY\r\n * @since 3.22.0\r\n *\r\n * @param {(Phaser.Types.Physics.Matter.MatterBody|Phaser.Types.Physics.Matter.MatterBody[])} bodies - Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.\r\n * @param {number} y - The vertical linear velocity value.\r\n *\r\n * @return {this} This Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 1124, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets just the vertical linear velocity of the physics bodies.\rThe horizontal velocity of the body is unchanged.", "kind": "function", "name": "setVelocityY", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } ] } }, "description": "Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.", "name": "bodies" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical linear velocity value.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter Physics instance." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#setVelocityY", "scope": "instance", "___id": "T000002R031101", "___s": true }, { "comment": "/**\r\n * Sets the angular velocity of the bodies instantly.\r\n * Position, angle, force etc. are unchanged.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#setAngularVelocity\r\n * @since 3.22.0\r\n *\r\n * @param {(Phaser.Types.Physics.Matter.MatterBody|Phaser.Types.Physics.Matter.MatterBody[])} bodies - Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.\r\n * @param {number} value - The angular velocity.\r\n *\r\n * @return {this} This Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 1153, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets the angular velocity of the bodies instantly.\rPosition, angle, force etc. are unchanged.", "kind": "function", "name": "setAngularVelocity", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } ] } }, "description": "Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.", "name": "bodies" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angular velocity.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter Physics instance." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#setAngularVelocity", "scope": "instance", "___id": "T000002R031107", "___s": true }, { "comment": "/**\r\n * Applies a force to a body, at the bodies current position, including resulting torque.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#applyForce\r\n * @since 3.22.0\r\n *\r\n * @param {(Phaser.Types.Physics.Matter.MatterBody|Phaser.Types.Physics.Matter.MatterBody[])} bodies - Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.\r\n * @param {Phaser.Types.Math.Vector2Like} force - A Vector that specifies the force to apply.\r\n *\r\n * @return {this} This Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 1177, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Applies a force to a body, at the bodies current position, including resulting torque.", "kind": "function", "name": "applyForce", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } ] } }, "description": "Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.", "name": "bodies" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "A Vector that specifies the force to apply.", "name": "force" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter Physics instance." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#applyForce", "scope": "instance", "___id": "T000002R031110", "___s": true }, { "comment": "/**\r\n * Applies a force to a body, from the given world position, including resulting torque.\r\n * If no angle is given, the current body angle is used.\r\n *\r\n * Use very small speed values, such as 0.1, depending on the mass and required velocity.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#applyForceFromPosition\r\n * @since 3.22.0\r\n *\r\n * @param {(Phaser.Types.Physics.Matter.MatterBody|Phaser.Types.Physics.Matter.MatterBody[])} bodies - Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.\r\n * @param {Phaser.Types.Math.Vector2Like} position - A Vector that specifies the world-space position to apply the force at.\r\n * @param {number} speed - A speed value to be applied to a directional force.\r\n * @param {number} [angle] - The angle, in radians, to apply the force from. Leave undefined to use the current body angle.\r\n *\r\n * @return {this} This Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 1205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Applies a force to a body, from the given world position, including resulting torque.\rIf no angle is given, the current body angle is used.\r\rUse very small speed values, such as 0.1, depending on the mass and required velocity.", "kind": "function", "name": "applyForceFromPosition", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } ] } }, "description": "Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.", "name": "bodies" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "A Vector that specifies the world-space position to apply the force at.", "name": "position" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A speed value to be applied to a directional force.", "name": "speed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The angle, in radians, to apply the force from. Leave undefined to use the current body angle.", "name": "angle" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter Physics instance." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#applyForceFromPosition", "scope": "instance", "___id": "T000002R031116", "___s": true }, { "comment": "/**\r\n * Apply a force to a body based on the given angle and speed.\r\n * If no angle is given, the current body angle is used.\r\n *\r\n * Use very small speed values, such as 0.1, depending on the mass and required velocity.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#applyForceFromAngle\r\n * @since 3.22.0\r\n *\r\n * @param {(Phaser.Types.Physics.Matter.MatterBody|Phaser.Types.Physics.Matter.MatterBody[])} bodies - Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.\r\n * @param {number} speed - A speed value to be applied to a directional force.\r\n * @param {number} [angle] - The angle, in radians, to apply the force from. Leave undefined to use the current body angle.\r\n *\r\n * @return {this} This Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 1243, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Apply a force to a body based on the given angle and speed.\rIf no angle is given, the current body angle is used.\r\rUse very small speed values, such as 0.1, depending on the mass and required velocity.", "kind": "function", "name": "applyForceFromAngle", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Physics.Matter.MatterBody", "type": "NameExpression" } ] } ] } }, "description": "Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.", "name": "bodies" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A speed value to be applied to a directional force.", "name": "speed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The angle, in radians, to apply the force from. Leave undefined to use the current body angle.", "name": "angle" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter Physics instance." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#applyForceFromAngle", "scope": "instance", "___id": "T000002R031123", "___s": true }, { "comment": "/**\r\n * Returns the length of the given constraint, which is the distance between the two points.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#getConstraintLength\r\n * @since 3.22.0\r\n *\r\n * @param {MatterJS.ConstraintType} constraint - The constraint to get the length from.\r\n *\r\n * @return {number} The length of the constraint.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 1280, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Returns the length of the given constraint, which is the distance between the two points.", "kind": "function", "name": "getConstraintLength", "since": "3.22.0", "params": [ { "type": { "names": [ "MatterJS.ConstraintType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.ConstraintType" } }, "description": "The constraint to get the length from.", "name": "constraint" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length of the constraint." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#getConstraintLength", "scope": "instance", "___id": "T000002R031132", "___s": true }, { "comment": "/**\r\n * Aligns a Body, or Matter Game Object, against the given coordinates.\r\n *\r\n * The alignment takes place using the body bounds, which take into consideration things\r\n * like body scale and rotation.\r\n *\r\n * Although a Body has a `position` property, it is based on the center of mass for the body,\r\n * not a dimension based center. This makes aligning bodies difficult, especially if they have\r\n * rotated or scaled. This method will derive the correct position based on the body bounds and\r\n * its center of mass offset, in order to align the body with the given coordinate.\r\n *\r\n * For example, if you wanted to align a body so it sat in the bottom-center of the\r\n * Scene, and the world was 800 x 600 in size:\r\n *\r\n * ```javascript\r\n * this.matter.alignBody(body, 400, 600, Phaser.Display.Align.BOTTOM_CENTER);\r\n * ```\r\n *\r\n * You pass in 400 for the x coordinate, because that is the center of the world, and 600 for\r\n * the y coordinate, as that is the base of the world.\r\n *\r\n * @method Phaser.Physics.Matter.MatterPhysics#alignBody\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBody} body - The Body to align.\r\n * @param {number} x - The horizontal position to align the body to.\r\n * @param {number} y - The vertical position to align the body to.\r\n * @param {number} align - One of the `Phaser.Display.Align` constants, such as `Phaser.Display.Align.TOP_LEFT`.\r\n *\r\n * @return {this} This Matter Physics instance.\r\n */", "meta": { "filename": "MatterPhysics.js", "lineno": 1312, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Aligns a Body, or Matter Game Object, against the given coordinates.\r\rThe alignment takes place using the body bounds, which take into consideration things\rlike body scale and rotation.\r\rAlthough a Body has a `position` property, it is based on the center of mass for the body,\rnot a dimension based center. This makes aligning bodies difficult, especially if they have\rrotated or scaled. This method will derive the correct position based on the body bounds and\rits center of mass offset, in order to align the body with the given coordinate.\r\rFor example, if you wanted to align a body so it sat in the bottom-center of the\rScene, and the world was 800 x 600 in size:\r\r```javascript\rthis.matter.alignBody(body, 400, 600, Phaser.Display.Align.BOTTOM_CENTER);\r```\r\rYou pass in 400 for the x coordinate, because that is the center of the world, and 600 for\rthe y coordinate, as that is the base of the world.", "kind": "function", "name": "alignBody", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBody" } }, "description": "The Body to align.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position to align the body to.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position to align the body to.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "One of the `Phaser.Display.Align` constants, such as `Phaser.Display.Align.TOP_LEFT`.", "name": "align" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter Physics instance." } ], "memberof": "Phaser.Physics.Matter.MatterPhysics", "longname": "Phaser.Physics.Matter.MatterPhysics#alignBody", "scope": "instance", "___id": "T000002R031142", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Matter Physics 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.Sprite\r\n * @memberof Phaser.Physics.Matter\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.Physics.Matter.Components.Bounce\r\n * @extends Phaser.Physics.Matter.Components.Collision\r\n * @extends Phaser.Physics.Matter.Components.Force\r\n * @extends Phaser.Physics.Matter.Components.Friction\r\n * @extends Phaser.Physics.Matter.Components.Gravity\r\n * @extends Phaser.Physics.Matter.Components.Mass\r\n * @extends Phaser.Physics.Matter.Components.Sensor\r\n * @extends Phaser.Physics.Matter.Components.SetBody\r\n * @extends Phaser.Physics.Matter.Components.Sleep\r\n * @extends Phaser.Physics.Matter.Components.Static\r\n * @extends Phaser.Physics.Matter.Components.Transform\r\n * @extends Phaser.Physics.Matter.Components.Velocity\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.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\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.Physics.Matter.World} world - A reference to the Matter.World instance that this body belongs 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 * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n */", "meta": { "filename": "MatterSprite.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "classdesc": "A Matter Physics 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.Sprite", "Phaser.Physics.Matter.Components.Bounce", "Phaser.Physics.Matter.Components.Collision", "Phaser.Physics.Matter.Components.Force", "Phaser.Physics.Matter.Components.Friction", "Phaser.Physics.Matter.Components.Gravity", "Phaser.Physics.Matter.Components.Mass", "Phaser.Physics.Matter.Components.Sensor", "Phaser.Physics.Matter.Components.SetBody", "Phaser.Physics.Matter.Components.Sleep", "Phaser.Physics.Matter.Components.Static", "Phaser.Physics.Matter.Components.Transform", "Phaser.Physics.Matter.Components.Velocity", "Phaser.GameObjects.Components.Alpha", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.Flip", "Phaser.GameObjects.Components.GetBounds", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "Phaser.GameObjects.Components.ScrollFactor", "Phaser.GameObjects.Components.Size", "Phaser.GameObjects.Components.Texture", "Phaser.GameObjects.Components.Tint", "Phaser.GameObjects.Components.Transform", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.Physics.Matter", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Matter.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.World" } }, "description": "A reference to the Matter.World instance that this body belongs to.", "name": "world" }, { "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": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "scope": "static", "longname": "Phaser.Physics.Matter.Sprite", "___id": "T000002R031173", "___s": true }, { "comment": "/**\r\n * A reference to the Matter.World instance that this body belongs to.\r\n *\r\n * @name Phaser.Physics.Matter.Sprite#world\r\n * @type {Phaser.Physics.Matter.World}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MatterSprite.js", "lineno": 111, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the Matter.World instance that this body belongs to.", "name": "world", "type": { "names": [ "Phaser.Physics.Matter.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.World" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "longname": "Phaser.Physics.Matter.Sprite#world", "scope": "instance", "kind": "member", "___id": "T000002R031181", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A wrapper around a Tile that provides access to a corresponding Matter body. A tile can only\r\n * have one Matter body associated with it. You can either pass in an existing Matter body for\r\n * the tile or allow the constructor to create the corresponding body for you. If the Tile has a\r\n * collision group (defined in Tiled), those shapes will be used to create the body. If not, the\r\n * tile's rectangle bounding box will be used.\r\n *\r\n * The corresponding body will be accessible on the Tile itself via Tile.physics.matterBody.\r\n *\r\n * Note: not all Tiled collision shapes are supported. See\r\n * Phaser.Physics.Matter.TileBody#setFromTileCollision for more information.\r\n *\r\n * @class TileBody\r\n * @memberof Phaser.Physics.Matter\r\n * @extends Phaser.Events.EventEmitter\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.Physics.Matter.Components.Bounce\r\n * @extends Phaser.Physics.Matter.Components.Collision\r\n * @extends Phaser.Physics.Matter.Components.Friction\r\n * @extends Phaser.Physics.Matter.Components.Gravity\r\n * @extends Phaser.Physics.Matter.Components.Mass\r\n * @extends Phaser.Physics.Matter.Components.Sensor\r\n * @extends Phaser.Physics.Matter.Components.Sleep\r\n * @extends Phaser.Physics.Matter.Components.Static\r\n *\r\n * @param {Phaser.Physics.Matter.World} world - The Matter world instance this body belongs to.\r\n * @param {Phaser.Tilemaps.Tile} tile - The target tile that should have a Matter body.\r\n * @param {Phaser.Types.Physics.Matter.MatterTileOptions} [options] - Options to be used when creating the Matter body.\r\n */", "meta": { "filename": "MatterTileBody.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "classdesc": "A wrapper around a Tile that provides access to a corresponding Matter body. A tile can only\rhave one Matter body associated with it. You can either pass in an existing Matter body for\rthe tile or allow the constructor to create the corresponding body for you. If the Tile has a\rcollision group (defined in Tiled), those shapes will be used to create the body. If not, the\rtile's rectangle bounding box will be used.\r\rThe corresponding body will be accessible on the Tile itself via Tile.physics.matterBody.\r\rNote: not all Tiled collision shapes are supported. See\rPhaser.Physics.Matter.TileBody#setFromTileCollision for more information.", "kind": "class", "name": "TileBody", "memberof": "Phaser.Physics.Matter", "augments": [ "Phaser.Events.EventEmitter", "Phaser.Physics.Matter.Components.Bounce", "Phaser.Physics.Matter.Components.Collision", "Phaser.Physics.Matter.Components.Friction", "Phaser.Physics.Matter.Components.Gravity", "Phaser.Physics.Matter.Components.Mass", "Phaser.Physics.Matter.Components.Sensor", "Phaser.Physics.Matter.Components.Sleep", "Phaser.Physics.Matter.Components.Static" ], "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Physics.Matter.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.World" } }, "description": "The Matter world instance this body belongs to.", "name": "world" }, { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The target tile that should have a Matter body.", "name": "tile" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterTileOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterTileOptions" } }, "optional": true, "description": "Options to be used when creating the Matter body.", "name": "options" } ], "scope": "static", "longname": "Phaser.Physics.Matter.TileBody", "___id": "T000002R031196", "___s": true }, { "comment": "/**\r\n * The tile object the body is associated with.\r\n *\r\n * @name Phaser.Physics.Matter.TileBody#tile\r\n * @type {Phaser.Tilemaps.Tile}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MatterTileBody.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "The tile object the body is associated with.", "name": "tile", "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.TileBody", "longname": "Phaser.Physics.Matter.TileBody#tile", "scope": "instance", "kind": "member", "___id": "T000002R031201", "___s": true }, { "comment": "/**\r\n * The Matter world the body exists within.\r\n *\r\n * @name Phaser.Physics.Matter.TileBody#world\r\n * @type {Phaser.Physics.Matter.World}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MatterTileBody.js", "lineno": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "The Matter world the body exists within.", "name": "world", "type": { "names": [ "Phaser.Physics.Matter.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.World" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.TileBody", "longname": "Phaser.Physics.Matter.TileBody#world", "scope": "instance", "kind": "member", "___id": "T000002R031203", "___s": true }, { "comment": "/**\r\n * Sets the current body to a rectangle that matches the bounds of the tile.\r\n *\r\n * @method Phaser.Physics.Matter.TileBody#setFromTileRectangle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyTileOptions} [options] - Options to be used when creating the Matter body. See MatterJS.Body for a list of what Matter accepts.\r\n *\r\n * @return {Phaser.Physics.Matter.TileBody} This TileBody object.\r\n */", "meta": { "filename": "MatterTileBody.js", "lineno": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets the current body to a rectangle that matches the bounds of the tile.", "kind": "function", "name": "setFromTileRectangle", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyTileOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyTileOptions" } }, "optional": true, "description": "Options to be used when creating the Matter body. See MatterJS.Body for a list of what Matter accepts.", "name": "options" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Matter.TileBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.TileBody" } }, "description": "This TileBody object." } ], "memberof": "Phaser.Physics.Matter.TileBody", "longname": "Phaser.Physics.Matter.TileBody#setFromTileRectangle", "scope": "instance", "___id": "T000002R031215", "___s": true }, { "comment": "/**\r\n * Sets the current body from the collision group associated with the Tile. This is typically\r\n * set up in Tiled's collision editor.\r\n *\r\n * Note: Matter doesn't support all shapes from Tiled. Rectangles and polygons are directly\r\n * supported. Ellipses are converted into circle bodies. Polylines are treated as if they are\r\n * closed polygons. If a tile has multiple shapes, a multi-part body will be created. Concave\r\n * shapes are supported if poly-decomp library is included. Decomposition is not guaranteed to\r\n * work for complex shapes (e.g. holes), so it's often best to manually decompose a concave\r\n * polygon into multiple convex polygons yourself.\r\n *\r\n * @method Phaser.Physics.Matter.TileBody#setFromTileCollision\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyTileOptions} [options] - Options to be used when creating the Matter body. See MatterJS.Body for a list of what Matter accepts.\r\n *\r\n * @return {Phaser.Physics.Matter.TileBody} This TileBody object.\r\n */", "meta": { "filename": "MatterTileBody.js", "lineno": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets the current body from the collision group associated with the Tile. This is typically\rset up in Tiled's collision editor.\r\rNote: Matter doesn't support all shapes from Tiled. Rectangles and polygons are directly\rsupported. Ellipses are converted into circle bodies. Polylines are treated as if they are\rclosed polygons. If a tile has multiple shapes, a multi-part body will be created. Concave\rshapes are supported if poly-decomp library is included. Decomposition is not guaranteed to\rwork for complex shapes (e.g. holes), so it's often best to manually decompose a concave\rpolygon into multiple convex polygons yourself.", "kind": "function", "name": "setFromTileCollision", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyTileOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyTileOptions" } }, "optional": true, "description": "Options to be used when creating the Matter body. See MatterJS.Body for a list of what Matter accepts.", "name": "options" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Matter.TileBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.TileBody" } }, "description": "This TileBody object." } ], "memberof": "Phaser.Physics.Matter.TileBody", "longname": "Phaser.Physics.Matter.TileBody#setFromTileCollision", "scope": "instance", "___id": "T000002R031224", "___s": true }, { "comment": "/**\r\n * Sets the current body to the given body. This will remove the previous body, if one already\r\n * exists.\r\n *\r\n * @method Phaser.Physics.Matter.TileBody#setBody\r\n * @since 3.0.0\r\n *\r\n * @param {MatterJS.BodyType} body - The new Matter body to use.\r\n * @param {boolean} [addToWorld=true] - Whether or not to add the body to the Matter world.\r\n *\r\n * @return {Phaser.Physics.Matter.TileBody} This TileBody object.\r\n */", "meta": { "filename": "MatterTileBody.js", "lineno": 258, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets the current body to the given body. This will remove the previous body, if one already\rexists.", "kind": "function", "name": "setBody", "since": "3.0.0", "params": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The new Matter body to use.", "name": "body" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether or not to add the body to the Matter world.", "name": "addToWorld" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Matter.TileBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.TileBody" } }, "description": "This TileBody object." } ], "memberof": "Phaser.Physics.Matter.TileBody", "longname": "Phaser.Physics.Matter.TileBody#setBody", "scope": "instance", "___id": "T000002R031256", "___s": true }, { "comment": "/**\r\n * Removes the current body from the TileBody and from the Matter world\r\n *\r\n * @method Phaser.Physics.Matter.TileBody#removeBody\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Physics.Matter.TileBody} This TileBody object.\r\n */", "meta": { "filename": "MatterTileBody.js", "lineno": 290, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Removes the current body from the TileBody and from the Matter world", "kind": "function", "name": "removeBody", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Physics.Matter.TileBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.TileBody" } }, "description": "This TileBody object." } ], "memberof": "Phaser.Physics.Matter.TileBody", "longname": "Phaser.Physics.Matter.TileBody#removeBody", "scope": "instance", "___id": "T000002R031261", "___s": true }, { "comment": "/**\r\n * Removes the current body from the tile and the world.\r\n *\r\n * @method Phaser.Physics.Matter.TileBody#destroy\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Physics.Matter.TileBody} This TileBody object.\r\n */", "meta": { "filename": "MatterTileBody.js", "lineno": 310, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Removes the current body from the tile and the world.", "kind": "function", "name": "destroy", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Physics.Matter.TileBody" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.TileBody" } }, "description": "This TileBody object." } ], "memberof": "Phaser.Physics.Matter.TileBody", "longname": "Phaser.Physics.Matter.TileBody#destroy", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#destroy", "___id": "T000002R031265", "___s": true }, { "comment": "/**\r\n * Use PhysicsEditorParser.parseBody() to build a Matter body object, based on a physics data file\r\n * created and exported with PhysicsEditor (https://www.codeandweb.com/physicseditor).\r\n *\r\n * @namespace Phaser.Physics.Matter.PhysicsEditorParser\r\n * @since 3.10.0\r\n */", "meta": { "filename": "PhysicsEditorParser.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Use PhysicsEditorParser.parseBody() to build a Matter body object, based on a physics data file\rcreated and exported with PhysicsEditor (https://www.codeandweb.com/physicseditor).", "kind": "namespace", "name": "PhysicsEditorParser", "since": "3.10.0", "memberof": "Phaser.Physics.Matter", "longname": "Phaser.Physics.Matter.PhysicsEditorParser", "scope": "static", "___id": "T000002R031274", "___s": true }, { "comment": "/**\r\n * Parses a body element exported by PhysicsEditor.\r\n *\r\n * @function Phaser.Physics.Matter.PhysicsEditorParser.parseBody\r\n * @since 3.10.0\r\n *\r\n * @param {number} x - The horizontal world location of the body.\r\n * @param {number} y - The vertical world location of the body.\r\n * @param {object} config - The body configuration and fixture (child body) definitions, as exported by PhysicsEditor.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {MatterJS.BodyType} A compound Matter JS Body.\r\n */", "meta": { "filename": "PhysicsEditorParser.js", "lineno": 24, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Parses a body element exported by PhysicsEditor.", "kind": "function", "name": "parseBody", "since": "3.10.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal world location of the body.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical world location of the body.", "name": "y" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The body configuration and fixture (child body) definitions, as exported by PhysicsEditor.", "name": "config" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A compound Matter JS Body." } ], "memberof": "Phaser.Physics.Matter.PhysicsEditorParser", "longname": "Phaser.Physics.Matter.PhysicsEditorParser.parseBody", "scope": "static", "___id": "T000002R031276", "___s": true }, { "comment": "/**\r\n * Parses an element of the \"fixtures\" list exported by PhysicsEditor\r\n *\r\n * @function Phaser.Physics.Matter.PhysicsEditorParser.parseFixture\r\n * @since 3.10.0\r\n *\r\n * @param {object} fixtureConfig - The fixture object to parse.\r\n *\r\n * @return {MatterJS.BodyType[]} - An array of Matter JS Bodies.\r\n */", "meta": { "filename": "PhysicsEditorParser.js", "lineno": 70, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Parses an element of the \"fixtures\" list exported by PhysicsEditor", "kind": "function", "name": "parseFixture", "since": "3.10.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The fixture object to parse.", "name": "fixtureConfig" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.BodyType", "type": "NameExpression" } ] } }, "description": "- An array of Matter JS Bodies." } ], "memberof": "Phaser.Physics.Matter.PhysicsEditorParser", "longname": "Phaser.Physics.Matter.PhysicsEditorParser.parseFixture", "scope": "static", "___id": "T000002R031288", "___s": true }, { "comment": "/**\r\n * Parses the \"vertices\" lists exported by PhysicsEditor.\r\n *\r\n * @function Phaser.Physics.Matter.PhysicsEditorParser.parseVertices\r\n * @since 3.10.0\r\n *\r\n * @param {array} vertexSets - The vertex lists to parse.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {MatterJS.BodyType[]} - An array of Matter JS Bodies.\r\n */", "meta": { "filename": "PhysicsEditorParser.js", "lineno": 104, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Parses the \"vertices\" lists exported by PhysicsEditor.", "kind": "function", "name": "parseVertices", "since": "3.10.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The vertex lists to parse.", "name": "vertexSets" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.BodyType", "type": "NameExpression" } ] } }, "description": "- An array of Matter JS Bodies." } ], "memberof": "Phaser.Physics.Matter.PhysicsEditorParser", "longname": "Phaser.Physics.Matter.PhysicsEditorParser.parseVertices", "scope": "static", "___id": "T000002R031297", "___s": true }, { "comment": "/**\r\n * Creates a body using the supplied physics data, as provided by a JSON file.\r\n *\r\n * The data file should be loaded as JSON:\r\n *\r\n * ```javascript\r\n * preload ()\r\n * {\r\n * this.load.json('ninjas', 'assets/ninjas.json);\r\n * }\r\n *\r\n * create ()\r\n * {\r\n * const ninjaShapes = this.cache.json.get('ninjas');\r\n *\r\n * this.matter.add.fromJSON(400, 300, ninjaShapes.shinobi);\r\n * }\r\n * ```\r\n *\r\n * Do not pass the entire JSON file to this method, but instead pass one of the shapes contained within it.\r\n *\r\n * If you pas in an `options` object, any settings in there will override those in the config object.\r\n *\r\n * The structure of the JSON file is as follows:\r\n *\r\n * ```text\r\n * {\r\n * 'generator_info': // The name of the application that created the JSON data\r\n * 'shapeName': {\r\n * 'type': // The type of body\r\n * 'label': // Optional body label\r\n * 'vertices': // An array, or an array of arrays, containing the vertex data in x/y object pairs\r\n * }\r\n * }\r\n * ```\r\n *\r\n * At the time of writing, only the Phaser Physics Tracer App exports in this format.\r\n *\r\n * @namespace Phaser.Physics.Matter.PhysicsJSONParser\r\n * @since 3.22.0\r\n */", "meta": { "filename": "PhysicsJSONParser.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a body using the supplied physics data, as provided by a JSON file.\r\rThe data file should be loaded as JSON:\r\r```javascript\rpreload ()\r{\r this.load.json('ninjas', 'assets/ninjas.json);\r}\r\rcreate ()\r{\r const ninjaShapes = this.cache.json.get('ninjas');\r\r this.matter.add.fromJSON(400, 300, ninjaShapes.shinobi);\r}\r```\r\rDo not pass the entire JSON file to this method, but instead pass one of the shapes contained within it.\r\rIf you pas in an `options` object, any settings in there will override those in the config object.\r\rThe structure of the JSON file is as follows:\r\r```text\r{\r 'generator_info': // The name of the application that created the JSON data\r 'shapeName': {\r 'type': // The type of body\r 'label': // Optional body label\r 'vertices': // An array, or an array of arrays, containing the vertex data in x/y object pairs\r }\r}\r```\r\rAt the time of writing, only the Phaser Physics Tracer App exports in this format.", "kind": "namespace", "name": "PhysicsJSONParser", "since": "3.22.0", "memberof": "Phaser.Physics.Matter", "longname": "Phaser.Physics.Matter.PhysicsJSONParser", "scope": "static", "___id": "T000002R031307", "___s": true }, { "comment": "/**\r\n * Parses a body element from the given JSON data.\r\n *\r\n * @function Phaser.Physics.Matter.PhysicsJSONParser.parseBody\r\n * @since 3.22.0\r\n *\r\n * @param {number} x - The horizontal world location of the body.\r\n * @param {number} y - The vertical world location of the body.\r\n * @param {object} config - The body configuration data.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {MatterJS.BodyType} A Matter JS Body.\r\n */", "meta": { "filename": "PhysicsJSONParser.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Parses a body element from the given JSON data.", "kind": "function", "name": "parseBody", "since": "3.22.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal world location of the body.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical world location of the body.", "name": "y" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The body configuration data.", "name": "config" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "returns": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A Matter JS Body." } ], "memberof": "Phaser.Physics.Matter.PhysicsJSONParser", "longname": "Phaser.Physics.Matter.PhysicsJSONParser.parseBody", "scope": "static", "___id": "T000002R031309", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Pointer Constraint is a special type of constraint that allows you to click\r\n * and drag bodies in a Matter World. It monitors the active Pointers in a Scene,\r\n * and when one is pressed down it checks to see if that hit any part of any active\r\n * body in the world. If it did, and the body has input enabled, it will begin to\r\n * drag it until either released, or you stop it via the `stopDrag` method.\r\n *\r\n * You can adjust the stiffness, length and other properties of the constraint via\r\n * the `options` object on creation.\r\n *\r\n * @class PointerConstraint\r\n * @memberof Phaser.Physics.Matter\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - A reference to the Scene to which this Pointer Constraint belongs.\r\n * @param {Phaser.Physics.Matter.World} world - A reference to the Matter World instance to which this Constraint belongs.\r\n * @param {object} [options] - A Constraint configuration object.\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "classdesc": "A Pointer Constraint is a special type of constraint that allows you to click\rand drag bodies in a Matter World. It monitors the active Pointers in a Scene,\rand when one is pressed down it checks to see if that hit any part of any active\rbody in the world. If it did, and the body has input enabled, it will begin to\rdrag it until either released, or you stop it via the `stopDrag` method.\r\rYou can adjust the stiffness, length and other properties of the constraint via\rthe `options` object on creation.", "kind": "class", "name": "PointerConstraint", "memberof": "Phaser.Physics.Matter", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "A reference to the Scene to which this Pointer Constraint belongs.", "name": "scene" }, { "type": { "names": [ "Phaser.Physics.Matter.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.World" } }, "description": "A reference to the Matter World instance to which this Constraint belongs.", "name": "world" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "A Constraint configuration object.", "name": "options" } ], "scope": "static", "longname": "Phaser.Physics.Matter.PointerConstraint", "___id": "T000002R031337", "___s": true }, { "comment": "/**\r\n * A reference to the Scene to which this Pointer Constraint belongs.\r\n * This is the same Scene as the Matter World instance.\r\n *\r\n * @name Phaser.Physics.Matter.PointerConstraint#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the Scene to which this Pointer Constraint belongs.\rThis is the same Scene as the Matter World instance.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.PointerConstraint", "longname": "Phaser.Physics.Matter.PointerConstraint#scene", "scope": "instance", "kind": "member", "___id": "T000002R031356", "___s": true }, { "comment": "/**\r\n * A reference to the Matter World instance to which this Constraint belongs.\r\n *\r\n * @name Phaser.Physics.Matter.PointerConstraint#world\r\n * @type {Phaser.Physics.Matter.World}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the Matter World instance to which this Constraint belongs.", "name": "world", "type": { "names": [ "Phaser.Physics.Matter.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.World" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.PointerConstraint", "longname": "Phaser.Physics.Matter.PointerConstraint#world", "scope": "instance", "kind": "member", "___id": "T000002R031358", "___s": true }, { "comment": "/**\r\n * The Camera the Pointer was interacting with when the input\r\n * down event was processed.\r\n *\r\n * @name Phaser.Physics.Matter.PointerConstraint#camera\r\n * @type {Phaser.Cameras.Scene2D.Camera}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 81, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "The Camera the Pointer was interacting with when the input\rdown event was processed.", "name": "camera", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.PointerConstraint", "longname": "Phaser.Physics.Matter.PointerConstraint#camera", "scope": "instance", "kind": "member", "___id": "T000002R031360", "___s": true }, { "comment": "/**\r\n * A reference to the Input Pointer that activated this Constraint.\r\n * This is set in the `onDown` handler.\r\n *\r\n * @name Phaser.Physics.Matter.PointerConstraint#pointer\r\n * @type {Phaser.Input.Pointer}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A reference to the Input Pointer that activated this Constraint.\rThis is set in the `onDown` handler.", "name": "pointer", "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.PointerConstraint", "longname": "Phaser.Physics.Matter.PointerConstraint#pointer", "scope": "instance", "kind": "member", "___id": "T000002R031362", "___s": true }, { "comment": "/**\r\n * Is this Constraint active or not?\r\n *\r\n * An active constraint will be processed each update. An inactive one will be skipped.\r\n * Use this to toggle a Pointer Constraint on and off.\r\n *\r\n * @name Phaser.Physics.Matter.PointerConstraint#active\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Is this Constraint active or not?\r\rAn active constraint will be processed each update. An inactive one will be skipped.\rUse this to toggle a Pointer Constraint on and off.", "name": "active", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.PointerConstraint", "longname": "Phaser.Physics.Matter.PointerConstraint#active", "scope": "instance", "kind": "member", "___id": "T000002R031364", "___s": true }, { "comment": "/**\r\n * The internal transformed position.\r\n *\r\n * @name Phaser.Physics.Matter.PointerConstraint#position\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 115, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "The internal transformed position.", "name": "position", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.PointerConstraint", "longname": "Phaser.Physics.Matter.PointerConstraint#position", "scope": "instance", "kind": "member", "___id": "T000002R031366", "___s": true }, { "comment": "/**\r\n * The body that is currently being dragged, if any.\r\n *\r\n * @name Phaser.Physics.Matter.PointerConstraint#body\r\n * @type {?MatterJS.BodyType}\r\n * @since 3.16.2\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 124, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "The body that is currently being dragged, if any.", "name": "body", "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType", "nullable": true } }, "nullable": true, "since": "3.16.2", "memberof": "Phaser.Physics.Matter.PointerConstraint", "longname": "Phaser.Physics.Matter.PointerConstraint#body", "scope": "instance", "kind": "member", "___id": "T000002R031368", "___s": true }, { "comment": "/**\r\n * The part of the body that was clicked on to start the drag.\r\n *\r\n * @name Phaser.Physics.Matter.PointerConstraint#part\r\n * @type {?MatterJS.BodyType}\r\n * @since 3.16.2\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 133, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "The part of the body that was clicked on to start the drag.", "name": "part", "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType", "nullable": true } }, "nullable": true, "since": "3.16.2", "memberof": "Phaser.Physics.Matter.PointerConstraint", "longname": "Phaser.Physics.Matter.PointerConstraint#part", "scope": "instance", "kind": "member", "___id": "T000002R031370", "___s": true }, { "comment": "/**\r\n * The native Matter Constraint that is used to attach to bodies.\r\n *\r\n * @name Phaser.Physics.Matter.PointerConstraint#constraint\r\n * @type {MatterJS.ConstraintType}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "The native Matter Constraint that is used to attach to bodies.", "name": "constraint", "type": { "names": [ "MatterJS.ConstraintType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.ConstraintType" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.PointerConstraint", "longname": "Phaser.Physics.Matter.PointerConstraint#constraint", "scope": "instance", "kind": "member", "___id": "T000002R031372", "___s": true }, { "comment": "/**\r\n * A Pointer has been pressed down onto the Scene.\r\n *\r\n * If this Constraint doesn't have an active Pointer then a hit test is set to\r\n * run against all active bodies in the world during the _next_ call to `update`.\r\n * If a body is found, it is bound to this constraint and the drag begins.\r\n *\r\n * @method Phaser.Physics.Matter.PointerConstraint#onDown\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - A reference to the Pointer that was pressed.\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 157, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A Pointer has been pressed down onto the Scene.\r\rIf this Constraint doesn't have an active Pointer then a hit test is set to\rrun against all active bodies in the world during the _next_ call to `update`.\rIf a body is found, it is bound to this constraint and the drag begins.", "kind": "function", "name": "onDown", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "A reference to the Pointer that was pressed.", "name": "pointer" } ], "memberof": "Phaser.Physics.Matter.PointerConstraint", "longname": "Phaser.Physics.Matter.PointerConstraint#onDown", "scope": "instance", "___id": "T000002R031374", "___s": true }, { "comment": "/**\r\n * A Pointer has been released from the Scene. If it was the one this constraint was using, it's cleared.\r\n *\r\n * @method Phaser.Physics.Matter.PointerConstraint#onUp\r\n * @since 3.22.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - A reference to the Pointer that was pressed.\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 178, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A Pointer has been released from the Scene. If it was the one this constraint was using, it's cleared.", "kind": "function", "name": "onUp", "since": "3.22.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "A reference to the Pointer that was pressed.", "name": "pointer" } ], "memberof": "Phaser.Physics.Matter.PointerConstraint", "longname": "Phaser.Physics.Matter.PointerConstraint#onUp", "scope": "instance", "___id": "T000002R031378", "___s": true }, { "comment": "/**\r\n * Scans all active bodies in the current Matter World to see if any of them\r\n * are hit by the Pointer. The _first one_ found to hit is set as the active contraint\r\n * body.\r\n *\r\n * @method Phaser.Physics.Matter.PointerConstraint#getBody\r\n * @fires Phaser.Physics.Matter.Events#DRAG_START\r\n * @since 3.16.2\r\n *\r\n * @return {boolean} `true` if a body was found and set, otherwise `false`.\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 194, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Scans all active bodies in the current Matter World to see if any of them\rare hit by the Pointer. The _first one_ found to hit is set as the active contraint\rbody.", "kind": "function", "name": "getBody", "fires": [ "Phaser.Physics.Matter.Events#event:DRAG_START" ], "since": "3.16.2", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if a body was found and set, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.PointerConstraint", "longname": "Phaser.Physics.Matter.PointerConstraint#getBody", "scope": "instance", "___id": "T000002R031381", "___s": true }, { "comment": "/**\r\n * Scans the current body to determine if a part of it was clicked on.\r\n * If a part is found the body is set as the `constraint.bodyB` property,\r\n * as well as the `body` property of this class. The part is also set.\r\n *\r\n * @method Phaser.Physics.Matter.PointerConstraint#hitTestBody\r\n * @since 3.16.2\r\n *\r\n * @param {MatterJS.BodyType} body - The Matter Body to check.\r\n * @param {Phaser.Math.Vector2} position - A translated hit test position.\r\n *\r\n * @return {boolean} `true` if a part of the body was hit, otherwise `false`.\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Scans the current body to determine if a part of it was clicked on.\rIf a part is found the body is set as the `constraint.bodyB` property,\ras well as the `body` property of this class. The part is also set.", "kind": "function", "name": "hitTestBody", "since": "3.16.2", "params": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The Matter Body to check.", "name": "body" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A translated hit test position.", "name": "position" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if a part of the body was hit, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.PointerConstraint", "longname": "Phaser.Physics.Matter.PointerConstraint#hitTestBody", "scope": "instance", "___id": "T000002R031388", "___s": true }, { "comment": "/**\r\n * Internal update handler. Called in the Matter BEFORE_UPDATE step.\r\n *\r\n * @method Phaser.Physics.Matter.PointerConstraint#update\r\n * @fires Phaser.Physics.Matter.Events#DRAG\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 278, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Internal update handler. Called in the Matter BEFORE_UPDATE step.", "kind": "function", "name": "update", "fires": [ "Phaser.Physics.Matter.Events#event:DRAG" ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.PointerConstraint", "longname": "Phaser.Physics.Matter.PointerConstraint#update", "scope": "instance", "___id": "T000002R031403", "___s": true }, { "comment": "/**\r\n * Stops the Pointer Constraint from dragging the body any further.\r\n *\r\n * This is called automatically if the Pointer is released while actively\r\n * dragging a body. Or, you can call it manually to release a body from a\r\n * constraint without having to first release the pointer.\r\n *\r\n * @method Phaser.Physics.Matter.PointerConstraint#stopDrag\r\n * @fires Phaser.Physics.Matter.Events#DRAG_END\r\n * @since 3.16.2\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Stops the Pointer Constraint from dragging the body any further.\r\rThis is called automatically if the Pointer is released while actively\rdragging a body. Or, you can call it manually to release a body from a\rconstraint without having to first release the pointer.", "kind": "function", "name": "stopDrag", "fires": [ "Phaser.Physics.Matter.Events#event:DRAG_END" ], "since": "3.16.2", "memberof": "Phaser.Physics.Matter.PointerConstraint", "longname": "Phaser.Physics.Matter.PointerConstraint#stopDrag", "scope": "instance", "___id": "T000002R031412", "___s": true }, { "comment": "/**\r\n * Destroys this Pointer Constraint instance and all of its references.\r\n *\r\n * @method Phaser.Physics.Matter.PointerConstraint#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PointerConstraint.js", "lineno": 359, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Destroys this Pointer Constraint instance and all of its references.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.PointerConstraint", "longname": "Phaser.Physics.Matter.PointerConstraint#destroy", "scope": "instance", "___id": "T000002R031421", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Physics.Matter\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "kind": "namespace", "name": "Matter", "memberof": "Phaser.Types.Physics", "longname": "Phaser.Types.Physics.Matter", "scope": "static", "___id": "T000002R031428", "___s": true }, { "comment": "/**\r\n * @typedef {(MatterJS.BodyType|Phaser.GameObjects.GameObject|Phaser.Physics.Matter.Image|Phaser.Physics.Matter.Sprite|Phaser.Physics.Matter.TileBody)} Phaser.Types.Physics.Matter.MatterBody\r\n * @since 3.22.0\r\n */", "meta": { "filename": "MatterBody.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "kind": "typedef", "name": "MatterBody", "type": { "names": [ "MatterJS.BodyType", "Phaser.GameObjects.GameObject", "Phaser.Physics.Matter.Image", "Phaser.Physics.Matter.Sprite", "Phaser.Physics.Matter.TileBody" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "MatterJS.BodyType" }, { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Physics.Matter.Image" }, { "type": "NameExpression", "name": "Phaser.Physics.Matter.Sprite" }, { "type": "NameExpression", "name": "Phaser.Physics.Matter.TileBody" } ] } }, "since": "3.22.0", "memberof": "Phaser.Types.Physics.Matter", "longname": "Phaser.Types.Physics.Matter.MatterBody", "scope": "static", "___id": "T000002R031429", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Matter.MatterBodyConfig\r\n * @since 3.22.0\r\n *\r\n * @property {string} [label='Body'] - An arbitrary string-based name to help identify this body.\r\n * @property {(string|Phaser.Types.Physics.Matter.MatterSetBodyConfig)} [shape=null] - Set this Game Object to create and use a new Body based on the configuration object given.\r\n * @property {MatterJS.BodyType[]} [parts] - An array of bodies that make up this body. The first body in the array must always be a self reference to the current body instance. All bodies in the `parts` array together form a single rigid compound body.\r\n * @property {any} [plugin] - An object reserved for storing plugin-specific properties.\r\n * @property {number} [angle=0] - A number specifying the angle of the body, in radians.\r\n * @property {Phaser.Types.Math.Vector2Like[]} [vertices=null] - An array of `Vector` objects that specify the convex hull of the rigid body. These should be provided about the origin `(0, 0)`.\r\n * @property {Phaser.Types.Math.Vector2Like} [position] - A `Vector` that specifies the current world-space position of the body.\r\n * @property {Phaser.Types.Math.Vector2Like} [force] - A `Vector` that specifies the force to apply in the current step. It is zeroed after every `Body.update`. See also `Body.applyForce`.\r\n * @property {number} [torque=0] - A `Number` that specifies the torque (turning force) to apply in the current step. It is zeroed after every `Body.update`.\r\n * @property {boolean} [isSensor=false] - A flag that indicates whether a body is a sensor. Sensor triggers collision events, but doesn't react with colliding body physically.\r\n * @property {boolean} [isStatic=false] - A flag that indicates whether a body is considered static. A static body can never change position or angle and is completely fixed.\r\n * @property {number} [sleepThreshold=60] - A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping by the `Matter.Sleeping` module (if sleeping is enabled by the engine).\r\n * @property {number} [density=0.001] - A `Number` that defines the density of the body, that is its mass per unit area. If you pass the density via `Body.create` the `mass` property is automatically calculated for you based on the size (area) of the object. This is generally preferable to simply setting mass and allows for more intuitive definition of materials (e.g. rock has a higher density than wood).\r\n * @property {number} [restitution=0] - A `Number` that defines the restitution (elasticity) of the body. The value is always positive and is in the range `(0, 1)`.\r\n * @property {number} [friction=0.1] - A `Number` that defines the friction of the body. The value is always positive and is in the range `(0, 1)`. A value of `0` means that the body may slide indefinitely. A value of `1` means the body may come to a stop almost instantly after a force is applied.\r\n * @property {number} [frictionStatic=0.5] - A `Number` that defines the static friction of the body (in the Coulomb friction model). A value of `0` means the body will never 'stick' when it is nearly stationary and only dynamic `friction` is used. The higher the value (e.g. `10`), the more force it will take to initially get the body moving when nearly stationary. This value is multiplied with the `friction` property to make it easier to change `friction` and maintain an appropriate amount of static friction.\r\n * @property {number} [frictionAir=0.01] - A `Number` that defines the air friction of the body (air resistance). A value of `0` means the body will never slow as it moves through space. The higher the value, the faster a body slows when moving through space.\r\n * @property {Phaser.Types.Physics.Matter.MatterCollisionFilter} [collisionFilter] - An `Object` that specifies the collision filtering properties of this body.\r\n * @property {number} [slop=0.05] - A `Number` that specifies a tolerance on how far a body is allowed to 'sink' or rotate into other bodies. Avoid changing this value unless you understand the purpose of `slop` in physics engines. The default should generally suffice, although very large bodies may require larger values for stable stacking.\r\n * @property {number} [timeScale=1] - A `Number` that allows per-body time scaling, e.g. a force-field where bodies inside are in slow-motion, while others are at full speed.\r\n * @property {(number|number[]|Phaser.Types.Physics.Matter.MatterChamferConfig)} [chamfer=null] - A number, or array of numbers, to chamfer the vertices of the body, or a full Chamfer configuration object.\r\n * @property {number} [circleRadius=0] - The radius of this body if a circle.\r\n * @property {number} [mass=0] - A `Number` that defines the mass of the body, although it may be more appropriate to specify the `density` property instead. If you modify this value, you must also modify the `body.inverseMass` property (`1 / mass`).\r\n * @property {number} [inverseMass=0] - A `Number` that defines the inverse mass of the body (`1 / mass`). If you modify this value, you must also modify the `body.mass` property.\r\n * @property {Phaser.Types.Math.Vector2Like} [scale] - A `Vector` that specifies the initial scale of the body.\r\n * @property {Phaser.Types.Math.Vector2Like} [gravityScale] - A `Vector` that scales the influence of World gravity when applied to this body.\r\n * @property {boolean} [ignoreGravity=false] - A boolean that toggles if this body should ignore world gravity or not.\r\n * @property {boolean} [ignorePointer=false] - A boolean that toggles if this body should ignore pointer / mouse constraints or not.\r\n * @property {Phaser.Types.Physics.Matter.MatterBodyRenderConfig} [render] - The Debug Render configuration object for this body.\r\n * @property {function} [onCollideCallback] - A callback that is invoked when this Body starts colliding with any other Body. You can register callbacks by providing a function of type `( pair: Matter.Pair) => void`.\r\n * @property {function} [onCollideEndCallback] - A callback that is invoked when this Body stops colliding with any other Body. You can register callbacks by providing a function of type `( pair: Matter.Pair) => void`.\r\n * @property {function} [onCollideActiveCallback] - A callback that is invoked for the duration that this Body is colliding with any other Body. You can register callbacks by providing a function of type `( pair: Matter.Pair) => void`.\r\n * @property {any} [onCollideWith] - A collision callback dictionary used by the `Body.setOnCollideWith` function.\r\n */", "meta": { "filename": "MatterBodyConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "kind": "typedef", "name": "MatterBodyConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.22.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'Body'", "description": "An arbitrary string-based name to help identify this body.", "name": "label" }, { "type": { "names": [ "string", "Phaser.Types.Physics.Matter.MatterSetBodyConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterSetBodyConfig" } ] } }, "optional": true, "defaultvalue": null, "description": "Set this Game Object to create and use a new Body based on the configuration object given.", "name": "shape" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.BodyType", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of bodies that make up this body. The first body in the array must always be a self reference to the current body instance. All bodies in the `parts` array together form a single rigid compound body.", "name": "parts" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "An object reserved for storing plugin-specific properties.", "name": "plugin" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "A number specifying the angle of the body, in radians.", "name": "angle" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": null, "description": "An array of `Vector` objects that specify the convex hull of the rigid body. These should be provided about the origin `(0, 0)`.", "name": "vertices" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "A `Vector` that specifies the current world-space position of the body.", "name": "position" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "A `Vector` that specifies the force to apply in the current step. It is zeroed after every `Body.update`. See also `Body.applyForce`.", "name": "force" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "A `Number` that specifies the torque (turning force) to apply in the current step. It is zeroed after every `Body.update`.", "name": "torque" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "A flag that indicates whether a body is a sensor. Sensor triggers collision events, but doesn't react with colliding body physically.", "name": "isSensor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "A flag that indicates whether a body is considered static. A static body can never change position or angle and is completely fixed.", "name": "isStatic" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 60, "description": "A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping by the `Matter.Sleeping` module (if sleeping is enabled by the engine).", "name": "sleepThreshold" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.001, "description": "A `Number` that defines the density of the body, that is its mass per unit area. If you pass the density via `Body.create` the `mass` property is automatically calculated for you based on the size (area) of the object. This is generally preferable to simply setting mass and allows for more intuitive definition of materials (e.g. rock has a higher density than wood).", "name": "density" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "A `Number` that defines the restitution (elasticity) of the body. The value is always positive and is in the range `(0, 1)`.", "name": "restitution" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.1, "description": "A `Number` that defines the friction of the body. The value is always positive and is in the range `(0, 1)`. A value of `0` means that the body may slide indefinitely. A value of `1` means the body may come to a stop almost instantly after a force is applied.", "name": "friction" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "A `Number` that defines the static friction of the body (in the Coulomb friction model). A value of `0` means the body will never 'stick' when it is nearly stationary and only dynamic `friction` is used. The higher the value (e.g. `10`), the more force it will take to initially get the body moving when nearly stationary. This value is multiplied with the `friction` property to make it easier to change `friction` and maintain an appropriate amount of static friction.", "name": "frictionStatic" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.01, "description": "A `Number` that defines the air friction of the body (air resistance). A value of `0` means the body will never slow as it moves through space. The higher the value, the faster a body slows when moving through space.", "name": "frictionAir" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterCollisionFilter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterCollisionFilter" } }, "optional": true, "description": "An `Object` that specifies the collision filtering properties of this body.", "name": "collisionFilter" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.05, "description": "A `Number` that specifies a tolerance on how far a body is allowed to 'sink' or rotate into other bodies. Avoid changing this value unless you understand the purpose of `slop` in physics engines. The default should generally suffice, although very large bodies may require larger values for stable stacking.", "name": "slop" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "A `Number` that allows per-body time scaling, e.g. a force-field where bodies inside are in slow-motion, while others are at full speed.", "name": "timeScale" }, { "type": { "names": [ "number", "Array.", "Phaser.Types.Physics.Matter.MatterChamferConfig" ], "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.Physics.Matter.MatterChamferConfig" } ] } }, "optional": true, "defaultvalue": null, "description": "A number, or array of numbers, to chamfer the vertices of the body, or a full Chamfer configuration object.", "name": "chamfer" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The radius of this body if a circle.", "name": "circleRadius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "A `Number` that defines the mass of the body, although it may be more appropriate to specify the `density` property instead. If you modify this value, you must also modify the `body.inverseMass` property (`1 / mass`).", "name": "mass" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "A `Number` that defines the inverse mass of the body (`1 / mass`). If you modify this value, you must also modify the `body.mass` property.", "name": "inverseMass" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "A `Vector` that specifies the initial scale of the body.", "name": "scale" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "A `Vector` that scales the influence of World gravity when applied to this body.", "name": "gravityScale" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "A boolean that toggles if this body should ignore world gravity or not.", "name": "ignoreGravity" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "A boolean that toggles if this body should ignore pointer / mouse constraints or not.", "name": "ignorePointer" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyRenderConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyRenderConfig" } }, "optional": true, "description": "The Debug Render configuration object for this body.", "name": "render" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "A callback that is invoked when this Body starts colliding with any other Body. You can register callbacks by providing a function of type `( pair: Matter.Pair) => void`.", "name": "onCollideCallback" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "A callback that is invoked when this Body stops colliding with any other Body. You can register callbacks by providing a function of type `( pair: Matter.Pair) => void`.", "name": "onCollideEndCallback" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "A callback that is invoked for the duration that this Body is colliding with any other Body. You can register callbacks by providing a function of type `( pair: Matter.Pair) => void`.", "name": "onCollideActiveCallback" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "A collision callback dictionary used by the `Body.setOnCollideWith` function.", "name": "onCollideWith" } ], "memberof": "Phaser.Types.Physics.Matter", "longname": "Phaser.Types.Physics.Matter.MatterBodyConfig", "scope": "static", "___id": "T000002R031430", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Matter.MatterBodyRenderConfig\r\n * @since 3.22.0\r\n * \r\n * @property {boolean} [visible=true] - Should this body be rendered by the Debug Renderer?\r\n * @property {number} [opacity=1] - The opacity of the body and all parts within it.\r\n * @property {number} [fillColor] - The color value of the fill when rendering this body.\r\n * @property {number} [fillOpacity] - The opacity of the fill when rendering this body, a value between 0 and 1.\r\n * @property {number} [lineColor] - The color value of the line stroke when rendering this body.\r\n * @property {number} [lineOpacity] - The opacity of the line when rendering this body, a value between 0 and 1.\r\n * @property {number} [lineThickness] - If rendering lines, the thickness of the line.\r\n * @property {object} [sprite] - Controls the offset between the body and the parent Game Object, if it has one.\r\n * @property {number} [sprite.xOffset=0] - The horizontal offset between the body and the parent Game Object texture, if it has one.\r\n * @property {number} [sprite.yOffset=0] - The vertical offset between the body and the parent Game Object texture, if it has one.\r\n */", "meta": { "filename": "MatterBodyRenderConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "kind": "typedef", "name": "MatterBodyRenderConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.22.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should this body be rendered by the Debug Renderer?", "name": "visible" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The opacity of the body and all parts within it.", "name": "opacity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color value of the fill when rendering this body.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The opacity of the fill when rendering this body, a value between 0 and 1.", "name": "fillOpacity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color value of the line stroke when rendering this body.", "name": "lineColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The opacity of the line when rendering this body, a value between 0 and 1.", "name": "lineOpacity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If rendering lines, the thickness of the line.", "name": "lineThickness" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Controls the offset between the body and the parent Game Object, if it has one.", "name": "sprite" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal offset between the body and the parent Game Object texture, if it has one.", "name": "sprite.xOffset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical offset between the body and the parent Game Object texture, if it has one.", "name": "sprite.yOffset" } ], "memberof": "Phaser.Types.Physics.Matter", "longname": "Phaser.Types.Physics.Matter.MatterBodyRenderConfig", "scope": "static", "___id": "T000002R031431", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Matter.MatterBodyTileOptions\r\n * @since 3.0.0\r\n * \r\n * @property {boolean} [isStatic=true] - Whether or not the newly created body should be made static. This defaults to true since typically tiles should not be moved.\r\n * @property {boolean} [addToWorld=true] - Whether or not to add the newly created body (or existing body if options.body is used) to the Matter world.\r\n */", "meta": { "filename": "MatterBodyTileOptions.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "kind": "typedef", "name": "MatterBodyTileOptions", "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": "Whether or not the newly created body should be made static. This defaults to true since typically tiles should not be moved.", "name": "isStatic" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether or not to add the newly created body (or existing body if options.body is used) to the Matter world.", "name": "addToWorld" } ], "memberof": "Phaser.Types.Physics.Matter", "longname": "Phaser.Types.Physics.Matter.MatterBodyTileOptions", "scope": "static", "___id": "T000002R031432", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Matter.MatterChamferConfig\r\n * @since 3.22.0\r\n * \r\n * @property {(number|number[])} [radius=8] - A single number, or an array, to specify the radius for each vertex.\r\n * @property {number} [quality=-1] - The quality of the chamfering. -1 means 'auto'.\r\n * @property {number} [qualityMin=2] - The minimum quality of the chamfering. The higher this value, the more vertices are created.\r\n * @property {number} [qualityMax=14] - The maximum quality of the chamfering. The higher this value, the more vertices are created.\r\n */", "meta": { "filename": "MatterChamferConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "kind": "typedef", "name": "MatterChamferConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.22.0", "properties": [ { "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": 8, "description": "A single number, or an array, to specify the radius for each vertex.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": -1, "description": "The quality of the chamfering. -1 means 'auto'.", "name": "quality" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "The minimum quality of the chamfering. The higher this value, the more vertices are created.", "name": "qualityMin" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 14, "description": "The maximum quality of the chamfering. The higher this value, the more vertices are created.", "name": "qualityMax" } ], "memberof": "Phaser.Types.Physics.Matter", "longname": "Phaser.Types.Physics.Matter.MatterChamferConfig", "scope": "static", "___id": "T000002R031433", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Matter.MatterCollisionData\r\n * @since 3.22.0\r\n * \r\n * @property {boolean} collided - Have the pair collided or not?\r\n * @property {MatterJS.BodyType} bodyA - A reference to the first body involved in the collision.\r\n * @property {MatterJS.BodyType} bodyB - A reference to the second body involved in the collision.\r\n * @property {MatterJS.BodyType} axisBody - A reference to the dominant axis body.\r\n * @property {number} axisNumber - The index of the dominant collision axis vector (edge normal)\r\n * @property {number} depth - The depth of the collision on the minimum overlap.\r\n * @property {MatterJS.BodyType} parentA - A reference to the parent of Body A, or to Body A itself if it has no parent.\r\n * @property {MatterJS.BodyType} parentB - A reference to the parent of Body B, or to Body B itself if it has no parent.\r\n * @property {MatterJS.Vector} normal - The collision normal, facing away from Body A.\r\n * @property {MatterJS.Vector} tangent - The tangent of the collision normal.\r\n * @property {MatterJS.Vector} penetration - The penetration distances between the two bodies.\r\n * @property {MatterJS.Vector[]} supports - An array of support points, either exactly one or two points.\r\n * @property {number} inverseMass - The resulting inverse mass from the collision.\r\n * @property {number} friction - The resulting friction from the collision.\r\n * @property {number} frictionStatic - The resulting static friction from the collision.\r\n * @property {number} restitution - The resulting restitution from the collision.\r\n * @property {number} slop - The resulting slop from the collision.\r\n */", "meta": { "filename": "MatterCollisionData.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "kind": "typedef", "name": "MatterCollisionData", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.22.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Have the pair collided or not?", "name": "collided" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A reference to the first body involved in the collision.", "name": "bodyA" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A reference to the second body involved in the collision.", "name": "bodyB" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A reference to the dominant axis body.", "name": "axisBody" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the dominant collision axis vector (edge normal)", "name": "axisNumber" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The depth of the collision on the minimum overlap.", "name": "depth" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A reference to the parent of Body A, or to Body A itself if it has no parent.", "name": "parentA" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A reference to the parent of Body B, or to Body B itself if it has no parent.", "name": "parentB" }, { "type": { "names": [ "MatterJS.Vector" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.Vector" } }, "description": "The collision normal, facing away from Body A.", "name": "normal" }, { "type": { "names": [ "MatterJS.Vector" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.Vector" } }, "description": "The tangent of the collision normal.", "name": "tangent" }, { "type": { "names": [ "MatterJS.Vector" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.Vector" } }, "description": "The penetration distances between the two bodies.", "name": "penetration" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.Vector", "type": "NameExpression" } ] } }, "description": "An array of support points, either exactly one or two points.", "name": "supports" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resulting inverse mass from the collision.", "name": "inverseMass" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resulting friction from the collision.", "name": "friction" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resulting static friction from the collision.", "name": "frictionStatic" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resulting restitution from the collision.", "name": "restitution" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resulting slop from the collision.", "name": "slop" } ], "memberof": "Phaser.Types.Physics.Matter", "longname": "Phaser.Types.Physics.Matter.MatterCollisionData", "scope": "static", "___id": "T000002R031434", "___s": true }, { "comment": "/**\r\n * An `Object` that specifies the collision filtering properties of this body.\r\n *\r\n * Collisions between two bodies will obey the following rules:\r\n * - If the two bodies have the same non-zero value of `collisionFilter.group`,\r\n * they will always collide if the value is positive, and they will never collide\r\n * if the value is negative.\r\n * - If the two bodies have different values of `collisionFilter.group` or if one\r\n * (or both) of the bodies has a value of 0, then the category/mask rules apply as follows:\r\n *\r\n * Each body belongs to a collision category, given by `collisionFilter.category`. This\r\n * value is used as a bit field and the category should have only one bit set, meaning that\r\n * the value of this property is a power of two in the range [1, 2^31]. Thus, there are 32\r\n * different collision categories available.\r\n *\r\n * Each body also defines a collision bitmask, given by `collisionFilter.mask` which specifies\r\n * the categories it collides with (the value is the bitwise AND value of all these categories).\r\n *\r\n * Using the category/mask rules, two bodies `A` and `B` collide if each includes the other's\r\n * category in its mask, i.e. `(categoryA & maskB) !== 0` and `(categoryB & maskA) !== 0`\r\n * are both true.\r\n * \r\n * @typedef {object} Phaser.Types.Physics.Matter.MatterCollisionFilter\r\n * @since 3.22.0\r\n * \r\n * @property {number} [category=0x0001] - A bit field that specifies the collision category this body belongs to. The category value should have only one bit set, for example `0x0001`. This means there are up to 32 unique collision categories available.\r\n * @property {number} [mask=0xFFFFFFFF] - A bit mask that specifies the collision categories this body may collide with.\r\n * @property {number} [group=0] - An Integer `Number`, that specifies the collision group this body belongs to.\r\n */", "meta": { "filename": "MatterCollisionFilter.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "description": "An `Object` that specifies the collision filtering properties of this body.\r\rCollisions between two bodies will obey the following rules:\r- If the two bodies have the same non-zero value of `collisionFilter.group`,\r they will always collide if the value is positive, and they will never collide\r if the value is negative.\r- If the two bodies have different values of `collisionFilter.group` or if one\r (or both) of the bodies has a value of 0, then the category/mask rules apply as follows:\r\rEach body belongs to a collision category, given by `collisionFilter.category`. This\rvalue is used as a bit field and the category should have only one bit set, meaning that\rthe value of this property is a power of two in the range [1, 2^31]. Thus, there are 32\rdifferent collision categories available.\r\rEach body also defines a collision bitmask, given by `collisionFilter.mask` which specifies\rthe categories it collides with (the value is the bitwise AND value of all these categories).\r\rUsing the category/mask rules, two bodies `A` and `B` collide if each includes the other's\rcategory in its mask, i.e. `(categoryA & maskB) !== 0` and `(categoryB & maskA) !== 0`\rare both true.", "kind": "typedef", "name": "MatterCollisionFilter", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.22.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x0001", "description": "A bit field that specifies the collision category this body belongs to. The category value should have only one bit set, for example `0x0001`. This means there are up to 32 unique collision categories available.", "name": "category" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xFFFFFFFF", "description": "A bit mask that specifies the collision categories this body may collide with.", "name": "mask" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An Integer `Number`, that specifies the collision group this body belongs to.", "name": "group" } ], "memberof": "Phaser.Types.Physics.Matter", "longname": "Phaser.Types.Physics.Matter.MatterCollisionFilter", "scope": "static", "___id": "T000002R031435", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Matter.MatterCollisionPair\r\n * @since 3.22.0\r\n * \r\n * @property {string} id - The unique auto-generated collision pair id. A combination of the body A and B IDs.\r\n * @property {MatterJS.BodyType} bodyA - A reference to the first body involved in the collision.\r\n * @property {MatterJS.BodyType} bodyB - A reference to the second body involved in the collision.\r\n * @property {MatterJS.Vector[]} activeContacts - An array containing all of the active contacts between bodies A and B.\r\n * @property {number} separation - The amount of separation that occurred between bodies A and B.\r\n * @property {boolean} isActive - Is the collision still active or not?\r\n * @property {boolean} confirmedActive - Has Matter determined the collision are being active yet?\r\n * @property {boolean} isSensor - Is either body A or B a sensor?\r\n * @property {number} timeCreated - The timestamp when the collision pair was created.\r\n * @property {number} timeUpdated - The timestamp when the collision pair was most recently updated.\r\n * @property {Phaser.Types.Physics.Matter.MatterCollisionData} collision - The collision data object.\r\n * @property {number} inverseMass - The resulting inverse mass from the collision.\r\n * @property {number} friction - The resulting friction from the collision.\r\n * @property {number} frictionStatic - The resulting static friction from the collision.\r\n * @property {number} restitution - The resulting restitution from the collision.\r\n * @property {number} slop - The resulting slop from the collision.\r\n */", "meta": { "filename": "MatterCollisionPair.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "kind": "typedef", "name": "MatterCollisionPair", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.22.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique auto-generated collision pair id. A combination of the body A and B IDs.", "name": "id" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A reference to the first body involved in the collision.", "name": "bodyA" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "A reference to the second body involved in the collision.", "name": "bodyB" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.Vector", "type": "NameExpression" } ] } }, "description": "An array containing all of the active contacts between bodies A and B.", "name": "activeContacts" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of separation that occurred between bodies A and B.", "name": "separation" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is the collision still active or not?", "name": "isActive" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Has Matter determined the collision are being active yet?", "name": "confirmedActive" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is either body A or B a sensor?", "name": "isSensor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The timestamp when the collision pair was created.", "name": "timeCreated" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The timestamp when the collision pair was most recently updated.", "name": "timeUpdated" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterCollisionData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterCollisionData" } }, "description": "The collision data object.", "name": "collision" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resulting inverse mass from the collision.", "name": "inverseMass" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resulting friction from the collision.", "name": "friction" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resulting static friction from the collision.", "name": "frictionStatic" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resulting restitution from the collision.", "name": "restitution" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resulting slop from the collision.", "name": "slop" } ], "memberof": "Phaser.Types.Physics.Matter", "longname": "Phaser.Types.Physics.Matter.MatterCollisionPair", "scope": "static", "___id": "T000002R031436", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Matter.MatterConstraintConfig\r\n * @since 3.22.0\r\n * \r\n * @property {string} [label='Constraint'] - An arbitrary string-based name to help identify this constraint.\r\n * @property {MatterJS.BodyType} [bodyA] - The first possible `Body` that this constraint is attached to.\r\n * @property {MatterJS.BodyType} [bodyB] - The second possible `Body` that this constraint is attached to.\r\n * @property {Phaser.Types.Math.Vector2Like} [pointA] - A `Vector` that specifies the offset of the constraint from center of the `constraint.bodyA` if defined, otherwise a world-space position.\r\n * @property {Phaser.Types.Math.Vector2Like} [pointB] - A `Vector` that specifies the offset of the constraint from center of the `constraint.bodyB` if defined, otherwise a world-space position.\r\n * @property {number} [stiffness=1] - A `Number` that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts like a soft spring.\r\n * @property {number} [angularStiffness=0] - A `Number` that specifies the angular stiffness of the constraint.\r\n * @property {number} [angleA=0] - The angleA of the constraint. If bodyA is set, the angle of bodyA is used instead.\r\n * @property {number} [angleB=0] - The angleB of the constraint. If bodyB is set, the angle of bodyB is used instead.\r\n * @property {number} [damping=0] - A `Number` that specifies the damping of the constraint, i.e. the amount of resistance applied to each body based on their velocities to limit the amount of oscillation. Damping will only be apparent when the constraint also has a very low `stiffness`. A value of `0.1` means the constraint will apply heavy damping, resulting in little to no oscillation. A value of `0` means the constraint will apply no damping.\r\n * @property {number} [length] - A `Number` that specifies the target resting length of the constraint. It is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.\r\n * @property {any} [plugin] - An object reserved for storing plugin-specific properties.\r\n * @property {Phaser.Types.Physics.Matter.MatterConstraintRenderConfig} [render] - The Debug Render configuration object for this constraint.\r\n */", "meta": { "filename": "MatterConstraintConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "kind": "typedef", "name": "MatterConstraintConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.22.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'Constraint'", "description": "An arbitrary string-based name to help identify this constraint.", "name": "label" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "optional": true, "description": "The first possible `Body` that this constraint is attached to.", "name": "bodyA" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "optional": true, "description": "The second possible `Body` that this constraint is attached to.", "name": "bodyB" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "A `Vector` that specifies the offset of the constraint from center of the `constraint.bodyA` if defined, otherwise a world-space position.", "name": "pointA" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "A `Vector` that specifies the offset of the constraint from center of the `constraint.bodyB` if defined, otherwise a world-space position.", "name": "pointB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "A `Number` that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts like a soft spring.", "name": "stiffness" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "A `Number` that specifies the angular stiffness of the constraint.", "name": "angularStiffness" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The angleA of the constraint. If bodyA is set, the angle of bodyA is used instead.", "name": "angleA" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The angleB of the constraint. If bodyB is set, the angle of bodyB is used instead.", "name": "angleB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "A `Number` that specifies the damping of the constraint, i.e. the amount of resistance applied to each body based on their velocities to limit the amount of oscillation. Damping will only be apparent when the constraint also has a very low `stiffness`. A value of `0.1` means the constraint will apply heavy damping, resulting in little to no oscillation. A value of `0` means the constraint will apply no damping.", "name": "damping" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "A `Number` that specifies the target resting length of the constraint. It is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.", "name": "length" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "An object reserved for storing plugin-specific properties.", "name": "plugin" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterConstraintRenderConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterConstraintRenderConfig" } }, "optional": true, "description": "The Debug Render configuration object for this constraint.", "name": "render" } ], "memberof": "Phaser.Types.Physics.Matter", "longname": "Phaser.Types.Physics.Matter.MatterConstraintConfig", "scope": "static", "___id": "T000002R031437", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Matter.MatterConstraintRenderConfig\r\n * @since 3.22.0\r\n * \r\n * @property {boolean} [visible=true] - Should this constraint be rendered by the Debug Renderer?\r\n * @property {boolean} [anchors=true] - If this constraint has anchors, should they be rendered? Pin constraints never have anchors.\r\n * @property {number} [lineColor] - The color value of the line stroke when rendering this constraint.\r\n * @property {number} [lineOpacity] - The opacity of the line when rendering this constraint, a value between 0 and 1.\r\n * @property {number} [lineThickness] - If rendering lines, the thickness of the line.\r\n * @property {number} [pinSize=4] - The size of the circles drawn when rendering pin constraints.\r\n * @property {number} [anchorSize=4] - The size of the circles drawn as the constraint anchors.\r\n * @property {number} [anchorColor=0xefefef] - The color value of constraint anchors.\r\n */", "meta": { "filename": "MatterConstraintRenderConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "kind": "typedef", "name": "MatterConstraintRenderConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.22.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should this constraint be rendered by the Debug Renderer?", "name": "visible" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If this constraint has anchors, should they be rendered? Pin constraints never have anchors.", "name": "anchors" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color value of the line stroke when rendering this constraint.", "name": "lineColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The opacity of the line when rendering this constraint, a value between 0 and 1.", "name": "lineOpacity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If rendering lines, the thickness of the line.", "name": "lineThickness" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 4, "description": "The size of the circles drawn when rendering pin constraints.", "name": "pinSize" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 4, "description": "The size of the circles drawn as the constraint anchors.", "name": "anchorSize" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xefefef", "description": "The color value of constraint anchors.", "name": "anchorColor" } ], "memberof": "Phaser.Types.Physics.Matter", "longname": "Phaser.Types.Physics.Matter.MatterConstraintRenderConfig", "scope": "static", "___id": "T000002R031438", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Matter.MatterDebugConfig\r\n * @since 3.22.0\r\n * \r\n * @property {boolean} [showAxes=false] - Render all of the body axes?\r\n * @property {boolean} [showAngleIndicator=false] - Render just a single body axis?\r\n * @property {number} [angleColor=0xe81153] - The color of the body angle / axes lines.\r\n * @property {boolean} [showBroadphase=false] - Render the broadphase grid?\r\n * @property {number} [broadphaseColor=0xffb400] - The color of the broadphase grid.\r\n * @property {boolean} [showBounds=false] - Render the bounds of the bodies in the world?\r\n * @property {number} [boundsColor=0xffffff] - The color of the body bounds.\r\n * @property {boolean} [showVelocity=false] - Render the velocity of the bodies in the world?\r\n * @property {number} [velocityColor=0x00aeef] - The color of the body velocity line.\r\n * @property {boolean} [showCollisions=false] - Render the collision points and normals for colliding pairs.\r\n * @property {number} [collisionColor=0xf5950c] - The color of the collision points.\r\n * @property {boolean} [showSeparation=false] - Render lines showing the separation between bodies.\r\n * @property {number} [separationColor=0xffa500] - The color of the body separation line.\r\n * @property {boolean} [showBody=true] - Render the dynamic bodies in the world to the Graphics object?\r\n * @property {boolean} [showStaticBody=true] - Render the static bodies in the world to the Graphics object?\r\n * @property {boolean} [showInternalEdges=false] - When rendering bodies, render the internal edges as well?\r\n * @property {boolean} [renderFill=false] - Render the bodies using a fill color.\r\n * @property {boolean} [renderLine=true] - Render the bodies using a line stroke.\r\n * @property {number} [fillColor=0x106909] - The color value of the fill when rendering dynamic bodies.\r\n * @property {number} [fillOpacity=1] - The opacity of the fill when rendering dynamic bodies, a value between 0 and 1.\r\n * @property {number} [lineColor=0x28de19] - The color value of the line stroke when rendering dynamic bodies.\r\n * @property {number} [lineOpacity=1] - The opacity of the line when rendering dynamic bodies, a value between 0 and 1.\r\n * @property {number} [lineThickness=1] - If rendering lines, the thickness of the line.\r\n * @property {number} [staticFillColor=0x0d177b] - The color value of the fill when rendering static bodies.\r\n * @property {number} [staticLineColor=0x1327e4] - The color value of the line stroke when rendering static bodies.\r\n * @property {boolean} [showSleeping=false] - Render any sleeping bodies (dynamic or static) in the world to the Graphics object?\r\n * @property {number} [staticBodySleepOpacity=0.7] - The amount to multiply the opacity of sleeping static bodies by.\r\n * @property {number} [sleepFillColor=0x464646] - The color value of the fill when rendering sleeping dynamic bodies.\r\n * @property {number} [sleepLineColor=0x999a99] - The color value of the line stroke when rendering sleeping dynamic bodies.\r\n * @property {boolean} [showSensors=true] - Render bodies or body parts that are flagged as being a sensor?\r\n * @property {number} [sensorFillColor=0x0d177b] - The fill color when rendering body sensors.\r\n * @property {number} [sensorLineColor=0x1327e4] - The line color when rendering body sensors.\r\n * @property {boolean} [showPositions=true] - Render the position of non-static bodies?\r\n * @property {number} [positionSize=4] - The size of the rectangle drawn when rendering the body position.\r\n * @property {number} [positionColor=0xe042da] - The color value of the rectangle drawn when rendering the body position.\r\n * @property {boolean} [showJoint=true] - Render all world constraints to the Graphics object?\r\n * @property {number} [jointColor=0xe0e042] - The color value of joints when `showJoint` is set.\r\n * @property {number} [jointLineOpacity=1] - The line opacity when rendering joints, a value between 0 and 1.\r\n * @property {number} [jointLineThickness=2] - The line thickness when rendering joints.\r\n * @property {number} [pinSize=4] - The size of the circles drawn when rendering pin constraints.\r\n * @property {number} [pinColor=0x42e0e0] - The color value of the circles drawn when rendering pin constraints.\r\n * @property {number} [springColor=0xe042e0] - The color value of spring constraints.\r\n * @property {number} [anchorColor=0xefefef] - The color value of constraint anchors.\r\n * @property {number} [anchorSize=4] - The size of the circles drawn as the constraint anchors.\r\n * @property {boolean} [showConvexHulls=false] - When rendering polygon bodies, render the convex hull as well?\r\n * @property {number} [hullColor=0xd703d0] - The color value of hulls when `showConvexHulls` is set.\r\n */", "meta": { "filename": "MatterDebugConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "kind": "typedef", "name": "MatterDebugConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.22.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Render all of the body axes?", "name": "showAxes" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Render just a single body axis?", "name": "showAngleIndicator" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xe81153", "description": "The color of the body angle / axes lines.", "name": "angleColor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Render the broadphase grid?", "name": "showBroadphase" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffb400", "description": "The color of the broadphase grid.", "name": "broadphaseColor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Render the bounds of the bodies in the world?", "name": "showBounds" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color of the body bounds.", "name": "boundsColor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Render the velocity of the bodies in the world?", "name": "showVelocity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x00aeef", "description": "The color of the body velocity line.", "name": "velocityColor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Render the collision points and normals for colliding pairs.", "name": "showCollisions" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xf5950c", "description": "The color of the collision points.", "name": "collisionColor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Render lines showing the separation between bodies.", "name": "showSeparation" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffa500", "description": "The color of the body separation line.", "name": "separationColor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Render the dynamic bodies in the world to the Graphics object?", "name": "showBody" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Render the static bodies in the world to the Graphics object?", "name": "showStaticBody" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "When rendering bodies, render the internal edges as well?", "name": "showInternalEdges" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Render the bodies using a fill color.", "name": "renderFill" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Render the bodies using a line stroke.", "name": "renderLine" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x106909", "description": "The color value of the fill when rendering dynamic bodies.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The opacity of the fill when rendering dynamic bodies, a value between 0 and 1.", "name": "fillOpacity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x28de19", "description": "The color value of the line stroke when rendering dynamic bodies.", "name": "lineColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The opacity of the line when rendering dynamic bodies, a value between 0 and 1.", "name": "lineOpacity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "If rendering lines, the thickness of the line.", "name": "lineThickness" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x0d177b", "description": "The color value of the fill when rendering static bodies.", "name": "staticFillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x1327e4", "description": "The color value of the line stroke when rendering static bodies.", "name": "staticLineColor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Render any sleeping bodies (dynamic or static) in the world to the Graphics object?", "name": "showSleeping" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.7, "description": "The amount to multiply the opacity of sleeping static bodies by.", "name": "staticBodySleepOpacity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x464646", "description": "The color value of the fill when rendering sleeping dynamic bodies.", "name": "sleepFillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x999a99", "description": "The color value of the line stroke when rendering sleeping dynamic bodies.", "name": "sleepLineColor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Render bodies or body parts that are flagged as being a sensor?", "name": "showSensors" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x0d177b", "description": "The fill color when rendering body sensors.", "name": "sensorFillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x1327e4", "description": "The line color when rendering body sensors.", "name": "sensorLineColor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Render the position of non-static bodies?", "name": "showPositions" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 4, "description": "The size of the rectangle drawn when rendering the body position.", "name": "positionSize" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xe042da", "description": "The color value of the rectangle drawn when rendering the body position.", "name": "positionColor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Render all world constraints to the Graphics object?", "name": "showJoint" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xe0e042", "description": "The color value of joints when `showJoint` is set.", "name": "jointColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The line opacity when rendering joints, a value between 0 and 1.", "name": "jointLineOpacity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "The line thickness when rendering joints.", "name": "jointLineThickness" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 4, "description": "The size of the circles drawn when rendering pin constraints.", "name": "pinSize" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x42e0e0", "description": "The color value of the circles drawn when rendering pin constraints.", "name": "pinColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xe042e0", "description": "The color value of spring constraints.", "name": "springColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xefefef", "description": "The color value of constraint anchors.", "name": "anchorColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 4, "description": "The size of the circles drawn as the constraint anchors.", "name": "anchorSize" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "When rendering polygon bodies, render the convex hull as well?", "name": "showConvexHulls" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xd703d0", "description": "The color value of hulls when `showConvexHulls` is set.", "name": "hullColor" } ], "memberof": "Phaser.Types.Physics.Matter", "longname": "Phaser.Types.Physics.Matter.MatterDebugConfig", "scope": "static", "___id": "T000002R031439", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Matter.MatterRunnerConfig\r\n * @since 3.22.0\r\n * \r\n * @property {boolean} [isFixed=false] - A boolean that specifies if the runner should use a fixed timestep (otherwise it is variable). If timing is fixed, then the apparent simulation speed will change depending on the frame rate (but behaviour will be deterministic). If the timing is variable, then the apparent simulation speed will be constant (approximately, but at the cost of determininism).\r\n * @property {number} [fps=60] - A number that specifies the frame rate in seconds. If you don't specify this, but do specify `delta`, those values set the fps rate.\r\n * @property {number} [correction=1] - A number that specifies the time correction factor to apply to the update. This can help improve the accuracy of the simulation in cases where delta is changing between updates.\r\n * @property {number} [deltaSampleSize=60] - The size of the delta smoothing array when `isFixed` is `false`.\r\n * @property {number} [delta=16.666] - A number that specifies the time step between updates in milliseconds. If you set the `fps` property, this value is set based on that. If `isFixed` is set to `true`, then `delta` is fixed. If it is `false`, then `delta` can dynamically change to maintain the correct apparent simulation speed.\r\n * @property {number} [deltaMin=16.666] - A number that specifies the minimum time step between updates in milliseconds.\r\n * @property {number} [deltaMax=33.333] - A number that specifies the maximum time step between updates in milliseconds.\r\n */", "meta": { "filename": "MatterRunnerConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "kind": "typedef", "name": "MatterRunnerConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.22.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "A boolean that specifies if the runner should use a fixed timestep (otherwise it is variable). If timing is fixed, then the apparent simulation speed will change depending on the frame rate (but behaviour will be deterministic). If the timing is variable, then the apparent simulation speed will be constant (approximately, but at the cost of determininism).", "name": "isFixed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 60, "description": "A number that specifies the frame rate in seconds. If you don't specify this, but do specify `delta`, those values set the fps rate.", "name": "fps" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "A number that specifies the time correction factor to apply to the update. This can help improve the accuracy of the simulation in cases where delta is changing between updates.", "name": "correction" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 60, "description": "The size of the delta smoothing array when `isFixed` is `false`.", "name": "deltaSampleSize" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 16.666, "description": "A number that specifies the time step between updates in milliseconds. If you set the `fps` property, this value is set based on that. If `isFixed` is set to `true`, then `delta` is fixed. If it is `false`, then `delta` can dynamically change to maintain the correct apparent simulation speed.", "name": "delta" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 16.666, "description": "A number that specifies the minimum time step between updates in milliseconds.", "name": "deltaMin" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 33.333, "description": "A number that specifies the maximum time step between updates in milliseconds.", "name": "deltaMax" } ], "memberof": "Phaser.Types.Physics.Matter", "longname": "Phaser.Types.Physics.Matter.MatterRunnerConfig", "scope": "static", "___id": "T000002R031440", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Matter.MatterSetBodyConfig\r\n * @since 3.22.0\r\n * \r\n * @property {string} [type='rectangle'] - The shape type. Either `rectangle`, `circle`, `trapezoid`, `polygon`, `fromVertices`, `fromVerts` or `fromPhysicsEditor`.\r\n * @property {number} [x] - The horizontal world position to place the body at.\r\n * @property {number} [y] - The vertical world position to place the body at.\r\n * @property {number} [width] - The width of the body.\r\n * @property {number} [height] - The height of the body.\r\n * @property {number} [radius] - The radius of the body. Used by `circle` and `polygon` shapes.\r\n * @property {number} [maxSides=25] - The max sizes of the body. Used by the `circle` shape.\r\n * @property {number} [slope=0.5] - Used by the `trapezoid` shape. The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.\r\n * @property {number} [sides=5] - Used by the `polygon` shape. The number of sides the polygon will have.\r\n * @property {(string|array)} [verts] - Used by the `fromVerts` shape. The vertices data. Either a path string or an array of vertices.\r\n * @property {boolean} [flagInternal=false] - Used by the `fromVerts` shape. Flag internal edges (coincident part edges)\r\n * @property {number} [removeCollinear=0.01] - Used by the `fromVerts` shape. Whether Matter.js will discard collinear edges (to improve performance).\r\n * @property {number} [minimumArea=10] - Used by the `fromVerts` shape. During decomposition discard parts that have an area less than this.\r\n * @property {boolean} [addToWorld=true] - Should the new body be automatically added to the world?\r\n */", "meta": { "filename": "MatterSetBodyConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "kind": "typedef", "name": "MatterSetBodyConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.22.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'rectangle'", "description": "The shape type. Either `rectangle`, `circle`, `trapezoid`, `polygon`, `fromVertices`, `fromVerts` or `fromPhysicsEditor`.", "name": "type" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal world position to place the body at.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The vertical world position to place the body at.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the body.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the body.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The radius of the body. Used by `circle` and `polygon` shapes.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 25, "description": "The max sizes of the body. Used by the `circle` shape.", "name": "maxSides" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "Used by the `trapezoid` shape. The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.", "name": "slope" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 5, "description": "Used by the `polygon` shape. The number of sides the polygon will have.", "name": "sides" }, { "type": { "names": [ "string", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "array" } ] } }, "optional": true, "description": "Used by the `fromVerts` shape. The vertices data. Either a path string or an array of vertices.", "name": "verts" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Used by the `fromVerts` shape. Flag internal edges (coincident part edges)", "name": "flagInternal" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.01, "description": "Used by the `fromVerts` shape. Whether Matter.js will discard collinear edges (to improve performance).", "name": "removeCollinear" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "Used by the `fromVerts` shape. During decomposition discard parts that have an area less than this.", "name": "minimumArea" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the new body be automatically added to the world?", "name": "addToWorld" } ], "memberof": "Phaser.Types.Physics.Matter", "longname": "Phaser.Types.Physics.Matter.MatterSetBodyConfig", "scope": "static", "___id": "T000002R031441", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Matter.MatterTileOptions\r\n * @since 3.0.0\r\n * \r\n * @property {MatterJS.BodyType} [body=null] - An existing Matter body to be used instead of creating a new one.\r\n * @property {boolean} [isStatic=true] - Whether or not the newly created body should be made static. This defaults to true since typically tiles should not be moved.\r\n * @property {boolean} [addToWorld=true] - Whether or not to add the newly created body (or existing body if options.body is used) to the Matter world.\r\n */", "meta": { "filename": "MatterTileOptions.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "kind": "typedef", "name": "MatterTileOptions", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "optional": true, "defaultvalue": null, "description": "An existing Matter body to be used instead of creating a new one.", "name": "body" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether or not the newly created body should be made static. This defaults to true since typically tiles should not be moved.", "name": "isStatic" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether or not to add the newly created body (or existing body if options.body is used) to the Matter world.", "name": "addToWorld" } ], "memberof": "Phaser.Types.Physics.Matter", "longname": "Phaser.Types.Physics.Matter.MatterTileOptions", "scope": "static", "___id": "T000002R031442", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Matter.MatterWalls\r\n * @since 3.0.0\r\n *\r\n * @property {MatterJS.BodyType} [left=null] - The left wall for the Matter World.\r\n * @property {MatterJS.BodyType} [right=null] - The right wall for the Matter World.\r\n * @property {MatterJS.BodyType} [top=null] - The top wall for the Matter World.\r\n * @property {MatterJS.BodyType} [bottom=null] - The bottom wall for the Matter World.\r\n */", "meta": { "filename": "MatterWalls.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "kind": "typedef", "name": "MatterWalls", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "optional": true, "defaultvalue": null, "description": "The left wall for the Matter World.", "name": "left" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "optional": true, "defaultvalue": null, "description": "The right wall for the Matter World.", "name": "right" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "optional": true, "defaultvalue": null, "description": "The top wall for the Matter World.", "name": "top" }, { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "optional": true, "defaultvalue": null, "description": "The bottom wall for the Matter World.", "name": "bottom" } ], "memberof": "Phaser.Types.Physics.Matter", "longname": "Phaser.Types.Physics.Matter.MatterWalls", "scope": "static", "___id": "T000002R031443", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Physics.Matter.MatterWorldConfig\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.Types.Math.Vector2Like} [gravity] - Sets {@link Phaser.Physics.Matter.World#gravity}.\r\n * @property {(object|boolean)} [setBounds] - Should the world have bounds enabled by default?\r\n * @property {number} [setBounds.x=0] - The x coordinate of the world bounds.\r\n * @property {number} [setBounds.y=0] - The y coordinate of the world bounds.\r\n * @property {number} [setBounds.width] - The width of the world bounds.\r\n * @property {number} [setBounds.height] - The height of the world bounds.\r\n * @property {number} [setBounds.thickness=64] - The thickness of the walls of the world bounds.\r\n * @property {boolean} [setBounds.left=true] - Should the left-side world bounds wall be created?\r\n * @property {boolean} [setBounds.right=true] - Should the right-side world bounds wall be created?\r\n * @property {boolean} [setBounds.top=true] - Should the top world bounds wall be created?\r\n * @property {boolean} [setBounds.bottom=true] - Should the bottom world bounds wall be created?\r\n * @property {number} [positionIterations=6] - The number of position iterations to perform each update. The higher the value, the higher quality the simulation will be at the expense of performance.\r\n * @property {number} [velocityIterations=4] - The number of velocity iterations to perform each update. The higher the value, the higher quality the simulation will be at the expense of performance.\r\n * @property {number} [constraintIterations=2] - The number of constraint iterations to perform each update. The higher the value, the higher quality the simulation will be at the expense of performance.\r\n * @property {boolean} [enableSleeping=false] - A flag that specifies whether the engine should allow sleeping via the `Matter.Sleeping` module. Sleeping can improve stability and performance, but often at the expense of accuracy.\r\n * @property {number} [timing.timestamp=0] - A `Number` that specifies the current simulation-time in milliseconds starting from `0`. It is incremented on every `Engine.update` by the given `delta` argument.\r\n * @property {number} [timing.timeScale=1] - A `Number` that specifies the global scaling factor of time for all bodies. A value of `0` freezes the simulation. A value of `0.1` gives a slow-motion effect. A value of `1.2` gives a speed-up effect.\r\n * @property {boolean} [plugins.attractors=false] - Should the Matter Attractor Plugin be enabled? An attractors plugin that makes it easy to apply continual forces on bodies. It's possible to simulate effects such as wind, gravity and magnetism.\r\n * @property {boolean} [plugins.wrap=false] - Should the Matter Wrap Plugin be enabled? A coordinate wrapping plugin that automatically wraps the position of bodies such that they always stay within the given bounds. Upon crossing a boundary the body will appear on the opposite side of the bounds, while maintaining its velocity.\r\n * @property {boolean} [plugins.collisionevents=true] - Should the Matter Collision Events Plugin be enabled?\r\n * @property {boolean} [enabled=true] - Toggles if the world is enabled or not.\r\n * @property {number} [correction=1] - An optional Number that specifies the time correction factor to apply to the update.\r\n * @property {function} [getDelta] - This function is called every time the core game loop steps, which is bound to the Request Animation Frame frequency unless otherwise modified.\r\n * @property {boolean} [autoUpdate=true] - Automatically call Engine.update every time the game steps.\r\n * @property {number} [restingThresh=4] - Sets the Resolver resting threshold property.\r\n * @property {number} [restingThreshTangent=6] - Sets the Resolver resting threshold tangent property.\r\n * @property {number} [positionDampen=0.9] - Sets the Resolver position dampen property.\r\n * @property {number} [positionWarming=0.8] - Sets the Resolver position warming property.\r\n * @property {number} [frictionNormalMultiplier=5] - Sets the Resolver friction normal multiplier property.\r\n * @property {(boolean|Phaser.Types.Physics.Matter.MatterDebugConfig)} [debug=false] - Controls the Matter Debug Rendering options. If a boolean it will use the default values, otherwise, specify a Debug Config object.\r\n * @property {Phaser.Types.Physics.Matter.MatterRunnerConfig} [runner] - Sets the Matter Runner options.\r\n */", "meta": { "filename": "MatterWorldConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\typedefs", "code": {} }, "kind": "typedef", "name": "MatterWorldConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "Sets {@link Phaser.Physics.Matter.World#gravity}.", "name": "gravity" }, { "type": { "names": [ "object", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "boolean" } ] } }, "optional": true, "description": "Should the world have bounds enabled by default?", "name": "setBounds" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of the world bounds.", "name": "setBounds.x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the world bounds.", "name": "setBounds.y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the world bounds.", "name": "setBounds.width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the world bounds.", "name": "setBounds.height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 64, "description": "The thickness of the walls of the world bounds.", "name": "setBounds.thickness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the left-side world bounds wall be created?", "name": "setBounds.left" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the right-side world bounds wall be created?", "name": "setBounds.right" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the top world bounds wall be created?", "name": "setBounds.top" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the bottom world bounds wall be created?", "name": "setBounds.bottom" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 6, "description": "The number of position iterations to perform each update. The higher the value, the higher quality the simulation will be at the expense of performance.", "name": "positionIterations" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 4, "description": "The number of velocity iterations to perform each update. The higher the value, the higher quality the simulation will be at the expense of performance.", "name": "velocityIterations" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "The number of constraint iterations to perform each update. The higher the value, the higher quality the simulation will be at the expense of performance.", "name": "constraintIterations" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "A flag that specifies whether the engine should allow sleeping via the `Matter.Sleeping` module. Sleeping can improve stability and performance, but often at the expense of accuracy.", "name": "enableSleeping" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "A `Number` that specifies the current simulation-time in milliseconds starting from `0`. It is incremented on every `Engine.update` by the given `delta` argument.", "name": "timing.timestamp" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "A `Number` that specifies the global scaling factor of time for all bodies. A value of `0` freezes the simulation. A value of `0.1` gives a slow-motion effect. A value of `1.2` gives a speed-up effect.", "name": "timing.timeScale" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the Matter Attractor Plugin be enabled? An attractors plugin that makes it easy to apply continual forces on bodies. It's possible to simulate effects such as wind, gravity and magnetism.", "name": "plugins.attractors" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the Matter Wrap Plugin be enabled? A coordinate wrapping plugin that automatically wraps the position of bodies such that they always stay within the given bounds. Upon crossing a boundary the body will appear on the opposite side of the bounds, while maintaining its velocity.", "name": "plugins.wrap" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the Matter Collision Events Plugin be enabled?", "name": "plugins.collisionevents" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Toggles if the world is enabled or not.", "name": "enabled" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "An optional Number that specifies the time correction factor to apply to the update.", "name": "correction" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "This function is called every time the core game loop steps, which is bound to the Request Animation Frame frequency unless otherwise modified.", "name": "getDelta" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Automatically call Engine.update every time the game steps.", "name": "autoUpdate" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 4, "description": "Sets the Resolver resting threshold property.", "name": "restingThresh" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 6, "description": "Sets the Resolver resting threshold tangent property.", "name": "restingThreshTangent" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.9, "description": "Sets the Resolver position dampen property.", "name": "positionDampen" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.8, "description": "Sets the Resolver position warming property.", "name": "positionWarming" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 5, "description": "Sets the Resolver friction normal multiplier property.", "name": "frictionNormalMultiplier" }, { "type": { "names": [ "boolean", "Phaser.Types.Physics.Matter.MatterDebugConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterDebugConfig" } ] } }, "optional": true, "defaultvalue": false, "description": "Controls the Matter Debug Rendering options. If a boolean it will use the default values, otherwise, specify a Debug Config object.", "name": "debug" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterRunnerConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterRunnerConfig" } }, "optional": true, "description": "Sets the Matter Runner options.", "name": "runner" } ], "memberof": "Phaser.Types.Physics.Matter", "longname": "Phaser.Types.Physics.Matter.MatterWorldConfig", "scope": "static", "___id": "T000002R031444", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Matter World class is responsible for managing one single instance of a Matter Physics World for Phaser.\r\n *\r\n * Access this via `this.matter.world` from within a Scene.\r\n *\r\n * This class creates a Matter JS World Composite along with the Matter JS Engine during instantiation. It also\r\n * handles delta timing, bounds, body and constraint creation and debug drawing.\r\n *\r\n * If you wish to access the Matter JS World object directly, see the `localWorld` property.\r\n * If you wish to access the Matter Engine directly, see the `engine` property.\r\n *\r\n * This class is an Event Emitter and will proxy _all_ Matter JS events, as they are received.\r\n *\r\n * @class World\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Physics.Matter\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Matter World instance belongs.\r\n * @param {Phaser.Types.Physics.Matter.MatterWorldConfig} config - The Matter World configuration object.\r\n */", "meta": { "filename": "World.js", "lineno": 23, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "classdesc": "The Matter World class is responsible for managing one single instance of a Matter Physics World for Phaser.\r\rAccess this via `this.matter.world` from within a Scene.\r\rThis class creates a Matter JS World Composite along with the Matter JS Engine during instantiation. It also\rhandles delta timing, bounds, body and constraint creation and debug drawing.\r\rIf you wish to access the Matter JS World object directly, see the `localWorld` property.\rIf you wish to access the Matter Engine directly, see the `engine` property.\r\rThis class is an Event Emitter and will proxy _all_ Matter JS events, as they are received.", "kind": "class", "name": "World", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Physics.Matter", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Matter World instance belongs.", "name": "scene" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterWorldConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterWorldConfig" } }, "description": "The Matter World configuration object.", "name": "config" } ], "scope": "static", "longname": "Phaser.Physics.Matter.World", "___id": "T000002R031460", "___s": true }, { "comment": "/**\r\n * The Scene to which this Matter World instance belongs.\r\n *\r\n * @name Phaser.Physics.Matter.World#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 56, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "The Scene to which this Matter World instance belongs.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#scene", "scope": "instance", "kind": "member", "___id": "T000002R031464", "___s": true }, { "comment": "/**\r\n * An instance of the MatterJS Engine.\r\n *\r\n * @name Phaser.Physics.Matter.World#engine\r\n * @type {MatterJS.Engine}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "An instance of the MatterJS Engine.", "name": "engine", "type": { "names": [ "MatterJS.Engine" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.Engine" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#engine", "scope": "instance", "kind": "member", "___id": "T000002R031466", "___s": true }, { "comment": "/**\r\n * A `World` composite object that will contain all simulated bodies and constraints.\r\n *\r\n * @name Phaser.Physics.Matter.World#localWorld\r\n * @type {MatterJS.World}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A `World` composite object that will contain all simulated bodies and constraints.", "name": "localWorld", "type": { "names": [ "MatterJS.World" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.World" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#localWorld", "scope": "instance", "kind": "member", "___id": "T000002R031468", "___s": true }, { "comment": "/**\r\n * An object containing the 4 wall bodies that bound the physics world.\r\n *\r\n * @name Phaser.Physics.Matter.World#walls\r\n * @type {Phaser.Types.Physics.Matter.MatterWalls}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 94, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "An object containing the 4 wall bodies that bound the physics world.", "name": "walls", "type": { "names": [ "Phaser.Types.Physics.Matter.MatterWalls" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterWalls" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#walls", "scope": "instance", "kind": "member", "___id": "T000002R031471", "___s": true }, { "comment": "/**\r\n * A flag that toggles if the world is enabled or not.\r\n *\r\n * @name Phaser.Physics.Matter.World#enabled\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 103, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A flag that toggles if the world is enabled or not.", "name": "enabled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#enabled", "scope": "instance", "kind": "member", "___id": "T000002R031477", "___s": true }, { "comment": "/**\r\n * This function is called every time the core game loop steps, which is bound to the\r\n * Request Animation Frame frequency unless otherwise modified.\r\n *\r\n * The function is passed two values: `time` and `delta`, both of which come from the game step values.\r\n *\r\n * It must return a number. This number is used as the delta value passed to Matter.Engine.update.\r\n *\r\n * You can override this function with your own to define your own timestep.\r\n *\r\n * If you need to update the Engine multiple times in a single game step then call\r\n * `World.update` as many times as required. Each call will trigger the `getDelta` function.\r\n * If you wish to have full control over when the Engine updates then see the property `autoUpdate`.\r\n *\r\n * You can also adjust the number of iterations that Engine.update performs.\r\n * Use the Scene Matter Physics config object to set the following properties:\r\n *\r\n * positionIterations (defaults to 6)\r\n * velocityIterations (defaults to 4)\r\n * constraintIterations (defaults to 2)\r\n *\r\n * Adjusting these values can help performance in certain situations, depending on the physics requirements\r\n * of your game.\r\n *\r\n * @name Phaser.Physics.Matter.World#getDelta\r\n * @type {function}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "World.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "This function is called every time the core game loop steps, which is bound to the\rRequest Animation Frame frequency unless otherwise modified.\r\rThe function is passed two values: `time` and `delta`, both of which come from the game step values.\r\rIt must return a number. This number is used as the delta value passed to Matter.Engine.update.\r\rYou can override this function with your own to define your own timestep.\r\rIf you need to update the Engine multiple times in a single game step then call\r`World.update` as many times as required. Each call will trigger the `getDelta` function.\rIf you wish to have full control over when the Engine updates then see the property `autoUpdate`.\r\rYou can also adjust the number of iterations that Engine.update performs.\rUse the Scene Matter Physics config object to set the following properties:\r\rpositionIterations (defaults to 6)\rvelocityIterations (defaults to 4)\rconstraintIterations (defaults to 2)\r\rAdjusting these values can help performance in certain situations, depending on the physics requirements\rof your game.", "name": "getDelta", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.4.0", "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#getDelta", "scope": "instance", "kind": "member", "___id": "T000002R031479", "___s": true }, { "comment": "/**\r\n * The Matter JS Runner Configuration object.\r\n *\r\n * This object is populated via the Matter Configuration object's `runner` property and is\r\n * updated constantly during the game step.\r\n *\r\n * @name Phaser.Physics.Matter.World#runner\r\n * @type {Phaser.Types.Physics.Matter.MatterRunnerConfig}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "World.js", "lineno": 158, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "The Matter JS Runner Configuration object.\r\rThis object is populated via the Matter Configuration object's `runner` property and is\rupdated constantly during the game step.", "name": "runner", "type": { "names": [ "Phaser.Types.Physics.Matter.MatterRunnerConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterRunnerConfig" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#runner", "scope": "instance", "kind": "member", "___id": "T000002R031488", "___s": true }, { "comment": "/**\r\n * Automatically call Engine.update every time the game steps.\r\n * If you disable this then you are responsible for calling `World.step` directly from your game.\r\n * If you call `set60Hz` or `set30Hz` then `autoUpdate` is reset to `true`.\r\n *\r\n * @name Phaser.Physics.Matter.World#autoUpdate\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.4.0\r\n */", "meta": { "filename": "World.js", "lineno": 183, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Automatically call Engine.update every time the game steps.\rIf you disable this then you are responsible for calling `World.step` directly from your game.\rIf you call `set60Hz` or `set30Hz` then `autoUpdate` is reset to `true`.", "name": "autoUpdate", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.4.0", "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#autoUpdate", "scope": "instance", "kind": "member", "___id": "T000002R031502", "___s": true }, { "comment": "/**\r\n * A flag that controls if the debug graphics will be drawn to or not.\r\n *\r\n * @name Phaser.Physics.Matter.World#drawDebug\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "A flag that controls if the debug graphics will be drawn to or not.", "name": "drawDebug", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#drawDebug", "scope": "instance", "kind": "member", "___id": "T000002R031505", "___s": true }, { "comment": "/**\r\n * An instance of the Graphics object the debug bodies are drawn to, if enabled.\r\n *\r\n * @name Phaser.Physics.Matter.World#debugGraphic\r\n * @type {Phaser.GameObjects.Graphics}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "An instance of the Graphics object the debug bodies are drawn to, if enabled.", "name": "debugGraphic", "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#debugGraphic", "scope": "instance", "kind": "member", "___id": "T000002R031507", "___s": true }, { "comment": "/**\r\n * The debug configuration object.\r\n *\r\n * The values stored in this object are read from the Matter World Config `debug` property.\r\n *\r\n * When a new Body or Constraint is _added to the World_, they are given the values stored in this object,\r\n * unless they have their own `render` object set that will override them.\r\n *\r\n * Note that while you can modify the values of properties in this object at run-time, it will not change\r\n * any of the Matter objects _already added_. It will only impact objects newly added to the world, or one\r\n * that is removed and then re-added at a later time.\r\n *\r\n * @name Phaser.Physics.Matter.World#debugConfig\r\n * @type {Phaser.Types.Physics.Matter.MatterDebugConfig}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "World.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "The debug configuration object.\r\rThe values stored in this object are read from the Matter World Config `debug` property.\r\rWhen a new Body or Constraint is _added to the World_, they are given the values stored in this object,\runless they have their own `render` object set that will override them.\r\rNote that while you can modify the values of properties in this object at run-time, it will not change\rany of the Matter objects _already added_. It will only impact objects newly added to the world, or one\rthat is removed and then re-added at a later time.", "name": "debugConfig", "type": { "names": [ "Phaser.Types.Physics.Matter.MatterDebugConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterDebugConfig" } }, "since": "3.22.0", "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#debugConfig", "scope": "instance", "kind": "member", "___id": "T000002R031509", "___s": true }, { "comment": "/**\r\n * Sets the debug render style for the children of the given Matter Composite.\r\n *\r\n * Composites themselves do not render, but they can contain bodies, constraints and other composites that may do.\r\n * So the children of this composite are passed to the `setBodyRenderStyle`, `setCompositeRenderStyle` and\r\n * `setConstraintRenderStyle` methods accordingly.\r\n *\r\n * @method Phaser.Physics.Matter.World#setCompositeRenderStyle\r\n * @since 3.22.0\r\n *\r\n * @param {MatterJS.CompositeType} composite - The Matter Composite to set the render style on.\r\n *\r\n * @return {this} This Matter World instance for method chaining.\r\n */", "meta": { "filename": "World.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets the debug render style for the children of the given Matter Composite.\r\rComposites themselves do not render, but they can contain bodies, constraints and other composites that may do.\rSo the children of this composite are passed to the `setBodyRenderStyle`, `setCompositeRenderStyle` and\r`setConstraintRenderStyle` methods accordingly.", "kind": "function", "name": "setCompositeRenderStyle", "since": "3.22.0", "params": [ { "type": { "names": [ "MatterJS.CompositeType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.CompositeType" } }, "description": "The Matter Composite to set the render style on.", "name": "composite" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World instance for method chaining." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#setCompositeRenderStyle", "scope": "instance", "___id": "T000002R031567", "___s": true }, { "comment": "/**\r\n * Sets the debug render style for the given Matter Body.\r\n *\r\n * If you are using this on a Phaser Game Object, such as a Matter Sprite, then pass in the body property\r\n * to this method, not the Game Object itself.\r\n *\r\n * If you wish to skip a parameter, so it retains its current value, pass `false` for it.\r\n *\r\n * If you wish to reset the Body render colors to the defaults found in the World Debug Config, then call\r\n * this method with just the `body` parameter provided and no others.\r\n *\r\n * @method Phaser.Physics.Matter.World#setBodyRenderStyle\r\n * @since 3.22.0\r\n *\r\n * @param {MatterJS.BodyType} body - The Matter Body to set the render style on.\r\n * @param {number} [lineColor] - The line color. If `null` it will use the World Debug Config value.\r\n * @param {number} [lineOpacity] - The line opacity, between 0 and 1. If `null` it will use the World Debug Config value.\r\n * @param {number} [lineThickness] - The line thickness. If `null` it will use the World Debug Config value.\r\n * @param {number} [fillColor] - The fill color. If `null` it will use the World Debug Config value.\r\n * @param {number} [fillOpacity] - The fill opacity, between 0 and 1. If `null` it will use the World Debug Config value.\r\n *\r\n * @return {this} This Matter World instance for method chaining.\r\n */", "meta": { "filename": "World.js", "lineno": 382, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets the debug render style for the given Matter Body.\r\rIf you are using this on a Phaser Game Object, such as a Matter Sprite, then pass in the body property\rto this method, not the Game Object itself.\r\rIf you wish to skip a parameter, so it retains its current value, pass `false` for it.\r\rIf you wish to reset the Body render colors to the defaults found in the World Debug Config, then call\rthis method with just the `body` parameter provided and no others.", "kind": "function", "name": "setBodyRenderStyle", "since": "3.22.0", "params": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The Matter Body to set the render style on.", "name": "body" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The line color. If `null` it will use the World Debug Config value.", "name": "lineColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The line opacity, between 0 and 1. If `null` it will use the World Debug Config value.", "name": "lineOpacity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The line thickness. If `null` it will use the World Debug Config value.", "name": "lineThickness" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The fill color. If `null` it will use the World Debug Config value.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The fill opacity, between 0 and 1. If `null` it will use the World Debug Config value.", "name": "fillOpacity" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World instance for method chaining." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#setBodyRenderStyle", "scope": "instance", "___id": "T000002R031583", "___s": true }, { "comment": "/**\r\n * Sets the debug render style for the given Matter Constraint.\r\n *\r\n * If you are using this on a Phaser Game Object, then pass in the body property\r\n * to this method, not the Game Object itself.\r\n *\r\n * If you wish to skip a parameter, so it retains its current value, pass `false` for it.\r\n *\r\n * If you wish to reset the Constraint render colors to the defaults found in the World Debug Config, then call\r\n * this method with just the `constraint` parameter provided and no others.\r\n *\r\n * @method Phaser.Physics.Matter.World#setConstraintRenderStyle\r\n * @since 3.22.0\r\n *\r\n * @param {MatterJS.ConstraintType} constraint - The Matter Constraint to set the render style on.\r\n * @param {number} [lineColor] - The line color. If `null` it will use the World Debug Config value.\r\n * @param {number} [lineOpacity] - The line opacity, between 0 and 1. If `null` it will use the World Debug Config value.\r\n * @param {number} [lineThickness] - The line thickness. If `null` it will use the World Debug Config value.\r\n * @param {number} [pinSize] - If this constraint is a pin, this sets the size of the pin circle. If `null` it will use the World Debug Config value.\r\n * @param {number} [anchorColor] - The color used when rendering this constraints anchors. If `null` it will use the World Debug Config value.\r\n * @param {number} [anchorSize] - The size of the anchor circle, if this constraint has anchors. If `null` it will use the World Debug Config value.\r\n *\r\n * @return {this} This Matter World instance for method chaining.\r\n */", "meta": { "filename": "World.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets the debug render style for the given Matter Constraint.\r\rIf you are using this on a Phaser Game Object, then pass in the body property\rto this method, not the Game Object itself.\r\rIf you wish to skip a parameter, so it retains its current value, pass `false` for it.\r\rIf you wish to reset the Constraint render colors to the defaults found in the World Debug Config, then call\rthis method with just the `constraint` parameter provided and no others.", "kind": "function", "name": "setConstraintRenderStyle", "since": "3.22.0", "params": [ { "type": { "names": [ "MatterJS.ConstraintType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.ConstraintType" } }, "description": "The Matter Constraint to set the render style on.", "name": "constraint" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The line color. If `null` it will use the World Debug Config value.", "name": "lineColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The line opacity, between 0 and 1. If `null` it will use the World Debug Config value.", "name": "lineOpacity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The line thickness. If `null` it will use the World Debug Config value.", "name": "lineThickness" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If this constraint is a pin, this sets the size of the pin circle. If `null` it will use the World Debug Config value.", "name": "pinSize" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color used when rendering this constraints anchors. If `null` it will use the World Debug Config value.", "name": "anchorColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The size of the anchor circle, if this constraint has anchors. If `null` it will use the World Debug Config value.", "name": "anchorSize" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World instance for method chaining." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#setConstraintRenderStyle", "scope": "instance", "___id": "T000002R031597", "___s": true }, { "comment": "/**\r\n * This internal method acts as a proxy between all of the Matter JS events and then re-emits them\r\n * via this class.\r\n *\r\n * @method Phaser.Physics.Matter.World#setEventsProxy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "This internal method acts as a proxy between all of the Matter JS events and then re-emits them\rvia this class.", "kind": "function", "name": "setEventsProxy", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#setEventsProxy", "scope": "instance", "___id": "T000002R031616", "___s": true }, { "comment": "/**\r\n * Sets the bounds of the Physics world to match the given world pixel dimensions.\r\n *\r\n * You can optionally set which 'walls' to create: left, right, top or bottom.\r\n * If none of the walls are given it will default to use the walls settings it had previously.\r\n * I.e. if you previously told it to not have the left or right walls, and you then adjust the world size\r\n * the newly created bounds will also not have the left and right walls.\r\n * Explicitly state them in the parameters to override this.\r\n *\r\n * @method Phaser.Physics.Matter.World#setBounds\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The x coordinate of the top-left corner of the bounds.\r\n * @param {number} [y=0] - The y coordinate of the top-left corner of the bounds.\r\n * @param {number} [width] - The width of the bounds.\r\n * @param {number} [height] - The height of the bounds.\r\n * @param {number} [thickness=64] - The thickness of each wall, in pixels.\r\n * @param {boolean} [left=true] - If true will create the left bounds wall.\r\n * @param {boolean} [right=true] - If true will create the right bounds wall.\r\n * @param {boolean} [top=true] - If true will create the top bounds wall.\r\n * @param {boolean} [bottom=true] - If true will create the bottom bounds wall.\r\n *\r\n * @return {Phaser.Physics.Matter.World} This Matter World object.\r\n */", "meta": { "filename": "World.js", "lineno": 702, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets the bounds of the Physics world to match the given world pixel dimensions.\r\rYou can optionally set which 'walls' to create: left, right, top or bottom.\rIf none of the walls are given it will default to use the walls settings it had previously.\rI.e. if you previously told it to not have the left or right walls, and you then adjust the world size\rthe newly created bounds will also not have the left and right walls.\rExplicitly state them in the parameters to override this.", "kind": "function", "name": "setBounds", "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 bounds.", "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 bounds.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the bounds.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the bounds.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 64, "description": "The thickness of each wall, in pixels.", "name": "thickness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If true will create the left bounds wall.", "name": "left" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If true will create the right bounds wall.", "name": "right" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If true will create the top bounds wall.", "name": "top" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If true will create the bottom bounds wall.", "name": "bottom" } ], "returns": [ { "type": { "names": [ "Phaser.Physics.Matter.World" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.World" } }, "description": "This Matter World object." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#setBounds", "scope": "instance", "___id": "T000002R031640", "___s": true }, { "comment": "/**\r\n * Updates the 4 rectangle bodies that were created, if `setBounds` was set in the Matter config, to use\r\n * the new positions and sizes. This method is usually only called internally via the `setBounds` method.\r\n *\r\n * @method Phaser.Physics.Matter.World#updateWall\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} add - `true` if the walls are being added or updated, `false` to remove them from the world.\r\n * @param {string} [position] - Either `left`, `right`, `top` or `bottom`. Only optional if `add` is `false`.\r\n * @param {number} [x] - The horizontal position to place the walls at. Only optional if `add` is `false`.\r\n * @param {number} [y] - The vertical position to place the walls at. Only optional if `add` is `false`.\r\n * @param {number} [width] - The width of the walls, in pixels. Only optional if `add` is `false`.\r\n * @param {number} [height] - The height of the walls, in pixels. Only optional if `add` is `false`.\r\n */", "meta": { "filename": "World.js", "lineno": 746, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Updates the 4 rectangle bodies that were created, if `setBounds` was set in the Matter config, to use\rthe new positions and sizes. This method is usually only called internally via the `setBounds` method.", "kind": "function", "name": "updateWall", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the walls are being added or updated, `false` to remove them from the world.", "name": "add" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Either `left`, `right`, `top` or `bottom`. Only optional if `add` is `false`.", "name": "position" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position to place the walls at. Only optional if `add` is `false`.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The vertical position to place the walls at. Only optional if `add` is `false`.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the walls, in pixels. Only optional if `add` is `false`.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the walls, in pixels. Only optional if `add` is `false`.", "name": "height" } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#updateWall", "scope": "instance", "___id": "T000002R031651", "___s": true }, { "comment": "/**\r\n * Creates a Phaser.GameObjects.Graphics object that is used to render all of the debug bodies and joints to.\r\n *\r\n * This method is called automatically by the constructor, if debugging has been enabled.\r\n *\r\n * The created Graphics object is automatically added to the Scene at 0x0 and given a depth of `Number.MAX_VALUE`,\r\n * so it renders above all else in the Scene.\r\n *\r\n * The Graphics object is assigned to the `debugGraphic` property of this class and `drawDebug` is enabled.\r\n *\r\n * @method Phaser.Physics.Matter.World#createDebugGraphic\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.GameObjects.Graphics} The newly created Graphics object.\r\n */", "meta": { "filename": "World.js", "lineno": 788, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a Phaser.GameObjects.Graphics object that is used to render all of the debug bodies and joints to.\r\rThis method is called automatically by the constructor, if debugging has been enabled.\r\rThe created Graphics object is automatically added to the Scene at 0x0 and given a depth of `Number.MAX_VALUE`,\rso it renders above all else in the Scene.\r\rThe Graphics object is assigned to the `debugGraphic` property of this class and `drawDebug` is enabled.", "kind": "function", "name": "createDebugGraphic", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The newly created Graphics object." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#createDebugGraphic", "scope": "instance", "___id": "T000002R031661", "___s": true }, { "comment": "/**\r\n * Sets the world gravity and gravity scale to 0.\r\n *\r\n * @method Phaser.Physics.Matter.World#disableGravity\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Matter World object.\r\n */", "meta": { "filename": "World.js", "lineno": 816, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets the world gravity and gravity scale to 0.", "kind": "function", "name": "disableGravity", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World object." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#disableGravity", "scope": "instance", "___id": "T000002R031668", "___s": true }, { "comment": "/**\r\n * Sets the worlds gravity to the values given.\r\n *\r\n * Gravity effects all bodies in the world, unless they have the `ignoreGravity` flag set.\r\n *\r\n * @method Phaser.Physics.Matter.World#setGravity\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The world gravity x component.\r\n * @param {number} [y=1] - The world gravity y component.\r\n * @param {number} [scale=0.001] - The gravity scale factor.\r\n *\r\n * @return {this} This Matter World object.\r\n */", "meta": { "filename": "World.js", "lineno": 833, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Sets the worlds gravity to the values given.\r\rGravity effects all bodies in the world, unless they have the `ignoreGravity` flag set.", "kind": "function", "name": "setGravity", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The world gravity x component.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The world gravity y component.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.001, "description": "The gravity scale factor.", "name": "scale" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World object." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#setGravity", "scope": "instance", "___id": "T000002R031673", "___s": true }, { "comment": "/**\r\n * Creates a rectangle Matter body and adds it to the world.\r\n *\r\n * @method Phaser.Physics.Matter.World#create\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal position of the body in the world.\r\n * @param {number} y - The vertical position of the body in the world.\r\n * @param {number} width - The width of the body.\r\n * @param {number} height - The height of the body.\r\n * @param {object} options - Optional Matter configuration object.\r\n *\r\n * @return {MatterJS.BodyType} The Matter.js body that was created.\r\n */", "meta": { "filename": "World.js", "lineno": 860, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates a rectangle Matter body and adds it to the world.", "kind": "function", "name": "create", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of the body in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of the body in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the body.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the body.", "name": "height" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "Optional Matter configuration object.", "name": "options" } ], "returns": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The Matter.js body that was created." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#create", "scope": "instance", "___id": "T000002R031681", "___s": true }, { "comment": "/**\r\n * Adds a Matter JS object, or array of objects, to the world.\r\n *\r\n * The objects should be valid Matter JS entities, such as a Body, Composite or Constraint.\r\n *\r\n * Triggers `beforeAdd` and `afterAdd` events.\r\n *\r\n * @method Phaser.Physics.Matter.World#add\r\n * @since 3.0.0\r\n *\r\n * @param {(object|object[])} object - Can be single object, or an array, and can be a body, composite or constraint.\r\n *\r\n * @return {this} This Matter World object.\r\n */", "meta": { "filename": "World.js", "lineno": 883, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Adds a Matter JS object, or array of objects, to the world.\r\rThe objects should be valid Matter JS entities, such as a Body, Composite or Constraint.\r\rTriggers `beforeAdd` and `afterAdd` events.", "kind": "function", "name": "add", "since": "3.0.0", "params": [ { "type": { "names": [ "object", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } ] } }, "description": "Can be single object, or an array, and can be a body, composite or constraint.", "name": "object" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World object." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#add", "scope": "instance", "___id": "T000002R031684", "___s": true }, { "comment": "/**\r\n * Removes a Matter JS object, or array of objects, from the world.\r\n *\r\n * The objects should be valid Matter JS entities, such as a Body, Composite or Constraint.\r\n *\r\n * Triggers `beforeRemove` and `afterRemove` events.\r\n *\r\n * @method Phaser.Physics.Matter.World#remove\r\n * @since 3.0.0\r\n *\r\n * @param {(object|object[])} object - Can be single object, or an array, and can be a body, composite or constraint.\r\n * @param {boolean} [deep=false] - Optionally search the objects children and recursively remove those as well.\r\n *\r\n * @return {this} This Matter World object.\r\n */", "meta": { "filename": "World.js", "lineno": 904, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Removes a Matter JS object, or array of objects, from the world.\r\rThe objects should be valid Matter JS entities, such as a Body, Composite or Constraint.\r\rTriggers `beforeRemove` and `afterRemove` events.", "kind": "function", "name": "remove", "since": "3.0.0", "params": [ { "type": { "names": [ "object", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } ] } }, "description": "Can be single object, or an array, and can be a body, composite or constraint.", "name": "object" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Optionally search the objects children and recursively remove those as well.", "name": "deep" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World object." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#remove", "scope": "instance", "___id": "T000002R031686", "___s": true }, { "comment": "/**\r\n * Removes a Matter JS constraint, or array of constraints, from the world.\r\n *\r\n * Triggers `beforeRemove` and `afterRemove` events.\r\n *\r\n * @method Phaser.Physics.Matter.World#removeConstraint\r\n * @since 3.0.0\r\n *\r\n * @param {(MatterJS.ConstraintType|MatterJS.ConstraintType[])} constraint - A Matter JS Constraint, or an array of constraints, to be removed.\r\n * @param {boolean} [deep=false] - Optionally search the objects children and recursively remove those as well.\r\n *\r\n * @return {this} This Matter World object.\r\n */", "meta": { "filename": "World.js", "lineno": 938, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Removes a Matter JS constraint, or array of constraints, from the world.\r\rTriggers `beforeRemove` and `afterRemove` events.", "kind": "function", "name": "removeConstraint", "since": "3.0.0", "params": [ { "type": { "names": [ "MatterJS.ConstraintType", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "MatterJS.ConstraintType" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.ConstraintType", "type": "NameExpression" } ] } ] } }, "description": "A Matter JS Constraint, or an array of constraints, to be removed.", "name": "constraint" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Optionally search the objects children and recursively remove those as well.", "name": "deep" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World object." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#removeConstraint", "scope": "instance", "___id": "T000002R031692", "___s": true }, { "comment": "/**\r\n * Adds `MatterTileBody` instances for all the colliding tiles within the given tilemap layer.\r\n *\r\n * Set the appropriate tiles in your layer to collide before calling this method!\r\n *\r\n * If you modify the map after calling this method, i.e. via a function like `putTileAt` then\r\n * you should call the `Phaser.Physics.Matter.World.convertTiles` function directly, passing\r\n * it an array of the tiles you've added to your map.\r\n *\r\n * @method Phaser.Physics.Matter.World#convertTilemapLayer\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Tilemaps.TilemapLayer} tilemapLayer - An array of tiles.\r\n * @param {object} [options] - Options to be passed to the MatterTileBody constructor. {@see Phaser.Physics.Matter.TileBody}\r\n *\r\n * @return {this} This Matter World object.\r\n */", "meta": { "filename": "World.js", "lineno": 958, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Adds `MatterTileBody` instances for all the colliding tiles within the given tilemap layer.\r\rSet the appropriate tiles in your layer to collide before calling this method!\r\rIf you modify the map after calling this method, i.e. via a function like `putTileAt` then\ryou should call the `Phaser.Physics.Matter.World.convertTiles` function directly, passing\rit an array of the tiles you've added to your map.", "kind": "function", "name": "convertTilemapLayer", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } }, "description": "An array of tiles.", "name": "tilemapLayer" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Options to be passed to the MatterTileBody constructor. {@see Phaser.Physics.Matter.TileBody}", "name": "options" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World object." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#convertTilemapLayer", "scope": "instance", "___id": "T000002R031694", "___s": true }, { "comment": "/**\r\n * Creates `MatterTileBody` instances for all of the given tiles. This creates bodies regardless of whether the\r\n * tiles are set to collide or not, or if they have a body already, or not.\r\n *\r\n * If you wish to pass an array of tiles that may already have bodies, you should filter the array before hand.\r\n *\r\n * @method Phaser.Physics.Matter.World#convertTiles\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Tilemaps.Tile[]} tiles - An array of tiles.\r\n * @param {object} [options] - Options to be passed to the MatterTileBody constructor. {@see Phaser.Physics.Matter.TileBody}\r\n *\r\n * @return {this} This Matter World object.\r\n */", "meta": { "filename": "World.js", "lineno": 985, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Creates `MatterTileBody` instances for all of the given tiles. This creates bodies regardless of whether the\rtiles are set to collide or not, or if they have a body already, or not.\r\rIf you wish to pass an array of tiles that may already have bodies, you should filter the array before hand.", "kind": "function", "name": "convertTiles", "since": "3.0.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of tiles.", "name": "tiles" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Options to be passed to the MatterTileBody constructor. {@see Phaser.Physics.Matter.TileBody}", "name": "options" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World object." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#convertTiles", "scope": "instance", "___id": "T000002R031699", "___s": true }, { "comment": "/**\r\n * Returns the next unique group index for which bodies will collide.\r\n * If `isNonColliding` is `true`, returns the next unique group index for which bodies will not collide.\r\n *\r\n * @method Phaser.Physics.Matter.World#nextGroup\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isNonColliding=false] - If `true`, returns the next unique group index for which bodies will _not_ collide.\r\n *\r\n * @return {number} Unique category bitfield\r\n */", "meta": { "filename": "World.js", "lineno": 1014, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Returns the next unique group index for which bodies will collide.\rIf `isNonColliding` is `true`, returns the next unique group index for which bodies will not collide.", "kind": "function", "name": "nextGroup", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true`, returns the next unique group index for which bodies will _not_ collide.", "name": "isNonColliding" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Unique category bitfield" } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#nextGroup", "scope": "instance", "___id": "T000002R031702", "___s": true }, { "comment": "/**\r\n * Returns the next unique category bitfield (starting after the initial default category 0x0001).\r\n * There are 32 available.\r\n *\r\n * @method Phaser.Physics.Matter.World#nextCategory\r\n * @since 3.0.0\r\n *\r\n * @return {number} Unique category bitfield\r\n */", "meta": { "filename": "World.js", "lineno": 1030, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Returns the next unique category bitfield (starting after the initial default category 0x0001).\rThere are 32 available.", "kind": "function", "name": "nextCategory", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Unique category bitfield" } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#nextCategory", "scope": "instance", "___id": "T000002R031704", "___s": true }, { "comment": "/**\r\n * Pauses this Matter World instance and sets `enabled` to `false`.\r\n *\r\n * A paused world will not run any simulations for the duration it is paused.\r\n *\r\n * @method Phaser.Physics.Matter.World#pause\r\n * @fires Phaser.Physics.Matter.Events#PAUSE\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Matter World object.\r\n */", "meta": { "filename": "World.js", "lineno": 1044, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Pauses this Matter World instance and sets `enabled` to `false`.\r\rA paused world will not run any simulations for the duration it is paused.", "kind": "function", "name": "pause", "fires": [ "Phaser.Physics.Matter.Events#event:PAUSE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World object." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#pause", "scope": "instance", "___id": "T000002R031706", "___s": true }, { "comment": "/**\r\n * Resumes this Matter World instance from a paused state and sets `enabled` to `true`.\r\n *\r\n * @method Phaser.Physics.Matter.World#resume\r\n * @fires Phaser.Physics.Matter.Events#RESUME\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Matter World object.\r\n */", "meta": { "filename": "World.js", "lineno": 1064, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Resumes this Matter World instance from a paused state and sets `enabled` to `true`.", "kind": "function", "name": "resume", "fires": [ "Phaser.Physics.Matter.Events#event:RESUME" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World object." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#resume", "scope": "instance", "___id": "T000002R031709", "___s": true }, { "comment": "/**\r\n * The internal update method. This is called automatically by the parent Scene.\r\n *\r\n * Moves the simulation forward in time by delta ms. Uses `World.correction` value as an optional number that\r\n * specifies the time correction factor to apply to the update. This can help improve the accuracy of the\r\n * simulation in cases where delta is changing between updates. The value of correction is defined as `delta / lastDelta`,\r\n * i.e. the percentage change of delta over the last step. Therefore the value is always 1 (no correction) when\r\n * delta is constant (or when no correction is desired, which is the default).\r\n * See the paper on Time Corrected Verlet for more information.\r\n *\r\n * Triggers `beforeUpdate` and `afterUpdate` events. Triggers `collisionStart`, `collisionActive` and `collisionEnd` events.\r\n *\r\n * If the World is paused, `update` is still run, but exits early and does not update the Matter Engine.\r\n *\r\n * @method Phaser.Physics.Matter.World#update\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": "World.js", "lineno": 1082, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "The internal update method. This is called automatically by the parent Scene.\r\rMoves the simulation forward in time by delta ms. Uses `World.correction` value as an optional number that\rspecifies the time correction factor to apply to the update. This can help improve the accuracy of the\rsimulation in cases where delta is changing between updates. The value of correction is defined as `delta / lastDelta`,\ri.e. the percentage change of delta over the last step. Therefore the value is always 1 (no correction) when\rdelta is constant (or when no correction is desired, which is the default).\rSee the paper on Time Corrected Verlet for more information.\r\rTriggers `beforeUpdate` and `afterUpdate` events. Triggers `collisionStart`, `collisionActive` and `collisionEnd` events.\r\rIf the World is paused, `update` is still run, but exits early and does not update the Matter Engine.", "kind": "function", "name": "update", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "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.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#update", "scope": "instance", "___id": "T000002R031712", "___s": true }, { "comment": "/**\r\n * Manually advances the physics simulation by one iteration.\r\n *\r\n * You can optionally pass in the `delta` and `correction` values to be used by Engine.update.\r\n * If undefined they use the Matter defaults of 60Hz and no correction.\r\n *\r\n * Calling `step` directly bypasses any checks of `enabled` or `autoUpdate`.\r\n *\r\n * It also ignores any custom `getDelta` functions, as you should be passing the delta\r\n * value in to this call.\r\n *\r\n * You can adjust the number of iterations that Engine.update performs internally.\r\n * Use the Scene Matter Physics config object to set the following properties:\r\n *\r\n * positionIterations (defaults to 6)\r\n * velocityIterations (defaults to 4)\r\n * constraintIterations (defaults to 2)\r\n *\r\n * Adjusting these values can help performance in certain situations, depending on the physics requirements\r\n * of your game.\r\n *\r\n * @method Phaser.Physics.Matter.World#step\r\n * @since 3.4.0\r\n *\r\n * @param {number} [delta=16.666] - The delta value.\r\n */", "meta": { "filename": "World.js", "lineno": 1153, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Manually advances the physics simulation by one iteration.\r\rYou can optionally pass in the `delta` and `correction` values to be used by Engine.update.\rIf undefined they use the Matter defaults of 60Hz and no correction.\r\rCalling `step` directly bypasses any checks of `enabled` or `autoUpdate`.\r\rIt also ignores any custom `getDelta` functions, as you should be passing the delta\rvalue in to this call.\r\rYou can adjust the number of iterations that Engine.update performs internally.\rUse the Scene Matter Physics config object to set the following properties:\r\rpositionIterations (defaults to 6)\rvelocityIterations (defaults to 4)\rconstraintIterations (defaults to 2)\r\rAdjusting these values can help performance in certain situations, depending on the physics requirements\rof your game.", "kind": "function", "name": "step", "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 16.666, "description": "The delta value.", "name": "delta" } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#step", "scope": "instance", "___id": "T000002R031730", "___s": true }, { "comment": "/**\r\n * Runs the Matter Engine.update at a fixed timestep of 60Hz.\r\n *\r\n * @method Phaser.Physics.Matter.World#update60Hz\r\n * @since 3.4.0\r\n *\r\n * @return {number} The delta value to be passed to Engine.update.\r\n */", "meta": { "filename": "World.js", "lineno": 1184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Runs the Matter Engine.update at a fixed timestep of 60Hz.", "kind": "function", "name": "update60Hz", "since": "3.4.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value to be passed to Engine.update." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#update60Hz", "scope": "instance", "___id": "T000002R031732", "___s": true }, { "comment": "/**\r\n * Runs the Matter Engine.update at a fixed timestep of 30Hz.\r\n *\r\n * @method Phaser.Physics.Matter.World#update30Hz\r\n * @since 3.4.0\r\n *\r\n * @return {number} The delta value to be passed to Engine.update.\r\n */", "meta": { "filename": "World.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Runs the Matter Engine.update at a fixed timestep of 30Hz.", "kind": "function", "name": "update30Hz", "since": "3.4.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value to be passed to Engine.update." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#update30Hz", "scope": "instance", "___id": "T000002R031734", "___s": true }, { "comment": "/**\r\n * Returns `true` if the given body can be found within the World.\r\n *\r\n * @method Phaser.Physics.Matter.World#has\r\n * @since 3.22.0\r\n *\r\n * @param {(MatterJS.Body|Phaser.GameObjects.GameObject)} body - The Matter Body, or Game Object, to search for within the world.\r\n *\r\n * @return {MatterJS.BodyType[]} An array of all the Matter JS Bodies in this World.\r\n */", "meta": { "filename": "World.js", "lineno": 1210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Returns `true` if the given body can be found within the World.", "kind": "function", "name": "has", "since": "3.22.0", "params": [ { "type": { "names": [ "MatterJS.Body", "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "MatterJS.Body" }, { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } }, "description": "The Matter Body, or Game Object, to search for within the world.", "name": "body" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.BodyType", "type": "NameExpression" } ] } }, "description": "An array of all the Matter JS Bodies in this World." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#has", "scope": "instance", "___id": "T000002R031736", "___s": true }, { "comment": "/**\r\n * Returns all the bodies in the Matter World, including all bodies in children, recursively.\r\n *\r\n * @method Phaser.Physics.Matter.World#getAllBodies\r\n * @since 3.22.0\r\n *\r\n * @return {MatterJS.BodyType[]} An array of all the Matter JS Bodies in this World.\r\n */", "meta": { "filename": "World.js", "lineno": 1227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Returns all the bodies in the Matter World, including all bodies in children, recursively.", "kind": "function", "name": "getAllBodies", "since": "3.22.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.BodyType", "type": "NameExpression" } ] } }, "description": "An array of all the Matter JS Bodies in this World." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#getAllBodies", "scope": "instance", "___id": "T000002R031739", "___s": true }, { "comment": "/**\r\n * Returns all the constraints in the Matter World, including all constraints in children, recursively.\r\n *\r\n * @method Phaser.Physics.Matter.World#getAllConstraints\r\n * @since 3.22.0\r\n *\r\n * @return {MatterJS.ConstraintType[]} An array of all the Matter JS Constraints in this World.\r\n */", "meta": { "filename": "World.js", "lineno": 1240, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Returns all the constraints in the Matter World, including all constraints in children, recursively.", "kind": "function", "name": "getAllConstraints", "since": "3.22.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.ConstraintType", "type": "NameExpression" } ] } }, "description": "An array of all the Matter JS Constraints in this World." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#getAllConstraints", "scope": "instance", "___id": "T000002R031741", "___s": true }, { "comment": "/**\r\n * Returns all the composites in the Matter World, including all composites in children, recursively.\r\n *\r\n * @method Phaser.Physics.Matter.World#getAllComposites\r\n * @since 3.22.0\r\n *\r\n * @return {MatterJS.CompositeType[]} An array of all the Matter JS Composites in this World.\r\n */", "meta": { "filename": "World.js", "lineno": 1253, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Returns all the composites in the Matter World, including all composites in children, recursively.", "kind": "function", "name": "getAllComposites", "since": "3.22.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.CompositeType", "type": "NameExpression" } ] } }, "description": "An array of all the Matter JS Composites in this World." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#getAllComposites", "scope": "instance", "___id": "T000002R031743", "___s": true }, { "comment": "/**\r\n * Renders the Engine Broadphase Controller Grid to the given Graphics instance.\r\n *\r\n * The debug renderer calls this method if the `showBroadphase` config value is set.\r\n *\r\n * This method is used internally by the Matter Debug Renderer, but is also exposed publically should\r\n * you wish to render the Grid to your own Graphics instance.\r\n *\r\n * @method Phaser.Physics.Matter.World#renderGrid\r\n * @since 3.22.0\r\n *\r\n * @param {MatterJS.Grid} grid - The Matter Grid to be rendered.\r\n * @param {Phaser.GameObjects.Graphics} graphics - The Graphics object to render to.\r\n * @param {number} lineColor - The line color.\r\n * @param {number} lineOpacity - The line opacity, between 0 and 1.\r\n *\r\n * @return {this} This Matter World instance for method chaining.\r\n */", "meta": { "filename": "World.js", "lineno": 1331, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Renders the Engine Broadphase Controller Grid to the given Graphics instance.\r\rThe debug renderer calls this method if the `showBroadphase` config value is set.\r\rThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\ryou wish to render the Grid to your own Graphics instance.", "kind": "function", "name": "renderGrid", "since": "3.22.0", "params": [ { "type": { "names": [ "MatterJS.Grid" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.Grid" } }, "description": "The Matter Grid to be rendered.", "name": "grid" }, { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics object to render to.", "name": "graphics" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line color.", "name": "lineColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line opacity, between 0 and 1.", "name": "lineOpacity" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World instance for method chaining." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#renderGrid", "scope": "instance", "___id": "T000002R031751", "___s": true }, { "comment": "/**\r\n * Renders the list of Pair separations to the given Graphics instance.\r\n *\r\n * The debug renderer calls this method if the `showSeparations` config value is set.\r\n *\r\n * This method is used internally by the Matter Debug Renderer, but is also exposed publically should\r\n * you wish to render the Grid to your own Graphics instance.\r\n *\r\n * @method Phaser.Physics.Matter.World#renderSeparations\r\n * @since 3.22.0\r\n *\r\n * @param {MatterJS.Pair[]} pairs - An array of Matter Pairs to be rendered.\r\n * @param {Phaser.GameObjects.Graphics} graphics - The Graphics object to render to.\r\n * @param {number} lineColor - The line color.\r\n *\r\n * @return {this} This Matter World instance for method chaining.\r\n */", "meta": { "filename": "World.js", "lineno": 1377, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Renders the list of Pair separations to the given Graphics instance.\r\rThe debug renderer calls this method if the `showSeparations` config value is set.\r\rThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\ryou wish to render the Grid to your own Graphics instance.", "kind": "function", "name": "renderSeparations", "since": "3.22.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.Pair", "type": "NameExpression" } ] } }, "description": "An array of Matter Pairs to be rendered.", "name": "pairs" }, { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics object to render to.", "name": "graphics" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line color.", "name": "lineColor" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World instance for method chaining." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#renderSeparations", "scope": "instance", "___id": "T000002R031757", "___s": true }, { "comment": "/**\r\n * Renders the list of collision points and normals to the given Graphics instance.\r\n *\r\n * The debug renderer calls this method if the `showCollisions` config value is set.\r\n *\r\n * This method is used internally by the Matter Debug Renderer, but is also exposed publically should\r\n * you wish to render the Grid to your own Graphics instance.\r\n *\r\n * @method Phaser.Physics.Matter.World#renderCollisions\r\n * @since 3.22.0\r\n *\r\n * @param {MatterJS.Pair[]} pairs - An array of Matter Pairs to be rendered.\r\n * @param {Phaser.GameObjects.Graphics} graphics - The Graphics object to render to.\r\n * @param {number} lineColor - The line color.\r\n *\r\n * @return {this} This Matter World instance for method chaining.\r\n */", "meta": { "filename": "World.js", "lineno": 1446, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Renders the list of collision points and normals to the given Graphics instance.\r\rThe debug renderer calls this method if the `showCollisions` config value is set.\r\rThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\ryou wish to render the Grid to your own Graphics instance.", "kind": "function", "name": "renderCollisions", "since": "3.22.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.Pair", "type": "NameExpression" } ] } }, "description": "An array of Matter Pairs to be rendered.", "name": "pairs" }, { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics object to render to.", "name": "graphics" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line color.", "name": "lineColor" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World instance for method chaining." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#renderCollisions", "scope": "instance", "___id": "T000002R031771", "___s": true }, { "comment": "/**\r\n * Renders the bounds of an array of Bodies to the given Graphics instance.\r\n *\r\n * If the body is a compound body, it will render the bounds for the parent compound.\r\n *\r\n * The debug renderer calls this method if the `showBounds` config value is set.\r\n *\r\n * This method is used internally by the Matter Debug Renderer, but is also exposed publically should\r\n * you wish to render bounds to your own Graphics instance.\r\n *\r\n * @method Phaser.Physics.Matter.World#renderBodyBounds\r\n * @since 3.22.0\r\n *\r\n * @param {array} bodies - An array of bodies from the localWorld.\r\n * @param {Phaser.GameObjects.Graphics} graphics - The Graphics object to render to.\r\n * @param {number} lineColor - The line color.\r\n * @param {number} lineOpacity - The line opacity, between 0 and 1.\r\n */", "meta": { "filename": "World.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Renders the bounds of an array of Bodies to the given Graphics instance.\r\rIf the body is a compound body, it will render the bounds for the parent compound.\r\rThe debug renderer calls this method if the `showBounds` config value is set.\r\rThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\ryou wish to render bounds to your own Graphics instance.", "kind": "function", "name": "renderBodyBounds", "since": "3.22.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "An array of bodies from the localWorld.", "name": "bodies" }, { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics object to render to.", "name": "graphics" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line color.", "name": "lineColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line opacity, between 0 and 1.", "name": "lineOpacity" } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#renderBodyBounds", "scope": "instance", "___id": "T000002R031788", "___s": true }, { "comment": "/**\r\n * Renders either all axes, or a single axis indicator, for an array of Bodies, to the given Graphics instance.\r\n *\r\n * The debug renderer calls this method if the `showAxes` or `showAngleIndicator` config values are set.\r\n *\r\n * This method is used internally by the Matter Debug Renderer, but is also exposed publically should\r\n * you wish to render bounds to your own Graphics instance.\r\n *\r\n * @method Phaser.Physics.Matter.World#renderBodyAxes\r\n * @since 3.22.0\r\n *\r\n * @param {array} bodies - An array of bodies from the localWorld.\r\n * @param {Phaser.GameObjects.Graphics} graphics - The Graphics object to render to.\r\n * @param {boolean} showAxes - If `true` it will render all body axes. If `false` it will render a single axis indicator.\r\n * @param {number} lineColor - The line color.\r\n * @param {number} lineOpacity - The line opacity, between 0 and 1.\r\n */", "meta": { "filename": "World.js", "lineno": 1604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Renders either all axes, or a single axis indicator, for an array of Bodies, to the given Graphics instance.\r\rThe debug renderer calls this method if the `showAxes` or `showAngleIndicator` config values are set.\r\rThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\ryou wish to render bounds to your own Graphics instance.", "kind": "function", "name": "renderBodyAxes", "since": "3.22.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "An array of bodies from the localWorld.", "name": "bodies" }, { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics object to render to.", "name": "graphics" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If `true` it will render all body axes. If `false` it will render a single axis indicator.", "name": "showAxes" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line color.", "name": "lineColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line opacity, between 0 and 1.", "name": "lineOpacity" } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#renderBodyAxes", "scope": "instance", "___id": "T000002R031796", "___s": true }, { "comment": "/**\r\n * Renders a velocity indicator for an array of Bodies, to the given Graphics instance.\r\n *\r\n * The debug renderer calls this method if the `showVelocity` config value is set.\r\n *\r\n * This method is used internally by the Matter Debug Renderer, but is also exposed publically should\r\n * you wish to render bounds to your own Graphics instance.\r\n *\r\n * @method Phaser.Physics.Matter.World#renderBodyVelocity\r\n * @since 3.22.0\r\n *\r\n * @param {array} bodies - An array of bodies from the localWorld.\r\n * @param {Phaser.GameObjects.Graphics} graphics - The Graphics object to render to.\r\n * @param {number} lineColor - The line color.\r\n * @param {number} lineOpacity - The line opacity, between 0 and 1.\r\n * @param {number} lineThickness - The line thickness.\r\n */", "meta": { "filename": "World.js", "lineno": 1681, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Renders a velocity indicator for an array of Bodies, to the given Graphics instance.\r\rThe debug renderer calls this method if the `showVelocity` config value is set.\r\rThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\ryou wish to render bounds to your own Graphics instance.", "kind": "function", "name": "renderBodyVelocity", "since": "3.22.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "An array of bodies from the localWorld.", "name": "bodies" }, { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics object to render to.", "name": "graphics" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line color.", "name": "lineColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line opacity, between 0 and 1.", "name": "lineOpacity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line thickness.", "name": "lineThickness" } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#renderBodyVelocity", "scope": "instance", "___id": "T000002R031811", "___s": true }, { "comment": "/**\r\n * Renders a single Matter Body to the given Phaser Graphics Game Object.\r\n *\r\n * This method is used internally by the Matter Debug Renderer, but is also exposed publically should\r\n * you wish to render a Body to your own Graphics instance.\r\n *\r\n * If you don't wish to render a line around the body, set the `lineColor` parameter to `null`.\r\n * Equally, if you don't wish to render a fill, set the `fillColor` parameter to `null`.\r\n *\r\n * @method Phaser.Physics.Matter.World#renderBody\r\n * @since 3.22.0\r\n *\r\n * @param {MatterJS.BodyType} body - The Matter Body to be rendered.\r\n * @param {Phaser.GameObjects.Graphics} graphics - The Graphics object to render to.\r\n * @param {boolean} showInternalEdges - Render internal edges of the polygon?\r\n * @param {number} [lineColor] - The line color.\r\n * @param {number} [lineOpacity] - The line opacity, between 0 and 1.\r\n * @param {number} [lineThickness=1] - The line thickness.\r\n * @param {number} [fillColor] - The fill color.\r\n * @param {number} [fillOpacity] - The fill opacity, between 0 and 1.\r\n *\r\n * @return {this} This Matter World instance for method chaining.\r\n */", "meta": { "filename": "World.js", "lineno": 1813, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Renders a single Matter Body to the given Phaser Graphics Game Object.\r\rThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\ryou wish to render a Body to your own Graphics instance.\r\rIf you don't wish to render a line around the body, set the `lineColor` parameter to `null`.\rEqually, if you don't wish to render a fill, set the `fillColor` parameter to `null`.", "kind": "function", "name": "renderBody", "since": "3.22.0", "params": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The Matter Body to be rendered.", "name": "body" }, { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics object to render to.", "name": "graphics" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Render internal edges of the polygon?", "name": "showInternalEdges" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The line color.", "name": "lineColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The line opacity, between 0 and 1.", "name": "lineOpacity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The line thickness.", "name": "lineThickness" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The fill color.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The fill opacity, between 0 and 1.", "name": "fillOpacity" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World instance for method chaining." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#renderBody", "scope": "instance", "___id": "T000002R031844", "___s": true }, { "comment": "/**\r\n * Renders the Convex Hull for a single Matter Body to the given Phaser Graphics Game Object.\r\n *\r\n * This method is used internally by the Matter Debug Renderer, but is also exposed publically should\r\n * you wish to render a Body hull to your own Graphics instance.\r\n *\r\n * @method Phaser.Physics.Matter.World#renderConvexHull\r\n * @since 3.22.0\r\n *\r\n * @param {MatterJS.BodyType} body - The Matter Body to be rendered.\r\n * @param {Phaser.GameObjects.Graphics} graphics - The Graphics object to render to.\r\n * @param {number} hullColor - The color used to render the hull.\r\n * @param {number} [lineThickness=1] - The hull line thickness.\r\n *\r\n * @return {this} This Matter World instance for method chaining.\r\n */", "meta": { "filename": "World.js", "lineno": 1953, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Renders the Convex Hull for a single Matter Body to the given Phaser Graphics Game Object.\r\rThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\ryou wish to render a Body hull to your own Graphics instance.", "kind": "function", "name": "renderConvexHull", "since": "3.22.0", "params": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The Matter Body to be rendered.", "name": "body" }, { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics object to render to.", "name": "graphics" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The color used to render the hull.", "name": "hullColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The hull line thickness.", "name": "lineThickness" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World instance for method chaining." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#renderConvexHull", "scope": "instance", "___id": "T000002R031869", "___s": true }, { "comment": "/**\r\n * Renders a single Matter Constraint, such as a Pin or a Spring, to the given Phaser Graphics Game Object.\r\n *\r\n * This method is used internally by the Matter Debug Renderer, but is also exposed publically should\r\n * you wish to render a Constraint to your own Graphics instance.\r\n *\r\n * @method Phaser.Physics.Matter.World#renderConstraint\r\n * @since 3.22.0\r\n *\r\n * @param {MatterJS.ConstraintType} constraint - The Matter Constraint to render.\r\n * @param {Phaser.GameObjects.Graphics} graphics - The Graphics object to render to.\r\n * @param {number} lineColor - The line color.\r\n * @param {number} lineOpacity - The line opacity, between 0 and 1.\r\n * @param {number} lineThickness - The line thickness.\r\n * @param {number} pinSize - If this constraint is a pin, this sets the size of the pin circle.\r\n * @param {number} anchorColor - The color used when rendering this constraints anchors. Set to `null` to not render anchors.\r\n * @param {number} anchorSize - The size of the anchor circle, if this constraint has anchors and is rendering them.\r\n *\r\n * @return {this} This Matter World instance for method chaining.\r\n */", "meta": { "filename": "World.js", "lineno": 2031, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Renders a single Matter Constraint, such as a Pin or a Spring, to the given Phaser Graphics Game Object.\r\rThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\ryou wish to render a Constraint to your own Graphics instance.", "kind": "function", "name": "renderConstraint", "since": "3.22.0", "params": [ { "type": { "names": [ "MatterJS.ConstraintType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.ConstraintType" } }, "description": "The Matter Constraint to render.", "name": "constraint" }, { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics object to render to.", "name": "graphics" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line color.", "name": "lineColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line opacity, between 0 and 1.", "name": "lineOpacity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line thickness.", "name": "lineThickness" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "If this constraint is a pin, this sets the size of the pin circle.", "name": "pinSize" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The color used when rendering this constraints anchors. Set to `null` to not render anchors.", "name": "anchorColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The size of the anchor circle, if this constraint has anchors and is rendering them.", "name": "anchorSize" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Matter World instance for method chaining." } ], "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#renderConstraint", "scope": "instance", "___id": "T000002R031888", "___s": true }, { "comment": "/**\r\n * Resets the internal collision IDs that Matter.JS uses for Body collision groups.\r\n *\r\n * You should call this before destroying your game if you need to restart the game\r\n * again on the same page, without first reloading the page. Or, if you wish to\r\n * consistently destroy a Scene that contains Matter.js and then run it again\r\n * later in the same game.\r\n *\r\n * @method Phaser.Physics.Matter.World#resetCollisionIDs\r\n * @since 3.17.0\r\n */", "meta": { "filename": "World.js", "lineno": 2127, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Resets the internal collision IDs that Matter.JS uses for Body collision groups.\r\rYou should call this before destroying your game if you need to restart the game\ragain on the same page, without first reloading the page. Or, if you wish to\rconsistently destroy a Scene that contains Matter.js and then run it again\rlater in the same game.", "kind": "function", "name": "resetCollisionIDs", "since": "3.17.0", "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#resetCollisionIDs", "scope": "instance", "___id": "T000002R031906", "___s": true }, { "comment": "/**\r\n * Will remove all Matter physics event listeners and clear the matter physics world,\r\n * engine and any debug graphics, if any.\r\n *\r\n * @method Phaser.Physics.Matter.World#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 2147, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Will remove all Matter physics event listeners and clear the matter physics world,\rengine and any debug graphics, if any.", "kind": "function", "name": "shutdown", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#shutdown", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#shutdown", "___id": "T000002R031911", "___s": true }, { "comment": "/**\r\n * Will remove all Matter physics event listeners and clear the matter physics world,\r\n * engine and any debug graphics, if any.\r\n *\r\n * After destroying the world it cannot be re-used again.\r\n *\r\n * @method Phaser.Physics.Matter.World#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "World.js", "lineno": 2170, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js", "code": {} }, "description": "Will remove all Matter physics event listeners and clear the matter physics world,\rengine and any debug graphics, if any.\r\rAfter destroying the world it cannot be re-used again.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.World", "longname": "Phaser.Physics.Matter.World#destroy", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#destroy", "___id": "T000002R031913", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Global Plugin is installed just once into the Game owned Plugin Manager.\r\n * It can listen for Game events and respond to them.\r\n *\r\n * @class BasePlugin\r\n * @memberof Phaser.Plugins\r\n * @constructor\r\n * @since 3.8.0\r\n *\r\n * @param {Phaser.Plugins.PluginManager} pluginManager - A reference to the Plugin Manager.\r\n */", "meta": { "filename": "BasePlugin.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "classdesc": "A Global Plugin is installed just once into the Game owned Plugin Manager.\rIt can listen for Game events and respond to them.", "kind": "class", "name": "BasePlugin", "memberof": "Phaser.Plugins", "since": "3.8.0", "params": [ { "type": { "names": [ "Phaser.Plugins.PluginManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Plugins.PluginManager" } }, "description": "A reference to the Plugin Manager.", "name": "pluginManager" } ], "scope": "static", "longname": "Phaser.Plugins.BasePlugin", "___id": "T000002R031917", "___s": true }, { "comment": "/**\r\n * A handy reference to the Plugin Manager that is responsible for this plugin.\r\n * Can be used as a route to gain access to game systems and events.\r\n *\r\n * @name Phaser.Plugins.BasePlugin#pluginManager\r\n * @type {Phaser.Plugins.PluginManager}\r\n * @protected\r\n * @since 3.8.0\r\n */", "meta": { "filename": "BasePlugin.js", "lineno": 27, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "A handy reference to the Plugin Manager that is responsible for this plugin.\rCan be used as a route to gain access to game systems and events.", "name": "pluginManager", "type": { "names": [ "Phaser.Plugins.PluginManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Plugins.PluginManager" } }, "access": "protected", "since": "3.8.0", "memberof": "Phaser.Plugins.BasePlugin", "longname": "Phaser.Plugins.BasePlugin#pluginManager", "scope": "instance", "kind": "member", "___id": "T000002R031920", "___s": true }, { "comment": "/**\r\n * A reference to the Game instance this plugin is running under.\r\n *\r\n * @name Phaser.Plugins.BasePlugin#game\r\n * @type {Phaser.Game}\r\n * @protected\r\n * @since 3.8.0\r\n */", "meta": { "filename": "BasePlugin.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "A reference to the Game instance this plugin is running under.", "name": "game", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "access": "protected", "since": "3.8.0", "memberof": "Phaser.Plugins.BasePlugin", "longname": "Phaser.Plugins.BasePlugin#game", "scope": "instance", "kind": "member", "___id": "T000002R031922", "___s": true }, { "comment": "/**\r\n * The PluginManager calls this method on a Global Plugin when the plugin is first instantiated.\r\n * It will never be called again on this instance.\r\n * In here you can set-up whatever you need for this plugin to run.\r\n * If a plugin is set to automatically start then `BasePlugin.start` will be called immediately after this.\r\n * On a Scene Plugin, this method is never called. Use {@link Phaser.Plugins.ScenePlugin#boot} instead.\r\n *\r\n * @method Phaser.Plugins.BasePlugin#init\r\n * @since 3.8.0\r\n *\r\n * @param {?any} [data] - A value specified by the user, if any, from the `data` property of the plugin's configuration object (if started at game boot) or passed in the PluginManager's `install` method (if started manually).\r\n */", "meta": { "filename": "BasePlugin.js", "lineno": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "The PluginManager calls this method on a Global Plugin when the plugin is first instantiated.\rIt will never be called again on this instance.\rIn here you can set-up whatever you need for this plugin to run.\rIf a plugin is set to automatically start then `BasePlugin.start` will be called immediately after this.\rOn a Scene Plugin, this method is never called. Use {@link Phaser.Plugins.ScenePlugin#boot} instead.", "kind": "function", "name": "init", "since": "3.8.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "nullable": true } }, "optional": true, "nullable": true, "description": "A value specified by the user, if any, from the `data` property of the plugin's configuration object (if started at game boot) or passed in the PluginManager's `install` method (if started manually).", "name": "data" } ], "memberof": "Phaser.Plugins.BasePlugin", "longname": "Phaser.Plugins.BasePlugin#init", "scope": "instance", "___id": "T000002R031924", "___s": true }, { "comment": "/**\r\n * The PluginManager calls this method on a Global Plugin when the plugin is started.\r\n * If a plugin is stopped, and then started again, this will get called again.\r\n * Typically called immediately after `BasePlugin.init`.\r\n * On a Scene Plugin, this method is never called.\r\n *\r\n * @method Phaser.Plugins.BasePlugin#start\r\n * @since 3.8.0\r\n */", "meta": { "filename": "BasePlugin.js", "lineno": 65, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "The PluginManager calls this method on a Global Plugin when the plugin is started.\rIf a plugin is stopped, and then started again, this will get called again.\rTypically called immediately after `BasePlugin.init`.\rOn a Scene Plugin, this method is never called.", "kind": "function", "name": "start", "since": "3.8.0", "memberof": "Phaser.Plugins.BasePlugin", "longname": "Phaser.Plugins.BasePlugin#start", "scope": "instance", "___id": "T000002R031926", "___s": true }, { "comment": "/**\r\n * The PluginManager calls this method on a Global Plugin when the plugin is stopped.\r\n * The game code has requested that your plugin stop doing whatever it does.\r\n * It is now considered as 'inactive' by the PluginManager.\r\n * Handle that process here (i.e. stop listening for events, etc)\r\n * If the plugin is started again then `BasePlugin.start` will be called again.\r\n * On a Scene Plugin, this method is never called.\r\n *\r\n * @method Phaser.Plugins.BasePlugin#stop\r\n * @since 3.8.0\r\n */", "meta": { "filename": "BasePlugin.js", "lineno": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "The PluginManager calls this method on a Global Plugin when the plugin is stopped.\rThe game code has requested that your plugin stop doing whatever it does.\rIt is now considered as 'inactive' by the PluginManager.\rHandle that process here (i.e. stop listening for events, etc)\rIf the plugin is started again then `BasePlugin.start` will be called again.\rOn a Scene Plugin, this method is never called.", "kind": "function", "name": "stop", "since": "3.8.0", "memberof": "Phaser.Plugins.BasePlugin", "longname": "Phaser.Plugins.BasePlugin#stop", "scope": "instance", "___id": "T000002R031928", "___s": true }, { "comment": "/**\r\n * Game instance has been destroyed.\r\n * You must release everything in here, all references, all objects, free it all up.\r\n *\r\n * @method Phaser.Plugins.BasePlugin#destroy\r\n * @since 3.8.0\r\n */", "meta": { "filename": "BasePlugin.js", "lineno": 107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Game instance has been destroyed.\rYou must release everything in here, all references, all objects, free it all up.", "kind": "function", "name": "destroy", "since": "3.8.0", "memberof": "Phaser.Plugins.BasePlugin", "longname": "Phaser.Plugins.BasePlugin#destroy", "scope": "instance", "___id": "T000002R031930", "___s": true }, { "comment": "/**\r\n * The Default Plugins.\r\n *\r\n * @namespace Phaser.Plugins.DefaultPlugins\r\n * @memberof Phaser.Plugins\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DefaultPlugins.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "The Default Plugins.", "kind": "namespace", "name": "DefaultPlugins", "memberof": "Phaser.Plugins", "since": "3.0.0", "longname": "Phaser.Plugins.DefaultPlugins", "scope": "static", "___id": "T000002R031937", "___s": true }, { "comment": "/**\r\n * These are the Global Managers that are created by the Phaser.Game instance.\r\n * They are referenced from Scene.Systems so that plugins can use them.\r\n *\r\n * @name Phaser.Plugins.DefaultPlugins.Global\r\n * @type {array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DefaultPlugins.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "These are the Global Managers that are created by the Phaser.Game instance.\rThey are referenced from Scene.Systems so that plugins can use them.", "name": "Global", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.0.0", "memberof": "Phaser.Plugins.DefaultPlugins", "longname": "Phaser.Plugins.DefaultPlugins.Global", "scope": "static", "kind": "member", "___id": "T000002R031939", "___s": true }, { "comment": "/**\r\n * These are the core plugins that are installed into every Scene.Systems instance, no matter what.\r\n * They are optionally exposed in the Scene as well (see the InjectionMap for details)\r\n *\r\n * They are created in the order in which they appear in this array and EventEmitter is always first.\r\n *\r\n * @name Phaser.Plugins.DefaultPlugins.CoreScene\r\n * @type {array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DefaultPlugins.js", "lineno": 39, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "These are the core plugins that are installed into every Scene.Systems instance, no matter what.\rThey are optionally exposed in the Scene as well (see the InjectionMap for details)\r\rThey are created in the order in which they appear in this array and EventEmitter is always first.", "name": "CoreScene", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.0.0", "memberof": "Phaser.Plugins.DefaultPlugins", "longname": "Phaser.Plugins.DefaultPlugins.CoreScene", "scope": "static", "kind": "member", "___id": "T000002R031941", "___s": true }, { "comment": "/**\r\n * These plugins are created in Scene.Systems in addition to the CoreScenePlugins.\r\n *\r\n * You can elect not to have these plugins by either creating a DefaultPlugins object as part\r\n * of the Game Config, by creating a Plugins object as part of a Scene Config, or by modifying this array\r\n * and building your own bundle.\r\n *\r\n * They are optionally exposed in the Scene as well (see the InjectionMap for details)\r\n *\r\n * They are always created in the order in which they appear in the array.\r\n *\r\n * @name Phaser.Plugins.DefaultPlugins.DefaultScene\r\n * @type {array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DefaultPlugins.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "These plugins are created in Scene.Systems in addition to the CoreScenePlugins.\r\rYou can elect not to have these plugins by either creating a DefaultPlugins object as part\rof the Game Config, by creating a Plugins object as part of a Scene Config, or by modifying this array\rand building your own bundle.\r\rThey are optionally exposed in the Scene as well (see the InjectionMap for details)\r\rThey are always created in the order in which they appear in the array.", "name": "DefaultScene", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.0.0", "memberof": "Phaser.Plugins.DefaultPlugins", "longname": "Phaser.Plugins.DefaultPlugins.DefaultScene", "scope": "static", "kind": "member", "___id": "T000002R031943", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Plugins\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "kind": "namespace", "name": "Plugins", "memberof": "Phaser", "longname": "Phaser.Plugins", "scope": "static", "___id": "T000002R031946", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Plugins.PluginCache\r\n */", "meta": { "filename": "PluginCache.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "kind": "namespace", "name": "PluginCache", "memberof": "Phaser.Plugins", "longname": "Phaser.Plugins.PluginCache", "scope": "static", "___id": "T000002R031956", "___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 plugins object (i.e. InputPlugin)\r\n * Plugin is the object to instantiate to create the plugin\r\n * Mapping is what the plugin is injected into the Scene.Systems as (i.e. input)\r\n *\r\n * @method Phaser.Plugins.PluginCache.register\r\n * @since 3.8.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 Scene Systems, this is the property key map used.\r\n * @param {boolean} [custom=false] - Core Scene plugin or a Custom Scene plugin?\r\n */", "meta": { "filename": "PluginCache.js", "lineno": 21, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Static method called directly by the Core internal Plugins.\rKey is a reference used to get the plugin from the plugins object (i.e. InputPlugin)\rPlugin is the object to instantiate to create the plugin\rMapping is what the plugin is injected into the Scene.Systems as (i.e. input)", "kind": "function", "name": "register", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "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 Scene Systems, this is the property key map used.", "name": "mapping" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Core Scene plugin or a Custom Scene plugin?", "name": "custom" } ], "memberof": "Phaser.Plugins.PluginCache", "longname": "Phaser.Plugins.PluginCache.register", "scope": "static", "___id": "T000002R031957", "___s": true }, { "comment": "/**\r\n * Stores a custom plugin in the global plugin cache.\r\n * The key must be unique, within the scope of the cache.\r\n *\r\n * @method Phaser.Plugins.PluginCache.registerCustom\r\n * @since 3.8.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 Scene Systems, this is the property key map used.\r\n * @param {?any} data - A value to be passed to the plugin's `init` method.\r\n */", "meta": { "filename": "PluginCache.js", "lineno": 42, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Stores a custom plugin in the global plugin cache.\rThe key must be unique, within the scope of the cache.", "kind": "function", "name": "registerCustom", "since": "3.8.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 Scene Systems, this is the property key map used.", "name": "mapping" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "nullable": true } }, "nullable": true, "description": "A value to be passed to the plugin's `init` method.", "name": "data" } ], "memberof": "Phaser.Plugins.PluginCache", "longname": "Phaser.Plugins.PluginCache.registerCustom", "scope": "static", "___id": "T000002R031964", "___s": true }, { "comment": "/**\r\n * Checks if the given key is already being used in the core plugin cache.\r\n *\r\n * @method Phaser.Plugins.PluginCache.hasCore\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The key to check for.\r\n *\r\n * @return {boolean} `true` if the key is already in use in the core cache, otherwise `false`.\r\n */", "meta": { "filename": "PluginCache.js", "lineno": 59, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Checks if the given key is already being used in the core plugin cache.", "kind": "function", "name": "hasCore", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to check for.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the key is already in use in the core cache, otherwise `false`." } ], "memberof": "Phaser.Plugins.PluginCache", "longname": "Phaser.Plugins.PluginCache.hasCore", "scope": "static", "___id": "T000002R031970", "___s": true }, { "comment": "/**\r\n * Checks if the given key is already being used in the custom plugin cache.\r\n *\r\n * @method Phaser.Plugins.PluginCache.hasCustom\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The key to check for.\r\n *\r\n * @return {boolean} `true` if the key is already in use in the custom cache, otherwise `false`.\r\n */", "meta": { "filename": "PluginCache.js", "lineno": 74, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Checks if the given key is already being used in the custom plugin cache.", "kind": "function", "name": "hasCustom", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to check for.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the key is already in use in the custom cache, otherwise `false`." } ], "memberof": "Phaser.Plugins.PluginCache", "longname": "Phaser.Plugins.PluginCache.hasCustom", "scope": "static", "___id": "T000002R031972", "___s": true }, { "comment": "/**\r\n * Returns the core plugin object from the cache based on the given key.\r\n *\r\n * @method Phaser.Plugins.PluginCache.getCore\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The key of the core plugin to get.\r\n *\r\n * @return {Phaser.Types.Plugins.CorePluginContainer} The core plugin object.\r\n */", "meta": { "filename": "PluginCache.js", "lineno": 89, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Returns the core plugin object from the cache based on the given key.", "kind": "function", "name": "getCore", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the core plugin to get.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Plugins.CorePluginContainer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Plugins.CorePluginContainer" } }, "description": "The core plugin object." } ], "memberof": "Phaser.Plugins.PluginCache", "longname": "Phaser.Plugins.PluginCache.getCore", "scope": "static", "___id": "T000002R031974", "___s": true }, { "comment": "/**\r\n * Returns the custom plugin object from the cache based on the given key.\r\n *\r\n * @method Phaser.Plugins.PluginCache.getCustom\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The key of the custom plugin to get.\r\n *\r\n * @return {Phaser.Types.Plugins.CustomPluginContainer} The custom plugin object.\r\n */", "meta": { "filename": "PluginCache.js", "lineno": 104, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Returns the custom plugin object from the cache based on the given key.", "kind": "function", "name": "getCustom", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the custom plugin to get.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Plugins.CustomPluginContainer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Plugins.CustomPluginContainer" } }, "description": "The custom plugin object." } ], "memberof": "Phaser.Plugins.PluginCache", "longname": "Phaser.Plugins.PluginCache.getCustom", "scope": "static", "___id": "T000002R031976", "___s": true }, { "comment": "/**\r\n * Returns an object from the custom cache based on the given key that can be instantiated.\r\n *\r\n * @method Phaser.Plugins.PluginCache.getCustomClass\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The key of the custom plugin to get.\r\n *\r\n * @return {function} The custom plugin object.\r\n */", "meta": { "filename": "PluginCache.js", "lineno": 119, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Returns an object from the custom cache based on the given key that can be instantiated.", "kind": "function", "name": "getCustomClass", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the custom plugin to get.", "name": "key" } ], "returns": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The custom plugin object." } ], "memberof": "Phaser.Plugins.PluginCache", "longname": "Phaser.Plugins.PluginCache.getCustomClass", "scope": "static", "___id": "T000002R031978", "___s": true }, { "comment": "/**\r\n * Removes a core plugin based on the given key.\r\n *\r\n * @method Phaser.Plugins.PluginCache.remove\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The key of the core plugin to remove.\r\n */", "meta": { "filename": "PluginCache.js", "lineno": 134, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Removes a core plugin based on the given key.", "kind": "function", "name": "remove", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the core plugin to remove.", "name": "key" } ], "memberof": "Phaser.Plugins.PluginCache", "longname": "Phaser.Plugins.PluginCache.remove", "scope": "static", "___id": "T000002R031980", "___s": true }, { "comment": "/**\r\n * Removes a custom plugin based on the given key.\r\n *\r\n * @method Phaser.Plugins.PluginCache.removeCustom\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The key of the custom plugin to remove.\r\n */", "meta": { "filename": "PluginCache.js", "lineno": 150, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Removes a custom plugin based on the given key.", "kind": "function", "name": "removeCustom", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the custom plugin to remove.", "name": "key" } ], "memberof": "Phaser.Plugins.PluginCache", "longname": "Phaser.Plugins.PluginCache.removeCustom", "scope": "static", "___id": "T000002R031982", "___s": true }, { "comment": "/**\r\n * Removes all Core Plugins.\r\n *\r\n * This includes all of the internal system plugins that Phaser needs, like the Input Plugin and Loader Plugin.\r\n * So be sure you only call this if you do not wish to run Phaser again.\r\n *\r\n * @method Phaser.Plugins.PluginCache.destroyCorePlugins\r\n * @since 3.12.0\r\n */", "meta": { "filename": "PluginCache.js", "lineno": 166, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Removes all Core Plugins.\r\rThis includes all of the internal system plugins that Phaser needs, like the Input Plugin and Loader Plugin.\rSo be sure you only call this if you do not wish to run Phaser again.", "kind": "function", "name": "destroyCorePlugins", "since": "3.12.0", "memberof": "Phaser.Plugins.PluginCache", "longname": "Phaser.Plugins.PluginCache.destroyCorePlugins", "scope": "static", "___id": "T000002R031984", "___s": true }, { "comment": "/**\r\n * Removes all Custom Plugins.\r\n *\r\n * @method Phaser.Plugins.PluginCache.destroyCustomPlugins\r\n * @since 3.12.0\r\n */", "meta": { "filename": "PluginCache.js", "lineno": 186, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Removes all Custom Plugins.", "kind": "function", "name": "destroyCustomPlugins", "since": "3.12.0", "memberof": "Phaser.Plugins.PluginCache", "longname": "Phaser.Plugins.PluginCache.destroyCustomPlugins", "scope": "static", "___id": "T000002R031987", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The PluginManager is responsible for installing and adding plugins to Phaser.\r\n *\r\n * It is a global system and therefore belongs to the Game instance, not a specific Scene.\r\n *\r\n * It works in conjunction with the PluginCache. Core internal plugins automatically register themselves\r\n * with the Cache, but it's the Plugin Manager that is responsible for injecting them into the Scenes.\r\n *\r\n * There are two types of plugin:\r\n *\r\n * 1. A Global Plugin\r\n * 2. A Scene Plugin\r\n *\r\n * A Global Plugin is a plugin that lives within the Plugin Manager rather than a Scene. You can get\r\n * access to it by calling `PluginManager.get` and providing a key. Any Scene that requests a plugin in\r\n * this way will all get access to the same plugin instance, allowing you to use a single plugin across\r\n * multiple Scenes.\r\n *\r\n * A Scene Plugin is a plugin dedicated to running within a Scene. These are different to Global Plugins\r\n * in that their instances do not live within the Plugin Manager, but within the Scene Systems class instead.\r\n * And that every Scene created is given its own unique instance of a Scene Plugin. Examples of core Scene\r\n * Plugins include the Input Plugin, the Tween Plugin and the physics Plugins.\r\n *\r\n * You can add a plugin to Phaser in three different ways:\r\n *\r\n * 1. Preload it\r\n * 2. Include it in your source code and install it via the Game Config\r\n * 3. Include it in your source code and install it within a Scene\r\n *\r\n * For examples of all of these approaches please see the Phaser 3 Examples Repo `plugins` folder.\r\n *\r\n * For information on creating your own plugin please see the Phaser 3 Plugin Template.\r\n *\r\n * @class PluginManager\r\n * @memberof Phaser.Plugins\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - The game instance that owns this Plugin Manager.\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "classdesc": "The PluginManager is responsible for installing and adding plugins to Phaser.\r\rIt is a global system and therefore belongs to the Game instance, not a specific Scene.\r\rIt works in conjunction with the PluginCache. Core internal plugins automatically register themselves\rwith the Cache, but it's the Plugin Manager that is responsible for injecting them into the Scenes.\r\rThere are two types of plugin:\r\r1. A Global Plugin\r2. A Scene Plugin\r\rA Global Plugin is a plugin that lives within the Plugin Manager rather than a Scene. You can get\raccess to it by calling `PluginManager.get` and providing a key. Any Scene that requests a plugin in\rthis way will all get access to the same plugin instance, allowing you to use a single plugin across\rmultiple Scenes.\r\rA Scene Plugin is a plugin dedicated to running within a Scene. These are different to Global Plugins\rin that their instances do not live within the Plugin Manager, but within the Scene Systems class instead.\rAnd that every Scene created is given its own unique instance of a Scene Plugin. Examples of core Scene\rPlugins include the Input Plugin, the Tween Plugin and the physics Plugins.\r\rYou can add a plugin to Phaser in three different ways:\r\r1. Preload it\r2. Include it in your source code and install it via the Game Config\r3. Include it in your source code and install it within a Scene\r\rFor examples of all of these approaches please see the Phaser 3 Examples Repo `plugins` folder.\r\rFor information on creating your own plugin please see the Phaser 3 Plugin Template.", "kind": "class", "name": "PluginManager", "memberof": "Phaser.Plugins", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "The game instance that owns this Plugin Manager.", "name": "game" } ], "scope": "static", "longname": "Phaser.Plugins.PluginManager", "___id": "T000002R032000", "___s": true }, { "comment": "/**\r\n * The game instance that owns this Plugin Manager.\r\n *\r\n * @name Phaser.Plugins.PluginManager#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "The game instance that owns this Plugin Manager.", "name": "game", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#game", "scope": "instance", "kind": "member", "___id": "T000002R032004", "___s": true }, { "comment": "/**\r\n * The global plugins currently running and managed by this Plugin Manager.\r\n * A plugin must have been started at least once in order to appear in this list.\r\n *\r\n * @name Phaser.Plugins.PluginManager#plugins\r\n * @type {Phaser.Types.Plugins.GlobalPlugin[]}\r\n * @since 3.8.0\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "The global plugins currently running and managed by this Plugin Manager.\rA plugin must have been started at least once in order to appear in this list.", "name": "plugins", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Plugins.GlobalPlugin", "type": "NameExpression" } ] } }, "since": "3.8.0", "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#plugins", "scope": "instance", "kind": "member", "___id": "T000002R032006", "___s": true }, { "comment": "/**\r\n * A list of plugin keys that should be installed into Scenes as well as the Core Plugins.\r\n *\r\n * @name Phaser.Plugins.PluginManager#scenePlugins\r\n * @type {string[]}\r\n * @since 3.8.0\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 87, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "A list of plugin keys that should be installed into Scenes as well as the Core Plugins.", "name": "scenePlugins", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "since": "3.8.0", "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#scenePlugins", "scope": "instance", "kind": "member", "___id": "T000002R032008", "___s": true }, { "comment": "/**\r\n * Run once the game has booted and installs all of the plugins configured in the Game Config.\r\n *\r\n * @method Phaser.Plugins.PluginManager#boot\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 126, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Run once the game has booted and installs all of the plugins configured in the Game Config.", "kind": "function", "name": "boot", "access": "protected", "since": "3.0.0", "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#boot", "scope": "instance", "___id": "T000002R032014", "___s": true }, { "comment": "/**\r\n * Called by the Scene Systems class. Tells the plugin manager to install all Scene plugins into it.\r\n *\r\n * First it will install global references, i.e. references from the Game systems into the Scene Systems (and Scene if mapped.)\r\n * Then it will install Core Scene Plugins followed by Scene Plugins registered with the PluginManager.\r\n * Finally it will install any references to Global Plugins that have a Scene mapping property into the Scene itself.\r\n *\r\n * @method Phaser.Plugins.PluginManager#addToScene\r\n * @protected\r\n * @since 3.8.0\r\n *\r\n * @param {Phaser.Scenes.Systems} sys - The Scene Systems class to install all the plugins in to.\r\n * @param {array} globalPlugins - An array of global plugins to install.\r\n * @param {array} scenePlugins - An array of scene plugins to install.\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 211, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Called by the Scene Systems class. Tells the plugin manager to install all Scene plugins into it.\r\rFirst it will install global references, i.e. references from the Game systems into the Scene Systems (and Scene if mapped.)\rThen it will install Core Scene Plugins followed by Scene Plugins registered with the PluginManager.\rFinally it will install any references to Global Plugins that have a Scene mapping property into the Scene itself.", "kind": "function", "name": "addToScene", "access": "protected", "since": "3.8.0", "params": [ { "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "description": "The Scene Systems class to install all the plugins in to.", "name": "sys" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "An array of global plugins to install.", "name": "globalPlugins" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "An array of scene plugins to install.", "name": "scenePlugins" } ], "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#addToScene", "scope": "instance", "___id": "T000002R032042", "___s": true }, { "comment": "/**\r\n * Called by the Scene Systems class. Returns a list of plugins to be installed.\r\n *\r\n * @method Phaser.Plugins.PluginManager#getDefaultScenePlugins\r\n * @protected\r\n * @since 3.8.0\r\n *\r\n * @return {string[]} A list keys of all the Scene Plugins to install.\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 310, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Called by the Scene Systems class. Returns a list of plugins to be installed.", "kind": "function", "name": "getDefaultScenePlugins", "access": "protected", "since": "3.8.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "A list keys of all the Scene Plugins to install." } ], "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#getDefaultScenePlugins", "scope": "instance", "___id": "T000002R032070", "___s": true }, { "comment": "/**\r\n * Installs a new Scene Plugin into the Plugin Manager and optionally adds it\r\n * to the given Scene as well. A Scene Plugin added to the manager in this way\r\n * will be automatically installed into all new Scenes using the key and mapping given.\r\n *\r\n * The `key` property is what the plugin is injected into Scene.Systems as.\r\n * The `mapping` property is optional, and if specified is what the plugin is installed into\r\n * the Scene as. For example:\r\n *\r\n * ```javascript\r\n * this.plugins.installScenePlugin('powerupsPlugin', pluginCode, 'powerups');\r\n *\r\n * // and from within the scene:\r\n * this.sys.powerupsPlugin; // key value\r\n * this.powerups; // mapping value\r\n * ```\r\n *\r\n * This method is called automatically by Phaser if you install your plugins using either the\r\n * Game Configuration object, or by preloading them via the Loader.\r\n *\r\n * @method Phaser.Plugins.PluginManager#installScenePlugin\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The property key that will be used to add this plugin to Scene.Systems.\r\n * @param {function} plugin - The plugin code. This should be the non-instantiated version.\r\n * @param {string} [mapping] - If this plugin is injected into the Phaser.Scene class, this is the property key to use.\r\n * @param {Phaser.Scene} [addToScene] - Optionally automatically add this plugin to the given Scene.\r\n * @param {boolean} [fromLoader=false] - Is this being called by the Loader?\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 329, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Installs a new Scene Plugin into the Plugin Manager and optionally adds it\rto the given Scene as well. A Scene Plugin added to the manager in this way\rwill be automatically installed into all new Scenes using the key and mapping given.\r\rThe `key` property is what the plugin is injected into Scene.Systems as.\rThe `mapping` property is optional, and if specified is what the plugin is installed into\rthe Scene as. For example:\r\r```javascript\rthis.plugins.installScenePlugin('powerupsPlugin', pluginCode, 'powerups');\r\r// and from within the scene:\rthis.sys.powerupsPlugin; // key value\rthis.powerups; // mapping value\r```\r\rThis method is called automatically by Phaser if you install your plugins using either the\rGame Configuration object, or by preloading them via the Loader.", "kind": "function", "name": "installScenePlugin", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property key that will be used to add this plugin to Scene.Systems.", "name": "key" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The plugin code. This should be the non-instantiated version.", "name": "plugin" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If this plugin is injected into the Phaser.Scene class, this is the property key to use.", "name": "mapping" }, { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "optional": true, "description": "Optionally automatically add this plugin to the given Scene.", "name": "addToScene" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is this being called by the Loader?", "name": "fromLoader" } ], "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#installScenePlugin", "scope": "instance", "___id": "T000002R032074", "___s": true }, { "comment": "/**\r\n * Installs a new Global Plugin into the Plugin Manager and optionally starts it running.\r\n * A global plugin belongs to the Plugin Manager, rather than a specific Scene, and can be accessed\r\n * and used by all Scenes in your game.\r\n *\r\n * The `key` property is what you use to access this plugin from the Plugin Manager.\r\n *\r\n * ```javascript\r\n * this.plugins.install('powerupsPlugin', pluginCode);\r\n *\r\n * // and from within the scene:\r\n * this.plugins.get('powerupsPlugin');\r\n * ```\r\n *\r\n * This method is called automatically by Phaser if you install your plugins using either the\r\n * Game Configuration object, or by preloading them via the Loader.\r\n *\r\n * The same plugin can be installed multiple times into the Plugin Manager by simply giving each\r\n * instance its own unique key.\r\n *\r\n * @method Phaser.Plugins.PluginManager#install\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The unique handle given to this plugin within the Plugin Manager.\r\n * @param {function} plugin - The plugin code. This should be the non-instantiated version.\r\n * @param {boolean} [start=false] - Automatically start the plugin running? This is always `true` if you provide a mapping value.\r\n * @param {string} [mapping] - If this plugin is injected into the Phaser.Scene class, this is the property key to use.\r\n * @param {any} [data] - A value passed to the plugin's `init` method.\r\n *\r\n * @return {?Phaser.Plugins.BasePlugin} The plugin that was started, or `null` if `start` was false, or game isn't yet booted.\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 400, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Installs a new Global Plugin into the Plugin Manager and optionally starts it running.\rA global plugin belongs to the Plugin Manager, rather than a specific Scene, and can be accessed\rand used by all Scenes in your game.\r\rThe `key` property is what you use to access this plugin from the Plugin Manager.\r\r```javascript\rthis.plugins.install('powerupsPlugin', pluginCode);\r\r// and from within the scene:\rthis.plugins.get('powerupsPlugin');\r```\r\rThis method is called automatically by Phaser if you install your plugins using either the\rGame Configuration object, or by preloading them via the Loader.\r\rThe same plugin can be installed multiple times into the Plugin Manager by simply giving each\rinstance its own unique key.", "kind": "function", "name": "install", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique handle given to this plugin within the Plugin Manager.", "name": "key" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The plugin code. This should be the non-instantiated version.", "name": "plugin" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Automatically start the plugin running? This is always `true` if you provide a mapping value.", "name": "start" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "If this plugin is injected into the Phaser.Scene class, this is the property key to use.", "name": "mapping" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "A value passed to the plugin's `init` method.", "name": "data" } ], "returns": [ { "type": { "names": [ "Phaser.Plugins.BasePlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Plugins.BasePlugin", "nullable": true } }, "nullable": true, "description": "The plugin that was started, or `null` if `start` was false, or game isn't yet booted." } ], "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#install", "scope": "instance", "___id": "T000002R032080", "___s": true }, { "comment": "/**\r\n * Gets an index of a global plugin based on the given key.\r\n *\r\n * @method Phaser.Plugins.PluginManager#getIndex\r\n * @protected\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The unique plugin key.\r\n *\r\n * @return {number} The index of the plugin within the plugins array.\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 472, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Gets an index of a global plugin based on the given key.", "kind": "function", "name": "getIndex", "access": "protected", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique plugin key.", "name": "key" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the plugin within the plugins array." } ], "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#getIndex", "scope": "instance", "___id": "T000002R032091", "___s": true }, { "comment": "/**\r\n * Gets a global plugin based on the given key.\r\n *\r\n * @method Phaser.Plugins.PluginManager#getEntry\r\n * @protected\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The unique plugin key.\r\n *\r\n * @return {Phaser.Types.Plugins.GlobalPlugin} The plugin entry.\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 500, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Gets a global plugin based on the given key.", "kind": "function", "name": "getEntry", "access": "protected", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique plugin key.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Plugins.GlobalPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Plugins.GlobalPlugin" } }, "description": "The plugin entry." } ], "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#getEntry", "scope": "instance", "___id": "T000002R032096", "___s": true }, { "comment": "/**\r\n * Checks if the given global plugin, based on its key, is active or not.\r\n *\r\n * @method Phaser.Plugins.PluginManager#isActive\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The unique plugin key.\r\n *\r\n * @return {boolean} `true` if the plugin is active, otherwise `false`.\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 521, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Checks if the given global plugin, based on its key, is active or not.", "kind": "function", "name": "isActive", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique plugin key.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the plugin is active, otherwise `false`." } ], "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#isActive", "scope": "instance", "___id": "T000002R032099", "___s": true }, { "comment": "/**\r\n * Starts a global plugin running.\r\n *\r\n * If the plugin was previously active then calling `start` will reset it to an active state and then\r\n * call its `start` method.\r\n *\r\n * If the plugin has never been run before a new instance of it will be created within the Plugin Manager,\r\n * its active state set and then both of its `init` and `start` methods called, in that order.\r\n *\r\n * If the plugin is already running under the given key then nothing happens.\r\n *\r\n * @method Phaser.Plugins.PluginManager#start\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The key of the plugin to start.\r\n * @param {string} [runAs] - Run the plugin under a new key. This allows you to run one plugin multiple times.\r\n *\r\n * @return {?Phaser.Plugins.BasePlugin} The plugin that was started, or `null` if invalid key given or plugin is already stopped.\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 538, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Starts a global plugin running.\r\rIf the plugin was previously active then calling `start` will reset it to an active state and then\rcall its `start` method.\r\rIf the plugin has never been run before a new instance of it will be created within the Plugin Manager,\rits active state set and then both of its `init` and `start` methods called, in that order.\r\rIf the plugin is already running under the given key then nothing happens.", "kind": "function", "name": "start", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the plugin to start.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Run the plugin under a new key. This allows you to run one plugin multiple times.", "name": "runAs" } ], "returns": [ { "type": { "names": [ "Phaser.Plugins.BasePlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Plugins.BasePlugin", "nullable": true } }, "nullable": true, "description": "The plugin that was started, or `null` if invalid key given or plugin is already stopped." } ], "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#start", "scope": "instance", "___id": "T000002R032102", "___s": true }, { "comment": "/**\r\n * Stops a global plugin from running.\r\n *\r\n * If the plugin is active then its active state will be set to false and the plugins `stop` method\r\n * will be called.\r\n *\r\n * If the plugin is not already running, nothing will happen.\r\n *\r\n * @method Phaser.Plugins.PluginManager#stop\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The key of the plugin to stop.\r\n *\r\n * @return {this} The Plugin Manager.\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Stops a global plugin from running.\r\rIf the plugin is active then its active state will be set to false and the plugins `stop` method\rwill be called.\r\rIf the plugin is not already running, nothing will happen.", "kind": "function", "name": "stop", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the plugin to stop.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Plugin Manager." } ], "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#stop", "scope": "instance", "___id": "T000002R032118", "___s": true }, { "comment": "/**\r\n * Gets a global plugin from the Plugin Manager based on the given key and returns it.\r\n *\r\n * If it cannot find an active plugin based on the key, but there is one in the Plugin Cache with the same key,\r\n * then it will create a new instance of the cached plugin and return that.\r\n *\r\n * @method Phaser.Plugins.PluginManager#get\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The key of the plugin to get.\r\n * @param {boolean} [autoStart=true] - Automatically start a new instance of the plugin if found in the cache, but not actively running.\r\n *\r\n * @return {?(Phaser.Plugins.BasePlugin|function)} The plugin, or `null` if no plugin was found matching the key.\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 643, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Gets a global plugin from the Plugin Manager based on the given key and returns it.\r\rIf it cannot find an active plugin based on the key, but there is one in the Plugin Cache with the same key,\rthen it will create a new instance of the cached plugin and return that.", "kind": "function", "name": "get", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the plugin to get.", "name": "key" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Automatically start a new instance of the plugin if found in the cache, but not actively running.", "name": "autoStart" } ], "returns": [ { "type": { "names": [ "Phaser.Plugins.BasePlugin", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Plugins.BasePlugin" }, { "type": "FunctionType", "params": [] } ], "nullable": true } }, "nullable": true, "description": "The plugin, or `null` if no plugin was found matching the key." } ], "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#get", "scope": "instance", "___id": "T000002R032122", "___s": true }, { "comment": "/**\r\n * Returns the plugin class from the cache.\r\n * Used internally by the Plugin Manager.\r\n *\r\n * @method Phaser.Plugins.PluginManager#getClass\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The key of the plugin to get.\r\n *\r\n * @return {Phaser.Plugins.BasePlugin} A Plugin object\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 686, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Returns the plugin class from the cache.\rUsed internally by the Plugin Manager.", "kind": "function", "name": "getClass", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the plugin to get.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Plugins.BasePlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Plugins.BasePlugin" } }, "description": "A Plugin object" } ], "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#getClass", "scope": "instance", "___id": "T000002R032128", "___s": true }, { "comment": "/**\r\n * Removes a global plugin from the Plugin Manager and Plugin Cache.\r\n *\r\n * It is up to you to remove all references to this plugin that you may hold within your game code.\r\n *\r\n * @method Phaser.Plugins.PluginManager#removeGlobalPlugin\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The key of the plugin to remove.\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 702, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Removes a global plugin from the Plugin Manager and Plugin Cache.\r\rIt is up to you to remove all references to this plugin that you may hold within your game code.", "kind": "function", "name": "removeGlobalPlugin", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the plugin to remove.", "name": "key" } ], "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#removeGlobalPlugin", "scope": "instance", "___id": "T000002R032130", "___s": true }, { "comment": "/**\r\n * Removes a scene plugin from the Plugin Manager and Plugin Cache.\r\n *\r\n * This will not remove the plugin from any active Scenes that are already using it.\r\n *\r\n * It is up to you to remove all references to this plugin that you may hold within your game code.\r\n *\r\n * @method Phaser.Plugins.PluginManager#removeScenePlugin\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The key of the plugin to remove.\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 724, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Removes a scene plugin from the Plugin Manager and Plugin Cache.\r\rThis will not remove the plugin from any active Scenes that are already using it.\r\rIt is up to you to remove all references to this plugin that you may hold within your game code.", "kind": "function", "name": "removeScenePlugin", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the plugin to remove.", "name": "key" } ], "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#removeScenePlugin", "scope": "instance", "___id": "T000002R032133", "___s": true }, { "comment": "/**\r\n * Registers a new type of Game Object with the global Game Object Factory and / or Creator.\r\n * This is usually called from within your Plugin code and is a helpful short-cut for creating\r\n * new Game Objects.\r\n *\r\n * The key is the property that will be injected into the factories and used to create the\r\n * Game Object. For example:\r\n *\r\n * ```javascript\r\n * this.plugins.registerGameObject('clown', clownFactoryCallback, clownCreatorCallback);\r\n * // later in your game code:\r\n * this.add.clown();\r\n * this.make.clown();\r\n * ```\r\n *\r\n * The callbacks are what are called when the factories try to create a Game Object\r\n * matching the given key. It's important to understand that the callbacks are invoked within\r\n * the context of the GameObjectFactory. In this context there are several properties available\r\n * to use:\r\n *\r\n * this.scene - A reference to the Scene that owns the GameObjectFactory.\r\n * this.displayList - A reference to the Display List the Scene owns.\r\n * this.updateList - A reference to the Update List the Scene owns.\r\n *\r\n * See the GameObjectFactory and GameObjectCreator classes for more details.\r\n * Any public property or method listed is available from your callbacks under `this`.\r\n *\r\n * @method Phaser.Plugins.PluginManager#registerGameObject\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The key of the Game Object that the given callbacks will create, i.e. `image`, `sprite`.\r\n * @param {function} [factoryCallback] - The callback to invoke when the Game Object Factory is called.\r\n * @param {function} [creatorCallback] - The callback to invoke when the Game Object Creator is called.\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 743, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Registers a new type of Game Object with the global Game Object Factory and / or Creator.\rThis is usually called from within your Plugin code and is a helpful short-cut for creating\rnew Game Objects.\r\rThe key is the property that will be injected into the factories and used to create the\rGame Object. For example:\r\r```javascript\rthis.plugins.registerGameObject('clown', clownFactoryCallback, clownCreatorCallback);\r// later in your game code:\rthis.add.clown();\rthis.make.clown();\r```\r\rThe callbacks are what are called when the factories try to create a Game Object\rmatching the given key. It's important to understand that the callbacks are invoked within\rthe context of the GameObjectFactory. In this context there are several properties available\rto use:\r\rthis.scene - A reference to the Scene that owns the GameObjectFactory.\rthis.displayList - A reference to the Display List the Scene owns.\rthis.updateList - A reference to the Update List the Scene owns.\r\rSee the GameObjectFactory and GameObjectCreator classes for more details.\rAny public property or method listed is available from your callbacks under `this`.", "kind": "function", "name": "registerGameObject", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Game Object that the given callbacks will create, i.e. `image`, `sprite`.", "name": "key" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "The callback to invoke when the Game Object Factory is called.", "name": "factoryCallback" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "The callback to invoke when the Game Object Creator is called.", "name": "creatorCallback" } ], "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#registerGameObject", "scope": "instance", "___id": "T000002R032135", "___s": true }, { "comment": "/**\r\n * Removes a previously registered Game Object from the global Game Object Factory and / or Creator.\r\n * This is usually called from within your Plugin destruction code to help clean-up after your plugin has been removed.\r\n *\r\n * @method Phaser.Plugins.PluginManager#removeGameObject\r\n * @since 3.19.0\r\n *\r\n * @param {string} key - The key of the Game Object to be removed from the factories.\r\n * @param {boolean} [removeFromFactory=true] - Should the Game Object be removed from the Game Object Factory?\r\n * @param {boolean} [removeFromCreator=true] - Should the Game Object be removed from the Game Object Creator?\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 792, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Removes a previously registered Game Object from the global Game Object Factory and / or Creator.\rThis is usually called from within your Plugin destruction code to help clean-up after your plugin has been removed.", "kind": "function", "name": "removeGameObject", "since": "3.19.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Game Object to be removed from the factories.", "name": "key" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the Game Object be removed from the Game Object Factory?", "name": "removeFromFactory" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the Game Object be removed from the Game Object Creator?", "name": "removeFromCreator" } ], "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#removeGameObject", "scope": "instance", "___id": "T000002R032137", "___s": true }, { "comment": "/**\r\n * Registers a new file type with the global File Types Manager, making it available to all Loader\r\n * Plugins created after this.\r\n *\r\n * This is usually called from within your Plugin code and is a helpful short-cut for creating\r\n * new loader file types.\r\n *\r\n * The key is the property that will be injected into the Loader Plugin and used to load the\r\n * files. For example:\r\n *\r\n * ```javascript\r\n * this.plugins.registerFileType('wad', doomWadLoaderCallback);\r\n * // later in your preload code:\r\n * this.load.wad();\r\n * ```\r\n *\r\n * The callback is what is called when the loader tries to load a file matching the given key.\r\n * It's important to understand that the callback is invoked within\r\n * the context of the LoaderPlugin. In this context there are several properties / methods available\r\n * to use:\r\n *\r\n * this.addFile - A method to add the new file to the load queue.\r\n * this.scene - The Scene that owns the Loader Plugin instance.\r\n *\r\n * See the LoaderPlugin class for more details. Any public property or method listed is available from\r\n * your callback under `this`.\r\n *\r\n * @method Phaser.Plugins.PluginManager#registerFileType\r\n * @since 3.8.0\r\n *\r\n * @param {string} key - The key of the Game Object that the given callbacks will create, i.e. `image`, `sprite`.\r\n * @param {function} callback - The callback to invoke when the Game Object Factory is called.\r\n * @param {Phaser.Scene} [addToScene] - Optionally add this file type into the Loader Plugin owned by the given Scene.\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 821, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Registers a new file type with the global File Types Manager, making it available to all Loader\rPlugins created after this.\r\rThis is usually called from within your Plugin code and is a helpful short-cut for creating\rnew loader file types.\r\rThe key is the property that will be injected into the Loader Plugin and used to load the\rfiles. For example:\r\r```javascript\rthis.plugins.registerFileType('wad', doomWadLoaderCallback);\r// later in your preload code:\rthis.load.wad();\r```\r\rThe callback is what is called when the loader tries to load a file matching the given key.\rIt's important to understand that the callback is invoked within\rthe context of the LoaderPlugin. In this context there are several properties / methods available\rto use:\r\rthis.addFile - A method to add the new file to the load queue.\rthis.scene - The Scene that owns the Loader Plugin instance.\r\rSee the LoaderPlugin class for more details. Any public property or method listed is available from\ryour callback under `this`.", "kind": "function", "name": "registerFileType", "since": "3.8.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Game Object that the given callbacks will create, i.e. `image`, `sprite`.", "name": "key" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke when the Game Object Factory is called.", "name": "callback" }, { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "optional": true, "description": "Optionally add this file type into the Loader Plugin owned by the given Scene.", "name": "addToScene" } ], "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#registerFileType", "scope": "instance", "___id": "T000002R032141", "___s": true }, { "comment": "/**\r\n * Destroys this Plugin Manager and all associated plugins.\r\n * It will iterate all plugins found and call their `destroy` methods.\r\n *\r\n * The PluginCache will remove all custom plugins.\r\n *\r\n * @method Phaser.Plugins.PluginManager#destroy\r\n * @since 3.8.0\r\n */", "meta": { "filename": "PluginManager.js", "lineno": 865, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Destroys this Plugin Manager and all associated plugins.\rIt will iterate all plugins found and call their `destroy` methods.\r\rThe PluginCache will remove all custom plugins.", "kind": "function", "name": "destroy", "since": "3.8.0", "memberof": "Phaser.Plugins.PluginManager", "longname": "Phaser.Plugins.PluginManager#destroy", "scope": "instance", "___id": "T000002R032144", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Scene Level Plugin is installed into every Scene and belongs to that Scene.\r\n * It can listen for Scene events and respond to them.\r\n * It can map itself to a Scene property, or into the Scene Systems, or both.\r\n *\r\n * @class ScenePlugin\r\n * @memberof Phaser.Plugins\r\n * @extends Phaser.Plugins.BasePlugin\r\n * @constructor\r\n * @since 3.8.0\r\n *\r\n * @param {Phaser.Scene} scene - A reference to the Scene that has installed this plugin.\r\n * @param {Phaser.Plugins.PluginManager} pluginManager - A reference to the Plugin Manager.\r\n * @param {string} pluginKey - The key under which this plugin has been installed into the Scene Systems.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "classdesc": "A Scene Level Plugin is installed into every Scene and belongs to that Scene.\rIt can listen for Scene events and respond to them.\rIt can map itself to a Scene property, or into the Scene Systems, or both.", "kind": "class", "name": "ScenePlugin", "memberof": "Phaser.Plugins", "augments": [ "Phaser.Plugins.BasePlugin" ], "since": "3.8.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "A reference to the Scene that has installed this plugin.", "name": "scene" }, { "type": { "names": [ "Phaser.Plugins.PluginManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Plugins.PluginManager" } }, "description": "A reference to the Plugin Manager.", "name": "pluginManager" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key under which this plugin has been installed into the Scene Systems.", "name": "pluginKey" } ], "scope": "static", "longname": "Phaser.Plugins.ScenePlugin", "___id": "T000002R032154", "___s": true }, { "comment": "/**\r\n * A reference to the Scene that has installed this plugin.\r\n * Only set if it's a Scene Plugin, otherwise `null`.\r\n * This property is only set when the plugin is instantiated and added to the Scene, not before.\r\n * You can use it during the `boot` method.\r\n *\r\n * @name Phaser.Plugins.ScenePlugin#scene\r\n * @type {?Phaser.Scene}\r\n * @protected\r\n * @since 3.8.0\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 37, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "A reference to the Scene that has installed this plugin.\rOnly set if it's a Scene Plugin, otherwise `null`.\rThis property is only set when the plugin is instantiated and added to the Scene, not before.\rYou can use it during the `boot` method.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene", "nullable": true } }, "nullable": true, "access": "protected", "since": "3.8.0", "memberof": "Phaser.Plugins.ScenePlugin", "longname": "Phaser.Plugins.ScenePlugin#scene", "scope": "instance", "kind": "member", "___id": "T000002R032158", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Systems of the Scene that has installed this plugin.\r\n * Only set if it's a Scene Plugin, otherwise `null`.\r\n * This property is only set when the plugin is instantiated and added to the Scene, not before.\r\n * You can use it during the `boot` method.\r\n *\r\n * @name Phaser.Plugins.ScenePlugin#systems\r\n * @type {?Phaser.Scenes.Systems}\r\n * @protected\r\n * @since 3.8.0\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "A reference to the Scene Systems of the Scene that has installed this plugin.\rOnly set if it's a Scene Plugin, otherwise `null`.\rThis property is only set when the plugin is instantiated and added to the Scene, not before.\rYou can use it during the `boot` method.", "name": "systems", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems", "nullable": true } }, "nullable": true, "access": "protected", "since": "3.8.0", "memberof": "Phaser.Plugins.ScenePlugin", "longname": "Phaser.Plugins.ScenePlugin#systems", "scope": "instance", "kind": "member", "___id": "T000002R032160", "___s": true }, { "comment": "/**\r\n * The key under which this plugin was installed into the Scene Systems.\r\n *\r\n * This property is only set when the plugin is instantiated and added to the Scene, not before.\r\n * You can use it during the `boot` method.\r\n *\r\n * @name Phaser.Plugins.ScenePlugin#pluginKey\r\n * @type {string}\r\n * @readonly\r\n * @since 3.54.0\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "The key under which this plugin was installed into the Scene Systems.\r\rThis property is only set when the plugin is instantiated and added to the Scene, not before.\rYou can use it during the `boot` method.", "name": "pluginKey", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "readonly": true, "since": "3.54.0", "memberof": "Phaser.Plugins.ScenePlugin", "longname": "Phaser.Plugins.ScenePlugin#pluginKey", "scope": "instance", "kind": "member", "___id": "T000002R032162", "___s": true }, { "comment": "/**\r\n * This method is called when the Scene boots. It is only ever called once.\r\n *\r\n * By this point the plugin properties `scene` and `systems` will have already been set.\r\n *\r\n * In here you can listen for {@link Phaser.Scenes.Events Scene events} and set-up whatever you need for this plugin to run.\r\n * Here are the Scene events you can listen to:\r\n *\r\n * - start\r\n * - ready\r\n * - preupdate\r\n * - update\r\n * - postupdate\r\n * - resize\r\n * - pause\r\n * - resume\r\n * - sleep\r\n * - wake\r\n * - transitioninit\r\n * - transitionstart\r\n * - transitioncomplete\r\n * - transitionout\r\n * - shutdown\r\n * - destroy\r\n *\r\n * At the very least you should offer a destroy handler for when the Scene closes down, i.e:\r\n *\r\n * ```javascript\r\n * var eventEmitter = this.systems.events;\r\n * eventEmitter.once('destroy', this.sceneDestroy, this);\r\n * ```\r\n *\r\n * @method Phaser.Plugins.ScenePlugin#boot\r\n * @since 3.8.0\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "This method is called when the Scene boots. It is only ever called once.\r\rBy this point the plugin properties `scene` and `systems` will have already been set.\r\rIn here you can listen for {@link Phaser.Scenes.Events Scene events} and set-up whatever you need for this plugin to run.\rHere are the Scene events you can listen to:\r\r- start\r- ready\r- preupdate\r- update\r- postupdate\r- resize\r- pause\r- resume\r- sleep\r- wake\r- transitioninit\r- transitionstart\r- transitioncomplete\r- transitionout\r- shutdown\r- destroy\r\rAt the very least you should offer a destroy handler for when the Scene closes down, i.e:\r\r```javascript\rvar eventEmitter = this.systems.events;\reventEmitter.once('destroy', this.sceneDestroy, this);\r```", "kind": "function", "name": "boot", "since": "3.8.0", "memberof": "Phaser.Plugins.ScenePlugin", "longname": "Phaser.Plugins.ScenePlugin#boot", "scope": "instance", "___id": "T000002R032164", "___s": true }, { "comment": "/**\r\n * Game instance has been destroyed.\r\n *\r\n * You must release everything in here, all references, all objects, free it all up.\r\n *\r\n * @method Phaser.Plugins.ScenePlugin#destroy\r\n * @since 3.8.0\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 118, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "description": "Game instance has been destroyed.\r\rYou must release everything in here, all references, all objects, free it all up.", "kind": "function", "name": "destroy", "since": "3.8.0", "memberof": "Phaser.Plugins.ScenePlugin", "longname": "Phaser.Plugins.ScenePlugin#destroy", "scope": "instance", "overrides": "Phaser.Plugins.BasePlugin#destroy", "___id": "T000002R032166", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Plugins.CorePluginContainer\r\n * @since 3.8.0\r\n *\r\n * @property {string} key - The unique name of this plugin in the core 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 Scene Systems, this is the property key map used.\r\n * @property {boolean} [custom=false] - Core Scene plugin or a Custom Scene plugin?\r\n */", "meta": { "filename": "CorePluginContainer.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins\\typedefs", "code": {} }, "kind": "typedef", "name": "CorePluginContainer", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.8.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique name of this plugin in the core 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 Scene Systems, this is the property key map used.", "name": "mapping" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Core Scene plugin or a Custom Scene plugin?", "name": "custom" } ], "memberof": "Phaser.Types.Plugins", "longname": "Phaser.Types.Plugins.CorePluginContainer", "scope": "static", "___id": "T000002R032173", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Plugins.CustomPluginContainer\r\n * @since 3.8.0\r\n *\r\n * @property {string} key - The unique name of this plugin in the custom plugin cache.\r\n * @property {function} plugin - The plugin to be stored. Should be the source object, not instantiated.\r\n */", "meta": { "filename": "CustomPluginContainer.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins\\typedefs", "code": {} }, "kind": "typedef", "name": "CustomPluginContainer", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.8.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique name of this plugin in the custom 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" } ], "memberof": "Phaser.Types.Plugins", "longname": "Phaser.Types.Plugins.CustomPluginContainer", "scope": "static", "___id": "T000002R032174", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Plugins.GlobalPlugin\r\n * @since 3.0.0\r\n *\r\n * @property {string} key - The unique name of this plugin within the plugin cache.\r\n * @property {function} plugin - An instance of the plugin.\r\n * @property {boolean} [active] - Is the plugin active or not?\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 */", "meta": { "filename": "GlobalPlugin.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins\\typedefs", "code": {} }, "kind": "typedef", "name": "GlobalPlugin", "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 within the plugin cache.", "name": "key" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "An instance of the plugin.", "name": "plugin" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Is the plugin active or not?", "name": "active" }, { "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" } ], "memberof": "Phaser.Types.Plugins", "longname": "Phaser.Types.Plugins.GlobalPlugin", "scope": "static", "___id": "T000002R032175", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Plugins\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\plugins\\typedefs", "code": {} }, "kind": "namespace", "name": "Plugins", "memberof": "Phaser.Types", "longname": "Phaser.Types.Plugins", "scope": "static", "___id": "T000002R032176", "___s": true }, { "comment": "/**\r\n * Phaser Blend Modes.\r\n *\r\n * @namespace Phaser.BlendModes\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Phaser Blend Modes.", "kind": "namespace", "name": "BlendModes", "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.BlendModes", "scope": "static", "___id": "T000002R032177", "___s": true }, { "comment": "/**\r\n * Skips the Blend Mode check in the renderer.\r\n *\r\n * @name Phaser.BlendModes.SKIP_CHECK\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 16, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Skips the Blend Mode check in the renderer.", "name": "SKIP_CHECK", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.SKIP_CHECK", "scope": "static", "___id": "T000002R032179", "___s": true }, { "comment": "/**\r\n * Normal blend mode. For Canvas and WebGL.\r\n * This is the default setting and draws new shapes on top of the existing canvas content.\r\n *\r\n * @name Phaser.BlendModes.NORMAL\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 26, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Normal blend mode. For Canvas and WebGL.\rThis is the default setting and draws new shapes on top of the existing canvas content.", "name": "NORMAL", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.NORMAL", "scope": "static", "___id": "T000002R032181", "___s": true }, { "comment": "/**\r\n * Add blend mode. For Canvas and WebGL.\r\n * Where both shapes overlap the color is determined by adding color values.\r\n *\r\n * @name Phaser.BlendModes.ADD\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 37, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Add blend mode. For Canvas and WebGL.\rWhere both shapes overlap the color is determined by adding color values.", "name": "ADD", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.ADD", "scope": "static", "___id": "T000002R032183", "___s": true }, { "comment": "/**\r\n * Multiply blend mode. For Canvas and WebGL.\r\n * The pixels are of the top layer are multiplied with the corresponding pixel of the bottom layer. A darker picture is the result.\r\n *\r\n * @name Phaser.BlendModes.MULTIPLY\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Multiply blend mode. For Canvas and WebGL.\rThe pixels are of the top layer are multiplied with the corresponding pixel of the bottom layer. A darker picture is the result.", "name": "MULTIPLY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.MULTIPLY", "scope": "static", "___id": "T000002R032185", "___s": true }, { "comment": "/**\r\n * Screen blend mode. For Canvas and WebGL.\r\n * The pixels are inverted, multiplied, and inverted again. A lighter picture is the result (opposite of multiply)\r\n *\r\n * @name Phaser.BlendModes.SCREEN\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 59, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Screen blend mode. For Canvas and WebGL.\rThe pixels are inverted, multiplied, and inverted again. A lighter picture is the result (opposite of multiply)", "name": "SCREEN", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.SCREEN", "scope": "static", "___id": "T000002R032187", "___s": true }, { "comment": "/**\r\n * Overlay blend mode. For Canvas only.\r\n * A combination of multiply and screen. Dark parts on the base layer become darker, and light parts become lighter.\r\n *\r\n * @name Phaser.BlendModes.OVERLAY\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 70, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Overlay blend mode. For Canvas only.\rA combination of multiply and screen. Dark parts on the base layer become darker, and light parts become lighter.", "name": "OVERLAY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.OVERLAY", "scope": "static", "___id": "T000002R032189", "___s": true }, { "comment": "/**\r\n * Darken blend mode. For Canvas only.\r\n * Retains the darkest pixels of both layers.\r\n *\r\n * @name Phaser.BlendModes.DARKEN\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Darken blend mode. For Canvas only.\rRetains the darkest pixels of both layers.", "name": "DARKEN", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.DARKEN", "scope": "static", "___id": "T000002R032191", "___s": true }, { "comment": "/**\r\n * Lighten blend mode. For Canvas only.\r\n * Retains the lightest pixels of both layers.\r\n *\r\n * @name Phaser.BlendModes.LIGHTEN\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Lighten blend mode. For Canvas only.\rRetains the lightest pixels of both layers.", "name": "LIGHTEN", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.LIGHTEN", "scope": "static", "___id": "T000002R032193", "___s": true }, { "comment": "/**\r\n * Color Dodge blend mode. For Canvas only.\r\n * Divides the bottom layer by the inverted top layer.\r\n *\r\n * @name Phaser.BlendModes.COLOR_DODGE\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Color Dodge blend mode. For Canvas only.\rDivides the bottom layer by the inverted top layer.", "name": "COLOR_DODGE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.COLOR_DODGE", "scope": "static", "___id": "T000002R032195", "___s": true }, { "comment": "/**\r\n * Color Burn blend mode. For Canvas only.\r\n * Divides the inverted bottom layer by the top layer, and then inverts the result.\r\n *\r\n * @name Phaser.BlendModes.COLOR_BURN\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 114, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Color Burn blend mode. For Canvas only.\rDivides the inverted bottom layer by the top layer, and then inverts the result.", "name": "COLOR_BURN", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.COLOR_BURN", "scope": "static", "___id": "T000002R032197", "___s": true }, { "comment": "/**\r\n * Hard Light blend mode. For Canvas only.\r\n * A combination of multiply and screen like overlay, but with top and bottom layer swapped.\r\n *\r\n * @name Phaser.BlendModes.HARD_LIGHT\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 125, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Hard Light blend mode. For Canvas only.\rA combination of multiply and screen like overlay, but with top and bottom layer swapped.", "name": "HARD_LIGHT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.HARD_LIGHT", "scope": "static", "___id": "T000002R032199", "___s": true }, { "comment": "/**\r\n * Soft Light blend mode. For Canvas only.\r\n * A softer version of hard-light. Pure black or white does not result in pure black or white.\r\n *\r\n * @name Phaser.BlendModes.SOFT_LIGHT\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 136, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Soft Light blend mode. For Canvas only.\rA softer version of hard-light. Pure black or white does not result in pure black or white.", "name": "SOFT_LIGHT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.SOFT_LIGHT", "scope": "static", "___id": "T000002R032201", "___s": true }, { "comment": "/**\r\n * Difference blend mode. For Canvas only.\r\n * Subtracts the bottom layer from the top layer or the other way round to always get a positive value.\r\n *\r\n * @name Phaser.BlendModes.DIFFERENCE\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 147, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Difference blend mode. For Canvas only.\rSubtracts the bottom layer from the top layer or the other way round to always get a positive value.", "name": "DIFFERENCE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.DIFFERENCE", "scope": "static", "___id": "T000002R032203", "___s": true }, { "comment": "/**\r\n * Exclusion blend mode. For Canvas only.\r\n * Like difference, but with lower contrast.\r\n *\r\n * @name Phaser.BlendModes.EXCLUSION\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Exclusion blend mode. For Canvas only.\rLike difference, but with lower contrast.", "name": "EXCLUSION", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.EXCLUSION", "scope": "static", "___id": "T000002R032205", "___s": true }, { "comment": "/**\r\n * Hue blend mode. For Canvas only.\r\n * Preserves the luma and chroma of the bottom layer, while adopting the hue of the top layer.\r\n *\r\n * @name Phaser.BlendModes.HUE\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 169, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Hue blend mode. For Canvas only.\rPreserves the luma and chroma of the bottom layer, while adopting the hue of the top layer.", "name": "HUE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.HUE", "scope": "static", "___id": "T000002R032207", "___s": true }, { "comment": "/**\r\n * Saturation blend mode. For Canvas only.\r\n * Preserves the luma and hue of the bottom layer, while adopting the chroma of the top layer.\r\n *\r\n * @name Phaser.BlendModes.SATURATION\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 180, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Saturation blend mode. For Canvas only.\rPreserves the luma and hue of the bottom layer, while adopting the chroma of the top layer.", "name": "SATURATION", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.SATURATION", "scope": "static", "___id": "T000002R032209", "___s": true }, { "comment": "/**\r\n * Color blend mode. For Canvas only.\r\n * Preserves the luma of the bottom layer, while adopting the hue and chroma of the top layer.\r\n *\r\n * @name Phaser.BlendModes.COLOR\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Color blend mode. For Canvas only.\rPreserves the luma of the bottom layer, while adopting the hue and chroma of the top layer.", "name": "COLOR", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.COLOR", "scope": "static", "___id": "T000002R032211", "___s": true }, { "comment": "/**\r\n * Luminosity blend mode. For Canvas only.\r\n * Preserves the hue and chroma of the bottom layer, while adopting the luma of the top layer.\r\n *\r\n * @name Phaser.BlendModes.LUMINOSITY\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 202, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Luminosity blend mode. For Canvas only.\rPreserves the hue and chroma of the bottom layer, while adopting the luma of the top layer.", "name": "LUMINOSITY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.LUMINOSITY", "scope": "static", "___id": "T000002R032213", "___s": true }, { "comment": "/**\r\n * Alpha erase blend mode. For Canvas and WebGL.\r\n *\r\n * @name Phaser.BlendModes.ERASE\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 213, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Alpha erase blend mode. For Canvas and WebGL.", "name": "ERASE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.ERASE", "scope": "static", "___id": "T000002R032215", "___s": true }, { "comment": "/**\r\n * Source-in blend mode. For Canvas only.\r\n * The new shape is drawn only where both the new shape and the destination canvas overlap. Everything else is made transparent.\r\n *\r\n * @name Phaser.BlendModes.SOURCE_IN\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 223, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Source-in blend mode. For Canvas only.\rThe new shape is drawn only where both the new shape and the destination canvas overlap. Everything else is made transparent.", "name": "SOURCE_IN", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.SOURCE_IN", "scope": "static", "___id": "T000002R032217", "___s": true }, { "comment": "/**\r\n * Source-out blend mode. For Canvas only.\r\n * The new shape is drawn where it doesn't overlap the existing canvas content.\r\n *\r\n * @name Phaser.BlendModes.SOURCE_OUT\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Source-out blend mode. For Canvas only.\rThe new shape is drawn where it doesn't overlap the existing canvas content.", "name": "SOURCE_OUT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.SOURCE_OUT", "scope": "static", "___id": "T000002R032219", "___s": true }, { "comment": "/**\r\n * Source-out blend mode. For Canvas only.\r\n * The new shape is only drawn where it overlaps the existing canvas content.\r\n *\r\n * @name Phaser.BlendModes.SOURCE_ATOP\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Source-out blend mode. For Canvas only.\rThe new shape is only drawn where it overlaps the existing canvas content.", "name": "SOURCE_ATOP", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.SOURCE_ATOP", "scope": "static", "___id": "T000002R032221", "___s": true }, { "comment": "/**\r\n * Destination-over blend mode. For Canvas only.\r\n * New shapes are drawn behind the existing canvas content.\r\n *\r\n * @name Phaser.BlendModes.DESTINATION_OVER\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 256, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Destination-over blend mode. For Canvas only.\rNew shapes are drawn behind the existing canvas content.", "name": "DESTINATION_OVER", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.DESTINATION_OVER", "scope": "static", "___id": "T000002R032223", "___s": true }, { "comment": "/**\r\n * Destination-in blend mode. For Canvas only.\r\n * The existing canvas content is kept where both the new shape and existing canvas content overlap. Everything else is made transparent.\r\n *\r\n * @name Phaser.BlendModes.DESTINATION_IN\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 267, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Destination-in blend mode. For Canvas only.\rThe existing canvas content is kept where both the new shape and existing canvas content overlap. Everything else is made transparent.", "name": "DESTINATION_IN", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.DESTINATION_IN", "scope": "static", "___id": "T000002R032225", "___s": true }, { "comment": "/**\r\n * Destination-out blend mode. For Canvas only.\r\n * The existing content is kept where it doesn't overlap the new shape.\r\n *\r\n * @name Phaser.BlendModes.DESTINATION_OUT\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 278, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Destination-out blend mode. For Canvas only.\rThe existing content is kept where it doesn't overlap the new shape.", "name": "DESTINATION_OUT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.DESTINATION_OUT", "scope": "static", "___id": "T000002R032227", "___s": true }, { "comment": "/**\r\n * Destination-out blend mode. For Canvas only.\r\n * The existing canvas is only kept where it overlaps the new shape. The new shape is drawn behind the canvas content.\r\n *\r\n * @name Phaser.BlendModes.DESTINATION_ATOP\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Destination-out blend mode. For Canvas only.\rThe existing canvas is only kept where it overlaps the new shape. The new shape is drawn behind the canvas content.", "name": "DESTINATION_ATOP", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.DESTINATION_ATOP", "scope": "static", "___id": "T000002R032229", "___s": true }, { "comment": "/**\r\n * Lighten blend mode. For Canvas only.\r\n * Where both shapes overlap the color is determined by adding color values.\r\n *\r\n * @name Phaser.BlendModes.LIGHTER\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 300, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Lighten blend mode. For Canvas only.\rWhere both shapes overlap the color is determined by adding color values.", "name": "LIGHTER", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.LIGHTER", "scope": "static", "___id": "T000002R032231", "___s": true }, { "comment": "/**\r\n * Copy blend mode. For Canvas only.\r\n * Only the new shape is shown.\r\n *\r\n * @name Phaser.BlendModes.COPY\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 311, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Copy blend mode. For Canvas only.\rOnly the new shape is shown.", "name": "COPY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.COPY", "scope": "static", "___id": "T000002R032233", "___s": true }, { "comment": "/**\r\n * Xor blend mode. For Canvas only.\r\n * Shapes are made transparent where both overlap and drawn normal everywhere else.\r\n *\r\n * @name Phaser.BlendModes.XOR\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendModes.js", "lineno": 322, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Xor blend mode. For Canvas only.\rShapes are made transparent where both overlap and drawn normal everywhere else.", "name": "XOR", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.BlendModes", "longname": "Phaser.BlendModes.XOR", "scope": "static", "___id": "T000002R032235", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Canvas Renderer is responsible for managing 2D canvas rendering contexts,\r\n * including the one used by the Games canvas. It tracks the internal state of a\r\n * given context and can renderer textured Game Objects to it, taking into\r\n * account alpha, blending, and scaling.\r\n *\r\n * @class CanvasRenderer\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Renderer.Canvas\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - The Phaser Game instance that owns this renderer.\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "classdesc": "The Canvas Renderer is responsible for managing 2D canvas rendering contexts,\rincluding the one used by the Games canvas. It tracks the internal state of a\rgiven context and can renderer textured Game Objects to it, taking into\raccount alpha, blending, and scaling.", "kind": "class", "name": "CanvasRenderer", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Renderer.Canvas", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "The Phaser Game instance that owns this renderer.", "name": "game" } ], "scope": "static", "longname": "Phaser.Renderer.Canvas.CanvasRenderer", "___id": "T000002R032247", "___s": true }, { "comment": "/**\r\n * The local configuration settings of the CanvasRenderer.\r\n *\r\n * @name Phaser.Renderer.Canvas.CanvasRenderer#config\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 46, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "The local configuration settings of the CanvasRenderer.", "name": "config", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#config", "scope": "instance", "kind": "member", "___id": "T000002R032252", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance that owns this renderer.\r\n *\r\n * @name Phaser.Renderer.Canvas.CanvasRenderer#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "The Phaser Game instance that owns this renderer.", "name": "game", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#game", "scope": "instance", "kind": "member", "___id": "T000002R032258", "___s": true }, { "comment": "/**\r\n * A constant which allows the renderer to be easily identified as a Canvas Renderer.\r\n *\r\n * @name Phaser.Renderer.Canvas.CanvasRenderer#type\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 69, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "A constant which allows the renderer to be easily identified as a Canvas Renderer.", "name": "type", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#type", "scope": "instance", "kind": "member", "___id": "T000002R032260", "___s": true }, { "comment": "/**\r\n * The total number of Game Objects which were rendered in a frame.\r\n *\r\n * @name Phaser.Renderer.Canvas.CanvasRenderer#drawCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 78, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "The total number of Game Objects which were rendered in a frame.", "name": "drawCount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#drawCount", "scope": "instance", "kind": "member", "___id": "T000002R032262", "___s": true }, { "comment": "/**\r\n * The width of the canvas being rendered to.\r\n *\r\n * @name Phaser.Renderer.Canvas.CanvasRenderer#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "The width of the canvas being rendered to.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#width", "scope": "instance", "kind": "member", "___id": "T000002R032264", "___s": true }, { "comment": "/**\r\n * The height of the canvas being rendered to.\r\n *\r\n * @name Phaser.Renderer.Canvas.CanvasRenderer#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "The height of the canvas being rendered to.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#height", "scope": "instance", "kind": "member", "___id": "T000002R032266", "___s": true }, { "comment": "/**\r\n * The canvas element which the Game uses.\r\n *\r\n * @name Phaser.Renderer.Canvas.CanvasRenderer#gameCanvas\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 106, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "The canvas element which the Game uses.", "name": "gameCanvas", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#gameCanvas", "scope": "instance", "kind": "member", "___id": "T000002R032268", "___s": true }, { "comment": "/**\r\n * The canvas context used to render all Cameras in all Scenes during the game loop.\r\n *\r\n * @name Phaser.Renderer.Canvas.CanvasRenderer#gameContext\r\n * @type {CanvasRenderingContext2D}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 121, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "The canvas context used to render all Cameras in all Scenes during the game loop.", "name": "gameContext", "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#gameContext", "scope": "instance", "kind": "member", "___id": "T000002R032274", "___s": true }, { "comment": "/**\r\n * The canvas context currently used by the CanvasRenderer for all rendering operations.\r\n *\r\n * @name Phaser.Renderer.Canvas.CanvasRenderer#currentContext\r\n * @type {CanvasRenderingContext2D}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "The canvas context currently used by the CanvasRenderer for all rendering operations.", "name": "currentContext", "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#currentContext", "scope": "instance", "kind": "member", "___id": "T000002R032276", "___s": true }, { "comment": "/**\r\n * Should the Canvas use Image Smoothing or not when drawing Sprites?\r\n *\r\n * @name Phaser.Renderer.Canvas.CanvasRenderer#antialias\r\n * @type {boolean}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Should the Canvas use Image Smoothing or not when drawing Sprites?", "name": "antialias", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.20.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#antialias", "scope": "instance", "kind": "member", "___id": "T000002R032278", "___s": true }, { "comment": "/**\r\n * The blend modes supported by the Canvas Renderer.\r\n *\r\n * This object maps the {@link Phaser.BlendModes} to canvas compositing operations.\r\n *\r\n * @name Phaser.Renderer.Canvas.CanvasRenderer#blendModes\r\n * @type {array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "The blend modes supported by the Canvas Renderer.\r\rThis object maps the {@link Phaser.BlendModes} to canvas compositing operations.", "name": "blendModes", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#blendModes", "scope": "instance", "kind": "member", "___id": "T000002R032280", "___s": true }, { "comment": "/**\r\n * Details about the currently scheduled snapshot.\r\n *\r\n * If a non-null `callback` is set in this object, a snapshot of the canvas will be taken after the current frame is fully rendered.\r\n *\r\n * @name Phaser.Renderer.Canvas.CanvasRenderer#snapshotState\r\n * @type {Phaser.Types.Renderer.Snapshot.SnapshotState}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Details about the currently scheduled snapshot.\r\rIf a non-null `callback` is set in this object, a snapshot of the canvas will be taken after the current frame is fully rendered.", "name": "snapshotState", "type": { "names": [ "Phaser.Types.Renderer.Snapshot.SnapshotState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.Snapshot.SnapshotState" } }, "since": "3.16.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#snapshotState", "scope": "instance", "kind": "member", "___id": "T000002R032282", "___s": true }, { "comment": "/**\r\n * Has this renderer fully booted yet?\r\n *\r\n * @name Phaser.Renderer.Canvas.CanvasRenderer#isBooted\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 209, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Has this renderer fully booted yet?", "name": "isBooted", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#isBooted", "scope": "instance", "kind": "member", "___id": "T000002R032298", "___s": true }, { "comment": "/**\r\n * Prepares the game canvas for rendering.\r\n *\r\n * @method Phaser.Renderer.Canvas.CanvasRenderer#init\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 221, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Prepares the game canvas for rendering.", "kind": "function", "name": "init", "since": "3.0.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#init", "scope": "instance", "___id": "T000002R032300", "___s": true }, { "comment": "/**\r\n * The event handler that manages the `resize` event dispatched by the Scale Manager.\r\n *\r\n * @method Phaser.Renderer.Canvas.CanvasRenderer#onResize\r\n * @since 3.16.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 multiplied by the resolution. The canvas width / height values match this.\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "The event handler that manages the `resize` event dispatched by the Scale Manager.", "kind": "function", "name": "onResize", "since": "3.16.0", "params": [ { "type": { "names": [ "Phaser.Structs.Size" ], "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 multiplied by the resolution. The canvas width / height values match this.", "name": "baseSize" } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#onResize", "scope": "instance", "___id": "T000002R032309", "___s": true }, { "comment": "/**\r\n * Resize the main game canvas.\r\n *\r\n * @method Phaser.Renderer.Canvas.CanvasRenderer#resize\r\n * @fires Phaser.Renderer.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} [width] - The new width of the renderer.\r\n * @param {number} [height] - The new height of the renderer.\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 273, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Resize the main game canvas.", "kind": "function", "name": "resize", "fires": [ "Phaser.Renderer.Events#event:RESIZE" ], "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The new width of the renderer.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The new height of the renderer.", "name": "height" } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#resize", "scope": "instance", "___id": "T000002R032311", "___s": true }, { "comment": "/**\r\n * Resets the transformation matrix of the current context to the identity matrix, thus resetting any transformation.\r\n *\r\n * @method Phaser.Renderer.Canvas.CanvasRenderer#resetTransform\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 291, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Resets the transformation matrix of the current context to the identity matrix, thus resetting any transformation.", "kind": "function", "name": "resetTransform", "since": "3.0.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#resetTransform", "scope": "instance", "___id": "T000002R032315", "___s": true }, { "comment": "/**\r\n * Sets the blend mode (compositing operation) of the current context.\r\n *\r\n * @method Phaser.Renderer.Canvas.CanvasRenderer#setBlendMode\r\n * @since 3.0.0\r\n *\r\n * @param {string} blendMode - The new blend mode which should be used.\r\n *\r\n * @return {this} This CanvasRenderer object.\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 302, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Sets the blend mode (compositing operation) of the current context.", "kind": "function", "name": "setBlendMode", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The new blend mode which should be used.", "name": "blendMode" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This CanvasRenderer object." } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#setBlendMode", "scope": "instance", "___id": "T000002R032317", "___s": true }, { "comment": "/**\r\n * Changes the Canvas Rendering Context that all draw operations are performed against.\r\n *\r\n * @method Phaser.Renderer.Canvas.CanvasRenderer#setContext\r\n * @since 3.12.0\r\n *\r\n * @param {?CanvasRenderingContext2D} [ctx] - The new Canvas Rendering Context to draw everything to. Leave empty to reset to the Game Canvas.\r\n *\r\n * @return {this} The Canvas Renderer instance.\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 319, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Changes the Canvas Rendering Context that all draw operations are performed against.", "kind": "function", "name": "setContext", "since": "3.12.0", "params": [ { "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D", "nullable": true } }, "optional": true, "nullable": true, "description": "The new Canvas Rendering Context to draw everything to. Leave empty to reset to the Game Canvas.", "name": "ctx" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Canvas Renderer instance." } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#setContext", "scope": "instance", "___id": "T000002R032320", "___s": true }, { "comment": "/**\r\n * Sets the global alpha of the current context.\r\n *\r\n * @method Phaser.Renderer.Canvas.CanvasRenderer#setAlpha\r\n * @since 3.0.0\r\n *\r\n * @param {number} alpha - The new alpha to use, where 0 is fully transparent and 1 is fully opaque.\r\n *\r\n * @return {this} This CanvasRenderer object.\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 336, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Sets the global alpha of the current context.", "kind": "function", "name": "setAlpha", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new alpha to use, where 0 is fully transparent and 1 is fully opaque.", "name": "alpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This CanvasRenderer object." } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#setAlpha", "scope": "instance", "___id": "T000002R032323", "___s": true }, { "comment": "/**\r\n * Called at the start of the render loop.\r\n *\r\n * @method Phaser.Renderer.Canvas.CanvasRenderer#preRender\r\n * @fires Phaser.Renderer.Events#PRE_RENDER\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Called at the start of the render loop.", "kind": "function", "name": "preRender", "fires": [ "Phaser.Renderer.Events#event:PRE_RENDER" ], "since": "3.0.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#preRender", "scope": "instance", "___id": "T000002R032326", "___s": true }, { "comment": "/**\r\n * The core render step for a Scene Camera.\r\n *\r\n * Iterates through the given array of Game Objects and renders them with the given Camera.\r\n *\r\n * This is called by the `CameraManager.render` method. The Camera Manager instance belongs to a Scene, and is invoked\r\n * by the Scene Systems.render method.\r\n *\r\n * This method is not called if `Camera.visible` is `false`, or `Camera.alpha` is zero.\r\n *\r\n * @method Phaser.Renderer.Canvas.CanvasRenderer#render\r\n * @fires Phaser.Renderer.Events#RENDER\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to render.\r\n * @param {Phaser.GameObjects.GameObject[]} children - An array of filtered Game Objects that can be rendered by the given Camera.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera to render with.\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 390, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "The core render step for a Scene Camera.\r\rIterates through the given array of Game Objects and renders them with the given Camera.\r\rThis is called by the `CameraManager.render` method. The Camera Manager instance belongs to a Scene, and is invoked\rby the Scene Systems.render method.\r\rThis method is not called if `Camera.visible` is `false`, or `Camera.alpha` is zero.", "kind": "function", "name": "render", "fires": [ "Phaser.Renderer.Events#event:RENDER" ], "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to render.", "name": "scene" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "An array of filtered Game Objects that can be rendered by the given Camera.", "name": "children" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera to render with.", "name": "camera" } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#render", "scope": "instance", "___id": "T000002R032336", "___s": true }, { "comment": "/**\r\n * Restores the game context's global settings and takes a snapshot if one is scheduled.\r\n *\r\n * The post-render step happens after all Cameras in all Scenes have been rendered.\r\n *\r\n * @method Phaser.Renderer.Canvas.CanvasRenderer#postRender\r\n * @fires Phaser.Renderer.Events#POST_RENDER\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 508, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Restores the game context's global settings and takes a snapshot if one is scheduled.\r\rThe post-render step happens after all Cameras in all Scenes have been rendered.", "kind": "function", "name": "postRender", "fires": [ "Phaser.Renderer.Events#event:POST_RENDER" ], "since": "3.0.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#postRender", "scope": "instance", "___id": "T000002R032355", "___s": true }, { "comment": "/**\r\n * Takes a snapshot of the given area of the given canvas.\r\n *\r\n * Unlike the other snapshot methods, this one is processed immediately and doesn't wait for the next render.\r\n *\r\n * Snapshots work by creating an Image object from the canvas data, this is a blocking process, which gets\r\n * more expensive the larger the canvas size gets, so please be careful how you employ this in your game.\r\n *\r\n * @method Phaser.Renderer.Canvas.CanvasRenderer#snapshotCanvas\r\n * @since 3.19.0\r\n *\r\n * @param {HTMLCanvasElement} canvas - The canvas to grab from.\r\n * @param {Phaser.Types.Renderer.Snapshot.SnapshotCallback} callback - The Function to invoke after the snapshot image is created.\r\n * @param {boolean} [getPixel=false] - Grab a single pixel as a Color object, or an area as an Image object?\r\n * @param {number} [x=0] - The x coordinate to grab from.\r\n * @param {number} [y=0] - The y coordinate to grab from.\r\n * @param {number} [width=canvas.width] - The width of the area to grab.\r\n * @param {number} [height=canvas.height] - The height of the area to grab.\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 Canvas Renderer.\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 535, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Takes a snapshot of the given area of the given canvas.\r\rUnlike the other snapshot methods, this one is processed immediately and doesn't wait for the next render.\r\rSnapshots work by creating an Image object from the canvas data, this is a blocking process, which gets\rmore expensive the larger the canvas size gets, so please be careful how you employ this in your game.", "kind": "function", "name": "snapshotCanvas", "since": "3.19.0", "params": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The canvas to grab from.", "name": "canvas" }, { "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": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Grab a single pixel as a Color object, or an area as an Image object?", "name": "getPixel" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate to grab from.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate to grab from.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "canvas.width", "description": "The width of the area to grab.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "canvas.height", "description": "The height of the area to grab.", "name": "height" }, { "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 Canvas Renderer." } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#snapshotCanvas", "scope": "instance", "___id": "T000002R032360", "___s": true }, { "comment": "/**\r\n * Schedules a snapshot of the entire game viewport to be taken after the current frame is rendered.\r\n *\r\n * To capture a specific area see the `snapshotArea` method. To capture a specific pixel, see `snapshotPixel`.\r\n *\r\n * Only one snapshot can be active _per frame_. If you have already called `snapshotPixel`, for example, then\r\n * calling this method will override it.\r\n *\r\n * Snapshots work by creating an Image object from the canvas data, this is a blocking process, which gets\r\n * more expensive the larger the canvas size gets, so please be careful how you employ this in your game.\r\n *\r\n * @method Phaser.Renderer.Canvas.CanvasRenderer#snapshot\r\n * @since 3.0.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 WebGL Renderer.\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 575, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Schedules a snapshot of the entire game viewport to be taken after the current frame is rendered.\r\rTo capture a specific area see the `snapshotArea` method. To capture a specific pixel, see `snapshotPixel`.\r\rOnly one snapshot can be active _per frame_. If you have already called `snapshotPixel`, for example, then\rcalling this method will override it.\r\rSnapshots work by creating an Image object from the canvas data, this is a blocking process, which gets\rmore expensive the larger the canvas size gets, so please be careful how you employ this in your game.", "kind": "function", "name": "snapshot", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.Snapshot.SnapshotCallback" ], "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 WebGL Renderer." } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#snapshot", "scope": "instance", "___id": "T000002R032366", "___s": true }, { "comment": "/**\r\n * Schedules a snapshot of the given area of the game viewport to be taken after the current frame is rendered.\r\n *\r\n * To capture the whole game viewport see the `snapshot` method. To capture a specific pixel, see `snapshotPixel`.\r\n *\r\n * Only one snapshot can be active _per frame_. If you have already called `snapshotPixel`, for example, then\r\n * calling this method will override it.\r\n *\r\n * Snapshots work by creating an Image object from the canvas data, this is a blocking process, which gets\r\n * more expensive the larger the canvas size gets, so please be careful how you employ this in your game.\r\n *\r\n * @method Phaser.Renderer.Canvas.CanvasRenderer#snapshotArea\r\n * @since 3.16.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 WebGL Renderer.\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 600, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Schedules a snapshot of the given area of the game viewport to be taken after the current frame is rendered.\r\rTo capture the whole game viewport see the `snapshot` method. To capture a specific pixel, see `snapshotPixel`.\r\rOnly one snapshot can be active _per frame_. If you have already called `snapshotPixel`, for example, then\rcalling this method will override it.\r\rSnapshots work by creating an Image object from the canvas data, this is a blocking process, which gets\rmore expensive the larger the canvas size gets, so please be careful how you employ this in your game.", "kind": "function", "name": "snapshotArea", "since": "3.16.0", "params": [ { "type": { "names": [ "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 WebGL Renderer." } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#snapshotArea", "scope": "instance", "___id": "T000002R032368", "___s": true }, { "comment": "/**\r\n * Schedules a snapshot of the given pixel from the game viewport to be taken after the current frame is rendered.\r\n *\r\n * To capture the whole game viewport see the `snapshot` method. To capture a specific area, see `snapshotArea`.\r\n *\r\n * Only one snapshot can be active _per frame_. If you have already called `snapshotArea`, for example, then\r\n * calling this method will override it.\r\n *\r\n * Unlike the other two snapshot methods, this one will return a `Color` object containing the color data for\r\n * the requested pixel. It doesn't need to create an internal Canvas or Image object, so is a lot faster to execute,\r\n * using less memory.\r\n *\r\n * @method Phaser.Renderer.Canvas.CanvasRenderer#snapshotPixel\r\n * @since 3.16.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 WebGL Renderer.\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 640, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Schedules a snapshot of the given pixel from the game viewport to be taken after the current frame is rendered.\r\rTo capture the whole game viewport see the `snapshot` method. To capture a specific area, see `snapshotArea`.\r\rOnly one snapshot can be active _per frame_. If you have already called `snapshotArea`, for example, then\rcalling this method will override it.\r\rUnlike the other two snapshot methods, this one will return a `Color` object containing the color data for\rthe requested pixel. It doesn't need to create an internal Canvas or Image object, so is a lot faster to execute,\rusing less memory.", "kind": "function", "name": "snapshotPixel", "since": "3.16.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 WebGL Renderer." } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#snapshotPixel", "scope": "instance", "___id": "T000002R032379", "___s": true }, { "comment": "/**\r\n * Takes a Sprite Game Object, or any object that extends it, and draws it to the current context.\r\n *\r\n * @method Phaser.Renderer.Canvas.CanvasRenderer#batchSprite\r\n * @since 3.12.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} sprite - The texture based Game Object to draw.\r\n * @param {Phaser.Textures.Frame} frame - The frame to draw, doesn't have to be that owned by the Game Object.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use for the rendering transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentTransformMatrix] - The transform matrix of the parent container, if set.\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 670, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Takes a Sprite Game Object, or any object that extends it, and draws it to the current context.", "kind": "function", "name": "batchSprite", "since": "3.12.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The texture based Game Object to draw.", "name": "sprite" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "description": "The frame to draw, doesn't have to be that owned by the Game Object.", "name": "frame" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use for the rendering transform.", "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 set.", "name": "parentTransformMatrix" } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#batchSprite", "scope": "instance", "___id": "T000002R032382", "___s": true }, { "comment": "/**\r\n * Destroys all object references in the Canvas Renderer.\r\n *\r\n * @method Phaser.Renderer.Canvas.CanvasRenderer#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasRenderer.js", "lineno": 844, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "description": "Destroys all object references in the Canvas Renderer.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#destroy", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#destroy", "___id": "T000002R032429", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Renderer.Canvas\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas", "code": {} }, "kind": "namespace", "name": "Canvas", "memberof": "Phaser.Renderer", "longname": "Phaser.Renderer.Canvas", "scope": "static", "___id": "T000002R032435", "___s": true }, { "comment": "/**\r\n * Returns an array which maps the default blend modes to supported Canvas blend modes.\r\n *\r\n * If the browser doesn't support a blend mode, it will default to the normal `source-over` blend mode.\r\n *\r\n * @function Phaser.Renderer.Canvas.GetBlendModes\r\n * @since 3.0.0\r\n *\r\n * @return {array} Which Canvas blend mode corresponds to which default Phaser blend mode.\r\n */", "meta": { "filename": "GetBlendModes.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas\\utils", "code": {} }, "description": "Returns an array which maps the default blend modes to supported Canvas blend modes.\r\rIf the browser doesn't support a blend mode, it will default to the normal `source-over` blend mode.", "kind": "function", "name": "GetBlendModes", "since": "3.0.0", "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "Which Canvas blend mode corresponds to which default Phaser blend mode." } ], "memberof": "Phaser.Renderer.Canvas", "longname": "Phaser.Renderer.Canvas.GetBlendModes", "scope": "static", "___id": "T000002R032442", "___s": true }, { "comment": "/**\r\n * Takes a reference to the Canvas Renderer, a Canvas Rendering Context, a Game Object, a Camera and a parent matrix\r\n * and then performs the following steps:\r\n *\r\n * 1. Checks the alpha of the source combined with the Camera alpha. If 0 or less it aborts.\r\n * 2. Takes the Camera and Game Object matrix and multiplies them, combined with the parent matrix if given.\r\n * 3. Sets the blend mode of the context to be that used by the Game Object.\r\n * 4. Sets the alpha value of the context to be that used by the Game Object combined with the Camera.\r\n * 5. Saves the context state.\r\n * 6. Sets the final matrix values into the context via setTransform.\r\n * 7. If the Game Object has a texture frame, imageSmoothingEnabled is set based on frame.source.scaleMode.\r\n * 8. If the Game Object does not have a texture frame, imageSmoothingEnabled is set based on Renderer.antialias.\r\n *\r\n * This function is only meant to be used internally. Most of the Canvas Renderer classes use it.\r\n *\r\n * @function Phaser.Renderer.Canvas.SetTransform\r\n * @since 3.12.0\r\n *\r\n * @param {Phaser.Renderer.Canvas.CanvasRenderer} renderer - A reference to the current active Canvas renderer.\r\n * @param {CanvasRenderingContext2D} ctx - The canvas context to set the transform on.\r\n * @param {Phaser.GameObjects.GameObject} src - The Game Object being rendered. Can be any type that extends the base class.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that is rendering the Game Object.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentMatrix] - A parent transform matrix to apply to the Game Object before rendering.\r\n *\r\n * @return {boolean} `true` if the Game Object context was set, otherwise `false`.\r\n */", "meta": { "filename": "SetTransform.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\canvas\\utils", "code": {} }, "description": "Takes a reference to the Canvas Renderer, a Canvas Rendering Context, a Game Object, a Camera and a parent matrix\rand then performs the following steps:\r\r1. Checks the alpha of the source combined with the Camera alpha. If 0 or less it aborts.\r2. Takes the Camera and Game Object matrix and multiplies them, combined with the parent matrix if given.\r3. Sets the blend mode of the context to be that used by the Game Object.\r4. Sets the alpha value of the context to be that used by the Game Object combined with the Camera.\r5. Saves the context state.\r6. Sets the final matrix values into the context via setTransform.\r7. If the Game Object has a texture frame, imageSmoothingEnabled is set based on frame.source.scaleMode.\r8. If the Game Object does not have a texture frame, imageSmoothingEnabled is set based on Renderer.antialias.\r\rThis function is only meant to be used internally. Most of the Canvas Renderer classes use it.", "kind": "function", "name": "SetTransform", "since": "3.12.0", "params": [ { "type": { "names": [ "Phaser.Renderer.Canvas.CanvasRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.Canvas.CanvasRenderer" } }, "description": "A reference to the current active Canvas renderer.", "name": "renderer" }, { "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "description": "The canvas context to set the transform on.", "name": "ctx" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered. Can be any type that extends the base class.", "name": "src" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera that is rendering the Game Object.", "name": "camera" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "A parent transform matrix to apply to the Game Object before rendering.", "name": "parentMatrix" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Game Object context was set, otherwise `false`." } ], "memberof": "Phaser.Renderer.Canvas", "longname": "Phaser.Renderer.Canvas.SetTransform", "scope": "static", "___id": "T000002R032477", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Renderer.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Renderer", "longname": "Phaser.Renderer.Events", "scope": "static", "___id": "T000002R032485", "___s": true }, { "comment": "/**\r\n * The Post-Render Event.\r\n *\r\n * This event is dispatched by the Renderer when all rendering, for all cameras in all Scenes,\r\n * has completed, but before any pending snap shots have been taken.\r\n *\r\n * @event Phaser.Renderer.Events#POST_RENDER\r\n * @type {string}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "POST_RENDER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\events", "code": {} }, "description": "The Post-Render Event.\r\rThis event is dispatched by the Renderer when all rendering, for all cameras in all Scenes,\rhas completed, but before any pending snap shots have been taken.", "kind": "event", "name": "POST_RENDER", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.Events", "longname": "Phaser.Renderer.Events#event:POST_RENDER", "scope": "instance", "___id": "T000002R032491", "___s": true }, { "comment": "/**\r\n * The Pre-Render Event.\r\n *\r\n * This event is dispatched by the Phaser Renderer. This happens right at the start of the render\r\n * process, after the context has been cleared, the scissors enabled (WebGL only) and everything has been\r\n * reset ready for the render.\r\n *\r\n * @event Phaser.Renderer.Events#PRE_RENDER\r\n * @type {string}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PRE_RENDER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\events", "code": {} }, "description": "The Pre-Render Event.\r\rThis event is dispatched by the Phaser Renderer. This happens right at the start of the render\rprocess, after the context has been cleared, the scissors enabled (WebGL only) and everything has been\rreset ready for the render.", "kind": "event", "name": "PRE_RENDER", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.Events", "longname": "Phaser.Renderer.Events#event:PRE_RENDER", "scope": "instance", "___id": "T000002R032493", "___s": true }, { "comment": "/**\r\n * The Render Event.\r\n *\r\n * This event is dispatched by the Phaser Renderer for every camera in every Scene.\r\n *\r\n * It is dispatched before any of the children in the Scene have been rendered.\r\n *\r\n * @event Phaser.Renderer.Events#RENDER\r\n * @type {string}\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered.\r\n */", "meta": { "filename": "RENDER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\events", "code": {} }, "description": "The Render Event.\r\rThis event is dispatched by the Phaser Renderer for every camera in every Scene.\r\rIt is dispatched before any of the children in the Scene have been rendered.", "kind": "event", "name": "RENDER", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered.", "name": "camera" } ], "memberof": "Phaser.Renderer.Events", "longname": "Phaser.Renderer.Events#event:RENDER", "scope": "instance", "___id": "T000002R032495", "___s": true }, { "comment": "/**\r\n * The Renderer Resize Event.\r\n *\r\n * This event is dispatched by the Phaser Renderer when it is resized, usually as a result\r\n * of the Scale Manager resizing.\r\n *\r\n * @event Phaser.Renderer.Events#RESIZE\r\n * @type {string}\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of the renderer.\r\n * @param {number} height - The new height of the renderer.\r\n */", "meta": { "filename": "RESIZE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\events", "code": {} }, "description": "The Renderer Resize Event.\r\rThis event is dispatched by the Phaser Renderer when it is resized, usually as a result\rof the Scale Manager resizing.", "kind": "event", "name": "RESIZE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the renderer.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of the renderer.", "name": "height" } ], "memberof": "Phaser.Renderer.Events", "longname": "Phaser.Renderer.Events#event:RESIZE", "scope": "instance", "___id": "T000002R032497", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Renderer\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "kind": "namespace", "name": "Renderer", "memberof": "Phaser", "longname": "Phaser.Renderer", "scope": "static", "___id": "T000002R032499", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Renderer\r\n */", "meta": { "filename": "index.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "kind": "namespace", "name": "Renderer", "memberof": "Phaser.Types", "longname": "Phaser.Types.Renderer", "scope": "static", "___id": "T000002R032500", "___s": true }, { "comment": "/**\r\n * Phaser Scale Modes.\r\n *\r\n * @namespace Phaser.ScaleModes\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ScaleModes.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Phaser Scale Modes.", "kind": "namespace", "name": "ScaleModes", "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.ScaleModes", "scope": "static", "___id": "T000002R032506", "___s": true }, { "comment": "/**\r\n * Default Scale Mode (Linear).\r\n *\r\n * @name Phaser.ScaleModes.DEFAULT\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ScaleModes.js", "lineno": 16, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Default Scale Mode (Linear).", "name": "DEFAULT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.ScaleModes", "longname": "Phaser.ScaleModes.DEFAULT", "scope": "static", "kind": "member", "___id": "T000002R032508", "___s": true }, { "comment": "/**\r\n * Linear Scale Mode.\r\n *\r\n * @name Phaser.ScaleModes.LINEAR\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ScaleModes.js", "lineno": 26, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Linear Scale Mode.", "name": "LINEAR", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.ScaleModes", "longname": "Phaser.ScaleModes.LINEAR", "scope": "static", "kind": "member", "___id": "T000002R032510", "___s": true }, { "comment": "/**\r\n * Nearest Scale Mode.\r\n *\r\n * @name Phaser.ScaleModes.NEAREST\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ScaleModes.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer", "code": {} }, "description": "Nearest Scale Mode.", "name": "NEAREST", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.ScaleModes", "longname": "Phaser.ScaleModes.NEAREST", "scope": "static", "kind": "member", "___id": "T000002R032512", "___s": true }, { "comment": "/**\r\n * Takes a snapshot of an area from the current frame displayed by a canvas.\r\n *\r\n * This is then copied to an Image object. When this loads, the results are sent\r\n * to the callback provided in the Snapshot Configuration object.\r\n *\r\n * @function Phaser.Renderer.Snapshot.Canvas\r\n * @since 3.0.0\r\n *\r\n * @param {HTMLCanvasElement} sourceCanvas - The canvas to take a snapshot of.\r\n * @param {Phaser.Types.Renderer.Snapshot.SnapshotState} config - The snapshot configuration object.\r\n */", "meta": { "filename": "CanvasSnapshot.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\snapshot", "code": {} }, "description": "Takes a snapshot of an area from the current frame displayed by a canvas.\r\rThis is then copied to an Image object. When this loads, the results are sent\rto the callback provided in the Snapshot Configuration object.", "kind": "function", "name": "Canvas", "since": "3.0.0", "params": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The canvas to take a snapshot of.", "name": "sourceCanvas" }, { "type": { "names": [ "Phaser.Types.Renderer.Snapshot.SnapshotState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.Snapshot.SnapshotState" } }, "description": "The snapshot configuration object.", "name": "config" } ], "memberof": "Phaser.Renderer.Snapshot", "longname": "Phaser.Renderer.Snapshot.Canvas", "scope": "static", "___id": "T000002R032518", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Renderer.Snapshot\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\snapshot", "code": {} }, "kind": "namespace", "name": "Snapshot", "memberof": "Phaser.Renderer", "longname": "Phaser.Renderer.Snapshot", "scope": "static", "___id": "T000002R032544", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Renderer.Snapshot\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\snapshot\\typedefs", "code": {} }, "kind": "namespace", "name": "Snapshot", "memberof": "Phaser.Types.Renderer", "longname": "Phaser.Types.Renderer.Snapshot", "scope": "static", "___id": "T000002R032548", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Renderer.Snapshot.SnapshotCallback\r\n * @since 3.16.1\r\n *\r\n * @param {(Phaser.Display.Color|HTMLImageElement)} snapshot - Either a Color object if a single pixel is being grabbed, or a new Image which contains a snapshot of the canvas contents.\r\n */", "meta": { "filename": "SnapshotCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\snapshot\\typedefs", "code": {} }, "kind": "typedef", "name": "SnapshotCallback", "type": { "names": [ "function" ] }, "since": "3.16.1", "params": [ { "type": { "names": [ "Phaser.Display.Color", "HTMLImageElement" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Color" }, { "type": "NameExpression", "name": "HTMLImageElement" } ] } }, "description": "Either a Color object if a single pixel is being grabbed, or a new Image which contains a snapshot of the canvas contents.", "name": "snapshot" } ], "memberof": "Phaser.Types.Renderer.Snapshot", "longname": "Phaser.Types.Renderer.Snapshot.SnapshotCallback", "scope": "static", "___id": "T000002R032549", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Renderer.Snapshot.SnapshotState\r\n * @since 3.16.1\r\n *\r\n * @property {Phaser.Types.Renderer.Snapshot.SnapshotCallback} callback - The function to call after the snapshot is taken.\r\n * @property {string} [type='image/png'] - The format of the image to create, usually `image/png` or `image/jpeg`.\r\n * @property {number} [encoderOptions=0.92] - The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.\r\n * @property {number} [x=0] - The x coordinate to start the snapshot from.\r\n * @property {number} [y=0] - The y coordinate to start the snapshot from.\r\n * @property {number} [width] - The width of the snapshot.\r\n * @property {number} [height] - The height of the snapshot.\r\n * @property {boolean} [getPixel=false] - Is this a snapshot to get a single pixel, or an area?\r\n * @property {boolean} [isFramebuffer=false] - Is this snapshot grabbing from a frame buffer or a canvas?\r\n * @property {number} [bufferWidth] - The width of the frame buffer, if a frame buffer grab.\r\n * @property {number} [bufferHeight] - The height of the frame buffer, if a frame buffer grab.\r\n */", "meta": { "filename": "SnapshotState.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\snapshot\\typedefs", "code": {} }, "kind": "typedef", "name": "SnapshotState", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.16.1", "properties": [ { "type": { "names": [ "Phaser.Types.Renderer.Snapshot.SnapshotCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.Snapshot.SnapshotCallback" } }, "description": "The function to call after the snapshot is taken.", "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" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate to start the snapshot from.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate to start the snapshot from.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the snapshot.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the snapshot.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is this a snapshot to get a single pixel, or an area?", "name": "getPixel" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is this snapshot grabbing from a frame buffer or a canvas?", "name": "isFramebuffer" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the frame buffer, if a frame buffer grab.", "name": "bufferWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the frame buffer, if a frame buffer grab.", "name": "bufferHeight" } ], "memberof": "Phaser.Types.Renderer.Snapshot", "longname": "Phaser.Types.Renderer.Snapshot.SnapshotState", "scope": "static", "___id": "T000002R032550", "___s": true }, { "comment": "/**\r\n * Takes a snapshot of an area from the current frame displayed by a WebGL canvas.\r\n *\r\n * This is then copied to an Image object. When this loads, the results are sent\r\n * to the callback provided in the Snapshot Configuration object.\r\n *\r\n * @function Phaser.Renderer.Snapshot.WebGL\r\n * @since 3.0.0\r\n *\r\n * @param {WebGLRenderingContext} sourceContext - The WebGL context to take a snapshot of.\r\n * @param {Phaser.Types.Renderer.Snapshot.SnapshotState} config - The snapshot configuration object.\r\n */", "meta": { "filename": "WebGLSnapshot.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\snapshot", "code": {} }, "description": "Takes a snapshot of an area from the current frame displayed by a WebGL canvas.\r\rThis is then copied to an Image object. When this loads, the results are sent\rto the callback provided in the Snapshot Configuration object.", "kind": "function", "name": "WebGL", "since": "3.0.0", "params": [ { "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "description": "The WebGL context to take a snapshot of.", "name": "sourceContext" }, { "type": { "names": [ "Phaser.Types.Renderer.Snapshot.SnapshotState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.Snapshot.SnapshotState" } }, "description": "The snapshot configuration object.", "name": "config" } ], "memberof": "Phaser.Renderer.Snapshot", "longname": "Phaser.Renderer.Snapshot.WebGL", "scope": "static", "___id": "T000002R032554", "___s": true }, { "comment": "/**\r\n * \t8-bit twos complement signed integer.\r\n *\r\n * @name Phaser.Renderer.WebGL.BYTE\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLConst}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "const.js", "lineno": 9, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "8-bit twos complement signed integer.", "name": "BYTE", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLConst" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLConst" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL", "longname": "Phaser.Renderer.WebGL.BYTE", "scope": "static", "kind": "member", "___id": "T000002R032591", "___s": true }, { "comment": "/**\r\n * 8-bit twos complement unsigned integer.\r\n *\r\n * @name Phaser.Renderer.WebGL.UNSIGNED_BYTE\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLConst}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "const.js", "lineno": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "8-bit twos complement unsigned integer.", "name": "UNSIGNED_BYTE", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLConst" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLConst" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL", "longname": "Phaser.Renderer.WebGL.UNSIGNED_BYTE", "scope": "static", "kind": "member", "___id": "T000002R032595", "___s": true }, { "comment": "/**\r\n * 16-bit twos complement signed integer.\r\n *\r\n * @name Phaser.Renderer.WebGL.SHORT\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLConst}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "const.js", "lineno": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "16-bit twos complement signed integer.", "name": "SHORT", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLConst" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLConst" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL", "longname": "Phaser.Renderer.WebGL.SHORT", "scope": "static", "kind": "member", "___id": "T000002R032599", "___s": true }, { "comment": "/**\r\n * 16-bit twos complement unsigned integer.\r\n *\r\n * @name Phaser.Renderer.WebGL.UNSIGNED_SHORT\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLConst}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "const.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "16-bit twos complement unsigned integer.", "name": "UNSIGNED_SHORT", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLConst" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLConst" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL", "longname": "Phaser.Renderer.WebGL.UNSIGNED_SHORT", "scope": "static", "kind": "member", "___id": "T000002R032603", "___s": true }, { "comment": "/**\r\n * 32-bit twos complement signed integer.\r\n *\r\n * @name Phaser.Renderer.WebGL.INT\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLConst}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "const.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "32-bit twos complement signed integer.", "name": "INT", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLConst" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLConst" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL", "longname": "Phaser.Renderer.WebGL.INT", "scope": "static", "kind": "member", "___id": "T000002R032607", "___s": true }, { "comment": "/**\r\n * 32-bit twos complement unsigned integer.\r\n *\r\n * @name Phaser.Renderer.WebGL.UNSIGNED_INT\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLConst}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "const.js", "lineno": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "32-bit twos complement unsigned integer.", "name": "UNSIGNED_INT", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLConst" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLConst" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL", "longname": "Phaser.Renderer.WebGL.UNSIGNED_INT", "scope": "static", "kind": "member", "___id": "T000002R032611", "___s": true }, { "comment": "/**\r\n * 32-bit IEEE floating point number.\r\n *\r\n * @name Phaser.Renderer.WebGL.FLOAT\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLConst}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "const.js", "lineno": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "32-bit IEEE floating point number.", "name": "FLOAT", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLConst" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLConst" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL", "longname": "Phaser.Renderer.WebGL.FLOAT", "scope": "static", "kind": "member", "___id": "T000002R032615", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Renderer.WebGL\r\n */", "meta": { "filename": "index.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "kind": "namespace", "name": "WebGL", "memberof": "Phaser.Renderer", "longname": "Phaser.Renderer.WebGL", "scope": "static", "___id": "T000002R032622", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Pipeline Manager is responsible for the creation, activation, running and destruction\r\n * of WebGL Pipelines and Post FX Pipelines in Phaser 3.\r\n *\r\n * The `WebGLRenderer` owns a single instance of the Pipeline Manager, which you can access\r\n * via the `WebGLRenderer.pipelines` property.\r\n *\r\n * By default, there are 9 pipelines installed into the Pipeline Manager when Phaser boots:\r\n *\r\n * 1. The Multi Pipeline. Responsible for all multi-texture rendering, i.e. Sprites and Tilemaps.\r\n * 2. The Rope Pipeline. Responsible for rendering the Rope Game Object.\r\n * 3. The Light Pipeline. Responsible for rendering the Light Game Object.\r\n * 4. The Point Light Pipeline. Responsible for rendering the Point Light Game Object.\r\n * 5. The Single Pipeline. Responsible for rendering Game Objects that explicitly require one bound texture.\r\n * 6. The Bitmap Mask Pipeline. Responsible for Bitmap Mask rendering.\r\n * 7. The Utility Pipeline. Responsible for providing lots of handy texture manipulation functions.\r\n * 8. The Mobile Pipeline. Responsible for rendering on mobile with single-bound textures.\r\n * 9. The FX Pipeline. Responsible for rendering Game Objects with special FX applied to them.\r\n *\r\n * You can add your own custom pipeline via the `PipelineManager.add` method. Pipelines are\r\n * identified by unique string-based keys.\r\n *\r\n * @class PipelineManager\r\n * @memberof Phaser.Renderer.WebGL\r\n * @constructor\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - A reference to the WebGL Renderer that owns this Pipeline Manager.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 28, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "classdesc": "The Pipeline Manager is responsible for the creation, activation, running and destruction\rof WebGL Pipelines and Post FX Pipelines in Phaser 3.\r\rThe `WebGLRenderer` owns a single instance of the Pipeline Manager, which you can access\rvia the `WebGLRenderer.pipelines` property.\r\rBy default, there are 9 pipelines installed into the Pipeline Manager when Phaser boots:\r\r1. The Multi Pipeline. Responsible for all multi-texture rendering, i.e. Sprites and Tilemaps.\r2. The Rope Pipeline. Responsible for rendering the Rope Game Object.\r3. The Light Pipeline. Responsible for rendering the Light Game Object.\r4. The Point Light Pipeline. Responsible for rendering the Point Light Game Object.\r5. The Single Pipeline. Responsible for rendering Game Objects that explicitly require one bound texture.\r6. The Bitmap Mask Pipeline. Responsible for Bitmap Mask rendering.\r7. The Utility Pipeline. Responsible for providing lots of handy texture manipulation functions.\r8. The Mobile Pipeline. Responsible for rendering on mobile with single-bound textures.\r9. The FX Pipeline. Responsible for rendering Game Objects with special FX applied to them.\r\rYou can add your own custom pipeline via the `PipelineManager.add` method. Pipelines are\ridentified by unique string-based keys.", "kind": "class", "name": "PipelineManager", "memberof": "Phaser.Renderer.WebGL", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "description": "A reference to the WebGL Renderer that owns this Pipeline Manager.", "name": "renderer" } ], "scope": "static", "longname": "Phaser.Renderer.WebGL.PipelineManager", "___id": "T000002R032651", "___s": true }, { "comment": "/**\r\n * A reference to the Game instance.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#game\r\n * @type {Phaser.Game}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 64, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A reference to the Game instance.", "name": "game", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#game", "scope": "instance", "kind": "member", "___id": "T000002R032654", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Renderer instance.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A reference to the WebGL Renderer instance.", "name": "renderer", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#renderer", "scope": "instance", "kind": "member", "___id": "T000002R032656", "___s": true }, { "comment": "/**\r\n * This map stores all pipeline classes available in this manager.\r\n *\r\n * The Utility Class must always come first.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#classes\r\n * @type {Phaser.Structs.Map.}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This map stores all pipeline classes available in this manager.\r\rThe Utility Class must always come first.", "name": "classes", "type": { "names": [ "Phaser.Structs.Map." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.Map" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Class" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#classes", "scope": "instance", "kind": "member", "___id": "T000002R032658", "___s": true }, { "comment": "/**\r\n * This map stores all Post FX Pipeline classes available in this manager.\r\n *\r\n * As of v3.60 this is now populated by default with the following\r\n * Post FX Pipelines:\r\n *\r\n * * Barrel\r\n * * Bloom\r\n * * Blur\r\n * * Bokeh / TiltShift\r\n * * Circle\r\n * * ColorMatrix\r\n * * Displacement\r\n * * Glow\r\n * * Gradient\r\n * * Pixelate\r\n * * Shadow\r\n * * Shine\r\n * * Vignette\r\n * * Wipe\r\n *\r\n * See the FX Controller class for more details.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#postPipelineClasses\r\n * @type {Phaser.Structs.Map.}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 103, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This map stores all Post FX Pipeline classes available in this manager.\r\rAs of v3.60 this is now populated by default with the following\rPost FX Pipelines:\r\r* Barrel\r* Bloom\r* Blur\r* Bokeh / TiltShift\r* Circle\r* ColorMatrix\r* Displacement\r* Glow\r* Gradient\r* Pixelate\r* Shadow\r* Shine\r* Vignette\r* Wipe\r\rSee the FX Controller class for more details.", "name": "postPipelineClasses", "type": { "names": [ "Phaser.Structs.Map." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.Map" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Class" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#postPipelineClasses", "scope": "instance", "kind": "member", "___id": "T000002R032660", "___s": true }, { "comment": "/**\r\n * This map stores all pipeline instances in this manager.\r\n *\r\n * This is populated with the default pipelines in the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#pipelines\r\n * @type {Phaser.Structs.Map.}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 147, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This map stores all pipeline instances in this manager.\r\rThis is populated with the default pipelines in the `boot` method.", "name": "pipelines", "type": { "names": [ "Phaser.Structs.Map." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.Map" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#pipelines", "scope": "instance", "kind": "member", "___id": "T000002R032662", "___s": true }, { "comment": "/**\r\n * The default Game Object pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#default\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 158, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The default Game Object pipeline.", "name": "default", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#default", "scope": "instance", "kind": "member", "___id": "T000002R032664", "___s": true }, { "comment": "/**\r\n * Current pipeline in use by the WebGLRenderer.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#current\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 168, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Current pipeline in use by the WebGLRenderer.", "name": "current", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#current", "scope": "instance", "kind": "member", "___id": "T000002R032666", "___s": true }, { "comment": "/**\r\n * The previous WebGLPipeline that was in use.\r\n *\r\n * This is set when `clearPipeline` is called and restored in `rebindPipeline` if none is given.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#previous\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 178, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The previous WebGLPipeline that was in use.\r\rThis is set when `clearPipeline` is called and restored in `rebindPipeline` if none is given.", "name": "previous", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#previous", "scope": "instance", "kind": "member", "___id": "T000002R032668", "___s": true }, { "comment": "/**\r\n * A constant-style reference to the Multi Pipeline Instance.\r\n *\r\n * This is the default Phaser 3 pipeline and is used by the WebGL Renderer to manage\r\n * camera effects and more. This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#MULTI_PIPELINE\r\n * @type {Phaser.Renderer.WebGL.Pipelines.MultiPipeline}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 190, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A constant-style reference to the Multi Pipeline Instance.\r\rThis is the default Phaser 3 pipeline and is used by the WebGL Renderer to manage\rcamera effects and more. This property is set during the `boot` method.", "name": "MULTI_PIPELINE", "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.MultiPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#MULTI_PIPELINE", "scope": "instance", "kind": "member", "___id": "T000002R032670", "___s": true }, { "comment": "/**\r\n * A constant-style reference to the Bitmap Mask Pipeline Instance.\r\n *\r\n * This is the default Phaser 3 mask pipeline and is used Game Objects using\r\n * a Bitmap Mask. This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#BITMAPMASK_PIPELINE\r\n * @type {Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 203, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A constant-style reference to the Bitmap Mask Pipeline Instance.\r\rThis is the default Phaser 3 mask pipeline and is used Game Objects using\ra Bitmap Mask. This property is set during the `boot` method.", "name": "BITMAPMASK_PIPELINE", "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#BITMAPMASK_PIPELINE", "scope": "instance", "kind": "member", "___id": "T000002R032672", "___s": true }, { "comment": "/**\r\n * A constant-style reference to the Utility Pipeline Instance.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#UTILITY_PIPELINE\r\n * @type {Phaser.Renderer.WebGL.Pipelines.UtilityPipeline}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A constant-style reference to the Utility Pipeline Instance.", "name": "UTILITY_PIPELINE", "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#UTILITY_PIPELINE", "scope": "instance", "kind": "member", "___id": "T000002R032674", "___s": true }, { "comment": "/**\r\n * A constant-style reference to the Mobile Pipeline Instance.\r\n *\r\n * This is the default Phaser 3 mobile pipeline and is used by the WebGL Renderer to manage\r\n * camera effects and more on mobile devices. This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#MOBILE_PIPELINE\r\n * @type {Phaser.Renderer.WebGL.Pipelines.MobilePipeline}\r\n * @default null\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 226, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A constant-style reference to the Mobile Pipeline Instance.\r\rThis is the default Phaser 3 mobile pipeline and is used by the WebGL Renderer to manage\rcamera effects and more on mobile devices. This property is set during the `boot` method.", "name": "MOBILE_PIPELINE", "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.MobilePipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline" } }, "defaultvalue": "null", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#MOBILE_PIPELINE", "scope": "instance", "kind": "member", "___id": "T000002R032676", "___s": true }, { "comment": "/**\r\n * A constant-style reference to the FX Pipeline Instance.\r\n *\r\n * This is the default Phaser 3 FX pipeline and is used by the WebGL Renderer to manage\r\n * Game Objects with special effects enabled. This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#FX_PIPELINE\r\n * @type {Phaser.Renderer.WebGL.Pipelines.FXPipeline}\r\n * @default null\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 239, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A constant-style reference to the FX Pipeline Instance.\r\rThis is the default Phaser 3 FX pipeline and is used by the WebGL Renderer to manage\rGame Objects with special effects enabled. This property is set during the `boot` method.", "name": "FX_PIPELINE", "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.FXPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.FXPipeline" } }, "defaultvalue": "null", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#FX_PIPELINE", "scope": "instance", "kind": "member", "___id": "T000002R032678", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 252, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A reference to the Full Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "name": "fullFrame1", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#fullFrame1", "scope": "instance", "kind": "member", "___id": "T000002R032680", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 268, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A reference to the Full Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "name": "fullFrame2", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#fullFrame2", "scope": "instance", "kind": "member", "___id": "T000002R032682", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 284, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A reference to the Half Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "name": "halfFrame1", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#halfFrame1", "scope": "instance", "kind": "member", "___id": "T000002R032684", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 300, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A reference to the Half Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "name": "halfFrame2", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#halfFrame2", "scope": "instance", "kind": "member", "___id": "T000002R032686", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 316, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "An array of RenderTarget instances that belong to this pipeline.", "name": "renderTargets", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#renderTargets", "scope": "instance", "kind": "member", "___id": "T000002R032688", "___s": true }, { "comment": "/**\r\n * The largest render target dimension before we just use a full-screen target.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#maxDimension\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 325, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The largest render target dimension before we just use a full-screen target.", "name": "maxDimension", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#maxDimension", "scope": "instance", "kind": "member", "___id": "T000002R032690", "___s": true }, { "comment": "/**\r\n * The amount in which each target frame will increase.\r\n *\r\n * Defaults to 32px but can be overridden in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#frameInc\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The amount in which each target frame will increase.\r\rDefaults to 32px but can be overridden in the config.", "name": "frameInc", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#frameInc", "scope": "instance", "kind": "member", "___id": "T000002R032692", "___s": true }, { "comment": "/**\r\n * The Render Target index. Used internally by the methods\r\n * in this class. Do not modify directly.\r\n *\r\n * @name Phaser.Renderer.WebGL.PipelineManager#targetIndex\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 345, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The Render Target index. Used internally by the methods\rin this class. Do not modify directly.", "name": "targetIndex", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#targetIndex", "scope": "instance", "kind": "member", "___id": "T000002R032694", "___s": true }, { "comment": "/**\r\n * Internal boot handler, called by the WebGLRenderer durings its boot process.\r\n *\r\n * Adds all of the default pipelines, based on the game config, and then calls\r\n * the `boot` method on each one of them.\r\n *\r\n * Finally, the default pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#boot\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Core.PipelineConfig} pipelineConfig - The pipeline configuration object as set in the Game Config.\r\n * @param {string} defaultPipeline - The name of the default Game Object pipeline, as set in the Game Config\r\n * @param {boolean} autoMobilePipeline - Automatically set the default pipeline to mobile if non-desktop detected?\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Internal boot handler, called by the WebGLRenderer durings its boot process.\r\rAdds all of the default pipelines, based on the game config, and then calls\rthe `boot` method on each one of them.\r\rFinally, the default pipeline is set.", "kind": "function", "name": "boot", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Types.Core.PipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.PipelineConfig" } }, "description": "The pipeline configuration object as set in the Game Config.", "name": "pipelineConfig" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the default Game Object pipeline, as set in the Game Config", "name": "defaultPipeline" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Automatically set the default pipeline to mobile if non-desktop detected?", "name": "autoMobilePipeline" } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#boot", "scope": "instance", "___id": "T000002R032696", "___s": true }, { "comment": "/**\r\n * Sets the default pipeline being used by Game Objects.\r\n *\r\n * If no instance, or matching name, exists in this manager, it returns `undefined`.\r\n *\r\n * You can use this to override the default pipeline, for example by forcing\r\n * the Mobile or Multi Tint Pipelines, which is especially useful for development\r\n * testing.\r\n *\r\n * Make sure you call this method _before_ creating any Game Objects, as it will\r\n * only impact Game Objects created after you call it.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#setDefaultPipeline\r\n * @since 3.60.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline to get, or a pipeline instance to look-up.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLPipeline} The pipeline instance that was set as default, or `undefined` if not found.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 470, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the default pipeline being used by Game Objects.\r\rIf no instance, or matching name, exists in this manager, it returns `undefined`.\r\rYou can use this to override the default pipeline, for example by forcing\rthe Mobile or Multi Tint Pipelines, which is especially useful for development\rtesting.\r\rMake sure you call this method _before_ creating any Game Objects, as it will\ronly impact Game Objects created after you call it.", "kind": "function", "name": "setDefaultPipeline", "since": "3.60.0", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline to get, or a pipeline instance to look-up.", "name": "pipeline" } ], "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "description": "The pipeline instance that was set as default, or `undefined` if not found." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#setDefaultPipeline", "scope": "instance", "___id": "T000002R032728", "___s": true }, { "comment": "/**\r\n * Adds a pipeline instance to this Pipeline Manager.\r\n *\r\n * The name of the instance must be unique within this manager.\r\n *\r\n * Make sure to pass an instance to this method, not a base class.\r\n *\r\n * For example, you should pass it like this:\r\n *\r\n * ```javascript\r\n * this.add('yourName', new CustomPipeline(game));`\r\n * ```\r\n *\r\n * and **not** like this:\r\n *\r\n * ```javascript\r\n * this.add('yourName', CustomPipeline);`\r\n * ```\r\n *\r\n * To add a **Post Pipeline**, see `addPostPipeline` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#add\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - A unique string-based key for the pipeline within the manager.\r\n * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - A pipeline _instance_ which must extend `WebGLPipeline`.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLPipeline} The pipeline instance that was passed.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 501, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Adds a pipeline instance to this Pipeline Manager.\r\rThe name of the instance must be unique within this manager.\r\rMake sure to pass an instance to this method, not a base class.\r\rFor example, you should pass it like this:\r\r```javascript\rthis.add('yourName', new CustomPipeline(game));`\r```\r\rand **not** like this:\r\r```javascript\rthis.add('yourName', CustomPipeline);`\r```\r\rTo add a **Post Pipeline**, see `addPostPipeline` instead.", "kind": "function", "name": "add", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A unique string-based key for the pipeline within the manager.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "description": "A pipeline _instance_ which must extend `WebGLPipeline`.", "name": "pipeline" } ], "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "description": "The pipeline instance that was passed." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#add", "scope": "instance", "___id": "T000002R032732", "___s": true }, { "comment": "/**\r\n * Adds a Post Pipeline to this Pipeline Manager.\r\n *\r\n * Make sure to pass a base class to this method, not an instance.\r\n *\r\n * For example, you should pass it like this:\r\n *\r\n * ```javascript\r\n * this.addPostPipeline('yourName', CustomPipeline);`\r\n * ```\r\n *\r\n * and **not** like this:\r\n *\r\n * ```javascript\r\n * this.addPostPipeline('yourName', new CustomPipeline());`\r\n * ```\r\n *\r\n * To add a regular pipeline, see the `add` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#addPostPipeline\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - A unique string-based key for the pipeline within the manager.\r\n * @param {function} pipeline - A pipeline class which must extend `PostFXPipeline`.\r\n *\r\n * @return {this} This Pipeline Manager.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 567, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Adds a Post Pipeline to this Pipeline Manager.\r\rMake sure to pass a base class to this method, not an instance.\r\rFor example, you should pass it like this:\r\r```javascript\rthis.addPostPipeline('yourName', CustomPipeline);`\r```\r\rand **not** like this:\r\r```javascript\rthis.addPostPipeline('yourName', new CustomPipeline());`\r```\r\rTo add a regular pipeline, see the `add` method instead.", "kind": "function", "name": "addPostPipeline", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A unique string-based key for the pipeline within the manager.", "name": "name" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "A pipeline class which must extend `PostFXPipeline`.", "name": "pipeline" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Pipeline Manager." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#addPostPipeline", "scope": "instance", "___id": "T000002R032738", "___s": true }, { "comment": "/**\r\n * Flushes the current pipeline, if one is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#flush\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 602, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Flushes the current pipeline, if one is bound.", "kind": "function", "name": "flush", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#flush", "scope": "instance", "___id": "T000002R032740", "___s": true }, { "comment": "/**\r\n * Checks if a pipeline is present in this Pipeline Manager.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#has\r\n * @since 3.50.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline to get, or a pipeline instance to look-up.\r\n *\r\n * @return {boolean} `true` if the given pipeline is loaded, otherwise `false`.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 616, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Checks if a pipeline is present in this Pipeline Manager.", "kind": "function", "name": "has", "since": "3.50.0", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline to get, or a pipeline instance to look-up.", "name": "pipeline" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given pipeline is loaded, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#has", "scope": "instance", "___id": "T000002R032742", "___s": true }, { "comment": "/**\r\n * Returns the pipeline instance based on the given name, or instance.\r\n *\r\n * If no instance, or matching name, exists in this manager, it returns `undefined`.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#get\r\n * @since 3.50.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline to get, or a pipeline instance to look-up.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLPipeline} The pipeline instance, or `undefined` if not found.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 642, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Returns the pipeline instance based on the given name, or instance.\r\rIf no instance, or matching name, exists in this manager, it returns `undefined`.", "kind": "function", "name": "get", "since": "3.50.0", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline to get, or a pipeline instance to look-up.", "name": "pipeline" } ], "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "description": "The pipeline instance, or `undefined` if not found." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#get", "scope": "instance", "___id": "T000002R032745", "___s": true }, { "comment": "/**\r\n * Returns a _new instance_ of the post pipeline based on the given name, or class.\r\n *\r\n * If no instance, or matching name, exists in this manager, it returns `undefined`.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#getPostPipeline\r\n * @since 3.50.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - Either the string-based name of the pipeline to get, or a pipeline instance, or class to look-up.\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - If this post pipeline is being installed into a Game Object or Camera, this is a reference to it.\r\n * @param {object} [config] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n *\r\n * @return {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} The pipeline instance, or `undefined` if not found.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 668, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Returns a _new instance_ of the post pipeline based on the given name, or class.\r\rIf no instance, or matching name, exists in this manager, it returns `undefined`.", "kind": "function", "name": "getPostPipeline", "since": "3.50.0", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "Either the string-based name of the pipeline to get, or a pipeline instance, or class to look-up.", "name": "pipeline" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "If this post pipeline is being installed into a Game Object or Camera, this is a reference to it.", "name": "gameObject" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } }, "description": "The pipeline instance, or `undefined` if not found." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#getPostPipeline", "scope": "instance", "___id": "T000002R032748", "___s": true }, { "comment": "/**\r\n * Removes a pipeline instance based on the given name.\r\n *\r\n * If no pipeline matches the name, this method does nothing.\r\n *\r\n * Note that the pipeline will not be flushed or destroyed, it's simply removed from\r\n * this manager.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#remove\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the pipeline to be removed.\r\n * @param {boolean} [removeClass=true] - Remove the pipeline class as well as the instance?\r\n * @param {boolean} [removePostPipelineClass=true] - Remove the post pipeline class as well as the instance?\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 728, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Removes a pipeline instance based on the given name.\r\rIf no pipeline matches the name, this method does nothing.\r\rNote that the pipeline will not be flushed or destroyed, it's simply removed from\rthis manager.", "kind": "function", "name": "remove", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the pipeline to be removed.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Remove the pipeline class as well as the instance?", "name": "removeClass" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Remove the post pipeline class as well as the instance?", "name": "removePostPipelineClass" } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#remove", "scope": "instance", "___id": "T000002R032763", "___s": true }, { "comment": "/**\r\n * Sets the current pipeline to be used by the `WebGLRenderer`.\r\n *\r\n * This method accepts a pipeline instance as its parameter, not the name.\r\n *\r\n * If the pipeline isn't already the current one it will call `WebGLPipeline.bind` and then `onBind`.\r\n *\r\n * You cannot set Post FX Pipelines using this method. To use a Post FX Pipeline, you should\r\n * apply it to either a Camera, Container or other supporting Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#set\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline instance to be set as current.\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLPipeline} The pipeline that was set, or undefined if it couldn't be set.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 761, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the current pipeline to be used by the `WebGLRenderer`.\r\rThis method accepts a pipeline instance as its parameter, not the name.\r\rIf the pipeline isn't already the current one it will call `WebGLPipeline.bind` and then `onBind`.\r\rYou cannot set Post FX Pipelines using this method. To use a Post FX Pipeline, you should\rapply it to either a Camera, Container or other supporting Game Object.", "kind": "function", "name": "set", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "description": "The pipeline instance to be set as current.", "name": "pipeline" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "description": "The pipeline that was set, or undefined if it couldn't be set." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#set", "scope": "instance", "___id": "T000002R032767", "___s": true }, { "comment": "/**\r\n * This method is called by the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch.\r\n *\r\n * It is also called directly bu custom Game Objects, such as Nine Slice or Mesh,\r\n * from their render methods.\r\n *\r\n * It causes a batch flush, then calls the `preBatch` method on the Post FX Pipelines\r\n * belonging to the Game Object.\r\n *\r\n * It should be followed by a call to `postBatch` to complete the process.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object about to be batched.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 808, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method is called by the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch.\r\rIt is also called directly bu custom Game Objects, such as Nine Slice or Mesh,\rfrom their render methods.\r\rIt causes a batch flush, then calls the `preBatch` method on the Post FX Pipelines\rbelonging to the Game Object.\r\rIt should be followed by a call to `postBatch` to complete the process.", "kind": "function", "name": "preBatch", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object about to be batched.", "name": "gameObject" } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#preBatch", "scope": "instance", "___id": "T000002R032770", "___s": true }, { "comment": "/**\r\n * This method is called by the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch.\r\n *\r\n * It is also called directly bu custom Game Objects, such as Nine Slice or Mesh,\r\n * from their render methods.\r\n *\r\n * It causes a batch flush, then calls the `postBatch` method on the Post FX Pipelines\r\n * belonging to the Game Object.\r\n *\r\n * It should be preceeded by a call to `preBatch` to start the process.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that was just added to the batch.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 846, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method is called by the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch.\r\rIt is also called directly bu custom Game Objects, such as Nine Slice or Mesh,\rfrom their render methods.\r\rIt causes a batch flush, then calls the `postBatch` method on the Post FX Pipelines\rbelonging to the Game Object.\r\rIt should be preceeded by a call to `preBatch` to start the process.", "kind": "function", "name": "postBatch", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was just added to the batch.", "name": "gameObject" } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#postBatch", "scope": "instance", "___id": "T000002R032775", "___s": true }, { "comment": "/**\r\n * Called at the start of the `WebGLRenderer.preRenderCamera` method.\r\n *\r\n * If the Camera has post pipelines set, it will flush the batch and then call the\r\n * `preBatch` method on the post-fx pipelines belonging to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#preBatchCamera\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera about to be rendered.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 883, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Called at the start of the `WebGLRenderer.preRenderCamera` method.\r\rIf the Camera has post pipelines set, it will flush the batch and then call the\r`preBatch` method on the post-fx pipelines belonging to the Camera.", "kind": "function", "name": "preBatchCamera", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera about to be rendered.", "name": "camera" } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#preBatchCamera", "scope": "instance", "___id": "T000002R032780", "___s": true }, { "comment": "/**\r\n * Called at the end of the `WebGLRenderer.postRenderCamera` method.\r\n *\r\n * If the Camera has post pipelines set, it will flush the batch and then call the\r\n * `postBatch` method on the post-fx pipelines belonging to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#postBatchCamera\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that was just rendered.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 915, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Called at the end of the `WebGLRenderer.postRenderCamera` method.\r\rIf the Camera has post pipelines set, it will flush the batch and then call the\r`postBatch` method on the post-fx pipelines belonging to the Camera.", "kind": "function", "name": "postBatchCamera", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera that was just rendered.", "name": "camera" } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#postBatchCamera", "scope": "instance", "___id": "T000002R032785", "___s": true }, { "comment": "/**\r\n * Checks to see if the given pipeline is already the active pipeline, both within this\r\n * Pipeline Manager and also has the same shader set in the Renderer.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#isCurrent\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline instance to be checked.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {boolean} `true` if the given pipeline is already the current pipeline, otherwise `false`.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 946, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Checks to see if the given pipeline is already the active pipeline, both within this\rPipeline Manager and also has the same shader set in the Renderer.", "kind": "function", "name": "isCurrent", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "description": "The pipeline instance to be checked.", "name": "pipeline" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given pipeline is already the current pipeline, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#isCurrent", "scope": "instance", "___id": "T000002R032790", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * The copy itself is handled by the Utility Pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n *\r\n * @return {this} This Pipeline Manager instance.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 971, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.\r\rThe copy itself is handled by the Utility Pipeline.", "kind": "function", "name": "copyFrame", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Pipeline Manager instance." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#copyFrame", "scope": "instance", "___id": "T000002R032795", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1000, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "kind": "function", "name": "copyToGame", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#copyToGame", "scope": "instance", "___id": "T000002R032797", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using the\r\n * given Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * The copy itself is handled by the Utility Pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Display.ColorMatrix} [colorMatrix] - The Color Matrix to use when performing the draw.\r\n *\r\n * @return {this} This Pipeline Manager instance.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1022, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Copy the `source` Render Target to the `target` Render Target, using the\rgiven Color Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.\r\rThe copy itself is handled by the Utility Pipeline.", "kind": "function", "name": "drawFrame", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "optional": true, "description": "The Color Matrix to use when performing the draw.", "name": "colorMatrix" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Pipeline Manager instance." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#drawFrame", "scope": "instance", "___id": "T000002R032799", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * The draw itself is handled by the Utility Pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n *\r\n * @return {this} This Pipeline Manager instance.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.\r\rThe draw itself is handled by the Utility Pipeline.", "kind": "function", "name": "blendFrames", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Pipeline Manager instance." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#blendFrames", "scope": "instance", "___id": "T000002R032801", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * The draw itself is handled by the Utility Pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n *\r\n * @return {this} This Pipeline Manager instance.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1074, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.\r\rThe draw itself is handled by the Utility Pipeline.", "kind": "function", "name": "blendFramesAdditive", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Pipeline Manager instance." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#blendFramesAdditive", "scope": "instance", "___id": "T000002R032803", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n *\r\n * @return {this} This Pipeline Manager instance.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1098, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Clears the given Render Target.", "kind": "function", "name": "clearFrame", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Pipeline Manager instance." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#clearFrame", "scope": "instance", "___id": "T000002R032805", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n *\r\n * @return {this} This Pipeline Manager instance.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1116, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "kind": "function", "name": "blitFrame", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Pipeline Manager instance." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#blitFrame", "scope": "instance", "___id": "T000002R032807", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n *\r\n * @return {this} This Pipeline Manager instance.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "kind": "function", "name": "copyFrameRect", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Pipeline Manager instance." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#copyFrameRect", "scope": "instance", "___id": "T000002R032809", "___s": true }, { "comment": "/**\r\n * Returns `true` if the current pipeline is forced to use texture unit zero.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#forceZero\r\n * @since 3.50.0\r\n *\r\n * @return {boolean} `true` if the current pipeline is forced to use texture unit zero.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1174, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Returns `true` if the current pipeline is forced to use texture unit zero.", "kind": "function", "name": "forceZero", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current pipeline is forced to use texture unit zero." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#forceZero", "scope": "instance", "___id": "T000002R032811", "___s": true }, { "comment": "/**\r\n * Sets the Multi Pipeline to be the currently bound pipeline.\r\n *\r\n * This is the default Phaser 3 rendering pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#setMulti\r\n * @since 3.50.0\r\n *\r\n * @return {Phaser.Renderer.WebGL.Pipelines.MultiPipeline} The Multi Pipeline instance.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1187, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the Multi Pipeline to be the currently bound pipeline.\r\rThis is the default Phaser 3 rendering pipeline.", "kind": "function", "name": "setMulti", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.MultiPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline" } }, "description": "The Multi Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#setMulti", "scope": "instance", "___id": "T000002R032813", "___s": true }, { "comment": "/**\r\n * Sets the Utility Pipeline to be the currently bound pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#setUtility\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {Phaser.Renderer.WebGL.Pipelines.UtilityPipeline} The Utility Pipeline instance.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1202, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the Utility Pipeline to be the currently bound pipeline.", "kind": "function", "name": "setUtility", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline" } }, "description": "The Utility Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#setUtility", "scope": "instance", "___id": "T000002R032815", "___s": true }, { "comment": "/**\r\n * Sets the FX Pipeline to be the currently bound pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#setFX\r\n * @since 3.60.0\r\n *\r\n * @return {Phaser.Renderer.WebGL.Pipelines.FXPipeline} The FX Pipeline instance.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1217, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the FX Pipeline to be the currently bound pipeline.", "kind": "function", "name": "setFX", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.FXPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.FXPipeline" } }, "description": "The FX Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#setFX", "scope": "instance", "___id": "T000002R032817", "___s": true }, { "comment": "/**\r\n * Use this to reset the gl context to the state that Phaser requires to continue rendering.\r\n *\r\n * Calling this will:\r\n *\r\n * * Disable `DEPTH_TEST`, `CULL_FACE` and `STENCIL_TEST`.\r\n * * Clear the depth buffer and stencil buffers.\r\n * * Reset the viewport size.\r\n * * Reset the blend mode.\r\n * * Bind a blank texture as the active texture on texture unit zero.\r\n * * Rebinds the given pipeline instance.\r\n *\r\n * You should call this if you have previously called `clear`, and then wish to return\r\n * rendering control to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#rebind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLPipeline} [pipeline] - The pipeline instance to be rebound. If not given, the previous pipeline will be bound.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Use this to reset the gl context to the state that Phaser requires to continue rendering.\r\rCalling this will:\r\r* Disable `DEPTH_TEST`, `CULL_FACE` and `STENCIL_TEST`.\r* Clear the depth buffer and stencil buffers.\r* Reset the viewport size.\r* Reset the blend mode.\r* Bind a blank texture as the active texture on texture unit zero.\r* Rebinds the given pipeline instance.\r\rYou should call this if you have previously called `clear`, and then wish to return\rrendering control to Phaser again.", "kind": "function", "name": "rebind", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "optional": true, "description": "The pipeline instance to be rebound. If not given, the previous pipeline will be bound.", "name": "pipeline" } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#rebind", "scope": "instance", "___id": "T000002R032819", "___s": true }, { "comment": "/**\r\n * Flushes the current pipeline being used and then clears it, along with the\r\n * the current shader program and vertex buffer from the `WebGLRenderer`.\r\n *\r\n * Then resets the blend mode to NORMAL.\r\n *\r\n * Call this before jumping to your own gl context handler, and then call `rebind` when\r\n * you wish to return control to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#clear\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1302, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Flushes the current pipeline being used and then clears it, along with the\rthe current shader program and vertex buffer from the `WebGLRenderer`.\r\rThen resets the blend mode to NORMAL.\r\rCall this before jumping to your own gl context handler, and then call `rebind` when\ryou wish to return control to Phaser again.", "kind": "function", "name": "clear", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#clear", "scope": "instance", "___id": "T000002R032830", "___s": true }, { "comment": "/**\r\n * Gets a Render Target the right size to render the Sprite on.\r\n *\r\n * If the Sprite exceeds the size of the renderer, the Render Target will only ever be the maximum\r\n * size of the renderer.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#getRenderTarget\r\n * @since 3.60.0\r\n *\r\n * @param {number} size - The maximum dimension required.\r\n *\r\n * @return {Phaser.Renderer.WebGL.RenderTarget} A Render Target large enough to fit the sprite.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1343, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Gets a Render Target the right size to render the Sprite on.\r\rIf the Sprite exceeds the size of the renderer, the Render Target will only ever be the maximum\rsize of the renderer.", "kind": "function", "name": "getRenderTarget", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum dimension required.", "name": "size" } ], "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "A Render Target large enough to fit the sprite." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#getRenderTarget", "scope": "instance", "___id": "T000002R032838", "___s": true }, { "comment": "/**\r\n * Gets a matching Render Target, the same size as the one the Sprite was drawn to,\r\n * useful for double-buffer style effects such as blurs.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#getSwapRenderTarget\r\n * @since 3.60.0\r\n *\r\n * @return {Phaser.Renderer.WebGL.RenderTarget} The Render Target swap frame.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Gets a matching Render Target, the same size as the one the Sprite was drawn to,\ruseful for double-buffer style effects such as blurs.", "kind": "function", "name": "getSwapRenderTarget", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target swap frame." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#getSwapRenderTarget", "scope": "instance", "___id": "T000002R032845", "___s": true }, { "comment": "/**\r\n * Gets a matching Render Target, the same size as the one the Sprite was drawn to,\r\n * useful for double-buffer style effects such as blurs.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#getAltSwapRenderTarget\r\n * @since 3.60.0\r\n *\r\n * @return {Phaser.Renderer.WebGL.RenderTarget} The Render Target swap frame.\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Gets a matching Render Target, the same size as the one the Sprite was drawn to,\ruseful for double-buffer style effects such as blurs.", "kind": "function", "name": "getAltSwapRenderTarget", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target swap frame." } ], "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#getAltSwapRenderTarget", "scope": "instance", "___id": "T000002R032847", "___s": true }, { "comment": "/**\r\n * Destroy the Pipeline Manager, cleaning up all related resources and references.\r\n *\r\n * @method Phaser.Renderer.WebGL.PipelineManager#destroy\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PipelineManager.js", "lineno": 1408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Destroy the Pipeline Manager, cleaning up all related resources and references.", "kind": "function", "name": "destroy", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.PipelineManager", "longname": "Phaser.Renderer.WebGL.PipelineManager#destroy", "scope": "instance", "___id": "T000002R032849", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Bitmap Mask Pipeline handles all of the bitmap mask rendering in WebGL for applying\r\n * alpha masks to Game Objects. It works by sampling two texture on the fragment shader and\r\n * using the fragments alpha to clip the region.\r\n *\r\n * The fragment shader it uses can be found in `shaders/src/BitmapMask.frag`.\r\n * The vertex shader it uses can be found in `shaders/src/BitmapMask.vert`.\r\n *\r\n * The default shader attributes for this pipeline are:\r\n *\r\n * `inPosition` (vec2, offset 0)\r\n *\r\n * The default shader uniforms for this pipeline are:\r\n *\r\n * `uResolution` (vec2)\r\n * `uMainSampler` (sampler2D)\r\n * `uMaskSampler` (sampler2D)\r\n * `uInvertMaskAlpha` (bool)\r\n *\r\n * @class BitmapMaskPipeline\r\n * @extends Phaser.Renderer.WebGL.WebGLPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration options for this pipeline.\r\n */", "meta": { "filename": "BitmapMaskPipeline.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "classdesc": "The Bitmap Mask Pipeline handles all of the bitmap mask rendering in WebGL for applying\ralpha masks to Game Objects. It works by sampling two texture on the fragment shader and\rusing the fragments alpha to clip the region.\r\rThe fragment shader it uses can be found in `shaders/src/BitmapMask.frag`.\rThe vertex shader it uses can be found in `shaders/src/BitmapMask.vert`.\r\rThe default shader attributes for this pipeline are:\r\r`inPosition` (vec2, offset 0)\r\rThe default shader uniforms for this pipeline are:\r\r`uResolution` (vec2)\r`uMainSampler` (sampler2D)\r`uMaskSampler` (sampler2D)\r`uInvertMaskAlpha` (bool)", "kind": "class", "name": "BitmapMaskPipeline", "augments": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration options for this pipeline.", "name": "config" } ], "scope": "static", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "___id": "T000002R032866", "___s": true }, { "comment": "/**\r\n * Binds necessary resources and renders the mask to a separated framebuffer.\r\n * The framebuffer for the masked object is also bound for further use.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#beginMask\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Display.Masks.BitmapMask} mask - The BitmapMask instance that called beginMask.\r\n * @param {Phaser.GameObjects.GameObject} maskedObject - GameObject masked by the mask GameObject.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera rendering the current mask.\r\n */", "meta": { "filename": "BitmapMaskPipeline.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Binds necessary resources and renders the mask to a separated framebuffer.\rThe framebuffer for the masked object is also bound for further use.", "kind": "function", "name": "beginMask", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "The BitmapMask instance that called beginMask.", "name": "mask" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "GameObject masked by the mask GameObject.", "name": "maskedObject" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera rendering the current mask.", "name": "camera" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#beginMask", "scope": "instance", "___id": "T000002R032880", "___s": true }, { "comment": "/**\r\n * The masked game objects framebuffer is unbound and its texture\r\n * is bound together with the mask texture and the mask shader and\r\n * a draw call with a single quad is processed. Here is where the\r\n * masking effect is applied.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#endMask\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Display.Masks.BitmapMask} mask - The BitmapMask instance that called endMask.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to render to.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [renderTarget] - Optional WebGL RenderTarget.\r\n */", "meta": { "filename": "BitmapMaskPipeline.js", "lineno": 97, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The masked game objects framebuffer is unbound and its texture\ris bound together with the mask texture and the mask shader and\ra draw call with a single quad is processed. Here is where the\rmasking effect is applied.", "kind": "function", "name": "endMask", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "The BitmapMask instance that called endMask.", "name": "mask" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to render to.", "name": "camera" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "Optional WebGL RenderTarget.", "name": "renderTarget" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#endMask", "scope": "instance", "___id": "T000002R032882", "___s": true }, { "comment": "/**\r\n * The Bitmap Mask Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.BITMAPMASK_PIPELINE\r\n * @type {string}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "const.js", "lineno": 9, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The Bitmap Mask Pipeline.", "name": "BITMAPMASK_PIPELINE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines", "longname": "Phaser.Renderer.WebGL.Pipelines.BITMAPMASK_PIPELINE", "scope": "static", "___id": "T000002R032889", "___s": true }, { "comment": "/**\r\n * The Light 2D Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.LIGHT_PIPELINE\r\n * @type {string}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "const.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The Light 2D Pipeline.", "name": "LIGHT_PIPELINE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines", "longname": "Phaser.Renderer.WebGL.Pipelines.LIGHT_PIPELINE", "scope": "static", "___id": "T000002R032891", "___s": true }, { "comment": "/**\r\n * The Point Light Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.POINTLIGHT_PIPELINE\r\n * @type {string}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "const.js", "lineno": 29, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The Point Light Pipeline.", "name": "POINTLIGHT_PIPELINE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines", "longname": "Phaser.Renderer.WebGL.Pipelines.POINTLIGHT_PIPELINE", "scope": "static", "___id": "T000002R032893", "___s": true }, { "comment": "/**\r\n * The Single Texture Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.SINGLE_PIPELINE\r\n * @type {string}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "const.js", "lineno": 39, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The Single Texture Pipeline.", "name": "SINGLE_PIPELINE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines", "longname": "Phaser.Renderer.WebGL.Pipelines.SINGLE_PIPELINE", "scope": "static", "___id": "T000002R032895", "___s": true }, { "comment": "/**\r\n * The Multi Texture Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.MULTI_PIPELINE\r\n * @type {string}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "const.js", "lineno": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The Multi Texture Pipeline.", "name": "MULTI_PIPELINE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines", "longname": "Phaser.Renderer.WebGL.Pipelines.MULTI_PIPELINE", "scope": "static", "___id": "T000002R032897", "___s": true }, { "comment": "/**\r\n * The Rope Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.ROPE_PIPELINE\r\n * @type {string}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "const.js", "lineno": 59, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The Rope Pipeline.", "name": "ROPE_PIPELINE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines", "longname": "Phaser.Renderer.WebGL.Pipelines.ROPE_PIPELINE", "scope": "static", "___id": "T000002R032899", "___s": true }, { "comment": "/**\r\n * The Graphics and Shapes Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.GRAPHICS_PIPELINE\r\n * @type {string}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "const.js", "lineno": 69, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The Graphics and Shapes Pipeline.", "name": "GRAPHICS_PIPELINE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines", "longname": "Phaser.Renderer.WebGL.Pipelines.GRAPHICS_PIPELINE", "scope": "static", "___id": "T000002R032901", "___s": true }, { "comment": "/**\r\n * The Post FX Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.POSTFX_PIPELINE\r\n * @type {string}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "const.js", "lineno": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The Post FX Pipeline.", "name": "POSTFX_PIPELINE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines", "longname": "Phaser.Renderer.WebGL.Pipelines.POSTFX_PIPELINE", "scope": "static", "___id": "T000002R032903", "___s": true }, { "comment": "/**\r\n * The Utility Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.UTILITY_PIPELINE\r\n * @type {string}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "const.js", "lineno": 89, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The Utility Pipeline.", "name": "UTILITY_PIPELINE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines", "longname": "Phaser.Renderer.WebGL.Pipelines.UTILITY_PIPELINE", "scope": "static", "___id": "T000002R032905", "___s": true }, { "comment": "/**\r\n * The Mobile Texture Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.MOBILE_PIPELINE\r\n * @type {string}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 99, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The Mobile Texture Pipeline.", "name": "MOBILE_PIPELINE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines", "longname": "Phaser.Renderer.WebGL.Pipelines.MOBILE_PIPELINE", "scope": "static", "___id": "T000002R032907", "___s": true }, { "comment": "/**\r\n * The Special FX Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX_PIPELINE\r\n * @type {string}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 109, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The Special FX Pipeline.", "name": "FX_PIPELINE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines", "longname": "Phaser.Renderer.WebGL.Pipelines.FX_PIPELINE", "scope": "static", "___id": "T000002R032909", "___s": true }, { "comment": "/**\r\n * The WebGLPipeline After Flush Event.\r\n *\r\n * This event is dispatched by a WebGLPipeline right after it has issued a drawArrays command\r\n * and cleared its vertex count.\r\n *\r\n * @event Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline that has flushed.\r\n * @param {boolean} isPostFlush - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "AFTER_FLUSH_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\events", "code": {} }, "description": "The WebGLPipeline After Flush Event.\r\rThis event is dispatched by a WebGLPipeline right after it has issued a drawArrays command\rand cleared its vertex count.", "kind": "event", "name": "AFTER_FLUSH", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "description": "The pipeline that has flushed.", "name": "pipeline" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.Events", "longname": "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH", "scope": "instance", "___id": "T000002R032912", "___s": true }, { "comment": "/**\r\n * The WebGLPipeline Before Flush Event.\r\n *\r\n * This event is dispatched by a WebGLPipeline right before it is about to\r\n * flush and issue a bufferData and drawArrays command.\r\n *\r\n * @event Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline that is about to flush.\r\n * @param {boolean} isPostFlush - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "BEFORE_FLUSH_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\events", "code": {} }, "description": "The WebGLPipeline Before Flush Event.\r\rThis event is dispatched by a WebGLPipeline right before it is about to\rflush and issue a bufferData and drawArrays command.", "kind": "event", "name": "BEFORE_FLUSH", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "description": "The pipeline that is about to flush.", "name": "pipeline" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.Events", "longname": "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "scope": "instance", "___id": "T000002R032914", "___s": true }, { "comment": "/**\r\n * The WebGLPipeline Bind Event.\r\n *\r\n * This event is dispatched by a WebGLPipeline when it is bound by the Pipeline Manager.\r\n *\r\n * @event Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline that was bound.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as being current.\r\n */", "meta": { "filename": "BIND_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\events", "code": {} }, "description": "The WebGLPipeline Bind Event.\r\rThis event is dispatched by a WebGLPipeline when it is bound by the Pipeline Manager.", "kind": "event", "name": "BIND", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "description": "The pipeline that was bound.", "name": "pipeline" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as being current.", "name": "currentShader" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.Events", "longname": "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND", "scope": "instance", "___id": "T000002R032916", "___s": true }, { "comment": "/**\r\n * The WebGLPipeline Boot Event.\r\n *\r\n * This event is dispatched by a WebGLPipeline when it has completed its `boot` phase.\r\n *\r\n * @event Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline that booted.\r\n */", "meta": { "filename": "BOOT_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\events", "code": {} }, "description": "The WebGLPipeline Boot Event.\r\rThis event is dispatched by a WebGLPipeline when it has completed its `boot` phase.", "kind": "event", "name": "BOOT", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "description": "The pipeline that booted.", "name": "pipeline" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.Events", "longname": "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT", "scope": "instance", "___id": "T000002R032918", "___s": true }, { "comment": "/**\r\n * The WebGLPipeline Destroy Event.\r\n *\r\n * This event is dispatched by a WebGLPipeline when it is starting its destroy process.\r\n *\r\n * @event Phaser.Renderer.WebGL.Pipelines.Events#DESTROY\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline that has flushed.\r\n */", "meta": { "filename": "DESTROY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\events", "code": {} }, "description": "The WebGLPipeline Destroy Event.\r\rThis event is dispatched by a WebGLPipeline when it is starting its destroy process.", "kind": "event", "name": "DESTROY", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "description": "The pipeline that has flushed.", "name": "pipeline" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.Events", "longname": "Phaser.Renderer.WebGL.Pipelines.Events#event:DESTROY", "scope": "instance", "___id": "T000002R032920", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Renderer.WebGL.Pipelines.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Renderer.WebGL.Pipelines", "longname": "Phaser.Renderer.WebGL.Pipelines.Events", "scope": "static", "___id": "T000002R032922", "___s": true }, { "comment": "/**\r\n * The WebGLPipeline ReBind Event.\r\n *\r\n * This event is dispatched by a WebGLPipeline when it is re-bound by the Pipeline Manager.\r\n *\r\n * @event Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline that was rebound.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as being current.\r\n */", "meta": { "filename": "REBIND_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\events", "code": {} }, "description": "The WebGLPipeline ReBind Event.\r\rThis event is dispatched by a WebGLPipeline when it is re-bound by the Pipeline Manager.", "kind": "event", "name": "REBIND", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "description": "The pipeline that was rebound.", "name": "pipeline" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as being current.", "name": "currentShader" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.Events", "longname": "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND", "scope": "instance", "___id": "T000002R032931", "___s": true }, { "comment": "/**\r\n * The WebGLPipeline Resize Event.\r\n *\r\n * This event is dispatched by a WebGLPipeline when it is resized, usually as a result\r\n * of the Renderer resizing.\r\n *\r\n * @event Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of the pipeline.\r\n * @param {number} height - The new height of the pipeline.\r\n * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline that was resized.\r\n */", "meta": { "filename": "RESIZE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\events", "code": {} }, "description": "The WebGLPipeline Resize Event.\r\rThis event is dispatched by a WebGLPipeline when it is resized, usually as a result\rof the Renderer resizing.", "kind": "event", "name": "RESIZE", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of the pipeline.", "name": "height" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "description": "The pipeline that was resized.", "name": "pipeline" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.Events", "longname": "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE", "scope": "instance", "___id": "T000002R032933", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Barrel FX Pipeline.\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 * A Barrel effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.postFX.addBarrel();\r\n * ```\r\n *\r\n * @class BarrelFXPipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.PostFXPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser Game instance.\r\n */", "meta": { "filename": "BarrelFXPipeline.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "classdesc": "The Barrel FX Pipeline.\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.\r\rA Barrel effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.postFX.addBarrel();\r```", "kind": "class", "name": "BarrelFXPipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX", "since": "3.60.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.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "___id": "T000002R032938", "___s": true }, { "comment": "/**\r\n * The amount of distortion applied to the barrel effect.\r\n *\r\n * Typically keep this within the range 1 (no distortion) to +- 1.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#amount\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BarrelFXPipeline.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The amount of distortion applied to the barrel effect.\r\rTypically keep this within the range 1 (no distortion) to +- 1.", "name": "amount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#amount", "scope": "instance", "kind": "member", "___id": "T000002R032944", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Bloom FX Pipeline.\r\n *\r\n * Bloom is an effect used to reproduce an imaging artifact of real-world cameras.\r\n * The effect produces fringes of light extending from the borders of bright areas in an image,\r\n * contributing to the illusion of an extremely bright light overwhelming the\r\n * camera or eye capturing the scene.\r\n *\r\n * A Bloom effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.postFX.addBloom();\r\n * ```\r\n *\r\n * @class BloomFXPipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.PostFXPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser Game instance.\r\n */", "meta": { "filename": "BloomFXPipeline.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "classdesc": "The Bloom FX Pipeline.\r\rBloom is an effect used to reproduce an imaging artifact of real-world cameras.\rThe effect produces fringes of light extending from the borders of bright areas in an image,\rcontributing to the illusion of an extremely bright light overwhelming the\rcamera or eye capturing the scene.\r\rA Bloom effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.postFX.addBloom();\r```", "kind": "class", "name": "BloomFXPipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX", "since": "3.60.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.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "___id": "T000002R032952", "___s": true }, { "comment": "/**\r\n * The number of steps to run the Bloom effect for.\r\n *\r\n * This value should always be an integer.\r\n *\r\n * It defaults to 4. The higher the value, the smoother the Bloom,\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.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#steps\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BloomFXPipeline.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The number of steps to run the Bloom effect for.\r\rThis value should always be an integer.\r\rIt defaults to 4. The higher the value, the smoother the Bloom,\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" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#steps", "scope": "instance", "kind": "member", "___id": "T000002R032958", "___s": true }, { "comment": "/**\r\n * The horizontal offset of the bloom effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#offsetX\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BloomFXPipeline.js", "lineno": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The horizontal offset of the bloom effect.", "name": "offsetX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#offsetX", "scope": "instance", "kind": "member", "___id": "T000002R032960", "___s": true }, { "comment": "/**\r\n * The vertical offset of the bloom effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#offsetY\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BloomFXPipeline.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The vertical offset of the bloom effect.", "name": "offsetY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#offsetY", "scope": "instance", "kind": "member", "___id": "T000002R032962", "___s": true }, { "comment": "/**\r\n * The strength of the blur process of the bloom effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#blurStrength\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BloomFXPipeline.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The strength of the blur process of the bloom effect.", "name": "blurStrength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#blurStrength", "scope": "instance", "kind": "member", "___id": "T000002R032964", "___s": true }, { "comment": "/**\r\n * The strength of the blend process of the bloom effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#strength\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BloomFXPipeline.js", "lineno": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The strength of the blend process of the bloom effect.", "name": "strength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#strength", "scope": "instance", "kind": "member", "___id": "T000002R032966", "___s": true }, { "comment": "/**\r\n * The internal gl color array.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#glcolor\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BloomFXPipeline.js", "lineno": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "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": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#glcolor", "scope": "instance", "kind": "member", "___id": "T000002R032968", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Blur FX Pipeline.\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 * A Blur effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.postFX.addBlur();\r\n * ```\r\n *\r\n * @class BlurFXPipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.PostFXPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser Game instance.\r\n */", "meta": { "filename": "BlurFXPipeline.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "classdesc": "The Blur FX Pipeline.\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\rA Blur effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.postFX.addBlur();\r```", "kind": "class", "name": "BlurFXPipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX", "since": "3.60.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.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "___id": "T000002R032985", "___s": true }, { "comment": "/**\r\n * The horizontal offset of the blur effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#x\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BlurFXPipeline.js", "lineno": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The horizontal offset of the blur effect.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#x", "scope": "instance", "kind": "member", "___id": "T000002R032998", "___s": true }, { "comment": "/**\r\n * The vertical offset of the blur effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#y\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BlurFXPipeline.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The vertical offset of the blur effect.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#y", "scope": "instance", "kind": "member", "___id": "T000002R033000", "___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 * It defaults to 4. 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.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#steps\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BlurFXPipeline.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The number of steps to run the Blur effect for.\r\rThis value should always be an integer.\r\rIt defaults to 4. The 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" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#steps", "scope": "instance", "kind": "member", "___id": "T000002R033002", "___s": true }, { "comment": "/**\r\n * The strength of the blur effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#strength\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BlurFXPipeline.js", "lineno": 101, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The strength of the blur effect.", "name": "strength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#strength", "scope": "instance", "kind": "member", "___id": "T000002R033004", "___s": true }, { "comment": "/**\r\n * The internal gl color array.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#glcolor\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BlurFXPipeline.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "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": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#glcolor", "scope": "instance", "kind": "member", "___id": "T000002R033006", "___s": true }, { "comment": "/**\r\n * Sets the quality of the blur effect to low.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setQualityLow\r\n * @since 3.60.0\r\n *\r\n * @return {this} This FX Pipeline.\r\n */", "meta": { "filename": "BlurFXPipeline.js", "lineno": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "Sets the quality of the blur effect to low.", "kind": "function", "name": "setQualityLow", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setQualityLow", "scope": "instance", "___id": "T000002R033008", "___s": true }, { "comment": "/**\r\n * Sets the quality of the blur effect to medium.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setQualityMedium\r\n * @since 3.60.0\r\n *\r\n * @return {this} This FX Pipeline.\r\n */", "meta": { "filename": "BlurFXPipeline.js", "lineno": 135, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "Sets the quality of the blur effect to medium.", "kind": "function", "name": "setQualityMedium", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setQualityMedium", "scope": "instance", "___id": "T000002R033011", "___s": true }, { "comment": "/**\r\n * Sets the quality of the blur effect to high.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setQualityHigh\r\n * @since 3.60.0\r\n *\r\n * @return {this} This FX Pipeline.\r\n */", "meta": { "filename": "BlurFXPipeline.js", "lineno": 150, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "Sets the quality of the blur effect to high.", "kind": "function", "name": "setQualityHigh", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setQualityHigh", "scope": "instance", "___id": "T000002R033014", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Bokeh FX Pipeline.\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 * A Bokeh effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.postFX.addBokeh();\r\n * ```\r\n *\r\n * @class BokehFXPipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.PostFXPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser Game instance.\r\n */", "meta": { "filename": "BokehFXPipeline.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "classdesc": "The Bokeh FX Pipeline.\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\rA Bokeh effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.postFX.addBokeh();\r```", "kind": "class", "name": "BokehFXPipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX", "since": "3.60.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.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "___id": "T000002R033027", "___s": true }, { "comment": "/**\r\n * Is this a Tilt Shift effect or a standard bokeh effect?\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#isTiltShift\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BokehFXPipeline.js", "lineno": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "Is this a Tilt Shift effect or a standard bokeh effect?", "name": "isTiltShift", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#isTiltShift", "scope": "instance", "kind": "member", "___id": "T000002R033033", "___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.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#strength\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BokehFXPipeline.js", "lineno": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "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" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#strength", "scope": "instance", "kind": "member", "___id": "T000002R033035", "___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.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#blurX\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BokehFXPipeline.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "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" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#blurX", "scope": "instance", "kind": "member", "___id": "T000002R033037", "___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.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#blurY\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BokehFXPipeline.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "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" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#blurY", "scope": "instance", "kind": "member", "___id": "T000002R033039", "___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.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#radius\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BokehFXPipeline.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "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" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#radius", "scope": "instance", "kind": "member", "___id": "T000002R033041", "___s": true }, { "comment": "/**\r\n * The amount, or strength, of the bokeh effect. Defaults to 1.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#amount\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BokehFXPipeline.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The amount, or strength, of the bokeh effect. Defaults to 1.", "name": "amount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#amount", "scope": "instance", "kind": "member", "___id": "T000002R033043", "___s": true }, { "comment": "/**\r\n * The color contrast, or brightness, of the bokeh effect. Defaults to 0.2.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#contrast\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BokehFXPipeline.js", "lineno": 117, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The color contrast, or brightness, of the bokeh effect. Defaults to 0.2.", "name": "contrast", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#contrast", "scope": "instance", "kind": "member", "___id": "T000002R033045", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Circle FX Pipeline.\r\n *\r\n * This effect will draw a circle around the texture of the Game Object, effectively masking off\r\n * any area outside of the circle without the need for an actual mask. You can control the thickness\r\n * of the circle, the color of the circle and the color of the background, should the texture be\r\n * transparent. You can also control the feathering applied to the circle, allowing for a harsh or soft edge.\r\n *\r\n * Please note that adding this effect to a Game Object will not change the input area or physics body of\r\n * the Game Object, should it have one.\r\n *\r\n * A Circle effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.postFX.addCircle();\r\n * ```\r\n *\r\n * @class CircleFXPipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.PostFXPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser Game instance.\r\n */", "meta": { "filename": "CircleFXPipeline.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "classdesc": "The Circle FX Pipeline.\r\rThis effect will draw a circle around the texture of the Game Object, effectively masking off\rany area outside of the circle without the need for an actual mask. You can control the thickness\rof the circle, the color of the circle and the color of the background, should the texture be\rtransparent. You can also control the feathering applied to the circle, allowing for a harsh or soft edge.\r\rPlease note that adding this effect to a Game Object will not change the input area or physics body of\rthe Game Object, should it have one.\r\rA Circle effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.postFX.addCircle();\r```", "kind": "class", "name": "CircleFXPipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX", "since": "3.60.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.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "___id": "T000002R033054", "___s": true }, { "comment": "/**\r\n * The scale of the circle. The default scale is 1, which is a circle\r\n * the full size of the underlying texture. Reduce this value to create\r\n * a smaller circle, or increase it to create a circle that extends off\r\n * the edges of the texture.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#scale\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "CircleFXPipeline.js", "lineno": 52, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The scale of the circle. The default scale is 1, which is a circle\rthe full size of the underlying texture. Reduce this value to create\ra smaller circle, or increase it to create a circle that extends off\rthe edges of the texture.", "name": "scale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#scale", "scope": "instance", "kind": "member", "___id": "T000002R033060", "___s": true }, { "comment": "/**\r\n * The amount of feathering to apply to the circle from the ring,\r\n * extending into the middle of the circle. The default is 0.005,\r\n * which is a very low amount of feathering just making sure the ring\r\n * has a smooth edge. Increase this amount to a value such as 0.5\r\n * or 0.025 for larger amounts of feathering.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#feather\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "CircleFXPipeline.js", "lineno": 64, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The amount of feathering to apply to the circle from the ring,\rextending into the middle of the circle. The default is 0.005,\rwhich is a very low amount of feathering just making sure the ring\rhas a smooth edge. Increase this amount to a value such as 0.5\ror 0.025 for larger amounts of feathering.", "name": "feather", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#feather", "scope": "instance", "kind": "member", "___id": "T000002R033062", "___s": true }, { "comment": "/**\r\n * The width of the circle around the texture, in pixels. This value\r\n * doesn't factor in the feather, which can extend the thickness\r\n * internally depending on its value.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#thickness\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "CircleFXPipeline.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The width of the circle around the texture, in pixels. This value\rdoesn't factor in the feather, which can extend the thickness\rinternally depending on its value.", "name": "thickness", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#thickness", "scope": "instance", "kind": "member", "___id": "T000002R033064", "___s": true }, { "comment": "/**\r\n * The internal gl color array for the ring color.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#glcolor\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "CircleFXPipeline.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The internal gl color array for the ring color.", "name": "glcolor", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#glcolor", "scope": "instance", "kind": "member", "___id": "T000002R033066", "___s": true }, { "comment": "/**\r\n * The internal gl color array for the background color.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#glcolor2\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "CircleFXPipeline.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The internal gl color array for the background color.", "name": "glcolor2", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#glcolor2", "scope": "instance", "kind": "member", "___id": "T000002R033068", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The ColorMatrix FX Pipeline.\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 Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.postFX.addColorMatrix();\r\n * ```\r\n *\r\n * @class ColorMatrixFXPipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.PostFXPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser Game instance.\r\n */", "meta": { "filename": "ColorMatrixFXPipeline.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "classdesc": "The ColorMatrix FX Pipeline.\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 Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.postFX.addColorMatrix();\r```", "kind": "class", "name": "ColorMatrixFXPipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX", "since": "3.60.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.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "___id": "T000002R033076", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Displacement FX Pipeline.\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 * A Displacement effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.postFX.addDisplacement();\r\n * ```\r\n *\r\n * @class DisplacementFXPipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.PostFXPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser Game instance.\r\n */", "meta": { "filename": "DisplacementFXPipeline.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "classdesc": "The Displacement FX Pipeline.\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\rA Displacement effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.postFX.addDisplacement();\r```", "kind": "class", "name": "DisplacementFXPipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX", "since": "3.60.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.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "___id": "T000002R033087", "___s": true }, { "comment": "/**\r\n * The amount of horizontal displacement to apply.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#x\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "DisplacementFXPipeline.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The amount of horizontal displacement to apply.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#x", "scope": "instance", "kind": "member", "___id": "T000002R033093", "___s": true }, { "comment": "/**\r\n * The amount of vertical displacement to apply.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#y\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "DisplacementFXPipeline.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The amount of vertical displacement to apply.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#y", "scope": "instance", "kind": "member", "___id": "T000002R033095", "___s": true }, { "comment": "/**\r\n * The underlying WebGLTexture used for displacement.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#glTexture\r\n * @type {WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "DisplacementFXPipeline.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The underlying WebGLTexture used for displacement.", "name": "glTexture", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#glTexture", "scope": "instance", "kind": "member", "___id": "T000002R033097", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Glow FX Pipeline.\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 Game Object. The color and strength of the glow can be modified.\r\n *\r\n * A Glow effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.postFX.addGlow();\r\n * ```\r\n *\r\n * @class GlowFXPipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.PostFXPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser Game instance.\r\n * @param {object} config - The configuration options for this pipeline.\r\n */", "meta": { "filename": "GlowFXPipeline.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "classdesc": "The Glow FX Pipeline.\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 Game Object. The color and strength of the glow can be modified.\r\rA Glow effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.postFX.addGlow();\r```", "kind": "class", "name": "GlowFXPipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "A reference to the Phaser Game instance.", "name": "game" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The configuration options for this pipeline.", "name": "config" } ], "scope": "static", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "___id": "T000002R033112", "___s": true }, { "comment": "/**\r\n * The strength of the glow outward from the edge of the Sprite.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#outerStrength\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "GlowFXPipeline.js", "lineno": 55, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The strength of the glow outward from the edge of the Sprite.", "name": "outerStrength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#outerStrength", "scope": "instance", "kind": "member", "___id": "T000002R033120", "___s": true }, { "comment": "/**\r\n * The strength of the glow inward from the edge of the Sprite.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#innerStrength\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "GlowFXPipeline.js", "lineno": 64, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The strength of the glow inward from the edge of the Sprite.", "name": "innerStrength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#innerStrength", "scope": "instance", "kind": "member", "___id": "T000002R033122", "___s": true }, { "comment": "/**\r\n * If `true` only the glow is drawn, not the texture itself.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#knockout\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "GlowFXPipeline.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "If `true` only the glow is drawn, not the texture itself.", "name": "knockout", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#knockout", "scope": "instance", "kind": "member", "___id": "T000002R033124", "___s": true }, { "comment": "/**\r\n * A 4 element array of gl color values.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#glcolor\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "GlowFXPipeline.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "A 4 element array of gl color values.", "name": "glcolor", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#glcolor", "scope": "instance", "kind": "member", "___id": "T000002R033126", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Gradient FX Pipeline.\r\n *\r\n * The gradient overlay effect is a visual technique where a smooth color transition is applied over Game Objects,\r\n * such as sprites or UI components. This effect is used to enhance visual appeal, emphasize depth, or create\r\n * stylistic and atmospheric variations. It can also be utilized to convey information, such as representing\r\n * progress or health status through color changes.\r\n *\r\n * A Gradient effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.postFX.addGradient();\r\n * ```\r\n *\r\n * @class GradientFXPipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.PostFXPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser Game instance.\r\n */", "meta": { "filename": "GradientFXPipeline.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "classdesc": "The Gradient FX Pipeline.\r\rThe gradient overlay effect is a visual technique where a smooth color transition is applied over Game Objects,\rsuch as sprites or UI components. This effect is used to enhance visual appeal, emphasize depth, or create\rstylistic and atmospheric variations. It can also be utilized to convey information, such as representing\rprogress or health status through color changes.\r\rA Gradient effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.postFX.addGradient();\r```", "kind": "class", "name": "GradientFXPipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX", "since": "3.60.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.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "___id": "T000002R033135", "___s": true }, { "comment": "/**\r\n * The alpha value of the gradient effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#alpha\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "GradientFXPipeline.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The alpha value of the gradient effect.", "name": "alpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#alpha", "scope": "instance", "kind": "member", "___id": "T000002R033141", "___s": true }, { "comment": "/**\r\n * Sets how many 'chunks' the gradient is divided in to, as spread over the\r\n * entire height of the texture. Leave this at zero for a smooth gradient,\r\n * or set to a higher number to split the gradient into that many sections, giving\r\n * a more banded 'retro' effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#size\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "GradientFXPipeline.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "Sets how many 'chunks' the gradient is divided in to, as spread over the\rentire height of the texture. Leave this at zero for a smooth gradient,\ror set to a higher number to split the gradient into that many sections, giving\ra more banded 'retro' effect.", "name": "size", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#size", "scope": "instance", "kind": "member", "___id": "T000002R033143", "___s": true }, { "comment": "/**\r\n * The horizontal position the gradient will start from. This value is normalized, between 0 and 1 and is not in pixels.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#fromX\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "GradientFXPipeline.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The horizontal position the gradient will start from. This value is normalized, between 0 and 1 and is not in pixels.", "name": "fromX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#fromX", "scope": "instance", "kind": "member", "___id": "T000002R033145", "___s": true }, { "comment": "/**\r\n * The vertical position the gradient will start from. This value is normalized, between 0 and 1 and is not in pixels.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#fromY\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "GradientFXPipeline.js", "lineno": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The vertical position the gradient will start from. This value is normalized, between 0 and 1 and is not in pixels.", "name": "fromY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#fromY", "scope": "instance", "kind": "member", "___id": "T000002R033147", "___s": true }, { "comment": "/**\r\n * The horizontal position the gradient will end. This value is normalized, between 0 and 1 and is not in pixels.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#toX\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "GradientFXPipeline.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The horizontal position the gradient will end. This value is normalized, between 0 and 1 and is not in pixels.", "name": "toX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#toX", "scope": "instance", "kind": "member", "___id": "T000002R033149", "___s": true }, { "comment": "/**\r\n * The vertical position the gradient will end. This value is normalized, between 0 and 1 and is not in pixels.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#toY\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "GradientFXPipeline.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The vertical position the gradient will end. This value is normalized, between 0 and 1 and is not in pixels.", "name": "toY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#toY", "scope": "instance", "kind": "member", "___id": "T000002R033151", "___s": true }, { "comment": "/**\r\n * The internal gl color array for the starting color.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#glcolor1\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "GradientFXPipeline.js", "lineno": 106, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The internal gl color array for the starting color.", "name": "glcolor1", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#glcolor1", "scope": "instance", "kind": "member", "___id": "T000002R033153", "___s": true }, { "comment": "/**\r\n * The internal gl color array for the ending color.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#glcolor2\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "GradientFXPipeline.js", "lineno": 115, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The internal gl color array for the ending color.", "name": "glcolor2", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#glcolor2", "scope": "instance", "kind": "member", "___id": "T000002R033155", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Renderer.WebGL.Pipelines.FX\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "kind": "namespace", "name": "FX", "memberof": "Phaser.Renderer.WebGL.Pipelines", "longname": "Phaser.Renderer.WebGL.Pipelines.FX", "scope": "static", "___id": "T000002R033160", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Pixelate FX Pipeline.\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 * A Pixelate effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.postFX.addPixelate();\r\n * ```\r\n *\r\n * @class PixelateFXPipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.PostFXPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser Game instance.\r\n */", "meta": { "filename": "PixelateFXPipeline.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "classdesc": "The Pixelate FX Pipeline.\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.\r\rA Pixelate effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.postFX.addPixelate();\r```", "kind": "class", "name": "PixelateFXPipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX", "since": "3.60.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.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "___id": "T000002R033180", "___s": true }, { "comment": "/**\r\n * The amount of pixelation to apply.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#amount\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PixelateFXPipeline.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The amount of pixelation to apply.", "name": "amount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#amount", "scope": "instance", "kind": "member", "___id": "T000002R033186", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Shadow FX Pipeline.\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 * A Shadow effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.postFX.addShadow();\r\n * ```\r\n *\r\n * @class ShadowFXPipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.PostFXPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser Game instance.\r\n */", "meta": { "filename": "ShadowFXPipeline.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "classdesc": "The Shadow FX Pipeline.\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\rA Shadow effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.postFX.addShadow();\r```", "kind": "class", "name": "ShadowFXPipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX", "since": "3.60.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.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "___id": "T000002R033195", "___s": true }, { "comment": "/**\r\n * The horizontal offset of the shadow effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#x\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ShadowFXPipeline.js", "lineno": 48, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The horizontal offset of the shadow effect.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#x", "scope": "instance", "kind": "member", "___id": "T000002R033201", "___s": true }, { "comment": "/**\r\n * The vertical offset of the shadow effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#y\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ShadowFXPipeline.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The vertical offset of the shadow effect.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#y", "scope": "instance", "kind": "member", "___id": "T000002R033203", "___s": true }, { "comment": "/**\r\n * The amount of decay for the shadow effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#decay\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ShadowFXPipeline.js", "lineno": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The amount of decay for the shadow effect.", "name": "decay", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#decay", "scope": "instance", "kind": "member", "___id": "T000002R033205", "___s": true }, { "comment": "/**\r\n * The power of the shadow effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#power\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ShadowFXPipeline.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The power of the shadow effect.", "name": "power", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#power", "scope": "instance", "kind": "member", "___id": "T000002R033207", "___s": true }, { "comment": "/**\r\n * The internal gl color array.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#glcolor\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ShadowFXPipeline.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "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": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#glcolor", "scope": "instance", "kind": "member", "___id": "T000002R033209", "___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.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#samples\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ShadowFXPipeline.js", "lineno": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "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": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#samples", "scope": "instance", "kind": "member", "___id": "T000002R033211", "___s": true }, { "comment": "/**\r\n * The intensity of the shadow effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#intensity\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ShadowFXPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The intensity of the shadow effect.", "name": "intensity", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#intensity", "scope": "instance", "kind": "member", "___id": "T000002R033213", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Shine FX Pipeline.\r\n *\r\n * The shine effect is a visual technique that simulates the appearance of reflective\r\n * or glossy surfaces by passing a light beam across a Game Object. This effect is used to\r\n * enhance visual appeal, emphasize certain features, and create a sense of depth or\r\n * material properties.\r\n *\r\n * A Shine effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.postFX.addShine();\r\n * ```\r\n *\r\n * @class ShineFXPipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.PostFXPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser Game instance.\r\n */", "meta": { "filename": "ShineFXPipeline.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "classdesc": "The Shine FX Pipeline.\r\rThe shine effect is a visual technique that simulates the appearance of reflective\ror glossy surfaces by passing a light beam across a Game Object. This effect is used to\renhance visual appeal, emphasize certain features, and create a sense of depth or\rmaterial properties.\r\rA Shine effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.postFX.addShine();\r```", "kind": "class", "name": "ShineFXPipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX", "since": "3.60.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.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "___id": "T000002R033222", "___s": true }, { "comment": "/**\r\n * The speed of the Shine effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#speed\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ShineFXPipeline.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The speed of the Shine effect.", "name": "speed", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#speed", "scope": "instance", "kind": "member", "___id": "T000002R033228", "___s": true }, { "comment": "/**\r\n * The line width of the Shine effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#lineWidth\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ShineFXPipeline.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The line width of the Shine effect.", "name": "lineWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#lineWidth", "scope": "instance", "kind": "member", "___id": "T000002R033230", "___s": true }, { "comment": "/**\r\n * The gradient of the Shine effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#gradient\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ShineFXPipeline.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The gradient of the Shine effect.", "name": "gradient", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#gradient", "scope": "instance", "kind": "member", "___id": "T000002R033232", "___s": true }, { "comment": "/**\r\n * Does this Shine effect reveal or get added to its target?\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#reveal\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ShineFXPipeline.js", "lineno": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "Does this Shine effect reveal or get added to its target?", "name": "reveal", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#reveal", "scope": "instance", "kind": "member", "___id": "T000002R033234", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Vignette FX Pipeline.\r\n *\r\n * The vignette effect is a visual technique where the edges of the screen, or a Game Object, gradually darken or blur,\r\n * creating a frame-like appearance. This effect is used to draw the player's focus towards the central action or subject,\r\n * enhance immersion, and provide a cinematic or artistic quality to the game's visuals.\r\n *\r\n * A Vignette effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.postFX.addVignette();\r\n * ```\r\n *\r\n * @class VignetteFXPipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.PostFXPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser Game instance.\r\n */", "meta": { "filename": "VignetteFXPipeline.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "classdesc": "The Vignette FX Pipeline.\r\rThe vignette effect is a visual technique where the edges of the screen, or a Game Object, gradually darken or blur,\rcreating a frame-like appearance. This effect is used to draw the player's focus towards the central action or subject,\renhance immersion, and provide a cinematic or artistic quality to the game's visuals.\r\rA Vignette effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.postFX.addVignette();\r```", "kind": "class", "name": "VignetteFXPipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX", "since": "3.60.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.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "___id": "T000002R033243", "___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.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#x\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "VignetteFXPipeline.js", "lineno": 48, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "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": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#x", "scope": "instance", "kind": "member", "___id": "T000002R033249", "___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.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#y\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "VignetteFXPipeline.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "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": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#y", "scope": "instance", "kind": "member", "___id": "T000002R033251", "___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.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#radius\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "VignetteFXPipeline.js", "lineno": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "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": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#radius", "scope": "instance", "kind": "member", "___id": "T000002R033253", "___s": true }, { "comment": "/**\r\n * The strength of the vignette effect.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#strength\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "VignetteFXPipeline.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The strength of the vignette effect.", "name": "strength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#strength", "scope": "instance", "kind": "member", "___id": "T000002R033255", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Wipe FX Pipeline.\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 1, axis 0\r\n *\r\n * It is up to you to set the `progress` value yourself, i.e. via a Tween, in order to transition the effect.\r\n *\r\n * A Wipe effect is added to a Game Object via the FX component:\r\n *\r\n * ```js\r\n * const sprite = this.add.sprite();\r\n *\r\n * sprite.postFX.addWipe();\r\n * sprite.postFX.addReveal();\r\n * ```\r\n *\r\n * @class WipeFXPipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.PostFXPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines.FX\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser Game instance.\r\n */", "meta": { "filename": "WipeFXPipeline.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "classdesc": "The Wipe FX Pipeline.\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 1, axis 0\r\rIt is up to you to set the `progress` value yourself, i.e. via a Tween, in order to transition the effect.\r\rA Wipe effect is added to a Game Object via the FX component:\r\r```js\rconst sprite = this.add.sprite();\r\rsprite.postFX.addWipe();\rsprite.postFX.addReveal();\r```", "kind": "class", "name": "WipeFXPipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX", "since": "3.60.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.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "___id": "T000002R033263", "___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 (i.e. via a Tween)\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#progress\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WipeFXPipeline.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "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 (i.e. via a Tween)", "name": "progress", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#progress", "scope": "instance", "kind": "member", "___id": "T000002R033269", "___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.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#wipeWidth\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WipeFXPipeline.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "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": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#wipeWidth", "scope": "instance", "kind": "member", "___id": "T000002R033271", "___s": true }, { "comment": "/**\r\n * The direction of the wipe effect. Either 0 or 1. Set in conjunction with the axis property.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#direction\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WipeFXPipeline.js", "lineno": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The direction of the wipe effect. Either 0 or 1. Set in conjunction with the axis property.", "name": "direction", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#direction", "scope": "instance", "kind": "member", "___id": "T000002R033273", "___s": true }, { "comment": "/**\r\n * The axis of the wipe effect. Either 0 or 1. Set in conjunction with the direction property.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#axis\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WipeFXPipeline.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "The axis of the wipe effect. Either 0 or 1. Set in conjunction with the direction property.", "name": "axis", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#axis", "scope": "instance", "kind": "member", "___id": "T000002R033275", "___s": true }, { "comment": "/**\r\n * Is this a reveal (true) or a fade (false) effect?\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#reveal\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WipeFXPipeline.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines\\fx", "code": {} }, "description": "Is this a reveal (true) or a fade (false) effect?", "name": "reveal", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#reveal", "scope": "instance", "kind": "member", "___id": "T000002R033277", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The FXPipeline is a built-in pipeline that controls the application of FX Controllers during\r\n * the rendering process. It maintains all of the FX shaders, instances of Post FX Pipelines and\r\n * is responsible for rendering.\r\n *\r\n * You should rarely interact with this pipeline directly. Instead, use the FX Controllers that\r\n * is part of the Game Object class in order to manage the effects.\r\n *\r\n * @class FXPipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.PreFXPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser game instance.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "classdesc": "The FXPipeline is a built-in pipeline that controls the application of FX Controllers during\rthe rendering process. It maintains all of the FX shaders, instances of Post FX Pipelines and\ris responsible for rendering.\r\rYou should rarely interact with this pipeline directly. Instead, use the FX Controllers that\ris part of the Game Object class in order to manage the effects.", "kind": "class", "name": "FXPipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines", "since": "3.60.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.Renderer.WebGL.Pipelines.FXPipeline", "___id": "T000002R033293", "___s": true }, { "comment": "/**\r\n * An instance of the Glow Post FX Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FXPipeline#glow\r\n * @type {Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 64, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "An instance of the Glow Post FX Pipeline.", "name": "glow", "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#glow", "scope": "instance", "kind": "member", "___id": "T000002R033299", "___s": true }, { "comment": "/**\r\n * An instance of the Shadow Post FX Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FXPipeline#shadow\r\n * @type {Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "An instance of the Shadow Post FX Pipeline.", "name": "shadow", "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#shadow", "scope": "instance", "kind": "member", "___id": "T000002R033301", "___s": true }, { "comment": "/**\r\n * An instance of the Pixelate Post FX Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FXPipeline#pixelate\r\n * @type {Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "An instance of the Pixelate Post FX Pipeline.", "name": "pixelate", "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#pixelate", "scope": "instance", "kind": "member", "___id": "T000002R033303", "___s": true }, { "comment": "/**\r\n * An instance of the Vignette Post FX Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FXPipeline#vignette\r\n * @type {Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "An instance of the Vignette Post FX Pipeline.", "name": "vignette", "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#vignette", "scope": "instance", "kind": "member", "___id": "T000002R033305", "___s": true }, { "comment": "/**\r\n * An instance of the Shine Post FX Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FXPipeline#shine\r\n * @type {Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "An instance of the Shine Post FX Pipeline.", "name": "shine", "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#shine", "scope": "instance", "kind": "member", "___id": "T000002R033307", "___s": true }, { "comment": "/**\r\n * An instance of the Gradient Post FX Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FXPipeline#gradient\r\n * @type {Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 109, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "An instance of the Gradient Post FX Pipeline.", "name": "gradient", "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#gradient", "scope": "instance", "kind": "member", "___id": "T000002R033309", "___s": true }, { "comment": "/**\r\n * An instance of the Circle Post FX Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FXPipeline#circle\r\n * @type {Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 118, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "An instance of the Circle Post FX Pipeline.", "name": "circle", "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#circle", "scope": "instance", "kind": "member", "___id": "T000002R033311", "___s": true }, { "comment": "/**\r\n * An instance of the Barrel Post FX Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FXPipeline#barrel\r\n * @type {Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 127, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "An instance of the Barrel Post FX Pipeline.", "name": "barrel", "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#barrel", "scope": "instance", "kind": "member", "___id": "T000002R033313", "___s": true }, { "comment": "/**\r\n * An instance of the Wipe Post FX Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FXPipeline#wipe\r\n * @type {Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "An instance of the Wipe Post FX Pipeline.", "name": "wipe", "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#wipe", "scope": "instance", "kind": "member", "___id": "T000002R033315", "___s": true }, { "comment": "/**\r\n * An instance of the Bokeh Post FX Pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FXPipeline#bokeh\r\n * @type {Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "An instance of the Bokeh Post FX Pipeline.", "name": "bokeh", "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#bokeh", "scope": "instance", "kind": "member", "___id": "T000002R033317", "___s": true }, { "comment": "/**\r\n * An array containing references to the methods that map to the FX CONSTs.\r\n *\r\n * This array is intentionally sparse. Do not adjust.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FXPipeline#fxHandlers\r\n * @type {function[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 172, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "An array containing references to the methods that map to the FX CONSTs.\r\rThis array is intentionally sparse. Do not adjust.", "name": "fxHandlers", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#fxHandlers", "scope": "instance", "kind": "member", "___id": "T000002R033334", "___s": true }, { "comment": "/**\r\n * The source Render Target.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FXPipeline#source\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 183, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The source Render Target.", "name": "source", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#source", "scope": "instance", "kind": "member", "___id": "T000002R033336", "___s": true }, { "comment": "/**\r\n * The target Render Target.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FXPipeline#target\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 192, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The target Render Target.", "name": "target", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#target", "scope": "instance", "kind": "member", "___id": "T000002R033338", "___s": true }, { "comment": "/**\r\n * The swap Render Target.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.FXPipeline#swap\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 201, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The swap Render Target.", "name": "swap", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#swap", "scope": "instance", "kind": "member", "___id": "T000002R033340", "___s": true }, { "comment": "/**\r\n * Takes the currently bound Game Object and runs all of its pre-render effects,\r\n * using the given Render Target as the source.\r\n *\r\n * Finally calls `drawToGame` to copy the result to the Game Canvas.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#onDraw\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target1 - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target2 - The target Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target3 - The swap Render Target.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 211, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Takes the currently bound Game Object and runs all of its pre-render effects,\rusing the given Render Target as the source.\r\rFinally calls `drawToGame` to copy the result to the Game Canvas.", "kind": "function", "name": "onDraw", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "target1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The swap Render Target.", "name": "target3" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onDraw", "scope": "instance", "overrides": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onDraw", "___id": "T000002R033342", "___s": true }, { "comment": "/**\r\n * Takes the source and target and runs a copy from source to target.\r\n *\r\n * This will use the current shader and pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#runDraw\r\n * @since 3.60.0\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 254, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Takes the source and target and runs a copy from source to target.\r\rThis will use the current shader and pipeline.", "kind": "function", "name": "runDraw", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#runDraw", "scope": "instance", "___id": "T000002R033354", "___s": true }, { "comment": "/**\r\n * Runs the Glow FX controller.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#onGlow\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Glow} config - The Glow FX controller.\r\n * @param {number} width - The width of the target.\r\n * @param {number} height - The height of the target.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 273, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Runs the Glow FX controller.", "kind": "function", "name": "onGlow", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.FX.Glow" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Glow" } }, "description": "The Glow FX controller.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the target.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the target.", "name": "height" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onGlow", "scope": "instance", "___id": "T000002R033360", "___s": true }, { "comment": "/**\r\n * Runs the Shadow FX controller.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#onShadow\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Shadow} config - The Shadow FX controller.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 294, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Runs the Shadow FX controller.", "kind": "function", "name": "onShadow", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.FX.Shadow" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Shadow" } }, "description": "The Shadow FX controller.", "name": "config" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onShadow", "scope": "instance", "___id": "T000002R033363", "___s": true }, { "comment": "/**\r\n * Runs the Pixelate FX controller.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#onPixelate\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Pixelate} config - The Pixelate FX controller.\r\n * @param {number} width - The width of the target.\r\n * @param {number} height - The height of the target.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 313, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Runs the Pixelate FX controller.", "kind": "function", "name": "onPixelate", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.FX.Pixelate" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Pixelate" } }, "description": "The Pixelate FX controller.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the target.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the target.", "name": "height" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onPixelate", "scope": "instance", "___id": "T000002R033366", "___s": true }, { "comment": "/**\r\n * Runs the Vignette FX controller.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#onVignette\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Vignette} config - The Vignette FX controller.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 334, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Runs the Vignette FX controller.", "kind": "function", "name": "onVignette", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.FX.Vignette" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Vignette" } }, "description": "The Vignette FX controller.", "name": "config" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onVignette", "scope": "instance", "___id": "T000002R033369", "___s": true }, { "comment": "/**\r\n * Runs the Shine FX controller.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#onShine\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Shine} config - The Shine FX controller.\r\n * @param {number} width - The width of the target.\r\n * @param {number} height - The height of the target.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Runs the Shine FX controller.", "kind": "function", "name": "onShine", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.FX.Shine" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Shine" } }, "description": "The Shine FX controller.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the target.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the target.", "name": "height" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onShine", "scope": "instance", "___id": "T000002R033372", "___s": true }, { "comment": "/**\r\n * Runs the Blur FX controller.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#onBlur\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Blur} config - The Blur FX controller.\r\n * @param {number} width - The width of the target.\r\n * @param {number} height - The height of the target.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 374, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Runs the Blur FX controller.", "kind": "function", "name": "onBlur", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.FX.Blur" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Blur" } }, "description": "The Blur FX controller.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the target.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the target.", "name": "height" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onBlur", "scope": "instance", "___id": "T000002R033375", "___s": true }, { "comment": "/**\r\n * Runs the Gradient FX controller.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#onGradient\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Gradient} config - The Gradient FX controller.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Runs the Gradient FX controller.", "kind": "function", "name": "onGradient", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.FX.Gradient" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Gradient" } }, "description": "The Gradient FX controller.", "name": "config" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onGradient", "scope": "instance", "___id": "T000002R033383", "___s": true }, { "comment": "/**\r\n * Runs the Bloom FX controller.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#onBloom\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Bloom} config - The Bloom FX controller.\r\n * @param {number} width - The width of the target.\r\n * @param {number} height - The height of the target.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Runs the Bloom FX controller.", "kind": "function", "name": "onBloom", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.FX.Bloom" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Bloom" } }, "description": "The Bloom FX controller.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the target.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the target.", "name": "height" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onBloom", "scope": "instance", "___id": "T000002R033386", "___s": true }, { "comment": "/**\r\n * Runs the ColorMatrix FX controller.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#onColorMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.ColorMatrix} config - The ColorMatrix FX controller.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 469, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Runs the ColorMatrix FX controller.", "kind": "function", "name": "onColorMatrix", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.FX.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.ColorMatrix" } }, "description": "The ColorMatrix FX controller.", "name": "config" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onColorMatrix", "scope": "instance", "___id": "T000002R033393", "___s": true }, { "comment": "/**\r\n * Runs the Circle FX controller.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#onCircle\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Circle} config - The Circle FX controller.\r\n * @param {number} width - The width of the target.\r\n * @param {number} height - The height of the target.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 487, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Runs the Circle FX controller.", "kind": "function", "name": "onCircle", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.FX.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Circle" } }, "description": "The Circle FX controller.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the target.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the target.", "name": "height" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onCircle", "scope": "instance", "___id": "T000002R033395", "___s": true }, { "comment": "/**\r\n * Runs the Barrel FX controller.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#onBarrel\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Barrel} config - The Barrel FX controller.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 508, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Runs the Barrel FX controller.", "kind": "function", "name": "onBarrel", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.FX.Barrel" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Barrel" } }, "description": "The Barrel FX controller.", "name": "config" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onBarrel", "scope": "instance", "___id": "T000002R033398", "___s": true }, { "comment": "/**\r\n * Runs the Displacement FX controller.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#onDisplacement\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Displacement} config - The Displacement FX controller.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Runs the Displacement FX controller.", "kind": "function", "name": "onDisplacement", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.FX.Displacement" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Displacement" } }, "description": "The Displacement FX controller.", "name": "config" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onDisplacement", "scope": "instance", "___id": "T000002R033401", "___s": true }, { "comment": "/**\r\n * Runs the Wipe FX controller.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#onWipe\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Wipe} config - The Wipe FX controller.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 547, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Runs the Wipe FX controller.", "kind": "function", "name": "onWipe", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.FX.Wipe" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Wipe" } }, "description": "The Wipe FX controller.", "name": "config" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onWipe", "scope": "instance", "___id": "T000002R033403", "___s": true }, { "comment": "/**\r\n * Runs the Bokeh FX controller.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#onBokeh\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Bokeh} config - The Bokeh FX controller.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 566, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Runs the Bokeh FX controller.", "kind": "function", "name": "onBokeh", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.FX.Bokeh" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Bokeh" } }, "description": "The Bokeh FX controller.", "name": "config" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onBokeh", "scope": "instance", "___id": "T000002R033406", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.FXPipeline#destroy\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "FXPipeline.js", "lineno": 585, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Destroys all shader instances, removes all object references and nulls all external references.", "kind": "function", "name": "destroy", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#destroy", "scope": "instance", "overrides": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#destroy", "___id": "T000002R033409", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Renderer.WebGL.Pipelines\r\n */", "meta": { "filename": "index.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "kind": "namespace", "name": "Pipelines", "memberof": "Phaser.Renderer.WebGL", "longname": "Phaser.Renderer.WebGL.Pipelines", "scope": "static", "___id": "T000002R033418", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Light Pipeline is an extension of the Multi Pipeline and uses a custom shader\r\n * designed to handle forward diffused rendering of 2D lights in a Scene.\r\n *\r\n * The shader works in tandem with Light Game Objects, and optionally texture normal maps,\r\n * to provide an ambient illumination effect.\r\n *\r\n * If you wish to provide your own shader, you can use the `%LIGHT_COUNT%` declaration in the source,\r\n * and it will be automatically replaced at run-time with the total number of configured lights.\r\n *\r\n * The maximum number of lights can be set in the Render Config `maxLights` property and defaults to 10.\r\n *\r\n * Prior to Phaser v3.50 this pipeline was called the `ForwardDiffuseLightPipeline`.\r\n *\r\n * The fragment shader it uses can be found in `shaders/src/Light.frag`.\r\n * The vertex shader it uses can be found in `shaders/src/Multi.vert`.\r\n *\r\n * The default shader attributes for this pipeline are:\r\n *\r\n * `inPosition` (vec2, offset 0)\r\n * `inTexCoord` (vec2, offset 8)\r\n * `inTexId` (float, offset 16)\r\n * `inTintEffect` (float, offset 20)\r\n * `inTint` (vec4, offset 24, normalized)\r\n *\r\n * The default shader uniforms for this pipeline are those from the Multi Pipeline, plus:\r\n *\r\n * `uMainSampler` (sampler2D)\r\n * `uNormSampler` (sampler2D)\r\n * `uCamera` (vec4)\r\n * `uResolution` (vec2)\r\n * `uAmbientLightColor` (vec3)\r\n * `uInverseRotationMatrix` (mat3)\r\n * `uLights` (Light struct)\r\n *\r\n * @class LightPipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.MultiPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines\r\n * @constructor\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration options for this pipeline.\r\n */", "meta": { "filename": "LightPipeline.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "classdesc": "The Light Pipeline is an extension of the Multi Pipeline and uses a custom shader\rdesigned to handle forward diffused rendering of 2D lights in a Scene.\r\rThe shader works in tandem with Light Game Objects, and optionally texture normal maps,\rto provide an ambient illumination effect.\r\rIf you wish to provide your own shader, you can use the `%LIGHT_COUNT%` declaration in the source,\rand it will be automatically replaced at run-time with the total number of configured lights.\r\rThe maximum number of lights can be set in the Render Config `maxLights` property and defaults to 10.\r\rPrior to Phaser v3.50 this pipeline was called the `ForwardDiffuseLightPipeline`.\r\rThe fragment shader it uses can be found in `shaders/src/Light.frag`.\rThe vertex shader it uses can be found in `shaders/src/Multi.vert`.\r\rThe default shader attributes for this pipeline are:\r\r`inPosition` (vec2, offset 0)\r`inTexCoord` (vec2, offset 8)\r`inTexId` (float, offset 16)\r`inTintEffect` (float, offset 20)\r`inTint` (vec4, offset 24, normalized)\r\rThe default shader uniforms for this pipeline are those from the Multi Pipeline, plus:\r\r`uMainSampler` (sampler2D)\r`uNormSampler` (sampler2D)\r`uCamera` (vec4)\r`uResolution` (vec2)\r`uAmbientLightColor` (vec3)\r`uInverseRotationMatrix` (mat3)\r`uLights` (Light struct)", "kind": "class", "name": "LightPipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.MultiPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration options for this pipeline.", "name": "config" } ], "scope": "static", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "___id": "T000002R033442", "___s": true }, { "comment": "/**\r\n * Stores a default normal map, which is an object with a `glTexture` property that\r\n * maps to a 1x1 texture of the color #7f7fff created in the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.LightPipeline#defaultNormalMap\r\n * @type {object}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "LightPipeline.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Stores a default normal map, which is an object with a `glTexture` property that\rmaps to a 1x1 texture of the color #7f7fff created in the `boot` method.", "name": "defaultNormalMap", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#defaultNormalMap", "scope": "instance", "kind": "member", "___id": "T000002R033450", "___s": true }, { "comment": "/**\r\n * The currently bound normal map texture at texture unit one, if any.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#currentNormalMap;\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "LightPipeline.js", "lineno": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The currently bound normal map texture at texture unit one, if any.", "name": "currentNormalMap;", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#currentNormalMap;", "scope": "instance", "kind": "member", "___id": "T000002R033452", "___s": true }, { "comment": "/**\r\n * A boolean that is set automatically during `onRender` that determines\r\n * if the Scene LightManager is active, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.LightPipeline#lightsActive\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.53.0\r\n */", "meta": { "filename": "LightPipeline.js", "lineno": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A boolean that is set automatically during `onRender` that determines\rif the Scene LightManager is active, or not.", "name": "lightsActive", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#lightsActive", "scope": "instance", "kind": "member", "___id": "T000002R033454", "___s": true }, { "comment": "/**\r\n * A persistent calculation vector used when processing the lights.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.LightPipeline#tempVec2\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "LightPipeline.js", "lineno": 118, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A persistent calculation vector used when processing the lights.", "name": "tempVec2", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#tempVec2", "scope": "instance", "kind": "member", "___id": "T000002R033456", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place and you can perform any final\r\n * tasks that the pipeline may need that relied on game systems such as the Texture Manager.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.LightPipeline#boot\r\n * @since 3.11.0\r\n */", "meta": { "filename": "LightPipeline.js", "lineno": 148, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place and you can perform any final\rtasks that the pipeline may need that relied on game systems such as the Texture Manager.", "kind": "function", "name": "boot", "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#boot", "scope": "instance", "overrides": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#boot", "___id": "T000002R033462", "___s": true }, { "comment": "/**\r\n * Rotates the normal map vectors inversely by the given angle.\r\n * Only works in 2D space.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.LightPipeline#setNormalMapRotation\r\n * @since 3.16.0\r\n *\r\n * @param {number} rotation - The angle of rotation in radians.\r\n */", "meta": { "filename": "LightPipeline.js", "lineno": 233, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Rotates the normal map vectors inversely by the given angle.\rOnly works in 2D space.", "kind": "function", "name": "setNormalMapRotation", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle of rotation in radians.", "name": "rotation" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#setNormalMapRotation", "scope": "instance", "___id": "T000002R033485", "___s": true }, { "comment": "/**\r\n * Checks to see if the given diffuse and normal map textures are already bound, or not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#isNewNormalMap\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGL diffuse texture.\r\n * @param {WebGLTexture} normalMap - The WebGL normal map texture.\r\n *\r\n * @return {boolean} Returns `false` if this combination is already set, or `true` if it's a new combination.\r\n */", "meta": { "filename": "LightPipeline.js", "lineno": 367, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Checks to see if the given diffuse and normal map textures are already bound, or not.", "kind": "function", "name": "isNewNormalMap", "since": "3.50.0", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGL diffuse texture.", "name": "texture" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGL normal map texture.", "name": "normalMap" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `false` if this combination is already set, or `true` if it's a new combination." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#isNewNormalMap", "scope": "instance", "___id": "T000002R033517", "___s": true }, { "comment": "/**\r\n * Returns the normal map WebGLTexture from the given Game Object.\r\n * If the Game Object doesn't have one, it returns the default normal map from this pipeline instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.LightPipeline#getNormalMap\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object to get the normal map from.\r\n *\r\n * @return {WebGLTexture} The normal map texture.\r\n */", "meta": { "filename": "LightPipeline.js", "lineno": 383, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Returns the normal map WebGLTexture from the given Game Object.\rIf the Game Object doesn't have one, it returns the default normal map from this pipeline instead.", "kind": "function", "name": "getNormalMap", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object to get the normal map from.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The normal map texture." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#getNormalMap", "scope": "instance", "___id": "T000002R033519", "___s": true }, { "comment": "/**\r\n * Takes a Sprite Game Object, or any object that extends it, and adds it to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.LightPipeline#batchSprite\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.Image|Phaser.GameObjects.Sprite)} gameObject - The texture based Game Object to add to the batch.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use for the rendering transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentTransformMatrix] - The transform matrix of the parent container, if set.\r\n */", "meta": { "filename": "LightPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Takes a Sprite Game Object, or any object that extends it, and adds it to the batch.", "kind": "function", "name": "batchSprite", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Image", "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.Image" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } ] } }, "description": "The texture based Game Object to add to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use for the rendering transform.", "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 set.", "name": "parentTransformMatrix" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#batchSprite", "scope": "instance", "overrides": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchSprite", "___id": "T000002R033528", "___s": true }, { "comment": "/**\r\n * Generic function for batching a textured quad using argument values instead of a Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.LightPipeline#batchTexture\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - Source GameObject.\r\n * @param {WebGLTexture} texture - Raw WebGLTexture associated with the quad.\r\n * @param {number} textureWidth - Real texture width.\r\n * @param {number} textureHeight - Real texture height.\r\n * @param {number} srcX - X coordinate of the quad.\r\n * @param {number} srcY - Y coordinate of the quad.\r\n * @param {number} srcWidth - Width of the quad.\r\n * @param {number} srcHeight - Height of the quad.\r\n * @param {number} scaleX - X component of scale.\r\n * @param {number} scaleY - Y component of scale.\r\n * @param {number} rotation - Rotation of the quad.\r\n * @param {boolean} flipX - Indicates if the quad is horizontally flipped.\r\n * @param {boolean} flipY - Indicates if the quad is vertically flipped.\r\n * @param {number} scrollFactorX - By which factor is the quad affected by the camera horizontal scroll.\r\n * @param {number} scrollFactorY - By which factor is the quad effected by the camera vertical scroll.\r\n * @param {number} displayOriginX - Horizontal origin in pixels.\r\n * @param {number} displayOriginY - Vertical origin in pixels.\r\n * @param {number} frameX - X coordinate of the texture frame.\r\n * @param {number} frameY - Y coordinate of the texture frame.\r\n * @param {number} frameWidth - Width of the texture frame.\r\n * @param {number} frameHeight - Height of the texture frame.\r\n * @param {number} tintTL - Tint for top left.\r\n * @param {number} tintTR - Tint for top right.\r\n * @param {number} tintBL - Tint for bottom left.\r\n * @param {number} tintBR - Tint for bottom right.\r\n * @param {number} tintEffect - The tint effect.\r\n * @param {number} uOffset - Horizontal offset on texture coordinate.\r\n * @param {number} vOffset - Vertical offset on texture coordinate.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - Current used camera.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentTransformMatrix - Parent container.\r\n * @param {boolean} [skipFlip=false] - Skip the renderTexture check.\r\n * @param {number} [textureUnit] - Use the currently bound texture unit?\r\n */", "meta": { "filename": "LightPipeline.js", "lineno": 448, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Generic function for batching a textured quad using argument values instead of a Game Object.", "kind": "function", "name": "batchTexture", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "Source GameObject.", "name": "gameObject" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "Raw WebGLTexture associated with the quad.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Real texture width.", "name": "textureWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Real texture height.", "name": "textureHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X coordinate of the quad.", "name": "srcX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y coordinate of the quad.", "name": "srcY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the quad.", "name": "srcWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the quad.", "name": "srcHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of scale.", "name": "scaleX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of scale.", "name": "scaleY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Rotation of the quad.", "name": "rotation" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates if the quad is horizontally flipped.", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates if the quad is vertically flipped.", "name": "flipY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "By which factor is the quad affected by the camera horizontal scroll.", "name": "scrollFactorX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "By which factor is the quad effected by the camera vertical scroll.", "name": "scrollFactorY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal origin in pixels.", "name": "displayOriginX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical origin in pixels.", "name": "displayOriginY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X coordinate of the texture frame.", "name": "frameX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y coordinate of the texture frame.", "name": "frameY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the texture frame.", "name": "frameWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the texture frame.", "name": "frameHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for top left.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for top right.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for bottom left.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for bottom right.", "name": "tintBR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint effect.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal offset on texture coordinate.", "name": "uOffset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical offset on texture coordinate.", "name": "vOffset" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "Current used camera.", "name": "camera" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "Parent container.", "name": "parentTransformMatrix" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip the renderTexture check.", "name": "skipFlip" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Use the currently bound texture unit?", "name": "textureUnit" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#batchTexture", "scope": "instance", "overrides": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTexture", "___id": "T000002R033530", "___s": true }, { "comment": "/**\r\n * Adds a Texture Frame into the batch for rendering.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.LightPipeline#batchTextureFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Textures.Frame} frame - The Texture Frame to be rendered.\r\n * @param {number} x - The horizontal position to render the texture at.\r\n * @param {number} y - The vertical position to render the texture at.\r\n * @param {number} tint - The tint color.\r\n * @param {number} alpha - The alpha value.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} transformMatrix - The Transform Matrix to use for the texture.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentTransformMatrix] - A parent Transform Matrix.\r\n */", "meta": { "filename": "LightPipeline.js", "lineno": 531, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Adds a Texture Frame into the batch for rendering.", "kind": "function", "name": "batchTextureFrame", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "description": "The Texture Frame to be rendered.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position to render the texture at.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position to render the texture at.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color.", "name": "tint" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha value.", "name": "alpha" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The Transform Matrix to use for the texture.", "name": "transformMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "A parent Transform Matrix.", "name": "parentTransformMatrix" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#batchTextureFrame", "scope": "instance", "overrides": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTextureFrame", "___id": "T000002R033532", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Mobile Pipeline is the core 2D texture rendering pipeline used by Phaser in WebGL\r\n * when the device running the game is detected to be a mobile.\r\n *\r\n * You can control the use of this pipeline by setting the Game Configuration\r\n * property `autoMobilePipeline`. If set to `false` then all devices will use\r\n * the Multi Tint Pipeline. You can also call the `PipelineManager.setDefaultPipeline`\r\n * method at run-time, rather than boot-time, to modify the default Game Object\r\n * pipeline.\r\n *\r\n * Virtually all Game Objects use this pipeline by default, including Sprites, Graphics\r\n * and Tilemaps. It handles the batching of quads and tris, as well as methods for\r\n * drawing and batching geometry data.\r\n *\r\n * The fragment shader it uses can be found in `shaders/src/Mobile.frag`.\r\n * The vertex shader it uses can be found in `shaders/src/Mobile.vert`.\r\n *\r\n * The default shader attributes for this pipeline are:\r\n *\r\n * `inPosition` (vec2, offset 0)\r\n * `inTexCoord` (vec2, offset 8)\r\n * `inTexId` (float, offset 16)\r\n * `inTintEffect` (float, offset 20)\r\n * `inTint` (vec4, offset 24, normalized)\r\n *\r\n * Note that `inTexId` isn't used in the shader, it's just kept to allow us\r\n * to piggy-back on the Multi Tint Pipeline functions.\r\n *\r\n * The default shader uniforms for this pipeline are:\r\n *\r\n * `uProjectionMatrix` (mat4)\r\n * `uMainSampler` (sampler2D)\r\n *\r\n * @class MobilePipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.MultiPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration options for this pipeline.\r\n */", "meta": { "filename": "MobilePipeline.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "classdesc": "The Mobile Pipeline is the core 2D texture rendering pipeline used by Phaser in WebGL\rwhen the device running the game is detected to be a mobile.\r\rYou can control the use of this pipeline by setting the Game Configuration\rproperty `autoMobilePipeline`. If set to `false` then all devices will use\rthe Multi Tint Pipeline. You can also call the `PipelineManager.setDefaultPipeline`\rmethod at run-time, rather than boot-time, to modify the default Game Object\rpipeline.\r\rVirtually all Game Objects use this pipeline by default, including Sprites, Graphics\rand Tilemaps. It handles the batching of quads and tris, as well as methods for\rdrawing and batching geometry data.\r\rThe fragment shader it uses can be found in `shaders/src/Mobile.frag`.\rThe vertex shader it uses can be found in `shaders/src/Mobile.vert`.\r\rThe default shader attributes for this pipeline are:\r\r`inPosition` (vec2, offset 0)\r`inTexCoord` (vec2, offset 8)\r`inTexId` (float, offset 16)\r`inTintEffect` (float, offset 20)\r`inTint` (vec4, offset 24, normalized)\r\rNote that `inTexId` isn't used in the shader, it's just kept to allow us\rto piggy-back on the Multi Tint Pipeline functions.\r\rThe default shader uniforms for this pipeline are:\r\r`uProjectionMatrix` (mat4)\r`uMainSampler` (sampler2D)", "kind": "class", "name": "MobilePipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.MultiPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration options for this pipeline.", "name": "config" } ], "scope": "static", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "___id": "T000002R033542", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place and you can perform any final\r\n * tasks that the pipeline may need that relied on game systems such as the Texture Manager.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MobilePipeline#boot\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MobilePipeline.js", "lineno": 94, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place and you can perform any final\rtasks that the pipeline may need that relied on game systems such as the Texture Manager.", "kind": "function", "name": "boot", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#boot", "scope": "instance", "overrides": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#boot", "___id": "T000002R033560", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Multi Pipeline is the core 2D texture rendering pipeline used by Phaser in WebGL.\r\n * Virtually all Game Objects use this pipeline by default, including Sprites, Graphics\r\n * and Tilemaps. It handles the batching of quads and tris, as well as methods for\r\n * drawing and batching geometry data.\r\n *\r\n * Prior to Phaser v3.50 this pipeline was called the `TextureTintPipeline`.\r\n *\r\n * In previous versions of Phaser only one single texture unit was supported at any one time.\r\n * The Multi Pipeline is an evolution of the old Texture Tint Pipeline, updated to support\r\n * multi-textures for increased performance.\r\n *\r\n * The fragment shader it uses can be found in `shaders/src/Multi.frag`.\r\n * The vertex shader it uses can be found in `shaders/src/Multi.vert`.\r\n *\r\n * The default shader attributes for this pipeline are:\r\n *\r\n * `inPosition` (vec2, offset 0)\r\n * `inTexCoord` (vec2, offset 8)\r\n * `inTexId` (float, offset 16)\r\n * `inTintEffect` (float, offset 20)\r\n * `inTint` (vec4, offset 24, normalized)\r\n *\r\n * The default shader uniforms for this pipeline are:\r\n *\r\n * `uProjectionMatrix` (mat4)\r\n * `uMainSampler` (sampler2D array)\r\n *\r\n * If you wish to create a custom pipeline extending from this one, you can use two string\r\n * declarations in your fragment shader source: `%count%` and `%forloop%`, where `count` is\r\n * used to set the number of `sampler2Ds` available, and `forloop` is a block of GLSL code\r\n * that will get the currently bound texture unit.\r\n *\r\n * This pipeline will automatically inject that code for you, should those values exist\r\n * in your shader source. If you wish to handle this yourself, you can also use the\r\n * function `Utils.parseFragmentShaderMaxTextures`.\r\n *\r\n * The following fragment shader shows how to use the two variables:\r\n *\r\n * ```glsl\r\n * #define SHADER_NAME PHASER_MULTI_FS\r\n *\r\n * #ifdef GL_FRAGMENT_PRECISION_HIGH\r\n * precision highp float;\r\n * #else\r\n * precision mediump float;\r\n * #endif\r\n *\r\n * uniform sampler2D uMainSampler[%count%];\r\n *\r\n * varying vec2 outTexCoord;\r\n * varying float outTexId;\r\n * varying float outTintEffect;\r\n * varying vec4 outTint;\r\n *\r\n * void main ()\r\n * {\r\n * vec4 texture;\r\n *\r\n * %forloop%\r\n *\r\n * vec4 texel = vec4(outTint.bgr * outTint.a, outTint.a);\r\n *\r\n * // Multiply texture tint\r\n * vec4 color = texture * texel;\r\n *\r\n * if (outTintEffect == 1.0)\r\n * {\r\n * // Solid color + texture alpha\r\n * color.rgb = mix(texture.rgb, outTint.bgr * outTint.a, texture.a);\r\n * }\r\n * else if (outTintEffect == 2.0)\r\n * {\r\n * // Solid color, no texture\r\n * color = texel;\r\n * }\r\n *\r\n * gl_FragColor = color;\r\n * }\r\n * ```\r\n *\r\n * If you wish to create a pipeline that works from a single texture, or that doesn't have\r\n * internal texture iteration, please see the `SinglePipeline` instead. If you wish to create\r\n * a special effect, especially one that can impact the pixels around a texture (i.e. such as\r\n * a glitch effect) then you should use the PreFX and PostFX Pipelines for this task.\r\n *\r\n * @class MultiPipeline\r\n * @extends Phaser.Renderer.WebGL.WebGLPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines\r\n * @constructor\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration options for this pipeline.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 18, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "classdesc": "The Multi Pipeline is the core 2D texture rendering pipeline used by Phaser in WebGL.\rVirtually all Game Objects use this pipeline by default, including Sprites, Graphics\rand Tilemaps. It handles the batching of quads and tris, as well as methods for\rdrawing and batching geometry data.\r\rPrior to Phaser v3.50 this pipeline was called the `TextureTintPipeline`.\r\rIn previous versions of Phaser only one single texture unit was supported at any one time.\rThe Multi Pipeline is an evolution of the old Texture Tint Pipeline, updated to support\rmulti-textures for increased performance.\r\rThe fragment shader it uses can be found in `shaders/src/Multi.frag`.\rThe vertex shader it uses can be found in `shaders/src/Multi.vert`.\r\rThe default shader attributes for this pipeline are:\r\r`inPosition` (vec2, offset 0)\r`inTexCoord` (vec2, offset 8)\r`inTexId` (float, offset 16)\r`inTintEffect` (float, offset 20)\r`inTint` (vec4, offset 24, normalized)\r\rThe default shader uniforms for this pipeline are:\r\r`uProjectionMatrix` (mat4)\r`uMainSampler` (sampler2D array)\r\rIf you wish to create a custom pipeline extending from this one, you can use two string\rdeclarations in your fragment shader source: `%count%` and `%forloop%`, where `count` is\rused to set the number of `sampler2Ds` available, and `forloop` is a block of GLSL code\rthat will get the currently bound texture unit.\r\rThis pipeline will automatically inject that code for you, should those values exist\rin your shader source. If you wish to handle this yourself, you can also use the\rfunction `Utils.parseFragmentShaderMaxTextures`.\r\rThe following fragment shader shows how to use the two variables:\r\r```glsl\r#define SHADER_NAME PHASER_MULTI_FS\r\r#ifdef GL_FRAGMENT_PRECISION_HIGH\rprecision highp float;\r#else\rprecision mediump float;\r#endif\r\runiform sampler2D uMainSampler[%count%];\r\rvarying vec2 outTexCoord;\rvarying float outTexId;\rvarying float outTintEffect;\rvarying vec4 outTint;\r\rvoid main ()\r{\r vec4 texture;\r\r %forloop%\r\r vec4 texel = vec4(outTint.bgr * outTint.a, outTint.a);\r\r // Multiply texture tint\r vec4 color = texture * texel;\r\r if (outTintEffect == 1.0)\r {\r // Solid color + texture alpha\r color.rgb = mix(texture.rgb, outTint.bgr * outTint.a, texture.a);\r }\r else if (outTintEffect == 2.0)\r {\r // Solid color, no texture\r color = texel;\r }\r\r gl_FragColor = color;\r}\r```\r\rIf you wish to create a pipeline that works from a single texture, or that doesn't have\rinternal texture iteration, please see the `SinglePipeline` instead. If you wish to create\ra special effect, especially one that can impact the pixels around a texture (i.e. such as\ra glitch effect) then you should use the PreFX and PostFX Pipelines for this task.", "kind": "class", "name": "MultiPipeline", "augments": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration options for this pipeline.", "name": "config" } ], "scope": "static", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "___id": "T000002R033573", "___s": true }, { "comment": "/**\r\n * A temporary Transform Matrix, re-used internally during batching by the\r\n * Shape Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.MultiPipeline#calcMatrix\r\n * @type {Phaser.GameObjects.Components.TransformMatrix}\r\n * @since 3.55.0\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A temporary Transform Matrix, re-used internally during batching by the\rShape Game Objects.", "name": "calcMatrix", "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#calcMatrix", "scope": "instance", "kind": "member", "___id": "T000002R033598", "___s": true }, { "comment": "/**\r\n * Called every time the pipeline is bound by the renderer.\r\n * Sets the shader program, vertex buffer and other resources.\r\n * Should only be called when changing pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#boot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Called every time the pipeline is bound by the renderer.\rSets the shader program, vertex buffer and other resources.\rShould only be called when changing pipeline.", "kind": "function", "name": "boot", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#boot", "scope": "instance", "overrides": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "___id": "T000002R033638", "___s": true }, { "comment": "/**\r\n * Takes a Sprite Game Object, or any object that extends it, and adds it to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchSprite\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.Image|Phaser.GameObjects.Sprite)} gameObject - The texture based Game Object to add to the batch.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use for the rendering transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentTransformMatrix] - The transform matrix of the parent container, if set.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 287, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Takes a Sprite Game Object, or any object that extends it, and adds it to the batch.", "kind": "function", "name": "batchSprite", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Image", "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.Image" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } ] } }, "description": "The texture based Game Object to add to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use for the rendering transform.", "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 set.", "name": "parentTransformMatrix" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchSprite", "scope": "instance", "___id": "T000002R033641", "___s": true }, { "comment": "/**\r\n * Generic function for batching a textured quad using argument values instead of a Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTexture\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - Source GameObject.\r\n * @param {WebGLTexture} texture - Raw WebGLTexture associated with the quad.\r\n * @param {number} textureWidth - Real texture width.\r\n * @param {number} textureHeight - Real texture height.\r\n * @param {number} srcX - X coordinate of the quad.\r\n * @param {number} srcY - Y coordinate of the quad.\r\n * @param {number} srcWidth - Width of the quad.\r\n * @param {number} srcHeight - Height of the quad.\r\n * @param {number} scaleX - X component of scale.\r\n * @param {number} scaleY - Y component of scale.\r\n * @param {number} rotation - Rotation of the quad.\r\n * @param {boolean} flipX - Indicates if the quad is horizontally flipped.\r\n * @param {boolean} flipY - Indicates if the quad is vertically flipped.\r\n * @param {number} scrollFactorX - By which factor is the quad affected by the camera horizontal scroll.\r\n * @param {number} scrollFactorY - By which factor is the quad effected by the camera vertical scroll.\r\n * @param {number} displayOriginX - Horizontal origin in pixels.\r\n * @param {number} displayOriginY - Vertical origin in pixels.\r\n * @param {number} frameX - X coordinate of the texture frame.\r\n * @param {number} frameY - Y coordinate of the texture frame.\r\n * @param {number} frameWidth - Width of the texture frame.\r\n * @param {number} frameHeight - Height of the texture frame.\r\n * @param {number} tintTL - Tint for top left.\r\n * @param {number} tintTR - Tint for top right.\r\n * @param {number} tintBL - Tint for bottom left.\r\n * @param {number} tintBR - Tint for bottom right.\r\n * @param {number} tintEffect - The tint effect.\r\n * @param {number} uOffset - Horizontal offset on texture coordinate.\r\n * @param {number} vOffset - Vertical offset on texture coordinate.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - Current used camera.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentTransformMatrix - Parent container.\r\n * @param {boolean} [skipFlip=false] - Skip the renderTexture check.\r\n * @param {number} [textureUnit] - Use the currently bound texture unit?\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Generic function for batching a textured quad using argument values instead of a Game Object.", "kind": "function", "name": "batchTexture", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "Source GameObject.", "name": "gameObject" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "Raw WebGLTexture associated with the quad.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Real texture width.", "name": "textureWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Real texture height.", "name": "textureHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X coordinate of the quad.", "name": "srcX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y coordinate of the quad.", "name": "srcY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the quad.", "name": "srcWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the quad.", "name": "srcHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of scale.", "name": "scaleX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of scale.", "name": "scaleY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Rotation of the quad.", "name": "rotation" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates if the quad is horizontally flipped.", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates if the quad is vertically flipped.", "name": "flipY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "By which factor is the quad affected by the camera horizontal scroll.", "name": "scrollFactorX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "By which factor is the quad effected by the camera vertical scroll.", "name": "scrollFactorY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal origin in pixels.", "name": "displayOriginX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical origin in pixels.", "name": "displayOriginY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X coordinate of the texture frame.", "name": "frameX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y coordinate of the texture frame.", "name": "frameY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the texture frame.", "name": "frameWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the texture frame.", "name": "frameHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for top left.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for top right.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for bottom left.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for bottom right.", "name": "tintBR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint effect.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal offset on texture coordinate.", "name": "uOffset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical offset on texture coordinate.", "name": "vOffset" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "Current used camera.", "name": "camera" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "Parent container.", "name": "parentTransformMatrix" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip the renderTexture check.", "name": "skipFlip" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Use the currently bound texture unit?", "name": "textureUnit" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTexture", "scope": "instance", "___id": "T000002R033694", "___s": true }, { "comment": "/**\r\n * Adds a Texture Frame into the batch for rendering.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTextureFrame\r\n * @since 3.12.0\r\n *\r\n * @param {Phaser.Textures.Frame} frame - The Texture Frame to be rendered.\r\n * @param {number} x - The horizontal position to render the texture at.\r\n * @param {number} y - The vertical position to render the texture at.\r\n * @param {number} tint - The tint color.\r\n * @param {number} alpha - The alpha value.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} transformMatrix - The Transform Matrix to use for the texture.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentTransformMatrix] - A parent Transform Matrix.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 608, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Adds a Texture Frame into the batch for rendering.", "kind": "function", "name": "batchTextureFrame", "since": "3.12.0", "params": [ { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "description": "The Texture Frame to be rendered.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position to render the texture at.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position to render the texture at.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color.", "name": "tint" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha value.", "name": "alpha" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The Transform Matrix to use for the texture.", "name": "transformMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "A parent Transform Matrix.", "name": "parentTransformMatrix" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTextureFrame", "scope": "instance", "___id": "T000002R033739", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * Rectangle factors in the given transform matrices before adding to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillRect\r\n * @since 3.55.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 653, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Pushes a filled rectangle into the vertex batch.\r\rRectangle factors in the given transform matrices before adding to the batch.", "kind": "function", "name": "batchFillRect", "since": "3.55.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillRect", "scope": "instance", "___id": "T000002R033747", "___s": true }, { "comment": "/**\r\n * Pushes a filled triangle into the vertex batch.\r\n *\r\n * Triangle factors in the given transform matrices before adding to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillTriangle\r\n * @since 3.55.0\r\n *\r\n * @param {number} x0 - Point 0 x coordinate.\r\n * @param {number} y0 - Point 0 y coordinate.\r\n * @param {number} x1 - Point 1 x coordinate.\r\n * @param {number} y1 - Point 1 y coordinate.\r\n * @param {number} x2 - Point 2 x coordinate.\r\n * @param {number} y2 - Point 2 y coordinate.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 687, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Pushes a filled triangle into the vertex batch.\r\rTriangle factors in the given transform matrices before adding to the batch.", "kind": "function", "name": "batchFillTriangle", "since": "3.55.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 x coordinate.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 y coordinate.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 x coordinate.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 y coordinate.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 x coordinate.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 y coordinate.", "name": "y2" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillTriangle", "scope": "instance", "___id": "T000002R033752", "___s": true }, { "comment": "/**\r\n * Pushes a stroked triangle into the vertex batch.\r\n *\r\n * Triangle factors in the given transform matrices before adding to the batch.\r\n *\r\n * The triangle is created from 3 lines and drawn using the `batchStrokePath` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokeTriangle\r\n * @since 3.55.0\r\n *\r\n * @param {number} x0 - Point 0 x coordinate.\r\n * @param {number} y0 - Point 0 y coordinate.\r\n * @param {number} x1 - Point 1 x coordinate.\r\n * @param {number} y1 - Point 1 y coordinate.\r\n * @param {number} x2 - Point 2 x coordinate.\r\n * @param {number} y2 - Point 2 y coordinate.\r\n * @param {number} lineWidth - The width of the line in pixels.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 730, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Pushes a stroked triangle into the vertex batch.\r\rTriangle factors in the given transform matrices before adding to the batch.\r\rThe triangle is created from 3 lines and drawn using the `batchStrokePath` method.", "kind": "function", "name": "batchStrokeTriangle", "since": "3.55.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 x coordinate.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 y coordinate.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 x coordinate.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 y coordinate.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 x coordinate.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 y coordinate.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the line in pixels.", "name": "lineWidth" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokeTriangle", "scope": "instance", "___id": "T000002R033762", "___s": true }, { "comment": "/**\r\n * Adds the given path to the vertex batch for rendering.\r\n *\r\n * It works by taking the array of path data and then passing it through Earcut, which\r\n * creates a list of polygons. Each polygon is then added to the batch.\r\n *\r\n * The path is always automatically closed because it's filled.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillPath\r\n * @since 3.55.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like[]} path - Collection of points that represent the path.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Adds the given path to the vertex batch for rendering.\r\rIt works by taking the array of path data and then passing it through Earcut, which\rcreates a list of polygons. Each polygon is then added to the batch.\r\rThe path is always automatically closed because it's filled.", "kind": "function", "name": "batchFillPath", "since": "3.55.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "description": "Collection of points that represent the path.", "name": "path" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillPath", "scope": "instance", "___id": "T000002R033777", "___s": true }, { "comment": "/**\r\n * Adds the given path to the vertex batch for rendering.\r\n *\r\n * It works by taking the array of path data and calling `batchLine` for each section\r\n * of the path.\r\n *\r\n * The path is optionally closed at the end.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokePath\r\n * @since 3.55.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like[]} path - Collection of points that represent the path.\r\n * @param {number} lineWidth - The width of the line segments in pixels.\r\n * @param {boolean} pathOpen - Indicates if the path should be closed or left open.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 846, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Adds the given path to the vertex batch for rendering.\r\rIt works by taking the array of path data and calling `batchLine` for each section\rof the path.\r\rThe path is optionally closed at the end.", "kind": "function", "name": "batchStrokePath", "since": "3.55.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "description": "Collection of points that represent the path.", "name": "path" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the line segments in pixels.", "name": "lineWidth" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates if the path should be closed or left open.", "name": "pathOpen" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokePath", "scope": "instance", "___id": "T000002R033809", "___s": true }, { "comment": "/**\r\n * Creates a line out of 4 quads and adds it to the vertex batch based on the given line values.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchLine\r\n * @since 3.55.0\r\n *\r\n * @param {number} ax - x coordinate of the start of the line.\r\n * @param {number} ay - y coordinate of the start of the line.\r\n * @param {number} bx - x coordinate of the end of the line.\r\n * @param {number} by - y coordinate of the end of the line.\r\n * @param {number} aLineWidth - Width of the start of the line.\r\n * @param {number} bLineWidth - Width of the end of the line.\r\n * @param {number} index - If this line is part of a multi-line draw, the index of the line in the draw.\r\n * @param {boolean} closePath - Does this line close a multi-line path?\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 894, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Creates a line out of 4 quads and adds it to the vertex batch based on the given line values.", "kind": "function", "name": "batchLine", "since": "3.55.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "x coordinate of the start of the line.", "name": "ax" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "y coordinate of the start of the line.", "name": "ay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "x coordinate of the end of the line.", "name": "bx" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "y coordinate of the end of the line.", "name": "by" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the start of the line.", "name": "aLineWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the end of the line.", "name": "bLineWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "If this line is part of a multi-line draw, the index of the line in the draw.", "name": "index" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Does this line close a multi-line path?", "name": "closePath" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchLine", "scope": "instance", "___id": "T000002R033817", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#destroy\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#DESTROY\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 1013, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Destroys all shader instances, removes all object references and nulls all external references.", "kind": "function", "name": "destroy", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:DESTROY" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#destroy", "scope": "instance", "overrides": "Phaser.Renderer.WebGL.WebGLPipeline#destroy", "___id": "T000002R033860", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Point Light Pipeline handles rendering the Point Light Game Objects in WebGL.\r\n *\r\n * The fragment shader it uses can be found in `shaders/src/PointLight.frag`.\r\n * The vertex shader it uses can be found in `shaders/src/PointLight.vert`.\r\n *\r\n * The default shader attributes for this pipeline are:\r\n *\r\n * `inPosition` (vec2)\r\n * `inLightPosition` (vec2)\r\n * `inLightRadius` (float)\r\n * `inLightAttenuation` (float)\r\n * `inLightColor` (vec4)\r\n *\r\n * The default shader uniforms for this pipeline are:\r\n *\r\n * `uProjectionMatrix` (mat4)\r\n * `uResolution` (vec2)\r\n * `uCameraZoom` (sampler2D)\r\n *\r\n * @class PointLightPipeline\r\n * @extends Phaser.Renderer.WebGL.WebGLPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines\r\n * @constructor\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration options for this pipeline.\r\n */", "meta": { "filename": "PointLightPipeline.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "classdesc": "The Point Light Pipeline handles rendering the Point Light Game Objects in WebGL.\r\rThe fragment shader it uses can be found in `shaders/src/PointLight.frag`.\rThe vertex shader it uses can be found in `shaders/src/PointLight.vert`.\r\rThe default shader attributes for this pipeline are:\r\r`inPosition` (vec2)\r`inLightPosition` (vec2)\r`inLightRadius` (float)\r`inLightAttenuation` (float)\r`inLightColor` (vec4)\r\rThe default shader uniforms for this pipeline are:\r\r`uProjectionMatrix` (mat4)\r`uResolution` (vec2)\r`uCameraZoom` (sampler2D)", "kind": "class", "name": "PointLightPipeline", "augments": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration options for this pipeline.", "name": "config" } ], "scope": "static", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "___id": "T000002R033871", "___s": true }, { "comment": "/**\r\n * Adds a Point Light Game Object to the batch, flushing if required.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#batchPointLight\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.PointLight} light - The Point Light Game Object.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera rendering the Point Light.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} lightX - The horizontal center of the light.\r\n * @param {number} lightY - The vertical center of the light.\r\n */", "meta": { "filename": "PointLightPipeline.js", "lineno": 82, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Adds a Point Light Game Object to the batch, flushing if required.", "kind": "function", "name": "batchPointLight", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.PointLight" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.PointLight" } }, "description": "The Point Light Game Object.", "name": "light" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera rendering the Point Light.", "name": "camera" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal center of the light.", "name": "lightX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical center of the light.", "name": "lightY" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#batchPointLight", "scope": "instance", "___id": "T000002R033887", "___s": true }, { "comment": "/**\r\n * Adds a single Point Light vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchPointLight`.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#batchLightVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} lightX - The horizontal center of the light.\r\n * @param {number} lightY - The vertical center of the light.\r\n * @param {number} radius - The radius of the light.\r\n * @param {number} attenuation - The attenuation of the light.\r\n * @param {number} r - The red color channel of the light.\r\n * @param {number} g - The green color channel of the light.\r\n * @param {number} b - The blue color channel of the light.\r\n * @param {number} a - The alpha color channel of the light.\r\n */", "meta": { "filename": "PointLightPipeline.js", "lineno": 133, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Adds a single Point Light vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchPointLight`.", "kind": "function", "name": "batchLightVert", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal center of the light.", "name": "lightX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical center of the light.", "name": "lightY" }, { "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 attenuation of the light.", "name": "attenuation" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The red color channel of the light.", "name": "r" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The green color channel of the light.", "name": "g" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The blue color channel of the light.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha color channel of the light.", "name": "a" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#batchLightVert", "scope": "instance", "___id": "T000002R033898", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Post FX Pipeline is a special kind of pipeline specifically for handling post\r\n * processing effects. Where-as a standard Pipeline allows you to control the process\r\n * of rendering Game Objects by configuring the shaders and attributes used to draw them,\r\n * a Post FX Pipeline is designed to allow you to apply processing _after_ the Game Object/s\r\n * have been rendered. Typical examples of post processing effects are bloom filters,\r\n * blurs, light effects and color manipulation.\r\n *\r\n * The pipeline works by creating a tiny vertex buffer with just one single hard-coded quad\r\n * in it. Game Objects can have a Post Pipeline set on them. Those objects are then rendered\r\n * using their standard pipeline, but are redirected to the Render Targets owned by the\r\n * post pipeline, which can then apply their own shaders and effects, before passing them\r\n * back to the main renderer.\r\n *\r\n * Please see the Phaser 3 examples for further details on this extensive subject.\r\n *\r\n * The default fragment shader it uses can be found in `shaders/src/PostFX.frag`.\r\n * The default vertex shader it uses can be found in `shaders/src/Quad.vert`.\r\n *\r\n * The default shader attributes for this pipeline are:\r\n *\r\n * `inPosition` (vec2, offset 0)\r\n * `inTexCoord` (vec2, offset 8)\r\n *\r\n * The vertices array layout is:\r\n *\r\n * -1, 1 B----C 1, 1\r\n * 0, 1 | /| 1, 1\r\n * | / |\r\n * | / |\r\n * |/ |\r\n * -1, -1 A----D 1, -1\r\n * 0, 0 1, 0\r\n *\r\n * A = -1, -1 (pos) and 0, 0 (uv)\r\n * B = -1, 1 (pos) and 0, 1 (uv)\r\n * C = 1, 1 (pos) and 1, 1 (uv)\r\n * D = 1, -1 (pos) and 1, 0 (uv)\r\n *\r\n * First tri: A, B, C\r\n * Second tri: A, C, D\r\n *\r\n * Array index:\r\n *\r\n * 0 = Tri 1 - Vert A - x pos\r\n * 1 = Tri 1 - Vert A - y pos\r\n * 2 = Tri 1 - Vert A - uv u\r\n * 3 = Tri 1 - Vert A - uv v\r\n *\r\n * 4 = Tri 1 - Vert B - x pos\r\n * 5 = Tri 1 - Vert B - y pos\r\n * 6 = Tri 1 - Vert B - uv u\r\n * 7 = Tri 1 - Vert B - uv v\r\n *\r\n * 8 = Tri 1 - Vert C - x pos\r\n * 9 = Tri 1 - Vert C - y pos\r\n * 10 = Tri 1 - Vert C - uv u\r\n * 11 = Tri 1 - Vert C - uv v\r\n *\r\n * 12 = Tri 2 - Vert A - x pos\r\n * 13 = Tri 2 - Vert A - y pos\r\n * 14 = Tri 2 - Vert A - uv u\r\n * 15 = Tri 2 - Vert A - uv v\r\n *\r\n * 16 = Tri 2 - Vert C - x pos\r\n * 17 = Tri 2 - Vert C - y pos\r\n * 18 = Tri 2 - Vert C - uv u\r\n * 19 = Tri 2 - Vert C - uv v\r\n *\r\n * 20 = Tri 2 - Vert D - x pos\r\n * 21 = Tri 2 - Vert D - y pos\r\n * 22 = Tri 2 - Vert D - uv u\r\n * 23 = Tri 2 - Vert D - uv v\r\n *\r\n * @class PostFXPipeline\r\n * @extends Phaser.Renderer.WebGL.WebGLPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines\r\n * @constructor\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration options for this pipeline.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "classdesc": "The Post FX Pipeline is a special kind of pipeline specifically for handling post\rprocessing effects. Where-as a standard Pipeline allows you to control the process\rof rendering Game Objects by configuring the shaders and attributes used to draw them,\ra Post FX Pipeline is designed to allow you to apply processing _after_ the Game Object/s\rhave been rendered. Typical examples of post processing effects are bloom filters,\rblurs, light effects and color manipulation.\r\rThe pipeline works by creating a tiny vertex buffer with just one single hard-coded quad\rin it. Game Objects can have a Post Pipeline set on them. Those objects are then rendered\rusing their standard pipeline, but are redirected to the Render Targets owned by the\rpost pipeline, which can then apply their own shaders and effects, before passing them\rback to the main renderer.\r\rPlease see the Phaser 3 examples for further details on this extensive subject.\r\rThe default fragment shader it uses can be found in `shaders/src/PostFX.frag`.\rThe default vertex shader it uses can be found in `shaders/src/Quad.vert`.\r\rThe default shader attributes for this pipeline are:\r\r`inPosition` (vec2, offset 0)\r`inTexCoord` (vec2, offset 8)\r\rThe vertices array layout is:\r\r-1, 1 B----C 1, 1\r 0, 1 | /| 1, 1\r | / |\r | / |\r |/ |\r-1, -1 A----D 1, -1\r 0, 0 1, 0\r\rA = -1, -1 (pos) and 0, 0 (uv)\rB = -1, 1 (pos) and 0, 1 (uv)\rC = 1, 1 (pos) and 1, 1 (uv)\rD = 1, -1 (pos) and 1, 0 (uv)\r\rFirst tri: A, B, C\rSecond tri: A, C, D\r\rArray index:\r\r0 = Tri 1 - Vert A - x pos\r1 = Tri 1 - Vert A - y pos\r2 = Tri 1 - Vert A - uv u\r3 = Tri 1 - Vert A - uv v\r\r4 = Tri 1 - Vert B - x pos\r5 = Tri 1 - Vert B - y pos\r6 = Tri 1 - Vert B - uv u\r7 = Tri 1 - Vert B - uv v\r\r8 = Tri 1 - Vert C - x pos\r9 = Tri 1 - Vert C - y pos\r10 = Tri 1 - Vert C - uv u\r11 = Tri 1 - Vert C - uv v\r\r12 = Tri 2 - Vert A - x pos\r13 = Tri 2 - Vert A - y pos\r14 = Tri 2 - Vert A - uv u\r15 = Tri 2 - Vert A - uv v\r\r16 = Tri 2 - Vert C - x pos\r17 = Tri 2 - Vert C - y pos\r18 = Tri 2 - Vert C - uv u\r19 = Tri 2 - Vert C - uv v\r\r20 = Tri 2 - Vert D - x pos\r21 = Tri 2 - Vert D - y pos\r22 = Tri 2 - Vert D - uv u\r23 = Tri 2 - Vert D - uv v", "kind": "class", "name": "PostFXPipeline", "augments": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration options for this pipeline.", "name": "config" } ], "scope": "static", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "___id": "T000002R033919", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to a Game Object or Camera,\r\n * this property contains a reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject\r\n * @type {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "If this Post Pipeline belongs to a Game Object or Camera,\rthis property contains a reference to it.", "name": "gameObject", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject", "scope": "instance", "kind": "member", "___id": "T000002R033934", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to an FX Controller, this is a\r\n * reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller\r\n * @type {Phaser.FX.Controller}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "If this Post Pipeline belongs to an FX Controller, this is a\rreference to it.", "name": "controller", "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller", "scope": "instance", "kind": "member", "___id": "T000002R033936", "___s": true }, { "comment": "/**\r\n * A Color Matrix instance belonging to this pipeline.\r\n *\r\n * Used during calls to the `drawFrame` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A Color Matrix instance belonging to this pipeline.\r\rUsed during calls to the `drawFrame` method.", "name": "colorMatrix", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix", "scope": "instance", "kind": "member", "___id": "T000002R033938", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A reference to the Full Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "name": "fullFrame1", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1", "scope": "instance", "kind": "member", "___id": "T000002R033940", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A reference to the Full Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "name": "fullFrame2", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2", "scope": "instance", "kind": "member", "___id": "T000002R033942", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A reference to the Half Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "name": "halfFrame1", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1", "scope": "instance", "kind": "member", "___id": "T000002R033944", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A reference to the Half Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "name": "halfFrame2", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2", "scope": "instance", "kind": "member", "___id": "T000002R033946", "___s": true }, { "comment": "/**\r\n * Returns the FX Controller for this Post FX Pipeline.\r\n *\r\n * This is called internally and not typically required outside.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Controller} [controller] - An FX Controller, or undefined.\r\n *\r\n * @return {Phaser.FX.Controller|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} The FX Controller responsible, or this Pipeline.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Returns the FX Controller for this Post FX Pipeline.\r\rThis is called internally and not typically required outside.", "kind": "function", "name": "getController", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "optional": true, "description": "An FX Controller, or undefined.", "name": "controller" } ], "returns": [ { "type": { "names": [ "Phaser.FX.Controller", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.FX.Controller" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The FX Controller responsible, or this Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController", "scope": "instance", "___id": "T000002R033959", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * This method does _not_ bind a shader. It uses whatever shader\r\n * is currently bound in this pipeline. It also does _not_ clear\r\n * the frame buffers after use. You should take care of both of\r\n * these things if you call this method directly.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThis method does _not_ bind a shader. It uses whatever shader\ris currently bound in this pipeline. It also does _not_ clear\rthe frame buffers after use. You should take care of both of\rthese things if you call this method directly.", "kind": "function", "name": "copySprite", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite", "scope": "instance", "___id": "T000002R033961", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.", "kind": "function", "name": "copyFrame", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame", "scope": "instance", "___id": "T000002R033966", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "kind": "function", "name": "copyToGame", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame", "scope": "instance", "___id": "T000002R033968", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using this pipelines\r\n * Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Copy the `source` Render Target to the `target` Render Target, using this pipelines\rColor Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.", "kind": "function", "name": "drawFrame", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame", "scope": "instance", "___id": "T000002R033970", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "kind": "function", "name": "blendFrames", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames", "scope": "instance", "___id": "T000002R033972", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "kind": "function", "name": "blendFramesAdditive", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive", "scope": "instance", "___id": "T000002R033974", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Clears the given Render Target.", "kind": "function", "name": "clearFrame", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame", "scope": "instance", "___id": "T000002R033976", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "kind": "function", "name": "blitFrame", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame", "scope": "instance", "___id": "T000002R033978", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "kind": "function", "name": "copyFrameRect", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect", "scope": "instance", "___id": "T000002R033980", "___s": true }, { "comment": "/**\r\n * Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * If no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\r\n * and use that instead, which should be done when you need to draw the final results of\r\n * this pipeline to the game canvas.\r\n *\r\n * You can optionally set the shader to be used for the draw here, if this is a multi-shader\r\n * pipeline. By default `currentShader` will be used. If you need to set a shader but not\r\n * a target, just pass `null` as the `target` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to draw to. If not set, it will pop the fbo from the stack.\r\n * @param {boolean} [clear=true] - Clear the target before copying? Only used if `target` parameter is set.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to use during the draw.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\rIf no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\rand use that instead, which should be done when you need to draw the final results of\rthis pipeline to the game canvas.\r\rYou can optionally set the shader to be used for the draw here, if this is a multi-shader\rpipeline. By default `currentShader` will be used. If you need to set a shader but not\ra target, just pass `null` as the `target` parameter.", "kind": "function", "name": "bindAndDraw", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to draw to. If not set, it will pop the fbo from the stack.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying? Only used if `target` parameter is set.", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use during the draw.", "name": "currentShader" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw", "scope": "instance", "___id": "T000002R033982", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 571, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Destroys all shader instances, removes all object references and nulls all external references.", "kind": "function", "name": "destroy", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy", "scope": "instance", "overrides": "Phaser.Renderer.WebGL.WebGLPipeline#destroy", "___id": "T000002R033988", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Pre FX Pipeline is a special kind of pipeline designed specifically for applying\r\n * special effects to Game Objects before they are rendered. Where-as the Post FX Pipeline applies an effect _after_ the\r\n * object has been rendered, the Pre FX Pipeline allows you to control the rendering of\r\n * the object itself - passing it off to its own texture, where multi-buffer compositing\r\n * can take place.\r\n *\r\n * You can only use the PreFX Pipeline on the following types of Game Objects, or those\r\n * that extend from them:\r\n *\r\n * Sprite\r\n * Image\r\n * Text\r\n * TileSprite\r\n * RenderTexture\r\n * Video\r\n *\r\n * @class PreFXPipeline\r\n * @extends Phaser.Renderer.WebGL.WebGLPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration options for this pipeline.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 20, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "classdesc": "The Pre FX Pipeline is a special kind of pipeline designed specifically for applying\rspecial effects to Game Objects before they are rendered. Where-as the Post FX Pipeline applies an effect _after_ the\robject has been rendered, the Pre FX Pipeline allows you to control the rendering of\rthe object itself - passing it off to its own texture, where multi-buffer compositing\rcan take place.\r\rYou can only use the PreFX Pipeline on the following types of Game Objects, or those\rthat extend from them:\r\rSprite\rImage\rText\rTileSprite\rRenderTexture\rVideo", "kind": "class", "name": "PreFXPipeline", "augments": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration options for this pipeline.", "name": "config" } ], "scope": "static", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "___id": "T000002R034010", "___s": true }, { "comment": "/**\r\n * A reference to the Draw Sprite Shader belonging to this Pipeline.\r\n *\r\n * This shader is used when the sprite is drawn to this fbo (or to the game if drawToFrame is false)\r\n *\r\n * This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#drawSpriteShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @default null\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A reference to the Draw Sprite Shader belonging to this Pipeline.\r\rThis shader is used when the sprite is drawn to this fbo (or to the game if drawToFrame is false)\r\rThis property is set during the `boot` method.", "name": "drawSpriteShader", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "defaultvalue": "null", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#drawSpriteShader", "scope": "instance", "kind": "member", "___id": "T000002R034035", "___s": true }, { "comment": "/**\r\n * A reference to the Copy Shader belonging to this Pipeline.\r\n *\r\n * This shader is used when you call the `copySprite` method.\r\n *\r\n * This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#copyShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @default null\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 111, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A reference to the Copy Shader belonging to this Pipeline.\r\rThis shader is used when you call the `copySprite` method.\r\rThis property is set during the `boot` method.", "name": "copyShader", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "defaultvalue": "null", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#copyShader", "scope": "instance", "kind": "member", "___id": "T000002R034037", "___s": true }, { "comment": "/**\r\n * A reference to the Game Draw Shader belonging to this Pipeline.\r\n *\r\n * This shader draws the fbo to the game.\r\n *\r\n * This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#gameShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @default null\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A reference to the Game Draw Shader belonging to this Pipeline.\r\rThis shader draws the fbo to the game.\r\rThis property is set during the `boot` method.", "name": "gameShader", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "defaultvalue": "null", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#gameShader", "scope": "instance", "kind": "member", "___id": "T000002R034039", "___s": true }, { "comment": "/**\r\n * A reference to the Color Matrix Shader belonging to this Pipeline.\r\n *\r\n * This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#colorMatrixShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A reference to the Color Matrix Shader belonging to this Pipeline.\r\rThis property is set during the `boot` method.", "name": "colorMatrixShader", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#colorMatrixShader", "scope": "instance", "kind": "member", "___id": "T000002R034041", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices used specifically during the copySprite method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#quadVertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Raw byte buffer of vertices used specifically during the copySprite method.", "name": "quadVertexData", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#quadVertexData", "scope": "instance", "kind": "member", "___id": "T000002R034043", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the quadVertexData.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#quadVertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The WebGLBuffer that holds the quadVertexData.", "name": "quadVertexBuffer", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#quadVertexBuffer", "scope": "instance", "kind": "member", "___id": "T000002R034045", "___s": true }, { "comment": "/**\r\n * Float32 view of the quad array buffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#quadVertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 170, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Float32 view of the quad array buffer.", "name": "quadVertexViewF32", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#quadVertexViewF32", "scope": "instance", "kind": "member", "___id": "T000002R034047", "___s": true }, { "comment": "/**\r\n * The full-screen Render Target that the sprite is first drawn to.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#fsTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 199, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "The full-screen Render Target that the sprite is first drawn to.", "name": "fsTarget", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#fsTarget", "scope": "instance", "kind": "member", "___id": "T000002R034053", "___s": true }, { "comment": "/**\r\n * Handles the resizing of the quad vertex data.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onResize\r\n * @since 3.60.0\r\n *\r\n * @param {number} width - The new width of the quad.\r\n * @param {number} height - The new height of the quad.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 259, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Handles the resizing of the quad vertex data.", "kind": "function", "name": "onResize", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the quad.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of the quad.", "name": "height" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onResize", "scope": "instance", "overrides": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "___id": "T000002R034072", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where x0 / y0 = 0, x1 / y1 = 1, x2 / y2 = 2 and x3 / y3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#batchQuad\r\n * @since 3.60.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 292, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere x0 / y0 = 0, x1 / y1 = 1, x2 / y2 = 2 and x3 / y3 = 3", "kind": "function", "name": "batchQuad", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#batchQuad", "scope": "instance", "overrides": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "___id": "T000002R034081", "___s": true }, { "comment": "/**\r\n * This callback is invoked when a sprite is drawn by this pipeline.\r\n *\r\n * It will fire after the shader has been set, but before the sprite has been drawn,\r\n * so use it to set any additional uniforms you may need.\r\n *\r\n * Note: Manipulating the Sprite during this callback will _not_ change how it is drawn to the Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onDrawSprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Sprite} gameObject - The Sprite being drawn.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target the Sprite will be drawn to.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 428, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "This callback is invoked when a sprite is drawn by this pipeline.\r\rIt will fire after the shader has been set, but before the sprite has been drawn,\rso use it to set any additional uniforms you may need.\r\rNote: Manipulating the Sprite during this callback will _not_ change how it is drawn to the Render Target.", "kind": "function", "name": "onDrawSprite", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "The Sprite being drawn.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target the Sprite will be drawn to.", "name": "target" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onDrawSprite", "scope": "instance", "___id": "T000002R034101", "___s": true }, { "comment": "/**\r\n * This callback is invoked when you call the `copySprite` method.\r\n *\r\n * It will fire after the shader has been set, but before the source target has been copied,\r\n * so use it to set any additional uniforms you may need.\r\n *\r\n * Note: Manipulating the Sprite during this callback will _not_ change the Render Targets.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onCopySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target being copied from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target that will be copied to.\r\n * @param {Phaser.GameObjects.Sprite} gameObject - The Sprite being copied.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 446, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "This callback is invoked when you call the `copySprite` method.\r\rIt will fire after the shader has been set, but before the source target has been copied,\rso use it to set any additional uniforms you may need.\r\rNote: Manipulating the Sprite during this callback will _not_ change the Render Targets.", "kind": "function", "name": "onCopySprite", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target being copied from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target that will be copied to.", "name": "target" }, { "type": { "names": [ "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "The Sprite being copied.", "name": "gameObject" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onCopySprite", "scope": "instance", "___id": "T000002R034103", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * No target resizing takes place. If the `source` Render Target is larger than the `target`,\r\n * then only a portion the same size as the `target` dimensions is copied across.\r\n *\r\n * Calling this method will invoke the `onCopySprite` handler and will also call\r\n * the `onFXCopy` callback on the Sprite. Both of these happen prior to the copy, allowing you\r\n * to use them to set shader uniforms and other values.\r\n *\r\n * You can optionally pass in a ColorMatrix. If so, it will use the ColorMatrix shader\r\n * during the copy, allowing you to manipulate the colors to a fine degree.\r\n * See the `ColorMatrix` class for more details.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target being copied from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target that will be copied to.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n * @param {Phaser.Display.ColorMatrix} [colorMatrix] - Optional ColorMatrix to use when copying the Sprite.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to use to copy the target. Defaults to the `copyShader`.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 465, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Copy the `source` Render Target to the `target` Render Target.\r\rNo target resizing takes place. If the `source` Render Target is larger than the `target`,\rthen only a portion the same size as the `target` dimensions is copied across.\r\rCalling this method will invoke the `onCopySprite` handler and will also call\rthe `onFXCopy` callback on the Sprite. Both of these happen prior to the copy, allowing you\rto use them to set shader uniforms and other values.\r\rYou can optionally pass in a ColorMatrix. If so, it will use the ColorMatrix shader\rduring the copy, allowing you to manipulate the colors to a fine degree.\rSee the `ColorMatrix` class for more details.", "kind": "function", "name": "copySprite", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target being copied from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target that will be copied to.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" }, { "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "optional": true, "description": "Optional ColorMatrix to use when copying the Sprite.", "name": "colorMatrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use to copy the target. Defaults to the `copyShader`.", "name": "shader" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#copySprite", "scope": "instance", "___id": "T000002R034105", "___s": true }, { "comment": "/**\r\n * Draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * This is done using whatever the currently bound shader is. This method does\r\n * not set a shader. All it does is bind the source texture, set the viewport and UVs\r\n * then bind the target framebuffer, clears it and draws the source to it.\r\n *\r\n * At the end a null framebuffer is bound. No other clearing-up takes place, so\r\n * use this method carefully.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#copy\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 569, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Draws the `source` Render Target to the `target` Render Target.\r\rThis is done using whatever the currently bound shader is. This method does\rnot set a shader. All it does is bind the source texture, set the viewport and UVs\rthen bind the target framebuffer, clears it and draws the source to it.\r\rAt the end a null framebuffer is bound. No other clearing-up takes place, so\ruse this method carefully.", "kind": "function", "name": "copy", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#copy", "scope": "instance", "___id": "T000002R034118", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#blendFrames\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 611, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "kind": "function", "name": "blendFrames", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#blendFrames", "scope": "instance", "___id": "T000002R034121", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#blendFramesAdditive\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 629, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "kind": "function", "name": "blendFramesAdditive", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#blendFramesAdditive", "scope": "instance", "___id": "T000002R034123", "___s": true }, { "comment": "/**\r\n * This method will copy the given Render Target to the game canvas using the `copyShader`.\r\n *\r\n * This applies the results of the copy shader during the draw.\r\n *\r\n * If you wish to copy the target without any effects see the `copyToGame` method instead.\r\n *\r\n * This method should be the final thing called in your pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#drawToGame\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw to the game.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 647, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "This method will copy the given Render Target to the game canvas using the `copyShader`.\r\rThis applies the results of the copy shader during the draw.\r\rIf you wish to copy the target without any effects see the `copyToGame` method instead.\r\rThis method should be the final thing called in your pipeline.", "kind": "function", "name": "drawToGame", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw to the game.", "name": "source" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#drawToGame", "scope": "instance", "___id": "T000002R034125", "___s": true }, { "comment": "/**\r\n * This method will copy the given Render Target to the game canvas using the `gameShader`.\r\n *\r\n * Unless you've changed it, the `gameShader` copies the target without modifying it, just\r\n * ensuring it is placed in the correct location on the canvas.\r\n *\r\n * If you wish to draw the target with and apply the fragment shader at the same time,\r\n * see the `drawToGame` method instead.\r\n *\r\n * This method should be the final thing called in your pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#copyToGame\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to copy to the game.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 670, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "This method will copy the given Render Target to the game canvas using the `gameShader`.\r\rUnless you've changed it, the `gameShader` copies the target without modifying it, just\rensuring it is placed in the correct location on the canvas.\r\rIf you wish to draw the target with and apply the fragment shader at the same time,\rsee the `drawToGame` method instead.\r\rThis method should be the final thing called in your pipeline.", "kind": "function", "name": "copyToGame", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to copy to the game.", "name": "source" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#copyToGame", "scope": "instance", "___id": "T000002R034128", "___s": true }, { "comment": "/**\r\n * This method is called by `drawToGame` and `copyToGame`. It takes the source Render Target\r\n * and copies it back to the game canvas, or the next frame buffer in the stack, and should\r\n * be considered the very last thing this pipeline does.\r\n *\r\n * You don't normally need to call this method, or override it, however it is left public\r\n * should you wish to do so.\r\n *\r\n * Note that it does _not_ set a shader. You should do this yourself if invoking this.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#bindAndDraw\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw to the game.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 695, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "This method is called by `drawToGame` and `copyToGame`. It takes the source Render Target\rand copies it back to the game canvas, or the next frame buffer in the stack, and should\rbe considered the very last thing this pipeline does.\r\rYou don't normally need to call this method, or override it, however it is left public\rshould you wish to do so.\r\rNote that it does _not_ set a shader. You should do this yourself if invoking this.", "kind": "function", "name": "bindAndDraw", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw to the game.", "name": "source" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#bindAndDraw", "scope": "instance", "___id": "T000002R034131", "___s": true }, { "comment": "/**\r\n * This method is called every time the `batchSprite` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * If you override this method, then it should make sure it calls either the\r\n * `drawToGame` or `copyToGame` methods as the final thing it does. However, you can do as\r\n * much additional processing as you like prior to this.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onDraw\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to draw to the game.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - The Swap Render Target, useful for double-buffer effects.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [altSwapTarget] - The Swap Render Target, useful for double-buffer effects.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 781, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "This method is called every time the `batchSprite` method is called and is passed a\rreference to the current render target.\r\rIf you override this method, then it should make sure it calls either the\r`drawToGame` or `copyToGame` methods as the final thing it does. However, you can do as\rmuch additional processing as you like prior to this.", "kind": "function", "name": "onDraw", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw to the game.", "name": "target" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Swap Render Target, useful for double-buffer effects.", "name": "swapTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Swap Render Target, useful for double-buffer effects.", "name": "altSwapTarget" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onDraw", "scope": "instance", "overrides": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "___id": "T000002R034150", "___s": true }, { "comment": "/**\r\n * Set the UV values for the 6 vertices that make up the quad used by the copy shader.\r\n *\r\n * Be sure to call `resetUVs` once you have finished manipulating the UV coordinates.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setUVs\r\n * @since 3.60.0\r\n *\r\n * @param {number} uA - The u value of vertex A.\r\n * @param {number} vA - The v value of vertex A.\r\n * @param {number} uB - The u value of vertex B.\r\n * @param {number} vB - The v value of vertex B.\r\n * @param {number} uC - The u value of vertex C.\r\n * @param {number} vC - The v value of vertex C.\r\n * @param {number} uD - The u value of vertex D.\r\n * @param {number} vD - The v value of vertex D.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 801, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Set the UV values for the 6 vertices that make up the quad used by the copy shader.\r\rBe sure to call `resetUVs` once you have finished manipulating the UV coordinates.", "kind": "function", "name": "setUVs", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The u value of vertex A.", "name": "uA" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The v value of vertex A.", "name": "vA" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The u value of vertex B.", "name": "uB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The v value of vertex B.", "name": "vB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The u value of vertex C.", "name": "uC" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The v value of vertex C.", "name": "vC" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The u value of vertex D.", "name": "uD" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The v value of vertex D.", "name": "vD" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setUVs", "scope": "instance", "___id": "T000002R034152", "___s": true }, { "comment": "/**\r\n * Sets the vertex UV coordinates of the quad used by the copy shaders\r\n * so that they correctly adjust the texture coordinates for a blit frame effect.\r\n *\r\n * Be sure to call `resetUVs` once you have finished manipulating the UV coordinates.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setTargetUVs\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 841, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Sets the vertex UV coordinates of the quad used by the copy shaders\rso that they correctly adjust the texture coordinates for a blit frame effect.\r\rBe sure to call `resetUVs` once you have finished manipulating the UV coordinates.", "kind": "function", "name": "setTargetUVs", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setTargetUVs", "scope": "instance", "___id": "T000002R034167", "___s": true }, { "comment": "/**\r\n * Resets the quad vertice UV values to their default settings.\r\n *\r\n * The quad is used by the copy shader in this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#resetUVs\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 869, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Resets the quad vertice UV values to their default settings.\r\rThe quad is used by the copy shader in this pipeline.", "kind": "function", "name": "resetUVs", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#resetUVs", "scope": "instance", "___id": "T000002R034172", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#destroy\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#DESTROY\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 882, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Destroys all shader instances, removes all object references and nulls all external references.", "kind": "function", "name": "destroy", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:DESTROY" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#destroy", "scope": "instance", "overrides": "Phaser.Renderer.WebGL.WebGLPipeline#destroy", "___id": "T000002R034174", "___s": true }, { "comment": "/**\n * @classdesc\n * The Rope Pipeline is a variation of the Multi Pipeline that uses a `TRIANGLE_STRIP` for\n * its topology, instead of TRIANGLES. This is primarily used by the Rope Game Object,\n * or anything that extends it.\n *\n * Prior to Phaser v3.50 this pipeline was called the `TextureTintStripPipeline`.\n *\n * The fragment shader it uses can be found in `shaders/src/Multi.frag`.\n * The vertex shader it uses can be found in `shaders/src/Multi.vert`.\n *\n * The default shader attributes for this pipeline are:\n *\n * `inPosition` (vec2, offset 0)\n * `inTexCoord` (vec2, offset 8)\n * `inTexId` (float, offset 16)\n * `inTintEffect` (float, offset 20)\n * `inTint` (vec4, offset 24, normalized)\n *\n * The default shader uniforms for this pipeline are:\n *\n * `uProjectionMatrix` (mat4)\n * `uMainSampler` (sampler2D array)\n *\n * The pipeline is structurally identical to the Multi Pipeline and should be treated as such.\n *\n * @class RopePipeline\n * @extends Phaser.Renderer.WebGL.Pipelines.MultiPipeline\n * @memberof Phaser.Renderer.WebGL.Pipelines\n * @constructor\n * @since 3.50.0\n *\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration options for this pipeline.\n */", "meta": { "filename": "RopePipeline.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "classdesc": "The Rope Pipeline is a variation of the Multi Pipeline that uses a `TRIANGLE_STRIP` for\nits topology, instead of TRIANGLES. This is primarily used by the Rope Game Object,\nor anything that extends it.\n\nPrior to Phaser v3.50 this pipeline was called the `TextureTintStripPipeline`.\n\nThe fragment shader it uses can be found in `shaders/src/Multi.frag`.\nThe vertex shader it uses can be found in `shaders/src/Multi.vert`.\n\nThe default shader attributes for this pipeline are:\n\n`inPosition` (vec2, offset 0)\n`inTexCoord` (vec2, offset 8)\n`inTexId` (float, offset 16)\n`inTintEffect` (float, offset 20)\n`inTint` (vec4, offset 24, normalized)\n\nThe default shader uniforms for this pipeline are:\n\n`uProjectionMatrix` (mat4)\n`uMainSampler` (sampler2D array)\n\nThe pipeline is structurally identical to the Multi Pipeline and should be treated as such.", "kind": "class", "name": "RopePipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.MultiPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration options for this pipeline.", "name": "config" } ], "scope": "static", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "___id": "T000002R034189", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Single Pipeline is a special version of the Multi Pipeline that only ever\r\n * uses one texture, bound to texture unit zero. Although not as efficient as the\r\n * Multi Pipeline, it provides an easier way to create custom pipelines that only require\r\n * a single bound texture.\r\n *\r\n * Prior to Phaser v3.50 this pipeline didn't exist, but could be compared to the old `TextureTintPipeline`.\r\n *\r\n * The fragment shader it uses can be found in `shaders/src/Single.frag`.\r\n * The vertex shader it uses can be found in `shaders/src/Single.vert`.\r\n *\r\n * The default shader attributes for this pipeline are:\r\n *\r\n * `inPosition` (vec2, offset 0)\r\n * `inTexCoord` (vec2, offset 8)\r\n * `inTexId` (float, offset 16) - this value is always zero in the Single Pipeline\r\n * `inTintEffect` (float, offset 20)\r\n * `inTint` (vec4, offset 24, normalized)\r\n *\r\n * The default shader uniforms for this pipeline are:\r\n *\r\n * `uProjectionMatrix` (mat4)\r\n * `uMainSampler` (sampler2D)\r\n *\r\n * @class SinglePipeline\r\n * @extends Phaser.Renderer.WebGL.Pipelines.MultiPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines\r\n * @constructor\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration options for this pipeline.\r\n */", "meta": { "filename": "SinglePipeline.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "classdesc": "The Single Pipeline is a special version of the Multi Pipeline that only ever\ruses one texture, bound to texture unit zero. Although not as efficient as the\rMulti Pipeline, it provides an easier way to create custom pipelines that only require\ra single bound texture.\r\rPrior to Phaser v3.50 this pipeline didn't exist, but could be compared to the old `TextureTintPipeline`.\r\rThe fragment shader it uses can be found in `shaders/src/Single.frag`.\rThe vertex shader it uses can be found in `shaders/src/Single.vert`.\r\rThe default shader attributes for this pipeline are:\r\r`inPosition` (vec2, offset 0)\r`inTexCoord` (vec2, offset 8)\r`inTexId` (float, offset 16) - this value is always zero in the Single Pipeline\r`inTintEffect` (float, offset 20)\r`inTint` (vec4, offset 24, normalized)\r\rThe default shader uniforms for this pipeline are:\r\r`uProjectionMatrix` (mat4)\r`uMainSampler` (sampler2D)", "kind": "class", "name": "SinglePipeline", "augments": [ "Phaser.Renderer.WebGL.Pipelines.MultiPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration options for this pipeline.", "name": "config" } ], "scope": "static", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "___id": "T000002R034202", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Utility Pipeline is a special-use pipeline that belongs to the Pipeline Manager.\r\n *\r\n * It provides 4 shaders and handy associated methods:\r\n *\r\n * 1) Copy Shader. A fast texture to texture copy shader with optional brightness setting.\r\n * 2) Additive Blend Mode Shader. Blends two textures using an additive blend mode.\r\n * 3) Linear Blend Mode Shader. Blends two textures using a linear blend mode.\r\n * 4) Color Matrix Copy Shader. Draws a texture to a target using a Color Matrix.\r\n *\r\n * You do not extend this pipeline, but instead get a reference to it from the Pipeline\r\n * Manager via the `setUtility` method. You can also access methods such as `copyFrame`\r\n * directly from the Pipeline Manager.\r\n *\r\n * This pipeline provides methods for manipulating framebuffer backed textures, such as\r\n * copying or blending one texture to another, copying a portion of a texture, additively\r\n * blending two textures, flipping textures and more.\r\n *\r\n * The default shader attributes for this pipeline are:\r\n *\r\n * `inPosition` (vec2, offset 0)\r\n * `inTexCoord` (vec2, offset 8)\r\n *\r\n * This pipeline has a hard-coded batch size of 1 and a hard coded set of vertices.\r\n *\r\n * @class UtilityPipeline\r\n * @extends Phaser.Renderer.WebGL.WebGLPipeline\r\n * @memberof Phaser.Renderer.WebGL.Pipelines\r\n * @constructor\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration options for this pipeline.\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 18, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "classdesc": "The Utility Pipeline is a special-use pipeline that belongs to the Pipeline Manager.\r\rIt provides 4 shaders and handy associated methods:\r\r1) Copy Shader. A fast texture to texture copy shader with optional brightness setting.\r2) Additive Blend Mode Shader. Blends two textures using an additive blend mode.\r3) Linear Blend Mode Shader. Blends two textures using a linear blend mode.\r4) Color Matrix Copy Shader. Draws a texture to a target using a Color Matrix.\r\rYou do not extend this pipeline, but instead get a reference to it from the Pipeline\rManager via the `setUtility` method. You can also access methods such as `copyFrame`\rdirectly from the Pipeline Manager.\r\rThis pipeline provides methods for manipulating framebuffer backed textures, such as\rcopying or blending one texture to another, copying a portion of a texture, additively\rblending two textures, flipping textures and more.\r\rThe default shader attributes for this pipeline are:\r\r`inPosition` (vec2, offset 0)\r`inTexCoord` (vec2, offset 8)\r\rThis pipeline has a hard-coded batch size of 1 and a hard coded set of vertices.", "kind": "class", "name": "UtilityPipeline", "augments": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "memberof": "Phaser.Renderer.WebGL.Pipelines", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration options for this pipeline.", "name": "config" } ], "scope": "static", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "___id": "T000002R034222", "___s": true }, { "comment": "/**\r\n * A default Color Matrix, used by the Color Matrix Shader when one\r\n * isn't provided.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A default Color Matrix, used by the Color Matrix Shader when one\risn't provided.", "name": "colorMatrix", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#colorMatrix", "scope": "instance", "kind": "member", "___id": "T000002R034248", "___s": true }, { "comment": "/**\r\n * A reference to the Copy Shader belonging to this Utility Pipeline.\r\n *\r\n * This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#copyShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A reference to the Copy Shader belonging to this Utility Pipeline.\r\rThis property is set during the `boot` method.", "name": "copyShader", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#copyShader", "scope": "instance", "kind": "member", "___id": "T000002R034250", "___s": true }, { "comment": "/**\r\n * A reference to the Additive Blend Shader belonging to this Utility Pipeline.\r\n *\r\n * This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#addShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A reference to the Additive Blend Shader belonging to this Utility Pipeline.\r\rThis property is set during the `boot` method.", "name": "addShader", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#addShader", "scope": "instance", "kind": "member", "___id": "T000002R034252", "___s": true }, { "comment": "/**\r\n * A reference to the Linear Blend Shader belonging to this Utility Pipeline.\r\n *\r\n * This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#linearShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 153, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A reference to the Linear Blend Shader belonging to this Utility Pipeline.\r\rThis property is set during the `boot` method.", "name": "linearShader", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#linearShader", "scope": "instance", "kind": "member", "___id": "T000002R034254", "___s": true }, { "comment": "/**\r\n * A reference to the Color Matrix Shader belonging to this Utility Pipeline.\r\n *\r\n * This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#colorMatrixShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 164, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A reference to the Color Matrix Shader belonging to this Utility Pipeline.\r\rThis property is set during the `boot` method.", "name": "colorMatrixShader", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#colorMatrixShader", "scope": "instance", "kind": "member", "___id": "T000002R034256", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target.\r\n *\r\n * This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A reference to the Full Frame 1 Render Target.\r\rThis property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "name": "fullFrame1", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#fullFrame1", "scope": "instance", "kind": "member", "___id": "T000002R034258", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target.\r\n *\r\n * This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 191, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A reference to the Full Frame 2 Render Target.\r\rThis property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "name": "fullFrame2", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#fullFrame2", "scope": "instance", "kind": "member", "___id": "T000002R034260", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target.\r\n *\r\n * This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A reference to the Half Frame 1 Render Target.\r\rThis property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "name": "halfFrame1", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#halfFrame1", "scope": "instance", "kind": "member", "___id": "T000002R034262", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target.\r\n *\r\n * This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 223, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "A reference to the Half Frame 2 Render Target.\r\rThis property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "name": "halfFrame2", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#halfFrame2", "scope": "instance", "kind": "member", "___id": "T000002R034264", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 258, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.", "kind": "function", "name": "copyFrame", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#copyFrame", "scope": "instance", "___id": "T000002R034277", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n * @param {boolean} [flipY=false] - Flip the UV on the Y axis before drawing?\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 324, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "kind": "function", "name": "blitFrame", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Flip the UV on the Y axis before drawing?", "name": "flipY" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#blitFrame", "scope": "instance", "___id": "T000002R034283", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 418, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "kind": "function", "name": "copyFrameRect", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#copyFrameRect", "scope": "instance", "___id": "T000002R034293", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 472, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "kind": "function", "name": "copyToGame", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#copyToGame", "scope": "instance", "___id": "T000002R034298", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using the\r\n * given Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Display.ColorMatrix} [colorMatrix] - The Color Matrix to use when performing the draw.\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 505, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Copy the `source` Render Target to the `target` Render Target, using the\rgiven Color Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.", "kind": "function", "name": "drawFrame", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "optional": true, "description": "The Color Matrix to use when performing the draw.", "name": "colorMatrix" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#drawFrame", "scope": "instance", "___id": "T000002R034301", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [blendShader] - The shader to use during the blend copy.\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 567, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "kind": "function", "name": "blendFrames", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use during the blend copy.", "name": "blendShader" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#blendFrames", "scope": "instance", "___id": "T000002R034306", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 630, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "kind": "function", "name": "blendFramesAdditive", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#blendFramesAdditive", "scope": "instance", "___id": "T000002R034312", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 648, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Clears the given Render Target.", "kind": "function", "name": "clearFrame", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#clearFrame", "scope": "instance", "___id": "T000002R034314", "___s": true }, { "comment": "/**\r\n * Set the UV values for the 6 vertices that make up the quad used by the shaders\r\n * in the Utility Pipeline.\r\n *\r\n * Be sure to call `resetUVs` once you have finished manipulating the UV coordinates.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#setUVs\r\n * @since 3.50.0\r\n *\r\n * @param {number} uA - The u value of vertex A.\r\n * @param {number} vA - The v value of vertex A.\r\n * @param {number} uB - The u value of vertex B.\r\n * @param {number} vB - The v value of vertex B.\r\n * @param {number} uC - The u value of vertex C.\r\n * @param {number} vC - The v value of vertex C.\r\n * @param {number} uD - The u value of vertex D.\r\n * @param {number} vD - The v value of vertex D.\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 683, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Set the UV values for the 6 vertices that make up the quad used by the shaders\rin the Utility Pipeline.\r\rBe sure to call `resetUVs` once you have finished manipulating the UV coordinates.", "kind": "function", "name": "setUVs", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The u value of vertex A.", "name": "uA" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The v value of vertex A.", "name": "vA" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The u value of vertex B.", "name": "uB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The v value of vertex B.", "name": "vB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The u value of vertex C.", "name": "uC" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The v value of vertex C.", "name": "vC" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The u value of vertex D.", "name": "uD" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The v value of vertex D.", "name": "vD" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#setUVs", "scope": "instance", "___id": "T000002R034319", "___s": true }, { "comment": "/**\r\n * Sets the vertex UV coordinates of the quad used by the shaders in the Utility Pipeline\r\n * so that they correctly adjust the texture coordinates for a blit frame effect.\r\n *\r\n * Be sure to call `resetUVs` once you have finished manipulating the UV coordinates.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#setTargetUVs\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 719, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Sets the vertex UV coordinates of the quad used by the shaders in the Utility Pipeline\rso that they correctly adjust the texture coordinates for a blit frame effect.\r\rBe sure to call `resetUVs` once you have finished manipulating the UV coordinates.", "kind": "function", "name": "setTargetUVs", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#setTargetUVs", "scope": "instance", "___id": "T000002R034334", "___s": true }, { "comment": "/**\r\n * Horizontally flips the UV coordinates of the quad used by the shaders in this\r\n * Utility Pipeline.\r\n *\r\n * Be sure to call `resetUVs` once you have finished manipulating the UV coordinates.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#flipX\r\n * @since 3.50.0\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Horizontally flips the UV coordinates of the quad used by the shaders in this\rUtility Pipeline.\r\rBe sure to call `resetUVs` once you have finished manipulating the UV coordinates.", "kind": "function", "name": "flipX", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#flipX", "scope": "instance", "___id": "T000002R034339", "___s": true }, { "comment": "/**\r\n * Vertically flips the UV coordinates of the quad used by the shaders in this\r\n * Utility Pipeline.\r\n *\r\n * Be sure to call `resetUVs` once you have finished manipulating the UV coordinates.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#flipY\r\n * @since 3.50.0\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 761, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Vertically flips the UV coordinates of the quad used by the shaders in this\rUtility Pipeline.\r\rBe sure to call `resetUVs` once you have finished manipulating the UV coordinates.", "kind": "function", "name": "flipY", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#flipY", "scope": "instance", "___id": "T000002R034341", "___s": true }, { "comment": "/**\r\n * Resets the quad vertice UV values to their default settings.\r\n *\r\n * The quad is used by all shaders of the Utility Pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#resetUVs\r\n * @since 3.50.0\r\n */", "meta": { "filename": "UtilityPipeline.js", "lineno": 775, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "description": "Resets the quad vertice UV values to their default settings.\r\rThe quad is used by all shaders of the Utility Pipeline.", "kind": "function", "name": "resetUVs", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#resetUVs", "scope": "instance", "___id": "T000002R034343", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Render Target encapsulates a WebGL framebuffer and the WebGL Texture that displays it.\r\n *\r\n * Instances of this class are typically created by, and belong to WebGL Pipelines, however\r\n * other Game Objects and classes can take advantage of Render Targets as well.\r\n *\r\n * @class RenderTarget\r\n * @memberof Phaser.Renderer.WebGL\r\n * @constructor\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - A reference to the WebGLRenderer.\r\n * @param {number} width - The width of this Render Target.\r\n * @param {number} height - The height of this Render Target.\r\n * @param {number} [scale=1] - A value between 0 and 1. Controls the size of this Render Target in relation to the Renderer.\r\n * @param {number} [minFilter=0] - The minFilter mode of the texture when created. 0 is `LINEAR`, 1 is `NEAREST`.\r\n * @param {boolean} [autoClear=true] - Automatically clear this framebuffer when bound?\r\n * @param {boolean} [autoResize=false] - Automatically resize this Render Target if the WebGL Renderer resizes?\r\n * @param {boolean} [addDepthBuffer=true] - Add a DEPTH_STENCIL and attachment to this Render Target?\r\n * @param {boolean} [forceClamp=true] - Force the texture to use the CLAMP_TO_EDGE wrap mode, even if a power of two?\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "classdesc": "A Render Target encapsulates a WebGL framebuffer and the WebGL Texture that displays it.\r\rInstances of this class are typically created by, and belong to WebGL Pipelines, however\rother Game Objects and classes can take advantage of Render Targets as well.", "kind": "class", "name": "RenderTarget", "memberof": "Phaser.Renderer.WebGL", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "description": "A reference to the WebGLRenderer.", "name": "renderer" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this Render Target.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this Render Target.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "A value between 0 and 1. Controls the size of this Render Target in relation to the Renderer.", "name": "scale" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The minFilter mode of the texture when created. 0 is `LINEAR`, 1 is `NEAREST`.", "name": "minFilter" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Automatically clear this framebuffer when bound?", "name": "autoClear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Automatically resize this Render Target if the WebGL Renderer resizes?", "name": "autoResize" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Add a DEPTH_STENCIL and attachment to this Render Target?", "name": "addDepthBuffer" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Force the texture to use the CLAMP_TO_EDGE wrap mode, even if a power of two?", "name": "forceClamp" } ], "scope": "static", "longname": "Phaser.Renderer.WebGL.RenderTarget", "___id": "T000002R034348", "___s": true }, { "comment": "/**\r\n * A reference to the WebGLRenderer instance.\r\n *\r\n * @name Phaser.Renderer.WebGL.RenderTarget#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A reference to the WebGLRenderer instance.", "name": "renderer", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#renderer", "scope": "instance", "kind": "member", "___id": "T000002R034357", "___s": true }, { "comment": "/**\r\n * The WebGLFramebuffer of this Render Target.\r\n *\r\n * This is created in the `RenderTarget.resize` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.RenderTarget#framebuffer\r\n * @type {WebGLFramebuffer}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The WebGLFramebuffer of this Render Target.\r\rThis is created in the `RenderTarget.resize` method.", "name": "framebuffer", "type": { "names": [ "WebGLFramebuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLFramebuffer" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#framebuffer", "scope": "instance", "kind": "member", "___id": "T000002R034359", "___s": true }, { "comment": "/**\r\n * The WebGLTexture of this Render Target.\r\n *\r\n * This is created in the `RenderTarget.resize` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.RenderTarget#texture\r\n * @type {WebGLTexture}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The WebGLTexture of this Render Target.\r\rThis is created in the `RenderTarget.resize` method.", "name": "texture", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#texture", "scope": "instance", "kind": "member", "___id": "T000002R034361", "___s": true }, { "comment": "/**\r\n * The width of the texture.\r\n *\r\n * @name Phaser.Renderer.WebGL.RenderTarget#width\r\n * @type {number}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The width of the texture.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#width", "scope": "instance", "kind": "member", "___id": "T000002R034363", "___s": true }, { "comment": "/**\r\n * The height of the texture.\r\n *\r\n * @name Phaser.Renderer.WebGL.RenderTarget#height\r\n * @type {number}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The height of the texture.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#height", "scope": "instance", "kind": "member", "___id": "T000002R034365", "___s": true }, { "comment": "/**\r\n * A value between 0 and 1. Controls the size of this Render Target in relation to the Renderer.\r\n *\r\n * A value of 1 matches it. 0.5 makes the Render Target half the size of the renderer, etc.\r\n *\r\n * @name Phaser.Renderer.WebGL.RenderTarget#scale\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A value between 0 and 1. Controls the size of this Render Target in relation to the Renderer.\r\rA value of 1 matches it. 0.5 makes the Render Target half the size of the renderer, etc.", "name": "scale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#scale", "scope": "instance", "kind": "member", "___id": "T000002R034367", "___s": true }, { "comment": "/**\r\n * The minFilter mode of the texture. 0 is `LINEAR`, 1 is `NEAREST`.\r\n *\r\n * @name Phaser.Renderer.WebGL.RenderTarget#minFilter\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The minFilter mode of the texture. 0 is `LINEAR`, 1 is `NEAREST`.", "name": "minFilter", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#minFilter", "scope": "instance", "kind": "member", "___id": "T000002R034369", "___s": true }, { "comment": "/**\r\n * Controls if this Render Target is automatically cleared (via `gl.COLOR_BUFFER_BIT`)\r\n * during the `RenderTarget.bind` method.\r\n *\r\n * If you need more control over how, or if, the target is cleared, you can disable\r\n * this via the config on creation, or even toggle it directly at runtime.\r\n *\r\n * @name Phaser.Renderer.WebGL.RenderTarget#autoClear\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Controls if this Render Target is automatically cleared (via `gl.COLOR_BUFFER_BIT`)\rduring the `RenderTarget.bind` method.\r\rIf you need more control over how, or if, the target is cleared, you can disable\rthis via the config on creation, or even toggle it directly at runtime.", "name": "autoClear", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#autoClear", "scope": "instance", "kind": "member", "___id": "T000002R034371", "___s": true }, { "comment": "/**\r\n * Does this Render Target automatically resize when the WebGL Renderer does?\r\n *\r\n * Modify this property via the `setAutoResize` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.RenderTarget#autoResize\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 129, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Does this Render Target automatically resize when the WebGL Renderer does?\r\rModify this property via the `setAutoResize` method.", "name": "autoResize", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#autoResize", "scope": "instance", "kind": "member", "___id": "T000002R034373", "___s": true }, { "comment": "/**\r\n * Does this Render Target have a Depth Buffer?\r\n *\r\n * @name Phaser.Renderer.WebGL.RenderTarget#hasDepthBuffer\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Does this Render Target have a Depth Buffer?", "name": "hasDepthBuffer", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#hasDepthBuffer", "scope": "instance", "kind": "member", "___id": "T000002R034375", "___s": true }, { "comment": "/**\r\n * Force the WebGL Texture to use the CLAMP_TO_EDGE wrap mode, even if a power of two?\r\n *\r\n * If `false` it will use `gl.REPEAT` instead, which may be required for some effects, such\r\n * as using this Render Target as a texture for a Shader.\r\n *\r\n * @name Phaser.Renderer.WebGL.RenderTarget#forceClamp\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Force the WebGL Texture to use the CLAMP_TO_EDGE wrap mode, even if a power of two?\r\rIf `false` it will use `gl.REPEAT` instead, which may be required for some effects, such\ras using this Render Target as a texture for a Shader.", "name": "forceClamp", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#forceClamp", "scope": "instance", "kind": "member", "___id": "T000002R034377", "___s": true }, { "comment": "/**\r\n * Sets if this Render Target should automatically resize when the WebGL Renderer\r\n * emits a resize event.\r\n *\r\n * @method Phaser.Renderer.WebGL.RenderTarget#setAutoResize\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} autoResize - Automatically resize this Render Target when the WebGL Renderer resizes?\r\n *\r\n * @return {this} This RenderTarget instance.\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets if this Render Target should automatically resize when the WebGL Renderer\remits a resize event.", "kind": "function", "name": "setAutoResize", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Automatically resize this Render Target when the WebGL Renderer resizes?", "name": "autoResize" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This RenderTarget instance." } ], "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#setAutoResize", "scope": "instance", "___id": "T000002R034380", "___s": true }, { "comment": "/**\r\n * Resizes this Render Target.\r\n *\r\n * Deletes both the frame buffer and texture, if they exist and then re-creates\r\n * them using the new sizes.\r\n *\r\n * This method is called automatically by the pipeline during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.RenderTarget#resize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this Render Target.\r\n * @param {number} height - The new height of this Render Target.\r\n *\r\n * @return {this} This RenderTarget instance.\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Resizes this Render Target.\r\rDeletes both the frame buffer and texture, if they exist and then re-creates\rthem using the new sizes.\r\rThis method is called automatically by the pipeline during its resize handler.", "kind": "function", "name": "resize", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this Render Target.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this Render Target.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This RenderTarget instance." } ], "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#resize", "scope": "instance", "___id": "T000002R034384", "___s": true }, { "comment": "/**\r\n * Pushes this Render Target as the current frame buffer of the renderer.\r\n *\r\n * If `autoClear` is set, then clears the texture.\r\n *\r\n * If `adjustViewport` is `true` then it will flush the renderer and then adjust the GL viewport.\r\n *\r\n * @method Phaser.Renderer.WebGL.RenderTarget#bind\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [adjustViewport=false] - Adjust the GL viewport by calling `RenderTarget.adjustViewport` ?\r\n * @param {number} [width] - Optional new width of this Render Target.\r\n * @param {number} [height] - Optional new height of this Render Target.\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 260, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Pushes this Render Target as the current frame buffer of the renderer.\r\rIf `autoClear` is set, then clears the texture.\r\rIf `adjustViewport` is `true` then it will flush the renderer and then adjust the GL viewport.", "kind": "function", "name": "bind", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Adjust the GL viewport by calling `RenderTarget.adjustViewport` ?", "name": "adjustViewport" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional new width of this Render Target.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional new height of this Render Target.", "name": "height" } ], "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#bind", "scope": "instance", "___id": "T000002R034399", "___s": true }, { "comment": "/**\r\n * Adjusts the GL viewport to match the width and height of this Render Target.\r\n *\r\n * Also disables `SCISSOR_TEST`.\r\n *\r\n * @method Phaser.Renderer.WebGL.RenderTarget#adjustViewport\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 309, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Adjusts the GL viewport to match the width and height of this Render Target.\r\rAlso disables `SCISSOR_TEST`.", "kind": "function", "name": "adjustViewport", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#adjustViewport", "scope": "instance", "___id": "T000002R034404", "___s": true }, { "comment": "/**\r\n * Clears this Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.RenderTarget#clear\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Clears this Render Target.", "kind": "function", "name": "clear", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#clear", "scope": "instance", "___id": "T000002R034407", "___s": true }, { "comment": "/**\r\n * Unbinds this Render Target and optionally flushes the WebGL Renderer first.\r\n *\r\n * @name Phaser.Renderer.WebGL.RenderTarget#unbind\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [flush=false] - Flush the WebGL Renderer before unbinding?\r\n *\r\n * @return {WebGLFramebuffer} The Framebuffer that was set, or `null` if there aren't any more in the stack.\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 350, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Unbinds this Render Target and optionally flushes the WebGL Renderer first.", "name": "unbind", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Flush the WebGL Renderer before unbinding?", "name": "flush" } ], "returns": [ { "type": { "names": [ "WebGLFramebuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLFramebuffer" } }, "description": "The Framebuffer that was set, or `null` if there aren't any more in the stack." } ], "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#unbind", "scope": "instance", "kind": "member", "___id": "T000002R034411", "___s": true }, { "comment": "/**\r\n * Removes all external references from this class and deletes the\r\n * WebGL framebuffer and texture instances.\r\n *\r\n * Does not remove this Render Target from the parent pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.RenderTarget#destroy\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RenderTarget.js", "lineno": 374, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Removes all external references from this class and deletes the\rWebGL framebuffer and texture instances.\r\rDoes not remove this Render Target from the parent pipeline.", "name": "destroy", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.RenderTarget", "longname": "Phaser.Renderer.WebGL.RenderTarget#destroy", "scope": "instance", "kind": "member", "___id": "T000002R034415", "___s": true }, { "comment": "/**\n * @namespace Phaser.Renderer.WebGL.Shaders\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\shaders", "code": {} }, "kind": "namespace", "name": "Shaders", "memberof": "Phaser.Renderer.WebGL", "longname": "Phaser.Renderer.WebGL.Shaders", "scope": "static", "___id": "T000002R034442", "___s": true }, { "comment": "/**\n * @namespace Phaser.Types.Renderer.WebGL\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\typedefs", "code": {} }, "kind": "namespace", "name": "WebGL", "memberof": "Phaser.Types.Renderer", "longname": "Phaser.Types.Renderer.WebGL", "scope": "static", "___id": "T000002R034492", "___s": true }, { "comment": "/**\n * @typedef {object} Phaser.Types.Renderer.WebGL.RenderTargetConfig\n * @since 3.50.0\n *\n * @property {number} [scale=1] - A value between 0 and 1. Controls the size of this Render Target in relation to the Renderer. A value of 1 matches it. 0.5 makes the Render Target half the size of the renderer, etc.\n * @property {number} [minFilter=0] - The minFilter mode of the texture. 0 is `LINEAR`, 1 is `NEAREST`.\n * @property {boolean} [autoClear=true] - Controls if this Render Target is automatically cleared (via `gl.COLOR_BUFFER_BIT`) during the bind.\n * @property {number} [width] - The width of the Render Target. This is optional. If given it overrides the `scale` property.\n * @property {number} [height=width] - The height of the Render Target. This is optional. If not given, it will be set to the same as the `width` value.\n */", "meta": { "filename": "RenderTargetConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\typedefs", "code": {} }, "kind": "typedef", "name": "RenderTargetConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "A value between 0 and 1. Controls the size of this Render Target in relation to the Renderer. A value of 1 matches it. 0.5 makes the Render Target half the size of the renderer, etc.", "name": "scale" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The minFilter mode of the texture. 0 is `LINEAR`, 1 is `NEAREST`.", "name": "minFilter" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Controls if this Render Target is automatically cleared (via `gl.COLOR_BUFFER_BIT`) during the bind.", "name": "autoClear" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the Render Target. This is optional. If given it overrides the `scale` property.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "width", "description": "The height of the Render Target. This is optional. If not given, it will be set to the same as the `width` value.", "name": "height" } ], "memberof": "Phaser.Types.Renderer.WebGL", "longname": "Phaser.Types.Renderer.WebGL.RenderTargetConfig", "scope": "static", "___id": "T000002R034493", "___s": true }, { "comment": "/**\n * @typedef {object} Phaser.Types.Renderer.WebGL.WebGLConst\n * @since 3.50.0\n *\n * @property {GLenum} enum - The data type of the attribute, i.e. `gl.BYTE`, `gl.SHORT`, `gl.UNSIGNED_BYTE`, `gl.FLOAT`, etc.\n * @property {number} size - The size, in bytes, of the data type.\n */", "meta": { "filename": "WebGLConst.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\typedefs", "code": {} }, "kind": "typedef", "name": "WebGLConst", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "description": "The data type of the attribute, i.e. `gl.BYTE`, `gl.SHORT`, `gl.UNSIGNED_BYTE`, `gl.FLOAT`, etc.", "name": "enum" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The size, in bytes, of the data type.", "name": "size" } ], "memberof": "Phaser.Types.Renderer.WebGL", "longname": "Phaser.Types.Renderer.WebGL.WebGLConst", "scope": "static", "___id": "T000002R034494", "___s": true }, { "comment": "/**\n * @typedef {object} Phaser.Types.Renderer.WebGL.WebGLPipelineAttribute\n * @since 3.50.0\n *\n * @property {string} name - The name of the attribute as defined in the vertex shader.\n * @property {number} size - The number of components in the attribute, i.e. 1 for a float, 2 for a vec2, 3 for a vec3, etc.\n * @property {GLenum} type - The data type of the attribute. Either `gl.BYTE`, `gl.SHORT`, `gl.UNSIGNED_BYTE`, `gl.UNSIGNED_SHORT` or `gl.FLOAT`.\n * @property {number} offset - The offset, in bytes, of this attribute data in the vertex array. Equivalent to `offsetof(vertex, attrib)` in C.\n * @property {boolean} normalized - Should the attribute data be normalized?\n * @property {boolean} enabled - You should set this to `false` by default. The pipeline will enable it on boot.\n * @property {number} location - You should set this to `-1` by default. The pipeline will set it on boot.\n */", "meta": { "filename": "WebGLPipelineAttribute.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\typedefs", "code": {} }, "kind": "typedef", "name": "WebGLPipelineAttribute", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the attribute as defined in the vertex shader.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of components in the attribute, i.e. 1 for a float, 2 for a vec2, 3 for a vec3, etc.", "name": "size" }, { "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "description": "The data type of the attribute. Either `gl.BYTE`, `gl.SHORT`, `gl.UNSIGNED_BYTE`, `gl.UNSIGNED_SHORT` or `gl.FLOAT`.", "name": "type" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The offset, in bytes, of this attribute data in the vertex array. Equivalent to `offsetof(vertex, attrib)` in C.", "name": "offset" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should the attribute data be normalized?", "name": "normalized" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "You should set this to `false` by default. The pipeline will enable it on boot.", "name": "enabled" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "You should set this to `-1` by default. The pipeline will set it on boot.", "name": "location" } ], "memberof": "Phaser.Types.Renderer.WebGL", "longname": "Phaser.Types.Renderer.WebGL.WebGLPipelineAttribute", "scope": "static", "___id": "T000002R034495", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Renderer.WebGL.WebGLPipelineAttributeConfig\r\n * @since 3.50.0\r\n *\r\n * @property {string} name - The name of the attribute as defined in the vertex shader.\r\n * @property {number} size - The number of components in the attribute, i.e. 1 for a float, 2 for a vec2, 3 for a vec3, etc.\r\n * @property {Phaser.Types.Renderer.WebGL.WebGLConst} type - The data type of the attribute, one of the `WEBGL_CONST` values, i.e. `WEBGL_CONST.FLOAT`, `WEBGL_CONST.UNSIGNED_BYTE`, etc.\r\n * @property {boolean} [normalized=false] - Should the attribute data be normalized?\r\n */", "meta": { "filename": "WebGLPipelineAttributeConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\typedefs", "code": {} }, "kind": "typedef", "name": "WebGLPipelineAttributeConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the attribute as defined in the vertex shader.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of components in the attribute, i.e. 1 for a float, 2 for a vec2, 3 for a vec3, etc.", "name": "size" }, { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLConst" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLConst" } }, "description": "The data type of the attribute, one of the `WEBGL_CONST` values, i.e. `WEBGL_CONST.FLOAT`, `WEBGL_CONST.UNSIGNED_BYTE`, etc.", "name": "type" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the attribute data be normalized?", "name": "normalized" } ], "memberof": "Phaser.Types.Renderer.WebGL", "longname": "Phaser.Types.Renderer.WebGL.WebGLPipelineAttributeConfig", "scope": "static", "___id": "T000002R034496", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry\r\n * @since 3.60.0\r\n *\r\n * @property {number} start - The vertext count this batch entry starts from.\r\n * @property {number} count - The total number of vertices in this batch entry.\r\n * @property {number} unit - The current texture unit of the batch entry.\r\n * @property {number} maxUnit - The maximum number of texture units in this batch entry.\r\n * @property {WebGLTexture[]} texture - An array of WebGLTexture references used in this batch entry.\r\n */", "meta": { "filename": "WebGLPipelineBatchEntry.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\typedefs", "code": {} }, "kind": "typedef", "name": "WebGLPipelineBatchEntry", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertext count this batch entry starts from.", "name": "start" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total number of vertices in this batch entry.", "name": "count" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current texture unit of the batch entry.", "name": "unit" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum number of texture units in this batch entry.", "name": "maxUnit" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "description": "An array of WebGLTexture references used in this batch entry.", "name": "texture" } ], "memberof": "Phaser.Types.Renderer.WebGL", "longname": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "scope": "static", "___id": "T000002R034497", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Renderer.WebGL.WebGLPipelineConfig\r\n * @since 3.50.0\r\n *\r\n * @property {Phaser.Game} game - The Phaser.Game instance that owns this pipeline.\r\n * @property {string} [name] - The name of the pipeline.\r\n * @property {GLenum} [topology=gl.TRIANGLES] - How the primitives are rendered. The default value is GL_TRIANGLES. Here is the full list of rendering primitives: (https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Constants).\r\n * @property {string} [vertShader] - The source code, as a string, for the vertex shader. If you need to assign multiple shaders, see the `shaders` property.\r\n * @property {string} [fragShader] - The source code, as a string, for the fragment shader. Can include `%count%` and `%forloop%` declarations for multi-texture support. If you need to assign multiple shaders, see the `shaders` property.\r\n * @property {number} [batchSize] - The number of quads to hold in the batch. Defaults to `RenderConfig.batchSize`. This amount * 6 gives the vertex capacity.\r\n * @property {number} [vertexSize] - The size, in bytes, of a single entry in the vertex buffer. Defaults to Float32Array.BYTES_PER_ELEMENT * 6 + Uint8Array.BYTES_PER_ELEMENT * 4.\r\n * @property {(number[]|Float32Array)} [vertices] - An optional Array or Typed Array of pre-calculated vertices data that is copied into the vertex data.\r\n * @property {Phaser.Types.Renderer.WebGL.WebGLPipelineAttributeConfig[]} [attributes] - An array of shader attribute data. All shaders bound to this pipeline must use the same attributes.\r\n * @property {Phaser.Types.Renderer.WebGL.WebGLPipelineShaderConfig[]} [shaders] - An array of shaders, all of which are created for this one pipeline. Uses the `vertShader`, `fragShader`, `attributes` and `uniforms` properties of this object as defaults.\r\n * @property {boolean} [forceZero=false] - Force the shader to use just a single sampler2d? Set for anything that extends the Single Pipeline.\r\n * @property {(boolean|number|Phaser.Types.Renderer.WebGL.RenderTargetConfig[])} [renderTarget] - Create Render Targets for this pipeline. Can be a number, which determines the quantity, a boolean (sets quantity to 1), or an array of Render Target configuration objects.\r\n */", "meta": { "filename": "WebGLPipelineConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\typedefs", "code": {} }, "kind": "typedef", "name": "WebGLPipelineConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "The Phaser.Game instance that owns this pipeline.", "name": "game" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The name of the pipeline.", "name": "name" }, { "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "optional": true, "defaultvalue": "gl.TRIANGLES", "description": "How the primitives are rendered. The default value is GL_TRIANGLES. Here is the full list of rendering primitives: (https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Constants).", "name": "topology" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The source code, as a string, for the vertex shader. If you need to assign multiple shaders, see the `shaders` property.", "name": "vertShader" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The source code, as a string, for the fragment shader. Can include `%count%` and `%forloop%` declarations for multi-texture support. If you need to assign multiple shaders, see the `shaders` property.", "name": "fragShader" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The number of quads to hold in the batch. Defaults to `RenderConfig.batchSize`. This amount * 6 gives the vertex capacity.", "name": "batchSize" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The size, in bytes, of a single entry in the vertex buffer. Defaults to Float32Array.BYTES_PER_ELEMENT * 6 + Uint8Array.BYTES_PER_ELEMENT * 4.", "name": "vertexSize" }, { "type": { "names": [ "Array.", "Float32Array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Float32Array" } ] } }, "optional": true, "description": "An optional Array or Typed Array of pre-calculated vertices data that is copied into the vertex data.", "name": "vertices" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineAttributeConfig", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of shader attribute data. All shaders bound to this pipeline must use the same attributes.", "name": "attributes" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineShaderConfig", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of shaders, all of which are created for this one pipeline. Uses the `vertShader`, `fragShader`, `attributes` and `uniforms` properties of this object as defaults.", "name": "shaders" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Force the shader to use just a single sampler2d? Set for anything that extends the Single Pipeline.", "name": "forceZero" }, { "type": { "names": [ "boolean", "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.RenderTargetConfig", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "Create Render Targets for this pipeline. Can be a number, which determines the quantity, a boolean (sets quantity to 1), or an array of Render Target configuration objects.", "name": "renderTarget" } ], "memberof": "Phaser.Types.Renderer.WebGL", "longname": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig", "scope": "static", "___id": "T000002R034498", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Renderer.WebGL.WebGLPipelineShaderConfig\r\n * @since 3.50.0\r\n *\r\n * @property {string} [name] - The name of the shader. Doesn't have to be unique, but makes shader look-up easier if it is.\r\n * @property {string} [vertShader] - The source code, as a string, for the vertex shader. If not given, uses the `Phaser.Types.Renderer.WebGL.WebGLPipelineConfig.vertShader` property instead.\r\n * @property {string} [fragShader] - The source code, as a string, for the fragment shader. Can include `%count%` and `%forloop%` declarations for multi-texture support. If not given, uses the `Phaser.Types.Renderer.WebGL.WebGLPipelineConfig.fragShader` property instead.\r\n * @property {Phaser.Types.Renderer.WebGL.WebGLPipelineAttributeConfig[]} [attributes] - An array of shader attribute data. All shaders bound to this pipeline must use the same attributes.\r\n */", "meta": { "filename": "WebGLPipelineShaderConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\typedefs", "code": {} }, "kind": "typedef", "name": "WebGLPipelineShaderConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The name of the shader. Doesn't have to be unique, but makes shader look-up easier if it is.", "name": "name" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The source code, as a string, for the vertex shader. If not given, uses the `Phaser.Types.Renderer.WebGL.WebGLPipelineConfig.vertShader` property instead.", "name": "vertShader" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The source code, as a string, for the fragment shader. Can include `%count%` and `%forloop%` declarations for multi-texture support. If not given, uses the `Phaser.Types.Renderer.WebGL.WebGLPipelineConfig.fragShader` property instead.", "name": "fragShader" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineAttributeConfig", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of shader attribute data. All shaders bound to this pipeline must use the same attributes.", "name": "attributes" } ], "memberof": "Phaser.Types.Renderer.WebGL", "longname": "Phaser.Types.Renderer.WebGL.WebGLPipelineShaderConfig", "scope": "static", "___id": "T000002R034499", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Renderer.WebGL.WebGLPipelineUniformsConfig\r\n * @since 3.55.1\r\n *\r\n * @property {string} name - The name of the uniform as defined in the shader.\r\n * @property {number} location - The location of the uniform.\r\n * @property {number} [value1] - The first cached value of the uniform.\r\n * @property {number} [value2] - The first cached value of the uniform.\r\n * @property {number} [value3] - The first cached value of the uniform.\r\n * @property {number} [value4] - The first cached value of the uniform.\r\n */", "meta": { "filename": "WebGLPipelineUniformsConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\typedefs", "code": {} }, "kind": "typedef", "name": "WebGLPipelineUniformsConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.55.1", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform as defined in the shader.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The location of the uniform.", "name": "location" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The first cached value of the uniform.", "name": "value1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The first cached value of the uniform.", "name": "value2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The first cached value of the uniform.", "name": "value3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The first cached value of the uniform.", "name": "value4" } ], "memberof": "Phaser.Types.Renderer.WebGL", "longname": "Phaser.Types.Renderer.WebGL.WebGLPipelineUniformsConfig", "scope": "static", "___id": "T000002R034500", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Renderer.WebGL.WebGLTextureCompression\r\n * @since 3.55.0\r\n *\r\n * @property {object|undefined} ASTC - Indicates if ASTC compression is supported (mostly iOS).\r\n * @property {object|undefined} ATC - Indicates if ATC compression is supported.\r\n * @property {object|undefined} BPTC - Indicates if BPTC compression is supported.\r\n * @property {object|undefined} ETC - Indicates if ETC compression is supported (mostly Android).\r\n * @property {object|undefined} ETC1 - Indicates if ETC1 compression is supported (mostly Android).\r\n * @property {object|undefined} IMG - Indicates the browser supports true color images (all browsers).\r\n * @property {object|undefined} PVRTC - Indicates if PVRTC compression is supported (mostly iOS).\r\n * @property {object|undefined} RGTC - Indicates if RGTC compression is supported (mostly iOS).\r\n * @property {object|undefined} S3TC - Indicates if S3TC compression is supported on current device (mostly Windows).\r\n * @property {object|undefined} S3TCRGB - Indicates if S3TCRGB compression is supported on current device (mostly Windows).\r\n */", "meta": { "filename": "WebGLTextureCompression.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\typedefs", "code": {} }, "kind": "typedef", "name": "WebGLTextureCompression", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.55.0", "properties": [ { "type": { "names": [ "object", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "UndefinedLiteral" } ] } }, "description": "Indicates if ASTC compression is supported (mostly iOS).", "name": "ASTC" }, { "type": { "names": [ "object", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "UndefinedLiteral" } ] } }, "description": "Indicates if ATC compression is supported.", "name": "ATC" }, { "type": { "names": [ "object", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "UndefinedLiteral" } ] } }, "description": "Indicates if BPTC compression is supported.", "name": "BPTC" }, { "type": { "names": [ "object", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "UndefinedLiteral" } ] } }, "description": "Indicates if ETC compression is supported (mostly Android).", "name": "ETC" }, { "type": { "names": [ "object", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "UndefinedLiteral" } ] } }, "description": "Indicates if ETC1 compression is supported (mostly Android).", "name": "ETC1" }, { "type": { "names": [ "object", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "UndefinedLiteral" } ] } }, "description": "Indicates the browser supports true color images (all browsers).", "name": "IMG" }, { "type": { "names": [ "object", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "UndefinedLiteral" } ] } }, "description": "Indicates if PVRTC compression is supported (mostly iOS).", "name": "PVRTC" }, { "type": { "names": [ "object", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "UndefinedLiteral" } ] } }, "description": "Indicates if RGTC compression is supported (mostly iOS).", "name": "RGTC" }, { "type": { "names": [ "object", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "UndefinedLiteral" } ] } }, "description": "Indicates if S3TC compression is supported on current device (mostly Windows).", "name": "S3TC" }, { "type": { "names": [ "object", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "UndefinedLiteral" } ] } }, "description": "Indicates if S3TCRGB compression is supported on current device (mostly Windows).", "name": "S3TCRGB" } ], "memberof": "Phaser.Types.Renderer.WebGL", "longname": "Phaser.Types.Renderer.WebGL.WebGLTextureCompression", "scope": "static", "___id": "T000002R034501", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Renderer.WebGL.Utils\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Utils.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "kind": "namespace", "name": "Utils", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL", "longname": "Phaser.Renderer.WebGL.Utils", "scope": "static", "___id": "T000002R034502", "___s": true }, { "comment": "/**\r\n * Packs four floats on a range from 0.0 to 1.0 into a single Uint32\r\n *\r\n * @function Phaser.Renderer.WebGL.Utils.getTintFromFloats\r\n * @since 3.0.0\r\n *\r\n * @param {number} r - Red component in a range from 0.0 to 1.0\r\n * @param {number} g - Green component in a range from 0.0 to 1.0\r\n * @param {number} b - Blue component in a range from 0.0 to 1.0\r\n * @param {number} a - Alpha component in a range from 0.0 to 1.0\r\n *\r\n * @return {number} The packed RGBA values as a Uint32.\r\n */", "meta": { "filename": "Utils.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Packs four floats on a range from 0.0 to 1.0 into a single Uint32", "kind": "function", "name": "getTintFromFloats", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Red component in a range from 0.0 to 1.0", "name": "r" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Green component in a range from 0.0 to 1.0", "name": "g" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Blue component in a range from 0.0 to 1.0", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha component in a range from 0.0 to 1.0", "name": "a" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The packed RGBA values as a Uint32." } ], "memberof": "Phaser.Renderer.WebGL.Utils", "longname": "Phaser.Renderer.WebGL.Utils.getTintFromFloats", "scope": "static", "___id": "T000002R034504", "___s": true }, { "comment": "/**\r\n * Packs a Uint24, representing RGB components, with a Float32, representing\r\n * the alpha component, with a range between 0.0 and 1.0 and return a Uint32\r\n *\r\n * @function Phaser.Renderer.WebGL.Utils.getTintAppendFloatAlpha\r\n * @since 3.0.0\r\n *\r\n * @param {number} rgb - Uint24 representing RGB components\r\n * @param {number} a - Float32 representing Alpha component\r\n *\r\n * @return {number} Packed RGBA as Uint32\r\n */", "meta": { "filename": "Utils.js", "lineno": 38, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Packs a Uint24, representing RGB components, with a Float32, representing\rthe alpha component, with a range between 0.0 and 1.0 and return a Uint32", "kind": "function", "name": "getTintAppendFloatAlpha", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Uint24 representing RGB components", "name": "rgb" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Float32 representing Alpha component", "name": "a" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Packed RGBA as Uint32" } ], "memberof": "Phaser.Renderer.WebGL.Utils", "longname": "Phaser.Renderer.WebGL.Utils.getTintAppendFloatAlpha", "scope": "static", "___id": "T000002R034510", "___s": true }, { "comment": "/**\r\n * Packs a Uint24, representing RGB components, with a Float32, representing\r\n * the alpha component, with a range between 0.0 and 1.0 and return a\r\n * swizzled Uint32\r\n *\r\n * @function Phaser.Renderer.WebGL.Utils.getTintAppendFloatAlphaAndSwap\r\n * @since 3.0.0\r\n *\r\n * @param {number} rgb - Uint24 representing RGB components\r\n * @param {number} a - Float32 representing Alpha component\r\n *\r\n * @return {number} Packed RGBA as Uint32\r\n */", "meta": { "filename": "Utils.js", "lineno": 57, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Packs a Uint24, representing RGB components, with a Float32, representing\rthe alpha component, with a range between 0.0 and 1.0 and return a\rswizzled Uint32", "kind": "function", "name": "getTintAppendFloatAlphaAndSwap", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Uint24 representing RGB components", "name": "rgb" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Float32 representing Alpha component", "name": "a" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Packed RGBA as Uint32" } ], "memberof": "Phaser.Renderer.WebGL.Utils", "longname": "Phaser.Renderer.WebGL.Utils.getTintAppendFloatAlphaAndSwap", "scope": "static", "___id": "T000002R034513", "___s": true }, { "comment": "/**\r\n * Unpacks a Uint24 RGB into an array of floats of ranges of 0.0 and 1.0\r\n *\r\n * @function Phaser.Renderer.WebGL.Utils.getFloatsFromUintRGB\r\n * @since 3.0.0\r\n *\r\n * @param {number} rgb - RGB packed as a Uint24\r\n *\r\n * @return {array} Array of floats representing each component as a float\r\n */", "meta": { "filename": "Utils.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Unpacks a Uint24 RGB into an array of floats of ranges of 0.0 and 1.0", "kind": "function", "name": "getFloatsFromUintRGB", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "RGB packed as a Uint24", "name": "rgb" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "Array of floats representing each component as a float" } ], "memberof": "Phaser.Renderer.WebGL.Utils", "longname": "Phaser.Renderer.WebGL.Utils.getFloatsFromUintRGB", "scope": "static", "___id": "T000002R034519", "___s": true }, { "comment": "/**\r\n * Check to see how many texture units the GPU supports in a fragment shader\r\n * and if the value specific in the game config is allowed.\r\n *\r\n * This value is hard-clamped to 16 for performance reasons on Android devices.\r\n *\r\n * @function Phaser.Renderer.WebGL.Utils.checkShaderMax\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLRenderingContext} gl - The WebGLContext used to create the shaders.\r\n * @param {number} maxTextures - The Game Config maxTextures value.\r\n *\r\n * @return {number} The number of texture units that is supported by this browser and GPU.\r\n */", "meta": { "filename": "Utils.js", "lineno": 99, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Check to see how many texture units the GPU supports in a fragment shader\rand if the value specific in the game config is allowed.\r\rThis value is hard-clamped to 16 for performance reasons on Android devices.", "kind": "function", "name": "checkShaderMax", "since": "3.50.0", "params": [ { "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "description": "The WebGLContext used to create the shaders.", "name": "gl" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Game Config maxTextures value.", "name": "maxTextures" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of texture units that is supported by this browser and GPU." } ], "memberof": "Phaser.Renderer.WebGL.Utils", "longname": "Phaser.Renderer.WebGL.Utils.checkShaderMax", "scope": "static", "___id": "T000002R034524", "___s": true }, { "comment": "/**\r\n * Checks the given Fragment Shader Source for `%count%` and `%forloop%` declarations and\r\n * replaces those with GLSL code for setting `texture = texture2D(uMainSampler[i], outTexCoord)`.\r\n *\r\n * @function Phaser.Renderer.WebGL.Utils.parseFragmentShaderMaxTextures\r\n * @since 3.50.0\r\n *\r\n * @param {string} fragmentShaderSource - The Fragment Shader source code to operate on.\r\n * @param {number} maxTextures - The number of maxTextures value.\r\n *\r\n * @return {string} The modified Fragment Shader source.\r\n */", "meta": { "filename": "Utils.js", "lineno": 131, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Checks the given Fragment Shader Source for `%count%` and `%forloop%` declarations and\rreplaces those with GLSL code for setting `texture = texture2D(uMainSampler[i], outTexCoord)`.", "kind": "function", "name": "parseFragmentShaderMaxTextures", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The Fragment Shader source code to operate on.", "name": "fragmentShaderSource" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of maxTextures value.", "name": "maxTextures" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The modified Fragment Shader source." } ], "memberof": "Phaser.Renderer.WebGL.Utils", "longname": "Phaser.Renderer.WebGL.Utils.parseFragmentShaderMaxTextures", "scope": "static", "___id": "T000002R034527", "___s": true }, { "comment": "/**\r\n * Takes the Glow FX Shader source and parses out the __SIZE__ and __DIST__\r\n * consts with the configuration values.\r\n *\r\n * @function Phaser.Renderer.WebGL.Utils.setGlowQuality\r\n * @since 3.60.0\r\n *\r\n * @param {string} shader - The Fragment Shader source code to operate on.\r\n * @param {Phaser.Game} game - The Phaser Game instance.\r\n * @param {number} [quality] - The quality of the glow (defaults to 0.1)\r\n * @param {number} [distance] - The distance of the glow (defaults to 10)\r\n *\r\n * @return {string} The modified Fragment Shader source.\r\n */", "meta": { "filename": "Utils.js", "lineno": 174, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Takes the Glow FX Shader source and parses out the __SIZE__ and __DIST__\rconsts with the configuration values.", "kind": "function", "name": "setGlowQuality", "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The Fragment Shader source code to operate on.", "name": "shader" }, { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "The Phaser Game instance.", "name": "game" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The quality of the glow (defaults to 0.1)", "name": "quality" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The distance of the glow (defaults to 10)", "name": "distance" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The modified Fragment Shader source." } ], "memberof": "Phaser.Renderer.WebGL.Utils", "longname": "Phaser.Renderer.WebGL.Utils.setGlowQuality", "scope": "static", "___id": "T000002R034537", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The `WebGLPipeline` is a base class used by all of the core Phaser pipelines.\r\n *\r\n * It describes the way elements will be rendered in WebGL. Internally, it handles\r\n * compiling the shaders, creating vertex buffers, assigning primitive topology and\r\n * binding vertex attributes, all based on the given configuration data.\r\n *\r\n * The pipeline is configured by passing in a `WebGLPipelineConfig` object. Please\r\n * see the documentation for this type to fully understand the configuration options\r\n * available to you.\r\n *\r\n * Usually, you would not extend from this class directly, but would instead extend\r\n * from one of the core pipelines, such as the Multi Pipeline.\r\n *\r\n * The pipeline flow per render-step is as follows:\r\n *\r\n * 1) onPreRender - called once at the start of the render step\r\n * 2) onRender - call for each Scene Camera that needs to render (so can be multiple times per render step)\r\n * 3) Internal flow:\r\n * 3a) bind (only called if a Game Object is using this pipeline and it's not currently active)\r\n * 3b) onBind (called for every Game Object that uses this pipeline)\r\n * 3c) flush (can be called by a Game Object, internal method or from outside by changing pipeline)\r\n * 4) onPostRender - called once at the end of the render step\r\n *\r\n * @class WebGLPipeline\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Renderer.WebGL\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 18, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "classdesc": "The `WebGLPipeline` is a base class used by all of the core Phaser pipelines.\r\rIt describes the way elements will be rendered in WebGL. Internally, it handles\rcompiling the shaders, creating vertex buffers, assigning primitive topology and\rbinding vertex attributes, all based on the given configuration data.\r\rThe pipeline is configured by passing in a `WebGLPipelineConfig` object. Please\rsee the documentation for this type to fully understand the configuration options\ravailable to you.\r\rUsually, you would not extend from this class directly, but would instead extend\rfrom one of the core pipelines, such as the Multi Pipeline.\r\rThe pipeline flow per render-step is as follows:\r\r1) onPreRender - called once at the start of the render step\r2) onRender - call for each Scene Camera that needs to render (so can be multiple times per render step)\r3) Internal flow:\r3a) bind (only called if a Game Object is using this pipeline and it's not currently active)\r3b) onBind (called for every Game Object that uses this pipeline)\r3c) flush (can be called by a Game Object, internal method or from outside by changing pipeline)\r4) onPostRender - called once at the end of the render step", "kind": "class", "name": "WebGLPipeline", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Renderer.WebGL", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "scope": "static", "longname": "Phaser.Renderer.WebGL.WebGLPipeline", "___id": "T000002R034553", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "name": "name", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#name", "scope": "instance", "kind": "member", "___id": "T000002R034560", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The Phaser Game instance to which this pipeline is bound.", "name": "game", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#game", "scope": "instance", "kind": "member", "___id": "T000002R034562", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The WebGL Renderer instance to which this pipeline is bound.", "name": "renderer", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "scope": "instance", "kind": "member", "___id": "T000002R034564", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "name": "manager", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "scope": "instance", "kind": "member", "___id": "T000002R034566", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The WebGL context this WebGL Pipeline uses.", "name": "gl", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "scope": "instance", "kind": "member", "___id": "T000002R034568", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The canvas which this WebGL Pipeline renders to.", "name": "view", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#view", "scope": "instance", "kind": "member", "___id": "T000002R034570", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Width of the current viewport.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#width", "scope": "instance", "kind": "member", "___id": "T000002R034572", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Height of the current viewport.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#height", "scope": "instance", "kind": "member", "___id": "T000002R034574", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The current number of vertices that have been added to the pipeline batch.", "name": "vertexCount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "scope": "instance", "kind": "member", "___id": "T000002R034576", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "name": "vertexCapacity", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "scope": "instance", "kind": "member", "___id": "T000002R034578", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "name": "vertexData", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "scope": "instance", "kind": "member", "___id": "T000002R034580", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "name": "vertexBuffer", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "scope": "instance", "kind": "member", "___id": "T000002R034582", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The currently active WebGLBuffer.", "name": "activeBuffer", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "scope": "instance", "kind": "member", "___id": "T000002R034584", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "name": "topology", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "scope": "instance", "kind": "member", "___id": "T000002R034586", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "name": "bytes", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "scope": "instance", "kind": "member", "___id": "T000002R034588", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Float32 view of the array buffer containing the pipeline's vertices.", "name": "vertexViewF32", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "scope": "instance", "kind": "member", "___id": "T000002R034590", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "name": "vertexViewU32", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "scope": "instance", "kind": "member", "___id": "T000002R034592", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "name": "active", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#active", "scope": "instance", "kind": "member", "___id": "T000002R034594", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "name": "forceZero", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "scope": "instance", "kind": "member", "___id": "T000002R034596", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "name": "hasBooted", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "scope": "instance", "kind": "member", "___id": "T000002R034598", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Indicates if this is a Post FX Pipeline, or not.", "name": "isPostFX", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "scope": "instance", "kind": "member", "___id": "T000002R034600", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Indicates if this is a Pre FX Pipeline, or not.", "name": "isPreFX", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "scope": "instance", "kind": "member", "___id": "T000002R034602", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "An array of RenderTarget instances that belong to this pipeline.", "name": "renderTargets", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "scope": "instance", "kind": "member", "___id": "T000002R034604", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "name": "currentRenderTarget", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "scope": "instance", "kind": "member", "___id": "T000002R034606", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "name": "shaders", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "scope": "instance", "kind": "member", "___id": "T000002R034608", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "name": "currentShader", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "scope": "instance", "kind": "member", "___id": "T000002R034610", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "name": "projectionMatrix", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "scope": "instance", "kind": "member", "___id": "T000002R034612", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The cached width of the Projection matrix.", "name": "projectionWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "scope": "instance", "kind": "member", "___id": "T000002R034614", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The cached height of the Projection matrix.", "name": "projectionHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "scope": "instance", "kind": "member", "___id": "T000002R034616", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "name": "config", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#config", "scope": "instance", "kind": "member", "___id": "T000002R034618", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "name": "glReset", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "scope": "instance", "kind": "member", "___id": "T000002R034620", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "name": "batch", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "scope": "instance", "kind": "member", "___id": "T000002R034622", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "name": "currentBatch", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "scope": "instance", "kind": "member", "___id": "T000002R034624", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "name": "currentTexture", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "scope": "instance", "kind": "member", "___id": "T000002R034626", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "name": "currentUnit", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "scope": "instance", "kind": "member", "___id": "T000002R034628", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "name": "activeTextures", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "scope": "instance", "kind": "member", "___id": "T000002R034630", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "kind": "function", "name": "boot", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "scope": "instance", "___id": "T000002R034632", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "kind": "function", "name": "onBoot", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "scope": "instance", "___id": "T000002R034668", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "kind": "function", "name": "onResize", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "scope": "instance", "___id": "T000002R034670", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the currently active shader within this pipeline.", "kind": "function", "name": "setShader", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "scope": "instance", "___id": "T000002R034672", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "kind": "function", "name": "getShaderByName", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "scope": "instance", "___id": "T000002R034678", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "kind": "function", "name": "setShadersFromConfig", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "scope": "instance", "___id": "T000002R034682", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "kind": "function", "name": "createBatch", "since": "3.60.0", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "scope": "instance", "___id": "T000002R034717", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "kind": "function", "name": "addTextureToBatch", "since": "3.60.0", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "scope": "instance", "___id": "T000002R034727", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "kind": "function", "name": "pushBatch", "since": "3.60.0", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "scope": "instance", "___id": "T000002R034730", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "kind": "function", "name": "setGameObject", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "scope": "instance", "___id": "T000002R034738", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "kind": "function", "name": "shouldFlush", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "scope": "instance", "___id": "T000002R034741", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "kind": "function", "name": "vertexAvailable", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "scope": "instance", "___id": "T000002R034744", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "kind": "function", "name": "resize", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "scope": "instance", "___id": "T000002R034746", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "kind": "function", "name": "setProjectionMatrix", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "scope": "instance", "___id": "T000002R034752", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "kind": "function", "name": "flipProjectionMatrix", "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "scope": "instance", "___id": "T000002R034761", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "kind": "function", "name": "updateProjectionMatrix", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "scope": "instance", "___id": "T000002R034767", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "kind": "function", "name": "bind", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "scope": "instance", "___id": "T000002R034771", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "kind": "function", "name": "rebind", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "scope": "instance", "___id": "T000002R034780", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "kind": "function", "name": "setVertexBuffer", "since": "3.50.0", "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "scope": "instance", "___id": "T000002R034789", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "kind": "function", "name": "preBatch", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "scope": "instance", "___id": "T000002R034794", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "kind": "function", "name": "postBatch", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "scope": "instance", "___id": "T000002R034796", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "kind": "function", "name": "onDraw", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "scope": "instance", "___id": "T000002R034798", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "kind": "function", "name": "unbind", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "scope": "instance", "___id": "T000002R034800", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "kind": "function", "name": "flush", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "scope": "instance", "___id": "T000002R034802", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "kind": "function", "name": "onActive", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "scope": "instance", "___id": "T000002R034828", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "kind": "function", "name": "onBind", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "scope": "instance", "___id": "T000002R034830", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "kind": "function", "name": "onRebind", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "scope": "instance", "___id": "T000002R034832", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "kind": "function", "name": "onBatch", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "scope": "instance", "___id": "T000002R034834", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "kind": "function", "name": "onPreBatch", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "scope": "instance", "___id": "T000002R034836", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "kind": "function", "name": "onPostBatch", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "scope": "instance", "___id": "T000002R034838", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "kind": "function", "name": "onPreRender", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "scope": "instance", "___id": "T000002R034840", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "kind": "function", "name": "onRender", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "scope": "instance", "___id": "T000002R034842", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "kind": "function", "name": "onPostRender", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "scope": "instance", "___id": "T000002R034844", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "kind": "function", "name": "onBeforeFlush", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "scope": "instance", "___id": "T000002R034846", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "kind": "function", "name": "onAfterFlush", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "scope": "instance", "___id": "T000002R034848", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "kind": "function", "name": "batchVert", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "scope": "instance", "___id": "T000002R034850", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "kind": "function", "name": "batchQuad", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "scope": "instance", "___id": "T000002R034863", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "kind": "function", "name": "batchTri", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "scope": "instance", "___id": "T000002R034916", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "kind": "function", "name": "drawFillRect", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "scope": "instance", "___id": "T000002R034948", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "kind": "function", "name": "setTexture2D", "since": "3.50.0", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "scope": "instance", "___id": "T000002R034964", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "kind": "function", "name": "bindTexture", "since": "3.50.0", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "scope": "instance", "___id": "T000002R034967", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "kind": "function", "name": "bindRenderTarget", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "scope": "instance", "___id": "T000002R034971", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "kind": "function", "name": "setTime", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "scope": "instance", "___id": "T000002R034973", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "setBoolean", "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "scope": "instance", "___id": "T000002R034975", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "set1f", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "scope": "instance", "___id": "T000002R034978", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "set2f", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "scope": "instance", "___id": "T000002R034981", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "set3f", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "scope": "instance", "___id": "T000002R034984", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "set4f", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "scope": "instance", "___id": "T000002R034987", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "set1fv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "scope": "instance", "___id": "T000002R034990", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "set2fv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "scope": "instance", "___id": "T000002R034993", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "set3fv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "scope": "instance", "___id": "T000002R034996", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "set4fv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "scope": "instance", "___id": "T000002R034999", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "set1iv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "scope": "instance", "___id": "T000002R035002", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "set2iv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "scope": "instance", "___id": "T000002R035005", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "set3iv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "scope": "instance", "___id": "T000002R035008", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "set4iv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "scope": "instance", "___id": "T000002R035011", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "set1i", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "scope": "instance", "___id": "T000002R035014", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "set2i", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "scope": "instance", "___id": "T000002R035017", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "set3i", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "scope": "instance", "___id": "T000002R035020", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "set4i", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "scope": "instance", "___id": "T000002R035023", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "setMatrix2fv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "scope": "instance", "___id": "T000002R035026", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "setMatrix3fv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "scope": "instance", "___id": "T000002R035029", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "kind": "function", "name": "setMatrix4fv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "scope": "instance", "___id": "T000002R035032", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#destroy\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#DESTROY\r\n * @since 3.0.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2551, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Destroys all shader instances, removes all object references and nulls all external references.", "kind": "function", "name": "destroy", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:DESTROY" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#destroy", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#destroy", "___id": "T000002R035035", "___s": true }, { "comment": "/**\r\n * @callback WebGLContextCallback\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - The WebGL Renderer which owns the context.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 32, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "kind": "typedef", "name": "WebGLContextCallback", "type": { "names": [ "function" ] }, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "description": "The WebGL Renderer which owns the context.", "name": "renderer" } ], "longname": "WebGLContextCallback", "scope": "global", "___id": "T000002R035077", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * WebGLRenderer is a class that contains the needed functionality to keep the\r\n * WebGLRenderingContext state clean. The main idea of the WebGLRenderer is to keep track of\r\n * any context change that happens for WebGL rendering inside of Phaser. This means\r\n * if raw webgl functions are called outside the WebGLRenderer of the Phaser WebGL\r\n * rendering ecosystem they might pollute the current WebGLRenderingContext state producing\r\n * unexpected behavior. It's recommended that WebGL interaction is done through\r\n * WebGLRenderer and/or WebGLPipeline.\r\n *\r\n * @class WebGLRenderer\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Renderer.WebGL\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - The Game instance which owns this WebGL Renderer.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 38, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "classdesc": "WebGLRenderer is a class that contains the needed functionality to keep the\rWebGLRenderingContext state clean. The main idea of the WebGLRenderer is to keep track of\rany context change that happens for WebGL rendering inside of Phaser. This means\rif raw webgl functions are called outside the WebGLRenderer of the Phaser WebGL\rrendering ecosystem they might pollute the current WebGLRenderingContext state producing\runexpected behavior. It's recommended that WebGL interaction is done through\rWebGLRenderer and/or WebGLPipeline.", "kind": "class", "name": "WebGLRenderer", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Renderer.WebGL", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "The Game instance which owns this WebGL Renderer.", "name": "game" } ], "scope": "static", "longname": "Phaser.Renderer.WebGL.WebGLRenderer", "___id": "T000002R035078", "___s": true }, { "comment": "/**\r\n * The local configuration settings of this WebGL Renderer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#config\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 81, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The local configuration settings of this WebGL Renderer.", "name": "config", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#config", "scope": "instance", "kind": "member", "___id": "T000002R035094", "___s": true }, { "comment": "/**\r\n * The Game instance which owns this WebGL Renderer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 101, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The Game instance which owns this WebGL Renderer.", "name": "game", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#game", "scope": "instance", "kind": "member", "___id": "T000002R035106", "___s": true }, { "comment": "/**\r\n * A constant which allows the renderer to be easily identified as a WebGL Renderer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#type\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A constant which allows the renderer to be easily identified as a WebGL Renderer.", "name": "type", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#type", "scope": "instance", "kind": "member", "___id": "T000002R035108", "___s": true }, { "comment": "/**\r\n * An instance of the Pipeline Manager class, that handles all WebGL Pipelines.\r\n *\r\n * Use this to manage all of your interactions with pipelines, such as adding, getting,\r\n * setting and rendering them.\r\n *\r\n * The Pipeline Manager class is created in the `init` method and then populated\r\n * with pipelines during the `boot` method.\r\n *\r\n * Prior to Phaser v3.50.0 this was just a plain JavaScript object, not a class.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#pipelines\r\n * @type {Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 119, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "An instance of the Pipeline Manager class, that handles all WebGL Pipelines.\r\rUse this to manage all of your interactions with pipelines, such as adding, getting,\rsetting and rendering them.\r\rThe Pipeline Manager class is created in the `init` method and then populated\rwith pipelines during the `boot` method.\r\rPrior to Phaser v3.50.0 this was just a plain JavaScript object, not a class.", "name": "pipelines", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#pipelines", "scope": "instance", "kind": "member", "___id": "T000002R035110", "___s": true }, { "comment": "/**\r\n * The width of the canvas being rendered to.\r\n * This is populated in the onResize event handler.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The width of the canvas being rendered to.\rThis is populated in the onResize event handler.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#width", "scope": "instance", "kind": "member", "___id": "T000002R035112", "___s": true }, { "comment": "/**\r\n * The height of the canvas being rendered to.\r\n * This is populated in the onResize event handler.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 146, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The height of the canvas being rendered to.\rThis is populated in the onResize event handler.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#height", "scope": "instance", "kind": "member", "___id": "T000002R035114", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Renderer draws to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#canvas\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 156, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The canvas which this WebGL Renderer draws to.", "name": "canvas", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#canvas", "scope": "instance", "kind": "member", "___id": "T000002R035116", "___s": true }, { "comment": "/**\r\n * An array of blend modes supported by the WebGL Renderer.\r\n *\r\n * This array includes the default blend modes as well as any custom blend modes added through {@link #addBlendMode}.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#blendModes\r\n * @type {array}\r\n * @default []\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "An array of blend modes supported by the WebGL Renderer.\r\rThis array includes the default blend modes as well as any custom blend modes added through {@link #addBlendMode}.", "name": "blendModes", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#blendModes", "scope": "instance", "kind": "member", "___id": "T000002R035118", "___s": true }, { "comment": "/**\r\n * This property is set to `true` if the WebGL context of the renderer is lost.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#contextLost\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 177, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This property is set to `true` if the WebGL context of the renderer is lost.", "name": "contextLost", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#contextLost", "scope": "instance", "kind": "member", "___id": "T000002R035120", "___s": true }, { "comment": "/**\r\n * Details about the currently scheduled snapshot.\r\n *\r\n * If a non-null `callback` is set in this object, a snapshot of the canvas will be taken after the current frame is fully rendered.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#snapshotState\r\n * @type {Phaser.Types.Renderer.Snapshot.SnapshotState}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Details about the currently scheduled snapshot.\r\rIf a non-null `callback` is set in this object, a snapshot of the canvas will be taken after the current frame is fully rendered.", "name": "snapshotState", "type": { "names": [ "Phaser.Types.Renderer.Snapshot.SnapshotState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.Snapshot.SnapshotState" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#snapshotState", "scope": "instance", "kind": "member", "___id": "T000002R035122", "___s": true }, { "comment": "/**\r\n * The maximum number of textures the GPU can handle. The minimum under the WebGL1 spec is 8.\r\n * This is set via the Game Config `maxTextures` property and should never be changed after boot.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#maxTextures\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 210, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The maximum number of textures the GPU can handle. The minimum under the WebGL1 spec is 8.\rThis is set via the Game Config `maxTextures` property and should never be changed after boot.", "name": "maxTextures", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#maxTextures", "scope": "instance", "kind": "member", "___id": "T000002R035135", "___s": true }, { "comment": "/**\r\n * An array of the available WebGL texture units, used to populate the uSampler uniforms.\r\n *\r\n * This array is populated during the init phase and should never be changed after boot.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#textureIndexes\r\n * @type {array}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 220, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "An array of the available WebGL texture units, used to populate the uSampler uniforms.\r\rThis array is populated during the init phase and should never be changed after boot.", "name": "textureIndexes", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#textureIndexes", "scope": "instance", "kind": "member", "___id": "T000002R035137", "___s": true }, { "comment": "/**\r\n * The currently bound framebuffer in use.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#currentFramebuffer\r\n * @type {WebGLFramebuffer}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 231, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The currently bound framebuffer in use.", "name": "currentFramebuffer", "type": { "names": [ "WebGLFramebuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLFramebuffer" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#currentFramebuffer", "scope": "instance", "kind": "member", "___id": "T000002R035139", "___s": true }, { "comment": "/**\r\n * A stack into which the frame buffer objects are pushed and popped.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#fboStack\r\n * @type {WebGLFramebuffer[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 241, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A stack into which the frame buffer objects are pushed and popped.", "name": "fboStack", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLFramebuffer", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#fboStack", "scope": "instance", "kind": "member", "___id": "T000002R035141", "___s": true }, { "comment": "/**\r\n * Current WebGLProgram in use.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#currentProgram\r\n * @type {WebGLProgram}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 250, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Current WebGLProgram in use.", "name": "currentProgram", "type": { "names": [ "WebGLProgram" ], "parsedType": { "type": "NameExpression", "name": "WebGLProgram" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#currentProgram", "scope": "instance", "kind": "member", "___id": "T000002R035143", "___s": true }, { "comment": "/**\r\n * Current blend mode in use\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#currentBlendMode\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 260, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Current blend mode in use", "name": "currentBlendMode", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#currentBlendMode", "scope": "instance", "kind": "member", "___id": "T000002R035145", "___s": true }, { "comment": "/**\r\n * Indicates if the the scissor state is enabled in WebGLRenderingContext\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#currentScissorEnabled\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Indicates if the the scissor state is enabled in WebGLRenderingContext", "name": "currentScissorEnabled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#currentScissorEnabled", "scope": "instance", "kind": "member", "___id": "T000002R035147", "___s": true }, { "comment": "/**\r\n * Stores the current scissor data\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#currentScissor\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Stores the current scissor data", "name": "currentScissor", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#currentScissor", "scope": "instance", "kind": "member", "___id": "T000002R035149", "___s": true }, { "comment": "/**\r\n * Stack of scissor data\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#scissorStack\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 288, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Stack of scissor data", "name": "scissorStack", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#scissorStack", "scope": "instance", "kind": "member", "___id": "T000002R035151", "___s": true }, { "comment": "/**\r\n * The handler to invoke when the context is lost.\r\n * This should not be changed and is set in the boot method.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#contextLostHandler\r\n * @type {function}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 297, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The handler to invoke when the context is lost.\rThis should not be changed and is set in the boot method.", "name": "contextLostHandler", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.19.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#contextLostHandler", "scope": "instance", "kind": "member", "___id": "T000002R035153", "___s": true }, { "comment": "/**\r\n * The handler to invoke when the context is restored.\r\n * This should not be changed and is set in the boot method.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#contextRestoredHandler\r\n * @type {function}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The handler to invoke when the context is restored.\rThis should not be changed and is set in the boot method.", "name": "contextRestoredHandler", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.19.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#contextRestoredHandler", "scope": "instance", "kind": "member", "___id": "T000002R035155", "___s": true }, { "comment": "/**\r\n * The underlying WebGL context of the renderer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#gl\r\n * @type {WebGLRenderingContext}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 317, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The underlying WebGL context of the renderer.", "name": "gl", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#gl", "scope": "instance", "kind": "member", "___id": "T000002R035157", "___s": true }, { "comment": "/**\r\n * Array of strings that indicate which WebGL extensions are supported by the browser.\r\n * This is populated in the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#supportedExtensions\r\n * @type {string[]}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 327, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Array of strings that indicate which WebGL extensions are supported by the browser.\rThis is populated in the `boot` method.", "name": "supportedExtensions", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#supportedExtensions", "scope": "instance", "kind": "member", "___id": "T000002R035159", "___s": true }, { "comment": "/**\r\n * If the browser supports the `ANGLE_instanced_arrays` extension, this property will hold\r\n * a reference to the glExtension for it.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#instancedArraysExtension\r\n * @type {ANGLE_instanced_arrays}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 338, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "If the browser supports the `ANGLE_instanced_arrays` extension, this property will hold\ra reference to the glExtension for it.", "name": "instancedArraysExtension", "type": { "names": [ "ANGLE_instanced_arrays" ], "parsedType": { "type": "NameExpression", "name": "ANGLE_instanced_arrays" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#instancedArraysExtension", "scope": "instance", "kind": "member", "___id": "T000002R035161", "___s": true }, { "comment": "/**\r\n * If the browser supports the `OES_vertex_array_object` extension, this property will hold\r\n * a reference to the glExtension for it.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#vaoExtension\r\n * @type {OES_vertex_array_object}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 349, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "If the browser supports the `OES_vertex_array_object` extension, this property will hold\ra reference to the glExtension for it.", "name": "vaoExtension", "type": { "names": [ "OES_vertex_array_object" ], "parsedType": { "type": "NameExpression", "name": "OES_vertex_array_object" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#vaoExtension", "scope": "instance", "kind": "member", "___id": "T000002R035163", "___s": true }, { "comment": "/**\r\n * The WebGL Extensions loaded into the current context.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#extensions\r\n * @type {object}\r\n * @default {}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 360, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The WebGL Extensions loaded into the current context.", "name": "extensions", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "defaultvalue": "{}", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#extensions", "scope": "instance", "kind": "member", "___id": "T000002R035165", "___s": true }, { "comment": "/**\r\n * Stores the current WebGL component formats for further use.\r\n *\r\n * This array is populated in the `init` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#glFormats\r\n * @type {array}\r\n * @since 3.2.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 370, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Stores the current WebGL component formats for further use.\r\rThis array is populated in the `init` method.", "name": "glFormats", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.2.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#glFormats", "scope": "instance", "kind": "member", "___id": "T000002R035167", "___s": true }, { "comment": "/**\r\n * Stores the WebGL texture compression formats that this device and browser supports.\r\n *\r\n * Support for using compressed texture formats was added in Phaser version 3.60.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#compression\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLTextureCompression}\r\n * @since 3.8.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 381, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Stores the WebGL texture compression formats that this device and browser supports.\r\rSupport for using compressed texture formats was added in Phaser version 3.60.", "name": "compression", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLTextureCompression" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLTextureCompression" } }, "since": "3.8.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#compression", "scope": "instance", "kind": "member", "___id": "T000002R035169", "___s": true }, { "comment": "/**\r\n * Cached drawing buffer height to reduce gl calls.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#drawingBufferHeight\r\n * @type {number}\r\n * @readonly\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 392, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Cached drawing buffer height to reduce gl calls.", "name": "drawingBufferHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#drawingBufferHeight", "scope": "instance", "kind": "member", "___id": "T000002R035171", "___s": true }, { "comment": "/**\r\n * A blank 32x32 transparent texture, as used by the Graphics system where needed.\r\n * This is set in the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#blankTexture\r\n * @type {WebGLTexture}\r\n * @readonly\r\n * @since 3.12.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 402, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A blank 32x32 transparent texture, as used by the Graphics system where needed.\rThis is set in the `boot` method.", "name": "blankTexture", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "readonly": true, "since": "3.12.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#blankTexture", "scope": "instance", "kind": "member", "___id": "T000002R035173", "___s": true }, { "comment": "/**\r\n * A pure white 4x4 texture, as used by the Graphics system where needed.\r\n * This is set in the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#whiteTexture\r\n * @type {WebGLTexture}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 413, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A pure white 4x4 texture, as used by the Graphics system where needed.\rThis is set in the `boot` method.", "name": "whiteTexture", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#whiteTexture", "scope": "instance", "kind": "member", "___id": "T000002R035175", "___s": true }, { "comment": "/**\r\n * The total number of masks currently stacked.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#maskCount\r\n * @type {number}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 424, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The total number of masks currently stacked.", "name": "maskCount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.17.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#maskCount", "scope": "instance", "kind": "member", "___id": "T000002R035177", "___s": true }, { "comment": "/**\r\n * The mask stack.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#maskStack\r\n * @type {Phaser.Display.Masks.GeometryMask[]}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 433, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The mask stack.", "name": "maskStack", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Display.Masks.GeometryMask", "type": "NameExpression" } ] } }, "since": "3.17.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#maskStack", "scope": "instance", "kind": "member", "___id": "T000002R035179", "___s": true }, { "comment": "/**\r\n * Internal property that tracks the currently set mask.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#currentMask\r\n * @type {any}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 442, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Internal property that tracks the currently set mask.", "name": "currentMask", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.17.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#currentMask", "scope": "instance", "kind": "member", "___id": "T000002R035181", "___s": true }, { "comment": "/**\r\n * Internal property that tracks the currently set camera mask.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#currentCameraMask\r\n * @type {any}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 451, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Internal property that tracks the currently set camera mask.", "name": "currentCameraMask", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.17.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#currentCameraMask", "scope": "instance", "kind": "member", "___id": "T000002R035185", "___s": true }, { "comment": "/**\r\n * Internal gl function mapping for uniform look-up.\r\n * https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/uniform\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#glFuncMap\r\n * @type {any}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 460, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Internal gl function mapping for uniform look-up.\rhttps://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/uniform", "name": "glFuncMap", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.17.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#glFuncMap", "scope": "instance", "kind": "member", "___id": "T000002R035189", "___s": true }, { "comment": "/**\r\n * The `type` of the Game Object being currently rendered.\r\n * This can be used by advanced render functions for batching look-ahead.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#currentType\r\n * @type {string}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 470, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The `type` of the Game Object being currently rendered.\rThis can be used by advanced render functions for batching look-ahead.", "name": "currentType", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.19.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#currentType", "scope": "instance", "kind": "member", "___id": "T000002R035191", "___s": true }, { "comment": "/**\r\n * Is the `type` of the Game Object being currently rendered different than the\r\n * type of the object before it in the display list? I.e. it's a 'new' type.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#newType\r\n * @type {boolean}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 480, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Is the `type` of the Game Object being currently rendered different than the\rtype of the object before it in the display list? I.e. it's a 'new' type.", "name": "newType", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.19.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#newType", "scope": "instance", "kind": "member", "___id": "T000002R035193", "___s": true }, { "comment": "/**\r\n * Does the `type` of the next Game Object in the display list match that\r\n * of the object being currently rendered?\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#nextTypeMatch\r\n * @type {boolean}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 490, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Does the `type` of the next Game Object in the display list match that\rof the object being currently rendered?", "name": "nextTypeMatch", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.19.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#nextTypeMatch", "scope": "instance", "kind": "member", "___id": "T000002R035195", "___s": true }, { "comment": "/**\r\n * Is the Game Object being currently rendered the final one in the list?\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#finalType\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 500, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Is the Game Object being currently rendered the final one in the list?", "name": "finalType", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#finalType", "scope": "instance", "kind": "member", "___id": "T000002R035197", "___s": true }, { "comment": "/**\r\n * The mipmap magFilter to be used when creating textures.\r\n *\r\n * You can specify this as a string in the game config, i.e.:\r\n *\r\n * `render: { mipmapFilter: 'NEAREST_MIPMAP_LINEAR' }`\r\n *\r\n * The 6 options for WebGL1 are, in order from least to most computationally expensive:\r\n *\r\n * NEAREST (for pixel art)\r\n * LINEAR (the default)\r\n * NEAREST_MIPMAP_NEAREST\r\n * LINEAR_MIPMAP_NEAREST\r\n * NEAREST_MIPMAP_LINEAR\r\n * LINEAR_MIPMAP_LINEAR\r\n *\r\n * Mipmaps only work with textures that are fully power-of-two in size.\r\n *\r\n * For more details see https://webglfundamentals.org/webgl/lessons/webgl-3d-textures.html\r\n *\r\n * As of v3.60 no mipmaps will be generated unless a string is given in\r\n * the game config. This saves on VRAM use when it may not be required.\r\n * To obtain the previous result set the property to `LINEAR` in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#mipmapFilter\r\n * @type {GLenum}\r\n * @since 3.21.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 509, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The mipmap magFilter to be used when creating textures.\r\rYou can specify this as a string in the game config, i.e.:\r\r`render: { mipmapFilter: 'NEAREST_MIPMAP_LINEAR' }`\r\rThe 6 options for WebGL1 are, in order from least to most computationally expensive:\r\rNEAREST (for pixel art)\rLINEAR (the default)\rNEAREST_MIPMAP_NEAREST\rLINEAR_MIPMAP_NEAREST\rNEAREST_MIPMAP_LINEAR\rLINEAR_MIPMAP_LINEAR\r\rMipmaps only work with textures that are fully power-of-two in size.\r\rFor more details see https://webglfundamentals.org/webgl/lessons/webgl-3d-textures.html\r\rAs of v3.60 no mipmaps will be generated unless a string is given in\rthe game config. This saves on VRAM use when it may not be required.\rTo obtain the previous result set the property to `LINEAR` in the config.", "name": "mipmapFilter", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.21.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#mipmapFilter", "scope": "instance", "kind": "member", "___id": "T000002R035199", "___s": true }, { "comment": "/**\r\n * Has this renderer fully booted yet?\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#isBooted\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 549, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Has this renderer fully booted yet?", "name": "isBooted", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#isBooted", "scope": "instance", "kind": "member", "___id": "T000002R035203", "___s": true }, { "comment": "/**\r\n * A Render Target you can use to capture the current state of the Renderer.\r\n *\r\n * A Render Target encapsulates a framebuffer and texture for the WebGL Renderer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#renderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 558, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A Render Target you can use to capture the current state of the Renderer.\r\rA Render Target encapsulates a framebuffer and texture for the WebGL Renderer.", "name": "renderTarget", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#renderTarget", "scope": "instance", "kind": "member", "___id": "T000002R035205", "___s": true }, { "comment": "/**\r\n * The global game Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 569, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The global game Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "name": "projectionMatrix", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#projectionMatrix", "scope": "instance", "kind": "member", "___id": "T000002R035207", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 578, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The cached width of the Projection matrix.", "name": "projectionWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#projectionWidth", "scope": "instance", "kind": "member", "___id": "T000002R035209", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 587, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The cached height of the Projection matrix.", "name": "projectionHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#projectionHeight", "scope": "instance", "kind": "member", "___id": "T000002R035211", "___s": true }, { "comment": "/**\r\n * A RenderTarget used by the BitmapMask Pipeline.\r\n *\r\n * This is the source, i.e. the masked Game Object itself.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#maskSource\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 596, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A RenderTarget used by the BitmapMask Pipeline.\r\rThis is the source, i.e. the masked Game Object itself.", "name": "maskSource", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#maskSource", "scope": "instance", "kind": "member", "___id": "T000002R035213", "___s": true }, { "comment": "/**\r\n * A RenderTarget used by the BitmapMask Pipeline.\r\n *\r\n * This is the target, i.e. the framebuffer the masked objects are drawn to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#maskTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 607, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A RenderTarget used by the BitmapMask Pipeline.\r\rThis is the target, i.e. the framebuffer the masked objects are drawn to.", "name": "maskTarget", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#maskTarget", "scope": "instance", "kind": "member", "___id": "T000002R035215", "___s": true }, { "comment": "/**\r\n * An instance of SpectorJS used for WebGL Debugging.\r\n *\r\n * Only available in the Phaser Debug build.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLRenderer#spector\r\n * @type {function}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 618, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "An instance of SpectorJS used for WebGL Debugging.\r\rOnly available in the Phaser Debug build.", "name": "spector", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#spector", "scope": "instance", "kind": "member", "___id": "T000002R035217", "___s": true }, { "comment": "/**\r\n * Creates a new WebGLRenderingContext and initializes all internal state.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#init\r\n * @since 3.0.0\r\n *\r\n * @param {object} config - The configuration object for the renderer.\r\n *\r\n * @return {this} This WebGLRenderer instance.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 642, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Creates a new WebGLRenderingContext and initializes all internal state.", "kind": "function", "name": "init", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The configuration object for the renderer.", "name": "config" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLRenderer instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#init", "scope": "instance", "___id": "T000002R035221", "___s": true }, { "comment": "/**\r\n * This method is only available in the Debug Build of Phaser, or a build with the\r\n * `WEBGL_DEBUG` flag set in the Webpack Config.\r\n *\r\n * Phaser v3.60 Debug has a build of Spector.js embedded in it, which is a WebGL inspector\r\n * that allows for live inspection of your WebGL calls. Although it's easy to add the Spector\r\n * extension to a desktop browsr, by embedding it in Phaser we can make it available in mobile\r\n * browsers too, making it a powerful tool for debugging WebGL games on mobile devices where\r\n * extensions are not permitted.\r\n *\r\n * See https://github.com/BabylonJS/Spector.js for more details.\r\n *\r\n * This method will capture the current WebGL frame and send it to the Spector.js tool for inspection.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#captureFrame\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [quickCapture=false] - If `true` thumbnails are not captured in order to speed up the capture.\r\n * @param {boolean} [fullCapture=false] - If `true` all details are captured.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 871, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method is only available in the Debug Build of Phaser, or a build with the\r`WEBGL_DEBUG` flag set in the Webpack Config.\r\rPhaser v3.60 Debug has a build of Spector.js embedded in it, which is a WebGL inspector\rthat allows for live inspection of your WebGL calls. Although it's easy to add the Spector\rextension to a desktop browsr, by embedding it in Phaser we can make it available in mobile\rbrowsers too, making it a powerful tool for debugging WebGL games on mobile devices where\rextensions are not permitted.\r\rSee https://github.com/BabylonJS/Spector.js for more details.\r\rThis method will capture the current WebGL frame and send it to the Spector.js tool for inspection.", "kind": "function", "name": "captureFrame", "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true` thumbnails are not captured in order to speed up the capture.", "name": "quickCapture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true` all details are captured.", "name": "fullCapture" } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#captureFrame", "scope": "instance", "___id": "T000002R035341", "___s": true }, { "comment": "/**\r\n * This method is only available in the Debug Build of Phaser, or a build with the\r\n * `WEBGL_DEBUG` flag set in the Webpack Config.\r\n *\r\n * Phaser v3.60 Debug has a build of Spector.js embedded in it, which is a WebGL inspector\r\n * that allows for live inspection of your WebGL calls. Although it's easy to add the Spector\r\n * extension to a desktop browsr, by embedding it in Phaser we can make it available in mobile\r\n * browsers too, making it a powerful tool for debugging WebGL games on mobile devices where\r\n * extensions are not permitted.\r\n *\r\n * See https://github.com/BabylonJS/Spector.js for more details.\r\n *\r\n * This method will capture the next WebGL frame and send it to the Spector.js tool for inspection.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#captureNextFrame\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 904, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method is only available in the Debug Build of Phaser, or a build with the\r`WEBGL_DEBUG` flag set in the Webpack Config.\r\rPhaser v3.60 Debug has a build of Spector.js embedded in it, which is a WebGL inspector\rthat allows for live inspection of your WebGL calls. Although it's easy to add the Spector\rextension to a desktop browsr, by embedding it in Phaser we can make it available in mobile\rbrowsers too, making it a powerful tool for debugging WebGL games on mobile devices where\rextensions are not permitted.\r\rSee https://github.com/BabylonJS/Spector.js for more details.\r\rThis method will capture the next WebGL frame and send it to the Spector.js tool for inspection.", "kind": "function", "name": "captureNextFrame", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#captureNextFrame", "scope": "instance", "___id": "T000002R035346", "___s": true }, { "comment": "/**\r\n * This method is only available in the Debug Build of Phaser, or a build with the\r\n * `WEBGL_DEBUG` flag set in the Webpack Config.\r\n *\r\n * Phaser v3.60 Debug has a build of Spector.js embedded in it, which is a WebGL inspector\r\n * that allows for live inspection of your WebGL calls. Although it's easy to add the Spector\r\n * extension to a desktop browsr, by embedding it in Phaser we can make it available in mobile\r\n * browsers too, making it a powerful tool for debugging WebGL games on mobile devices where\r\n * extensions are not permitted.\r\n *\r\n * See https://github.com/BabylonJS/Spector.js for more details.\r\n *\r\n * This method will return the current FPS of the WebGL canvas.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#getFps\r\n * @since 3.60.0\r\n *\r\n * @return {number} The current FPS of the WebGL canvas.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 931, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method is only available in the Debug Build of Phaser, or a build with the\r`WEBGL_DEBUG` flag set in the Webpack Config.\r\rPhaser v3.60 Debug has a build of Spector.js embedded in it, which is a WebGL inspector\rthat allows for live inspection of your WebGL calls. Although it's easy to add the Spector\rextension to a desktop browsr, by embedding it in Phaser we can make it available in mobile\rbrowsers too, making it a powerful tool for debugging WebGL games on mobile devices where\rextensions are not permitted.\r\rSee https://github.com/BabylonJS/Spector.js for more details.\r\rThis method will return the current FPS of the WebGL canvas.", "kind": "function", "name": "getFps", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current FPS of the WebGL canvas." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#getFps", "scope": "instance", "___id": "T000002R035349", "___s": true }, { "comment": "/**\r\n * This method is only available in the Debug Build of Phaser, or a build with the\r\n * `WEBGL_DEBUG` flag set in the Webpack Config.\r\n *\r\n * Phaser v3.60 Debug has a build of Spector.js embedded in it, which is a WebGL inspector\r\n * that allows for live inspection of your WebGL calls. Although it's easy to add the Spector\r\n * extension to a desktop browsr, by embedding it in Phaser we can make it available in mobile\r\n * browsers too, making it a powerful tool for debugging WebGL games on mobile devices where\r\n * extensions are not permitted.\r\n *\r\n * See https://github.com/BabylonJS/Spector.js for more details.\r\n *\r\n * This method adds a command with the name value in the list. This can be filtered in the search.\r\n * All logs can be filtered searching for \"LOG\".\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#log\r\n * @since 3.60.0\r\n *\r\n * @param {...*} arguments - The arguments to log to Spector.\r\n *\r\n * @return {string} The current log.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 958, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method is only available in the Debug Build of Phaser, or a build with the\r`WEBGL_DEBUG` flag set in the Webpack Config.\r\rPhaser v3.60 Debug has a build of Spector.js embedded in it, which is a WebGL inspector\rthat allows for live inspection of your WebGL calls. Although it's easy to add the Spector\rextension to a desktop browsr, by embedding it in Phaser we can make it available in mobile\rbrowsers too, making it a powerful tool for debugging WebGL games on mobile devices where\rextensions are not permitted.\r\rSee https://github.com/BabylonJS/Spector.js for more details.\r\rThis method adds a command with the name value in the list. This can be filtered in the search.\rAll logs can be filtered searching for \"LOG\".", "kind": "function", "name": "log", "since": "3.60.0", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "variable": true, "description": "The arguments to log to Spector.", "name": "arguments" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The current log." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#log", "scope": "instance", "___id": "T000002R035351", "___s": true }, { "comment": "/**\r\n * This method is only available in the Debug Build of Phaser, or a build with the\r\n * `WEBGL_DEBUG` flag set in the Webpack Config.\r\n *\r\n * Phaser v3.60 Debug has a build of Spector.js embedded in it, which is a WebGL inspector\r\n * that allows for live inspection of your WebGL calls. Although it's easy to add the Spector\r\n * extension to a desktop browsr, by embedding it in Phaser we can make it available in mobile\r\n * browsers too, making it a powerful tool for debugging WebGL games on mobile devices where\r\n * extensions are not permitted.\r\n *\r\n * See https://github.com/BabylonJS/Spector.js for more details.\r\n *\r\n * This method will start a capture on the Phaser canvas. The capture will stop once it reaches\r\n * the number of commands specified as a parameter, or after 10 seconds. If quick capture is true,\r\n * the thumbnails are not captured in order to speed up the capture.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#startCapture\r\n * @since 3.60.0\r\n *\r\n * @param {number} [commandCount=0] - The number of commands to capture. If zero it will capture for 10 seconds.\r\n * @param {boolean} [quickCapture=false] - If `true` thumbnails are not captured in order to speed up the capture.\r\n * @param {boolean} [fullCapture=false] - If `true` all details are captured.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 990, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method is only available in the Debug Build of Phaser, or a build with the\r`WEBGL_DEBUG` flag set in the Webpack Config.\r\rPhaser v3.60 Debug has a build of Spector.js embedded in it, which is a WebGL inspector\rthat allows for live inspection of your WebGL calls. Although it's easy to add the Spector\rextension to a desktop browsr, by embedding it in Phaser we can make it available in mobile\rbrowsers too, making it a powerful tool for debugging WebGL games on mobile devices where\rextensions are not permitted.\r\rSee https://github.com/BabylonJS/Spector.js for more details.\r\rThis method will start a capture on the Phaser canvas. The capture will stop once it reaches\rthe number of commands specified as a parameter, or after 10 seconds. If quick capture is true,\rthe thumbnails are not captured in order to speed up the capture.", "kind": "function", "name": "startCapture", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of commands to capture. If zero it will capture for 10 seconds.", "name": "commandCount" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true` thumbnails are not captured in order to speed up the capture.", "name": "quickCapture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true` all details are captured.", "name": "fullCapture" } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#startCapture", "scope": "instance", "___id": "T000002R035354", "___s": true }, { "comment": "/**\r\n * This method is only available in the Debug Build of Phaser, or a build with the\r\n * `WEBGL_DEBUG` flag set in the Webpack Config.\r\n *\r\n * Phaser v3.60 Debug has a build of Spector.js embedded in it, which is a WebGL inspector\r\n * that allows for live inspection of your WebGL calls. Although it's easy to add the Spector\r\n * extension to a desktop browsr, by embedding it in Phaser we can make it available in mobile\r\n * browsers too, making it a powerful tool for debugging WebGL games on mobile devices where\r\n * extensions are not permitted.\r\n *\r\n * See https://github.com/BabylonJS/Spector.js for more details.\r\n *\r\n * This method will stop the current capture and returns the result in JSON. It displays the\r\n * result if the UI has been displayed. This returns undefined if the capture has not been completed\r\n * or did not find any commands.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#stopCapture\r\n * @since 3.60.0\r\n *\r\n * @return {object} The current capture.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1027, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method is only available in the Debug Build of Phaser, or a build with the\r`WEBGL_DEBUG` flag set in the Webpack Config.\r\rPhaser v3.60 Debug has a build of Spector.js embedded in it, which is a WebGL inspector\rthat allows for live inspection of your WebGL calls. Although it's easy to add the Spector\rextension to a desktop browsr, by embedding it in Phaser we can make it available in mobile\rbrowsers too, making it a powerful tool for debugging WebGL games on mobile devices where\rextensions are not permitted.\r\rSee https://github.com/BabylonJS/Spector.js for more details.\r\rThis method will stop the current capture and returns the result in JSON. It displays the\rresult if the UI has been displayed. This returns undefined if the capture has not been completed\ror did not find any commands.", "kind": "function", "name": "stopCapture", "since": "3.60.0", "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The current capture." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#stopCapture", "scope": "instance", "___id": "T000002R035360", "___s": true }, { "comment": "/**\r\n * The event handler that manages the `resize` event dispatched by the Scale Manager.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#onResize\r\n * @since 3.16.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": "WebGLRenderer.js", "lineno": 1080, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The event handler that manages the `resize` event dispatched by the Scale Manager.", "kind": "function", "name": "onResize", "since": "3.16.0", "params": [ { "type": { "names": [ "Phaser.Structs.Size" ], "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.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#onResize", "scope": "instance", "___id": "T000002R035366", "___s": true }, { "comment": "/**\r\n * Binds the WebGL Renderers Render Target, so all drawn content is now redirected to it.\r\n *\r\n * Make sure to call `endCapture` when you are finished.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#beginCapture\r\n * @since 3.50.0\r\n *\r\n * @param {number} [width] - Optional new width of the Render Target.\r\n * @param {number} [height] - Optional new height of the Render Target.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1098, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Binds the WebGL Renderers Render Target, so all drawn content is now redirected to it.\r\rMake sure to call `endCapture` when you are finished.", "kind": "function", "name": "beginCapture", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional new width of the Render Target.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional new height of the Render Target.", "name": "height" } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#beginCapture", "scope": "instance", "___id": "T000002R035368", "___s": true }, { "comment": "/**\r\n * Unbinds the WebGL Renderers Render Target and returns it, stopping any further content being drawn to it.\r\n *\r\n * If the viewport or scissors were modified during the capture, you should reset them by calling\r\n * `resetViewport` and `resetScissor` accordingly.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#endCapture\r\n * @since 3.50.0\r\n *\r\n * @return {Phaser.Renderer.WebGL.RenderTarget} A reference to the WebGL Renderer Render Target.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1119, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Unbinds the WebGL Renderers Render Target and returns it, stopping any further content being drawn to it.\r\rIf the viewport or scissors were modified during the capture, you should reset them by calling\r`resetViewport` and `resetScissor` accordingly.", "kind": "function", "name": "endCapture", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "A reference to the WebGL Renderer Render Target." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#endCapture", "scope": "instance", "___id": "T000002R035372", "___s": true }, { "comment": "/**\r\n * Resizes the drawing buffer to match that required by the Scale Manager.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#resize\r\n * @fires Phaser.Renderer.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} [width] - The new width of the renderer.\r\n * @param {number} [height] - The new height of the renderer.\r\n *\r\n * @return {this} This WebGLRenderer instance.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Resizes the drawing buffer to match that required by the Scale Manager.", "kind": "function", "name": "resize", "fires": [ "Phaser.Renderer.Events#event:RESIZE" ], "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The new width of the renderer.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The new height of the renderer.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLRenderer instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#resize", "scope": "instance", "___id": "T000002R035374", "___s": true }, { "comment": "/**\r\n * Determines which compressed texture formats this browser and device supports.\r\n *\r\n * Called automatically as part of the WebGL Renderer init process. If you need to investigate\r\n * which formats it supports, see the `Phaser.Renderer.WebGL.WebGLRenderer#compression` property instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#getCompressedTextures\r\n * @since 3.60.0\r\n *\r\n * @return {Phaser.Types.Renderer.WebGL.WebGLTextureCompression} The compression object.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1174, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Determines which compressed texture formats this browser and device supports.\r\rCalled automatically as part of the WebGL Renderer init process. If you need to investigate\rwhich formats it supports, see the `Phaser.Renderer.WebGL.WebGLRenderer#compression` property instead.", "kind": "function", "name": "getCompressedTextures", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLTextureCompression" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLTextureCompression" } }, "description": "The compression object." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#getCompressedTextures", "scope": "instance", "___id": "T000002R035382", "___s": true }, { "comment": "/**\r\n * Returns a compressed texture format GLenum name based on the given format.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#getCompressedTextureName\r\n * @since 3.60.0\r\n *\r\n * @param {string} baseFormat - The Base Format to check.\r\n * @param {GLenum} [format] - An optional GLenum format to check within the base format.\r\n *\r\n * @return {string} The compressed texture format name, as a string.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1223, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Returns a compressed texture format GLenum name based on the given format.", "kind": "function", "name": "getCompressedTextureName", "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The Base Format to check.", "name": "baseFormat" }, { "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "optional": true, "description": "An optional GLenum format to check within the base format.", "name": "format" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The compressed texture format name, as a string." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#getCompressedTextureName", "scope": "instance", "___id": "T000002R035402", "___s": true }, { "comment": "/**\r\n * Checks if the given compressed texture format is supported, or not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#supportsCompressedTexture\r\n * @since 3.60.0\r\n *\r\n * @param {string} baseFormat - The Base Format to check.\r\n * @param {GLenum} [format] - An optional GLenum format to check within the base format.\r\n *\r\n * @return {boolean} True if the format is supported, otherwise false.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1244, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Checks if the given compressed texture format is supported, or not.", "kind": "function", "name": "supportsCompressedTexture", "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The Base Format to check.", "name": "baseFormat" }, { "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "optional": true, "description": "An optional GLenum format to check within the base format.", "name": "format" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the format is supported, otherwise false." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#supportsCompressedTexture", "scope": "instance", "___id": "T000002R035405", "___s": true }, { "comment": "/**\r\n * Gets the aspect ratio of the WebGLRenderer dimensions.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#getAspectRatio\r\n * @since 3.50.0\r\n *\r\n * @return {number} The aspect ratio of the WebGLRenderer dimensions.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1274, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Gets the aspect ratio of the WebGLRenderer dimensions.", "kind": "function", "name": "getAspectRatio", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The aspect ratio of the WebGLRenderer dimensions." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#getAspectRatio", "scope": "instance", "___id": "T000002R035408", "___s": true }, { "comment": "/**\r\n * Sets the Projection Matrix of this renderer to the given dimensions.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of the Projection Matrix.\r\n * @param {number} height - The new height of the Projection Matrix.\r\n *\r\n * @return {this} This WebGLRenderer instance.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1287, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the Projection Matrix of this renderer to the given dimensions.", "kind": "function", "name": "setProjectionMatrix", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the Projection Matrix.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of the Projection Matrix.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLRenderer instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#setProjectionMatrix", "scope": "instance", "___id": "T000002R035410", "___s": true }, { "comment": "/**\r\n * Resets the Projection Matrix back to this renderers width and height.\r\n *\r\n * This is called during `endCapture`, should the matrix have been changed\r\n * as a result of the capture process.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#resetProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @return {this} This WebGLRenderer instance.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1311, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Resets the Projection Matrix back to this renderers width and height.\r\rThis is called during `endCapture`, should the matrix have been changed\ras a result of the capture process.", "kind": "function", "name": "resetProjectionMatrix", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLRenderer instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#resetProjectionMatrix", "scope": "instance", "___id": "T000002R035414", "___s": true }, { "comment": "/**\r\n * Checks if a WebGL extension is supported\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#hasExtension\r\n * @since 3.0.0\r\n *\r\n * @param {string} extensionName - Name of the WebGL extension\r\n *\r\n * @return {boolean} `true` if the extension is supported, otherwise `false`.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1327, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Checks if a WebGL extension is supported", "kind": "function", "name": "hasExtension", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Name of the WebGL extension", "name": "extensionName" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the extension is supported, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#hasExtension", "scope": "instance", "___id": "T000002R035416", "___s": true }, { "comment": "/**\r\n * Loads a WebGL extension\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#getExtension\r\n * @since 3.0.0\r\n *\r\n * @param {string} extensionName - The name of the extension to load.\r\n *\r\n * @return {object} WebGL extension if the extension is supported\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1342, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Loads a WebGL extension", "kind": "function", "name": "getExtension", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the extension to load.", "name": "extensionName" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "WebGL extension if the extension is supported" } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#getExtension", "scope": "instance", "___id": "T000002R035418", "___s": true }, { "comment": "/**\r\n * Flushes the current pipeline if the pipeline is bound\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#flush\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1364, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Flushes the current pipeline if the pipeline is bound", "kind": "function", "name": "flush", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#flush", "scope": "instance", "___id": "T000002R035421", "___s": true }, { "comment": "/**\r\n * Pushes a new scissor state. This is used to set nested scissor states.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#pushScissor\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x position of the scissor.\r\n * @param {number} y - The y position of the scissor.\r\n * @param {number} width - The width of the scissor.\r\n * @param {number} height - The height of the scissor.\r\n * @param {number} [drawingBufferHeight] - Optional drawingBufferHeight override value.\r\n *\r\n * @return {number[]} An array containing the scissor values.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1375, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Pushes a new scissor state. This is used to set nested scissor states.", "kind": "function", "name": "pushScissor", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the scissor.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the scissor.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the scissor.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the scissor.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional drawingBufferHeight override value.", "name": "drawingBufferHeight" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "An array containing the scissor values." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#pushScissor", "scope": "instance", "___id": "T000002R035423", "___s": true }, { "comment": "/**\r\n * Sets the current scissor state.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#setScissor\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x position of the scissor.\r\n * @param {number} y - The y position of the scissor.\r\n * @param {number} width - The width of the scissor.\r\n * @param {number} height - The height of the scissor.\r\n * @param {number} [drawingBufferHeight] - Optional drawingBufferHeight override value.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1406, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the current scissor state.", "kind": "function", "name": "setScissor", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the scissor.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the scissor.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the scissor.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the scissor.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional drawingBufferHeight override value.", "name": "drawingBufferHeight" } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#setScissor", "scope": "instance", "___id": "T000002R035429", "___s": true }, { "comment": "/**\r\n * Resets the gl scissor state to be whatever the current scissor is, if there is one, without\r\n * modifying the scissor stack.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#resetScissor\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1447, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Resets the gl scissor state to be whatever the current scissor is, if there is one, without\rmodifying the scissor stack.", "kind": "function", "name": "resetScissor", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#resetScissor", "scope": "instance", "___id": "T000002R035440", "___s": true }, { "comment": "/**\r\n * Pops the last scissor state and sets it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#popScissor\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1476, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Pops the last scissor state and sets it.", "kind": "function", "name": "popScissor", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#popScissor", "scope": "instance", "___id": "T000002R035448", "___s": true }, { "comment": "/**\r\n * Is there an active stencil mask?\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#hasActiveStencilMask\r\n * @since 3.17.0\r\n *\r\n * @return {boolean} `true` if there is an active stencil mask, otherwise `false`.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1500, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Is there an active stencil mask?", "kind": "function", "name": "hasActiveStencilMask", "since": "3.17.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if there is an active stencil mask, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#hasActiveStencilMask", "scope": "instance", "___id": "T000002R035453", "___s": true }, { "comment": "/**\r\n * Resets the gl viewport to the current renderer dimensions.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#resetViewport\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1516, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Resets the gl viewport to the current renderer dimensions.", "kind": "function", "name": "resetViewport", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#resetViewport", "scope": "instance", "___id": "T000002R035457", "___s": true }, { "comment": "/**\r\n * Sets the blend mode to the value given.\r\n *\r\n * If the current blend mode is different from the one given, the pipeline is flushed and the new\r\n * blend mode is enabled.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#setBlendMode\r\n * @since 3.0.0\r\n *\r\n * @param {number} blendModeId - The blend mode to be set. Can be a `BlendModes` const or an integer value.\r\n * @param {boolean} [force=false] - Force the blend mode to be set, regardless of the currently set blend mode.\r\n *\r\n * @return {boolean} `true` if the blend mode was changed as a result of this call, forcing a flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1531, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the blend mode to the value given.\r\rIf the current blend mode is different from the one given, the pipeline is flushed and the new\rblend mode is enabled.", "kind": "function", "name": "setBlendMode", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The blend mode to be set. Can be a `BlendModes` const or an integer value.", "name": "blendModeId" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Force the blend mode to be set, regardless of the currently set blend mode.", "name": "force" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the blend mode was changed as a result of this call, forcing a flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#setBlendMode", "scope": "instance", "___id": "T000002R035461", "___s": true }, { "comment": "/**\r\n * Creates a new custom blend mode for the renderer.\r\n *\r\n * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Constants#Blending_modes\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#addBlendMode\r\n * @since 3.0.0\r\n *\r\n * @param {GLenum[]} func - An array containing the WebGL functions to use for the source and the destination blending factors, respectively. See the possible constants for {@link WebGLRenderingContext#blendFunc()}.\r\n * @param {GLenum} equation - The equation to use for combining the RGB and alpha components of a new pixel with a rendered one. See the possible constants for {@link WebGLRenderingContext#blendEquation()}.\r\n *\r\n * @return {number} The index of the new blend mode, used for referencing it in the future.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1576, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Creates a new custom blend mode for the renderer.\r\rSee https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Constants#Blending_modes", "kind": "function", "name": "addBlendMode", "since": "3.0.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "GLenum", "type": "NameExpression" } ] } }, "description": "An array containing the WebGL functions to use for the source and the destination blending factors, respectively. See the possible constants for {@link WebGLRenderingContext#blendFunc()}.", "name": "func" }, { "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "description": "The equation to use for combining the RGB and alpha components of a new pixel with a rendered one. See the possible constants for {@link WebGLRenderingContext#blendEquation()}.", "name": "equation" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the new blend mode, used for referencing it in the future." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#addBlendMode", "scope": "instance", "___id": "T000002R035467", "___s": true }, { "comment": "/**\r\n * Updates the function bound to a given custom blend mode.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#updateBlendMode\r\n * @since 3.0.0\r\n *\r\n * @param {number} index - The index of the custom blend mode.\r\n * @param {function} func - The function to use for the blend mode.\r\n * @param {function} equation - The equation to use for the blend mode.\r\n *\r\n * @return {this} This WebGLRenderer instance.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1596, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Updates the function bound to a given custom blend mode.", "kind": "function", "name": "updateBlendMode", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the custom blend mode.", "name": "index" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The function to use for the blend mode.", "name": "func" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The equation to use for the blend mode.", "name": "equation" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLRenderer instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#updateBlendMode", "scope": "instance", "___id": "T000002R035472", "___s": true }, { "comment": "/**\r\n * Removes a custom blend mode from the renderer.\r\n * Any Game Objects still using this blend mode will error, so be sure to clear them first.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#removeBlendMode\r\n * @since 3.0.0\r\n *\r\n * @param {number} index - The index of the custom blend mode to be removed.\r\n *\r\n * @return {this} This WebGLRenderer instance.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1623, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Removes a custom blend mode from the renderer.\rAny Game Objects still using this blend mode will error, so be sure to clear them first.", "kind": "function", "name": "removeBlendMode", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the custom blend mode to be removed.", "name": "index" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLRenderer instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#removeBlendMode", "scope": "instance", "___id": "T000002R035476", "___s": true }, { "comment": "/**\r\n * Pushes a new framebuffer onto the FBO stack and makes it the currently bound framebuffer.\r\n *\r\n * If there was another framebuffer already bound it will force a pipeline flush.\r\n *\r\n * Call `popFramebuffer` to remove it again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#pushFramebuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLFramebuffer} framebuffer - The framebuffer that needs to be bound.\r\n * @param {boolean} [updateScissor=false] - Set the gl scissor to match the frame buffer size? Or, if `null` given, pop the scissor from the stack.\r\n * @param {boolean} [setViewport=true] - Should the WebGL viewport be set?\r\n * @param {WebGLTexture} [texture=null] - Bind the given frame buffer texture?\r\n * @param {boolean} [clear=false] - Clear the frame buffer after binding?\r\n *\r\n * @return {this} This WebGLRenderer instance.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1644, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Pushes a new framebuffer onto the FBO stack and makes it the currently bound framebuffer.\r\rIf there was another framebuffer already bound it will force a pipeline flush.\r\rCall `popFramebuffer` to remove it again.", "kind": "function", "name": "pushFramebuffer", "since": "3.50.0", "params": [ { "type": { "names": [ "WebGLFramebuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLFramebuffer" } }, "description": "The framebuffer that needs to be bound.", "name": "framebuffer" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Set the gl scissor to match the frame buffer size? Or, if `null` given, pop the scissor from the stack.", "name": "updateScissor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the WebGL viewport be set?", "name": "setViewport" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "defaultvalue": null, "description": "Bind the given frame buffer texture?", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Clear the frame buffer after binding?", "name": "clear" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLRenderer instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#pushFramebuffer", "scope": "instance", "___id": "T000002R035478", "___s": true }, { "comment": "/**\r\n * Sets the given framebuffer as the active and currently bound framebuffer.\r\n *\r\n * If there was another framebuffer already bound it will force a pipeline flush.\r\n *\r\n * Typically, you should call `pushFramebuffer` instead of this method.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#setFramebuffer\r\n * @since 3.0.0\r\n *\r\n * @param {WebGLFramebuffer} framebuffer - The framebuffer that needs to be bound.\r\n * @param {boolean} [updateScissor=false] - If a framebuffer is given, set the gl scissor to match the frame buffer size? Or, if `null` given, pop the scissor from the stack.\r\n * @param {boolean} [setViewport=true] - Should the WebGL viewport be set?\r\n * @param {WebGLTexture} [texture=null] - Bind the given frame buffer texture?\r\n * @param {boolean} [clear=false] - Clear the frame buffer after binding?\r\n *\r\n * @return {this} This WebGLRenderer instance.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1674, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the given framebuffer as the active and currently bound framebuffer.\r\rIf there was another framebuffer already bound it will force a pipeline flush.\r\rTypically, you should call `pushFramebuffer` instead of this method.", "kind": "function", "name": "setFramebuffer", "since": "3.0.0", "params": [ { "type": { "names": [ "WebGLFramebuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLFramebuffer" } }, "description": "The framebuffer that needs to be bound.", "name": "framebuffer" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If a framebuffer is given, set the gl scissor to match the frame buffer size? Or, if `null` given, pop the scissor from the stack.", "name": "updateScissor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the WebGL viewport be set?", "name": "setViewport" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "defaultvalue": null, "description": "Bind the given frame buffer texture?", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Clear the frame buffer after binding?", "name": "clear" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLRenderer instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#setFramebuffer", "scope": "instance", "___id": "T000002R035480", "___s": true }, { "comment": "/**\r\n * Pops the previous framebuffer from the fbo stack and sets it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#popFramebuffer\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [updateScissor=false] - If a framebuffer is given, set the gl scissor to match the frame buffer size? Or, if `null` given, pop the scissor from the stack.\r\n * @param {boolean} [setViewport=true] - Should the WebGL viewport be set?\r\n *\r\n * @return {WebGLFramebuffer} The Framebuffer that was set, or `null` if there aren't any more in the stack.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1758, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Pops the previous framebuffer from the fbo stack and sets it.", "kind": "function", "name": "popFramebuffer", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If a framebuffer is given, set the gl scissor to match the frame buffer size? Or, if `null` given, pop the scissor from the stack.", "name": "updateScissor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the WebGL viewport be set?", "name": "setViewport" } ], "returns": [ { "type": { "names": [ "WebGLFramebuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLFramebuffer" } }, "description": "The Framebuffer that was set, or `null` if there aren't any more in the stack." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#popFramebuffer", "scope": "instance", "___id": "T000002R035494", "___s": true }, { "comment": "/**\r\n * Restores the previous framebuffer from the fbo stack and sets it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#restoreFramebuffer\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [updateScissor=false] - If a framebuffer is given, set the gl scissor to match the frame buffer size? Or, if `null` given, pop the scissor from the stack.\r\n * @param {boolean} [setViewport=true] - Should the WebGL viewport be set?\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1792, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Restores the previous framebuffer from the fbo stack and sets it.", "kind": "function", "name": "restoreFramebuffer", "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If a framebuffer is given, set the gl scissor to match the frame buffer size? Or, if `null` given, pop the scissor from the stack.", "name": "updateScissor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the WebGL viewport be set?", "name": "setViewport" } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#restoreFramebuffer", "scope": "instance", "___id": "T000002R035501", "___s": true }, { "comment": "/**\r\n * Binds a shader program.\r\n *\r\n * If there was a different program already bound it will force a pipeline flush first.\r\n *\r\n * If the same program given to this method is already set as the current program, no change\r\n * will take place and this method will return `false`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#setProgram\r\n * @since 3.0.0\r\n *\r\n * @param {WebGLProgram} program - The program that needs to be bound.\r\n *\r\n * @return {boolean} `true` if the given program was bound, otherwise `false`.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1820, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Binds a shader program.\r\rIf there was a different program already bound it will force a pipeline flush first.\r\rIf the same program given to this method is already set as the current program, no change\rwill take place and this method will return `false`.", "kind": "function", "name": "setProgram", "since": "3.0.0", "params": [ { "type": { "names": [ "WebGLProgram" ], "parsedType": { "type": "NameExpression", "name": "WebGLProgram" } }, "description": "The program that needs to be bound.", "name": "program" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given program was bound, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#setProgram", "scope": "instance", "___id": "T000002R035509", "___s": true }, { "comment": "/**\r\n * Rebinds whatever program `WebGLRenderer.currentProgram` is set as, without\r\n * changing anything, or flushing.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#resetProgram\r\n * @since 3.50.0\r\n *\r\n * @return {this} This WebGLRenderer instance.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1851, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Rebinds whatever program `WebGLRenderer.currentProgram` is set as, without\rchanging anything, or flushing.", "kind": "function", "name": "resetProgram", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLRenderer instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#resetProgram", "scope": "instance", "___id": "T000002R035512", "___s": true }, { "comment": "/**\r\n * Creates a texture from an image source. If the source is not valid it creates an empty texture.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#createTextureFromSource\r\n * @since 3.0.0\r\n *\r\n * @param {object} source - The source of the texture.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {number} scaleMode - The scale mode to be used by the texture.\r\n * @param {boolean} [forceClamp=false] - Force the texture to use the CLAMP_TO_EDGE wrap mode, even if a power of two?\r\n *\r\n * @return {?WebGLTexture} The WebGL Texture that was created, or `null` if it couldn't be created.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Creates a texture from an image source. If the source is not valid it creates an empty texture.", "kind": "function", "name": "createTextureFromSource", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The source of the texture.", "name": "source" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The scale mode to be used by the texture.", "name": "scaleMode" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Force the texture to use the CLAMP_TO_EDGE wrap mode, even if a power of two?", "name": "forceClamp" } ], "returns": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "description": "The WebGL Texture that was created, or `null` if it couldn't be created." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#createTextureFromSource", "scope": "instance", "___id": "T000002R035514", "___s": true }, { "comment": "/**\r\n * A wrapper for creating a WebGLTexture. If no pixel data is passed it will create an empty texture.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#createTexture2D\r\n * @since 3.0.0\r\n *\r\n * @param {number} mipLevel - Mip level of the texture.\r\n * @param {number} minFilter - Filtering of the texture.\r\n * @param {number} magFilter - Filtering of the texture.\r\n * @param {number} wrapT - Wrapping mode of the texture.\r\n * @param {number} wrapS - Wrapping mode of the texture.\r\n * @param {number} format - Which format does the texture use.\r\n * @param {?object} pixels - pixel data.\r\n * @param {number} width - Width of the texture in pixels.\r\n * @param {number} height - Height of the texture in pixels.\r\n * @param {boolean} [pma=true] - Does the texture have premultiplied alpha?\r\n * @param {boolean} [forceSize=false] - If `true` it will use the width and height passed to this method, regardless of the pixels dimension.\r\n * @param {boolean} [flipY=false] - Sets the `UNPACK_FLIP_Y_WEBGL` flag the WebGL Texture uses during upload.\r\n *\r\n * @return {WebGLTexture} The WebGLTexture that was created.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 1926, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A wrapper for creating a WebGLTexture. If no pixel data is passed it will create an empty texture.", "kind": "function", "name": "createTexture2D", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Mip level of the texture.", "name": "mipLevel" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Filtering of the texture.", "name": "minFilter" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Filtering of the texture.", "name": "magFilter" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Wrapping mode of the texture.", "name": "wrapT" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Wrapping mode of the texture.", "name": "wrapS" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Which format does the texture use.", "name": "format" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "nullable": true, "description": "pixel data.", "name": "pixels" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the texture in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the texture in pixels.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Does the texture have premultiplied alpha?", "name": "pma" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true` it will use the width and height passed to this method, regardless of the pixels dimension.", "name": "forceSize" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Sets the `UNPACK_FLIP_Y_WEBGL` flag the WebGL Texture uses during upload.", "name": "flipY" } ], "returns": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture that was created." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#createTexture2D", "scope": "instance", "___id": "T000002R035532", "___s": true }, { "comment": "/**\r\n * Creates a WebGL Framebuffer object and optionally binds a depth stencil render buffer.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#createFramebuffer\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - If `addDepthStencilBuffer` is true, this controls the width of the depth stencil.\r\n * @param {number} height - If `addDepthStencilBuffer` is true, this controls the height of the depth stencil.\r\n * @param {WebGLTexture} renderTexture - The color texture where the color pixels are written.\r\n * @param {boolean} [addDepthStencilBuffer=false] - Create a Renderbuffer for the depth stencil?\r\n *\r\n * @return {WebGLFramebuffer} Raw WebGLFramebuffer\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2024, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Creates a WebGL Framebuffer object and optionally binds a depth stencil render buffer.", "kind": "function", "name": "createFramebuffer", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "If `addDepthStencilBuffer` is true, this controls the width of the depth stencil.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "If `addDepthStencilBuffer` is true, this controls the height of the depth stencil.", "name": "height" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The color texture where the color pixels are written.", "name": "renderTexture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Create a Renderbuffer for the depth stencil?", "name": "addDepthStencilBuffer" } ], "returns": [ { "type": { "names": [ "WebGLFramebuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLFramebuffer" } }, "description": "Raw WebGLFramebuffer" } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#createFramebuffer", "scope": "instance", "___id": "T000002R035553", "___s": true }, { "comment": "/**\r\n * Binds necessary resources and renders the mask to a separated framebuffer.\r\n * The framebuffer for the masked object is also bound for further use.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#beginBitmapMask\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Display.Masks.BitmapMask} mask - The BitmapMask instance that called beginMask.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera rendering the current mask.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2082, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Binds necessary resources and renders the mask to a separated framebuffer.\rThe framebuffer for the masked object is also bound for further use.", "kind": "function", "name": "beginBitmapMask", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "The BitmapMask instance that called beginMask.", "name": "mask" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera rendering the current mask.", "name": "camera" } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#beginBitmapMask", "scope": "instance", "___id": "T000002R035569", "___s": true }, { "comment": "/**\r\n * Binds necessary resources and renders the mask to a separated framebuffer.\r\n * The framebuffer for the masked object is also bound for further use.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#drawBitmapMask\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Display.Masks.BitmapMask} mask - The BitmapMask instance that called beginMask.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera rendering the current mask.\r\n * @param {Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline} bitmapMaskPipeline - The BitmapMask Pipeline instance that is requesting the draw.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2110, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Binds necessary resources and renders the mask to a separated framebuffer.\rThe framebuffer for the masked object is also bound for further use.", "kind": "function", "name": "drawBitmapMask", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "The BitmapMask instance that called beginMask.", "name": "mask" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera rendering the current mask.", "name": "camera" }, { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline" } }, "description": "The BitmapMask Pipeline instance that is requesting the draw.", "name": "bitmapMaskPipeline" } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#drawBitmapMask", "scope": "instance", "___id": "T000002R035574", "___s": true }, { "comment": "/**\r\n * Creates a WebGLProgram instance based on the given vertex and fragment shader source.\r\n *\r\n * Then compiles, attaches and links the program before returning it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#createProgram\r\n * @since 3.0.0\r\n *\r\n * @param {string} vertexShader - The vertex shader source code as a single string.\r\n * @param {string} fragmentShader - The fragment shader source code as a single string.\r\n *\r\n * @return {WebGLProgram} The linked WebGLProgram created from the given shader source.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2160, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Creates a WebGLProgram instance based on the given vertex and fragment shader source.\r\rThen compiles, attaches and links the program before returning it.", "kind": "function", "name": "createProgram", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The vertex shader source code as a single string.", "name": "vertexShader" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The fragment shader source code as a single string.", "name": "fragmentShader" } ], "returns": [ { "type": { "names": [ "WebGLProgram" ], "parsedType": { "type": "NameExpression", "name": "WebGLProgram" } }, "description": "The linked WebGLProgram created from the given shader source." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#createProgram", "scope": "instance", "___id": "T000002R035579", "___s": true }, { "comment": "/**\r\n * Wrapper for creating a vertex buffer.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#createVertexBuffer\r\n * @since 3.0.0\r\n *\r\n * @param {ArrayBuffer} initialDataOrSize - It's either ArrayBuffer or an integer indicating the size of the vbo\r\n * @param {number} bufferUsage - How the buffer is used. gl.DYNAMIC_DRAW, gl.STATIC_DRAW or gl.STREAM_DRAW\r\n *\r\n * @return {WebGLBuffer} Raw vertex buffer\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2215, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Wrapper for creating a vertex buffer.", "kind": "function", "name": "createVertexBuffer", "since": "3.0.0", "params": [ { "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "description": "It's either ArrayBuffer or an integer indicating the size of the vbo", "name": "initialDataOrSize" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How the buffer is used. gl.DYNAMIC_DRAW, gl.STATIC_DRAW or gl.STREAM_DRAW", "name": "bufferUsage" } ], "returns": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "description": "Raw vertex buffer" } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#createVertexBuffer", "scope": "instance", "___id": "T000002R035586", "___s": true }, { "comment": "/**\r\n * Wrapper for creating a vertex buffer.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#createIndexBuffer\r\n * @since 3.0.0\r\n *\r\n * @param {ArrayBuffer} initialDataOrSize - Either ArrayBuffer or an integer indicating the size of the vbo.\r\n * @param {number} bufferUsage - How the buffer is used. gl.DYNAMIC_DRAW, gl.STATIC_DRAW or gl.STREAM_DRAW.\r\n *\r\n * @return {WebGLBuffer} Raw index buffer\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2238, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Wrapper for creating a vertex buffer.", "kind": "function", "name": "createIndexBuffer", "since": "3.0.0", "params": [ { "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "description": "Either ArrayBuffer or an integer indicating the size of the vbo.", "name": "initialDataOrSize" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How the buffer is used. gl.DYNAMIC_DRAW, gl.STATIC_DRAW or gl.STREAM_DRAW.", "name": "bufferUsage" } ], "returns": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "description": "Raw index buffer" } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#createIndexBuffer", "scope": "instance", "___id": "T000002R035590", "___s": true }, { "comment": "/**\r\n * Calls `GL.deleteTexture` on the given WebGLTexture and also optionally\r\n * resets the currently defined textures.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#deleteTexture\r\n * @since 3.0.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGL Texture to be deleted.\r\n *\r\n * @return {this} This WebGLRenderer instance.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Calls `GL.deleteTexture` on the given WebGLTexture and also optionally\rresets the currently defined textures.", "kind": "function", "name": "deleteTexture", "since": "3.0.0", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGL Texture to be deleted.", "name": "texture" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLRenderer instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#deleteTexture", "scope": "instance", "___id": "T000002R035594", "___s": true }, { "comment": "/**\r\n * Deletes a WebGLFramebuffer from the GL instance.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#deleteFramebuffer\r\n * @since 3.0.0\r\n *\r\n * @param {WebGLFramebuffer} framebuffer - The Framebuffer to be deleted.\r\n *\r\n * @return {this} This WebGLRenderer instance.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2282, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Deletes a WebGLFramebuffer from the GL instance.", "kind": "function", "name": "deleteFramebuffer", "since": "3.0.0", "params": [ { "type": { "names": [ "WebGLFramebuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLFramebuffer" } }, "description": "The Framebuffer to be deleted.", "name": "framebuffer" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLRenderer instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#deleteFramebuffer", "scope": "instance", "___id": "T000002R035596", "___s": true }, { "comment": "/**\r\n * Deletes a WebGLProgram from the GL instance.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#deleteProgram\r\n * @since 3.0.0\r\n *\r\n * @param {WebGLProgram} program - The shader program to be deleted.\r\n *\r\n * @return {this} This WebGLRenderer instance.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Deletes a WebGLProgram from the GL instance.", "kind": "function", "name": "deleteProgram", "since": "3.0.0", "params": [ { "type": { "names": [ "WebGLProgram" ], "parsedType": { "type": "NameExpression", "name": "WebGLProgram" } }, "description": "The shader program to be deleted.", "name": "program" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLRenderer instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#deleteProgram", "scope": "instance", "___id": "T000002R035603", "___s": true }, { "comment": "/**\r\n * Deletes a WebGLBuffer from the GL instance.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#deleteBuffer\r\n * @since 3.0.0\r\n *\r\n * @param {WebGLBuffer} vertexBuffer - The WebGLBuffer to be deleted.\r\n *\r\n * @return {this} This WebGLRenderer instance.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Deletes a WebGLBuffer from the GL instance.", "kind": "function", "name": "deleteBuffer", "since": "3.0.0", "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "description": "The WebGLBuffer to be deleted.", "name": "vertexBuffer" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLRenderer instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#deleteBuffer", "scope": "instance", "___id": "T000002R035605", "___s": true }, { "comment": "/**\r\n * Controls the pre-render operations for the given camera.\r\n * Handles any clipping needed by the camera and renders the background color if a color is visible.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#preRenderCamera\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to pre-render.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2374, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Controls the pre-render operations for the given camera.\rHandles any clipping needed by the camera and renders the background color if a color is visible.", "kind": "function", "name": "preRenderCamera", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to pre-render.", "name": "camera" } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#preRenderCamera", "scope": "instance", "___id": "T000002R035607", "___s": true }, { "comment": "/**\r\n * Controls the post-render operations for the given camera.\r\n *\r\n * Renders the foreground camera effects like flash and fading, then resets the current scissor state.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#postRenderCamera\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to post-render.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2443, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Controls the post-render operations for the given camera.\r\rRenders the foreground camera effects like flash and fading, then resets the current scissor state.", "kind": "function", "name": "postRenderCamera", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to post-render.", "name": "camera" } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#postRenderCamera", "scope": "instance", "___id": "T000002R035624", "___s": true }, { "comment": "/**\r\n * Clears the current vertex buffer and updates pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#preRender\r\n * @fires Phaser.Renderer.Events#PRE_RENDER\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2482, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Clears the current vertex buffer and updates pipelines.", "kind": "function", "name": "preRender", "fires": [ "Phaser.Renderer.Events#event:PRE_RENDER" ], "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#preRender", "scope": "instance", "___id": "T000002R035631", "___s": true }, { "comment": "/**\r\n * The core render step for a Scene Camera.\r\n *\r\n * Iterates through the given array of Game Objects and renders them with the given Camera.\r\n *\r\n * This is called by the `CameraManager.render` method. The Camera Manager instance belongs to a Scene, and is invoked\r\n * by the Scene Systems.render method.\r\n *\r\n * This method is not called if `Camera.visible` is `false`, or `Camera.alpha` is zero.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#render\r\n * @fires Phaser.Renderer.Events#RENDER\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to render.\r\n * @param {Phaser.GameObjects.GameObject[]} children - An array of filtered Game Objects that can be rendered by the given Camera.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera to render with.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2526, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The core render step for a Scene Camera.\r\rIterates through the given array of Game Objects and renders them with the given Camera.\r\rThis is called by the `CameraManager.render` method. The Camera Manager instance belongs to a Scene, and is invoked\rby the Scene Systems.render method.\r\rThis method is not called if `Camera.visible` is `false`, or `Camera.alpha` is zero.", "kind": "function", "name": "render", "fires": [ "Phaser.Renderer.Events#event:RENDER" ], "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to render.", "name": "scene" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "An array of filtered Game Objects that can be rendered by the given Camera.", "name": "children" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera to render with.", "name": "camera" } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#render", "scope": "instance", "___id": "T000002R035640", "___s": true }, { "comment": "/**\r\n * The post-render step happens after all Cameras in all Scenes have been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#postRender\r\n * @fires Phaser.Renderer.Events#POST_RENDER\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2633, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The post-render step happens after all Cameras in all Scenes have been rendered.", "kind": "function", "name": "postRender", "fires": [ "Phaser.Renderer.Events#event:POST_RENDER" ], "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#postRender", "scope": "instance", "___id": "T000002R035657", "___s": true }, { "comment": "/**\r\n * Disables the STENCIL_TEST but does not change the status\r\n * of the current stencil mask.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#clearStencilMask\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2658, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Disables the STENCIL_TEST but does not change the status\rof the current stencil mask.", "kind": "function", "name": "clearStencilMask", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#clearStencilMask", "scope": "instance", "___id": "T000002R035661", "___s": true }, { "comment": "/**\r\n * Restores the current stencil function to the one that was in place\r\n * before `clearStencilMask` was called.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#restoreStencilMask\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2670, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Restores the current stencil function to the one that was in place\rbefore `clearStencilMask` was called.", "kind": "function", "name": "restoreStencilMask", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#restoreStencilMask", "scope": "instance", "___id": "T000002R035663", "___s": true }, { "comment": "/**\r\n * Schedules a snapshot of the entire game viewport to be taken after the current frame is rendered.\r\n *\r\n * To capture a specific area see the `snapshotArea` method. To capture a specific pixel, see `snapshotPixel`.\r\n *\r\n * Only one snapshot can be active _per frame_. If you have already called `snapshotPixel`, for example, then\r\n * calling this method will override it.\r\n *\r\n * Snapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer into an ArrayBufferView.\r\n * It then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,\r\n * which is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,\r\n * which gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#snapshot\r\n * @since 3.0.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 WebGL Renderer.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2702, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Schedules a snapshot of the entire game viewport to be taken after the current frame is rendered.\r\rTo capture a specific area see the `snapshotArea` method. To capture a specific pixel, see `snapshotPixel`.\r\rOnly one snapshot can be active _per frame_. If you have already called `snapshotPixel`, for example, then\rcalling this method will override it.\r\rSnapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer into an ArrayBufferView.\rIt then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,\rwhich is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,\rwhich gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.", "kind": "function", "name": "snapshot", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.Snapshot.SnapshotCallback" ], "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 WebGL Renderer." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#snapshot", "scope": "instance", "___id": "T000002R035668", "___s": true }, { "comment": "/**\r\n * Schedules a snapshot of the given area of the game viewport to be taken after the current frame is rendered.\r\n *\r\n * To capture the whole game viewport see the `snapshot` method. To capture a specific pixel, see `snapshotPixel`.\r\n *\r\n * Only one snapshot can be active _per frame_. If you have already called `snapshotPixel`, for example, then\r\n * calling this method will override it.\r\n *\r\n * Snapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer into an ArrayBufferView.\r\n * It then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,\r\n * which is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,\r\n * which gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#snapshotArea\r\n * @since 3.16.0\r\n *\r\n * @param {number} x - The x coordinate to grab from. This is based on the game viewport, not the world.\r\n * @param {number} y - The y coordinate to grab from. This is based on the game viewport, not the world.\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 WebGL Renderer.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2729, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Schedules a snapshot of the given area of the game viewport to be taken after the current frame is rendered.\r\rTo capture the whole game viewport see the `snapshot` method. To capture a specific pixel, see `snapshotPixel`.\r\rOnly one snapshot can be active _per frame_. If you have already called `snapshotPixel`, for example, then\rcalling this method will override it.\r\rSnapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer into an ArrayBufferView.\rIt then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,\rwhich is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,\rwhich gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.", "kind": "function", "name": "snapshotArea", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to grab from. This is based on the game viewport, not the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to grab from. This is based on the game viewport, not the world.", "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 WebGL Renderer." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#snapshotArea", "scope": "instance", "___id": "T000002R035670", "___s": true }, { "comment": "/**\r\n * Schedules a snapshot of the given pixel from the game viewport to be taken after the current frame is rendered.\r\n *\r\n * To capture the whole game viewport see the `snapshot` method. To capture a specific area, see `snapshotArea`.\r\n *\r\n * Only one snapshot can be active _per frame_. If you have already called `snapshotArea`, for example, then\r\n * calling this method will override it.\r\n *\r\n * Unlike the other two snapshot methods, this one will return a `Color` object containing the color data for\r\n * the requested pixel. It doesn't need to create an internal Canvas or Image object, so is a lot faster to execute,\r\n * using less memory.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#snapshotPixel\r\n * @since 3.16.0\r\n *\r\n * @param {number} x - The x coordinate of the pixel to get. This is based on the game viewport, not the world.\r\n * @param {number} y - The y coordinate of the pixel to get. This is based on the game viewport, not the world.\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 WebGL Renderer.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2771, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Schedules a snapshot of the given pixel from the game viewport to be taken after the current frame is rendered.\r\rTo capture the whole game viewport see the `snapshot` method. To capture a specific area, see `snapshotArea`.\r\rOnly one snapshot can be active _per frame_. If you have already called `snapshotArea`, for example, then\rcalling this method will override it.\r\rUnlike the other two snapshot methods, this one will return a `Color` object containing the color data for\rthe requested pixel. It doesn't need to create an internal Canvas or Image object, so is a lot faster to execute,\rusing less memory.", "kind": "function", "name": "snapshotPixel", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the pixel to get. This is based on the game viewport, not the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the pixel to get. This is based on the game viewport, not the world.", "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 WebGL Renderer." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#snapshotPixel", "scope": "instance", "___id": "T000002R035681", "___s": true }, { "comment": "/**\r\n * Takes a snapshot of the given area of the given frame buffer.\r\n *\r\n * Unlike the other snapshot methods, this one is processed immediately and doesn't wait for the next render.\r\n *\r\n * Snapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer into an ArrayBufferView.\r\n * It then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,\r\n * which is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,\r\n * which gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#snapshotFramebuffer\r\n * @since 3.19.0\r\n *\r\n * @param {WebGLFramebuffer} framebuffer - The framebuffer to grab from.\r\n * @param {number} bufferWidth - The width of the framebuffer.\r\n * @param {number} bufferHeight - The height of the framebuffer.\r\n * @param {Phaser.Types.Renderer.Snapshot.SnapshotCallback} callback - The Function to invoke after the snapshot image is created.\r\n * @param {boolean} [getPixel=false] - Grab a single pixel as a Color object, or an area as an Image object?\r\n * @param {number} [x=0] - The x coordinate to grab from. This is based on the framebuffer, not the world.\r\n * @param {number} [y=0] - The y coordinate to grab from. This is based on the framebuffer, not the world.\r\n * @param {number} [width=bufferWidth] - The width of the area to grab.\r\n * @param {number} [height=bufferHeight] - The height of the area to grab.\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 WebGL Renderer.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2801, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Takes a snapshot of the given area of the given frame buffer.\r\rUnlike the other snapshot methods, this one is processed immediately and doesn't wait for the next render.\r\rSnapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer into an ArrayBufferView.\rIt then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,\rwhich is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,\rwhich gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.", "kind": "function", "name": "snapshotFramebuffer", "since": "3.19.0", "params": [ { "type": { "names": [ "WebGLFramebuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLFramebuffer" } }, "description": "The framebuffer to grab from.", "name": "framebuffer" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the framebuffer.", "name": "bufferWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the framebuffer.", "name": "bufferHeight" }, { "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": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Grab a single pixel as a Color object, or an area as an Image object?", "name": "getPixel" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate to grab from. This is based on the framebuffer, not the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate to grab from. This is based on the framebuffer, not the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "bufferWidth", "description": "The width of the area to grab.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "bufferHeight", "description": "The height of the area to grab.", "name": "height" }, { "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 WebGL Renderer." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#snapshotFramebuffer", "scope": "instance", "___id": "T000002R035684", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Texture based on the given Canvas Element.\r\n *\r\n * If the `dstTexture` parameter is given, the WebGL Texture is updated, rather than created fresh.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#canvasToTexture\r\n * @since 3.0.0\r\n *\r\n * @param {HTMLCanvasElement} srcCanvas - The Canvas to create the WebGL Texture from\r\n * @param {WebGLTexture} [dstTexture] - The destination WebGL Texture to set.\r\n * @param {boolean} [noRepeat=false] - Should this canvas be allowed to set `REPEAT` (such as for Text objects?)\r\n * @param {boolean} [flipY=false] - Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?\r\n *\r\n * @return {WebGLTexture} The newly created, or updated, WebGL Texture.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2870, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Creates a new WebGL Texture based on the given Canvas Element.\r\rIf the `dstTexture` parameter is given, the WebGL Texture is updated, rather than created fresh.", "kind": "function", "name": "canvasToTexture", "since": "3.0.0", "params": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The Canvas to create the WebGL Texture from", "name": "srcCanvas" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The destination WebGL Texture to set.", "name": "dstTexture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should this canvas be allowed to set `REPEAT` (such as for Text objects?)", "name": "noRepeat" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?", "name": "flipY" } ], "returns": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The newly created, or updated, WebGL Texture." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#canvasToTexture", "scope": "instance", "___id": "T000002R035703", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Texture based on the given Canvas Element.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#createCanvasTexture\r\n * @since 3.20.0\r\n *\r\n * @param {HTMLCanvasElement} srcCanvas - The Canvas to create the WebGL Texture from.\r\n * @param {boolean} [noRepeat=false] - Should this canvas be allowed to set `REPEAT` (such as for Text objects?)\r\n * @param {boolean} [flipY=false] - Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?\r\n *\r\n * @return {WebGLTexture} The newly created WebGL Texture.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Creates a new WebGL Texture based on the given Canvas Element.", "kind": "function", "name": "createCanvasTexture", "since": "3.20.0", "params": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The Canvas to create the WebGL Texture from.", "name": "srcCanvas" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should this canvas be allowed to set `REPEAT` (such as for Text objects?)", "name": "noRepeat" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?", "name": "flipY" } ], "returns": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The newly created WebGL Texture." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#createCanvasTexture", "scope": "instance", "___id": "T000002R035707", "___s": true }, { "comment": "/**\r\n * Updates a WebGL Texture based on the given Canvas Element.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#updateCanvasTexture\r\n * @since 3.20.0\r\n *\r\n * @param {HTMLCanvasElement} srcCanvas - The Canvas to update the WebGL Texture from.\r\n * @param {WebGLTexture} dstTexture - The destination WebGL Texture to update.\r\n * @param {boolean} [flipY=false] - Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?\r\n *\r\n * @return {WebGLTexture} The updated WebGL Texture.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2942, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Updates a WebGL Texture based on the given Canvas Element.", "kind": "function", "name": "updateCanvasTexture", "since": "3.20.0", "params": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The Canvas to update the WebGL Texture from.", "name": "srcCanvas" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The destination WebGL Texture to update.", "name": "dstTexture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?", "name": "flipY" } ], "returns": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The updated WebGL Texture." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#updateCanvasTexture", "scope": "instance", "___id": "T000002R035721", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Texture based on the given HTML Video Element.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#createVideoTexture\r\n * @since 3.20.0\r\n *\r\n * @param {HTMLVideoElement} srcVideo - The Video to create the WebGL Texture from\r\n * @param {boolean} [noRepeat=false] - Should this canvas be allowed to set `REPEAT`?\r\n * @param {boolean} [flipY=false] - Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?\r\n *\r\n * @return {WebGLTexture} The newly created WebGL Texture.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 2990, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Creates a new WebGL Texture based on the given HTML Video Element.", "kind": "function", "name": "createVideoTexture", "since": "3.20.0", "params": [ { "type": { "names": [ "HTMLVideoElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLVideoElement" } }, "description": "The Video to create the WebGL Texture from", "name": "srcVideo" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should this canvas be allowed to set `REPEAT`?", "name": "noRepeat" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?", "name": "flipY" } ], "returns": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The newly created WebGL Texture." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#createVideoTexture", "scope": "instance", "___id": "T000002R035730", "___s": true }, { "comment": "/**\r\n * Updates a WebGL Texture based on the given HTML Video Element.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#updateVideoTexture\r\n * @since 3.20.0\r\n *\r\n * @param {HTMLVideoElement} srcVideo - The Video to update the WebGL Texture with.\r\n * @param {WebGLTexture} dstTexture - The destination WebGL Texture to update.\r\n * @param {boolean} [flipY=false] - Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?\r\n *\r\n * @return {WebGLTexture} The updated WebGL Texture.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 3032, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Updates a WebGL Texture based on the given HTML Video Element.", "kind": "function", "name": "updateVideoTexture", "since": "3.20.0", "params": [ { "type": { "names": [ "HTMLVideoElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLVideoElement" } }, "description": "The Video to update the WebGL Texture with.", "name": "srcVideo" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The destination WebGL Texture to update.", "name": "dstTexture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?", "name": "flipY" } ], "returns": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The updated WebGL Texture." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#updateVideoTexture", "scope": "instance", "___id": "T000002R035744", "___s": true }, { "comment": "/**\r\n * Sets the minification and magnification filter for a texture.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#setTextureFilter\r\n * @since 3.0.0\r\n *\r\n * @param {number} texture - The texture to set the filter for.\r\n * @param {number} filter - The filter to set. 0 for linear filtering, 1 for nearest neighbor (blocky) filtering.\r\n *\r\n * @return {this} This WebGL Renderer instance.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 3075, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the minification and magnification filter for a texture.", "kind": "function", "name": "setTextureFilter", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture to set the filter for.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The filter to set. 0 for linear filtering, 1 for nearest neighbor (blocky) filtering.", "name": "filter" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Renderer instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#setTextureFilter", "scope": "instance", "___id": "T000002R035753", "___s": true }, { "comment": "/**\r\n * Returns the largest texture size (either width or height) that can be created.\r\n * Note that VRAM may not allow a texture of any given size, it just expresses\r\n * hardware / driver support for a given size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#getMaxTextureSize\r\n * @since 3.8.0\r\n *\r\n * @return {number} The maximum supported texture size.\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 3108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Returns the largest texture size (either width or height) that can be created.\rNote that VRAM may not allow a texture of any given size, it just expresses\rhardware / driver support for a given size.", "kind": "function", "name": "getMaxTextureSize", "since": "3.8.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum supported texture size." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#getMaxTextureSize", "scope": "instance", "___id": "T000002R035758", "___s": true }, { "comment": "/**\r\n * Destroy this WebGLRenderer, cleaning up all related resources such as pipelines, native textures, etc.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLRenderer#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLRenderer.js", "lineno": 3123, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Destroy this WebGLRenderer, cleaning up all related resources such as pipelines, native textures, etc.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#destroy", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#destroy", "___id": "T000002R035760", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Instances of the WebGLShader class belong to the WebGL Pipeline classes. When the pipeline is\r\n * created it will create an instance of this class for each one of its shaders, as defined in\r\n * the pipeline configuration.\r\n *\r\n * This class encapsulates everything needed to manage a shader in a pipeline, including the\r\n * shader attributes and uniforms, as well as lots of handy methods such as `set2f`, for setting\r\n * uniform values on this shader.\r\n *\r\n * Typically, you do not create an instance of this class directly, as it works in unison with\r\n * the pipeline to which it belongs. You can gain access to this class via a pipeline's `shaders`\r\n * array, post-creation.\r\n *\r\n * @class WebGLShader\r\n * @memberof Phaser.Renderer.WebGL\r\n * @constructor\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The WebGLPipeline to which this Shader belongs.\r\n * @param {string} name - The name of this Shader.\r\n * @param {string} vertexShader - The vertex shader source code as a single string.\r\n * @param {string} fragmentShader - The fragment shader source code as a single string.\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineAttributeConfig[]} attributes - An array of attributes.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "classdesc": "Instances of the WebGLShader class belong to the WebGL Pipeline classes. When the pipeline is\rcreated it will create an instance of this class for each one of its shaders, as defined in\rthe pipeline configuration.\r\rThis class encapsulates everything needed to manage a shader in a pipeline, including the\rshader attributes and uniforms, as well as lots of handy methods such as `set2f`, for setting\runiform values on this shader.\r\rTypically, you do not create an instance of this class directly, as it works in unison with\rthe pipeline to which it belongs. You can gain access to this class via a pipeline's `shaders`\rarray, post-creation.", "kind": "class", "name": "WebGLShader", "memberof": "Phaser.Renderer.WebGL", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "description": "The WebGLPipeline to which this Shader belongs.", "name": "pipeline" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of this Shader.", "name": "name" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The vertex shader source code as a single string.", "name": "vertexShader" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The fragment shader source code as a single string.", "name": "fragmentShader" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineAttributeConfig", "type": "NameExpression" } ] } }, "description": "An array of attributes.", "name": "attributes" } ], "scope": "static", "longname": "Phaser.Renderer.WebGL.WebGLShader", "___id": "T000002R035777", "___s": true }, { "comment": "/**\r\n * A reference to the WebGLPipeline that owns this Shader.\r\n *\r\n * A Shader class can only belong to a single pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLShader#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 42, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A reference to the WebGLPipeline that owns this Shader.\r\rA Shader class can only belong to a single pipeline.", "name": "pipeline", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#pipeline", "scope": "instance", "kind": "member", "___id": "T000002R035780", "___s": true }, { "comment": "/**\r\n * The name of this shader.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLShader#name\r\n * @type {string}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The name of this shader.", "name": "name", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#name", "scope": "instance", "kind": "member", "___id": "T000002R035782", "___s": true }, { "comment": "/**\r\n * A reference to the WebGLRenderer instance.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLShader#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A reference to the WebGLRenderer instance.", "name": "renderer", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#renderer", "scope": "instance", "kind": "member", "___id": "T000002R035784", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Rendering Context the WebGL Renderer is using.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLShader#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 71, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "A reference to the WebGL Rendering Context the WebGL Renderer is using.", "name": "gl", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#gl", "scope": "instance", "kind": "member", "___id": "T000002R035786", "___s": true }, { "comment": "/**\r\n * The fragment shader source code.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLShader#fragSrc\r\n * @type {string}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The fragment shader source code.", "name": "fragSrc", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#fragSrc", "scope": "instance", "kind": "member", "___id": "T000002R035788", "___s": true }, { "comment": "/**\r\n * The vertex shader source code.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLShader#vertSrc\r\n * @type {string}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 89, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The vertex shader source code.", "name": "vertSrc", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#vertSrc", "scope": "instance", "kind": "member", "___id": "T000002R035790", "___s": true }, { "comment": "/**\r\n * The WebGLProgram created from the vertex and fragment shaders.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLShader#program\r\n * @type {WebGLProgram}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The WebGLProgram created from the vertex and fragment shaders.", "name": "program", "type": { "names": [ "WebGLProgram" ], "parsedType": { "type": "NameExpression", "name": "WebGLProgram" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#program", "scope": "instance", "kind": "member", "___id": "T000002R035792", "___s": true }, { "comment": "/**\r\n * Array of objects that describe the vertex attributes.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLShader#attributes\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineAttribute[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Array of objects that describe the vertex attributes.", "name": "attributes", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineAttribute", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#attributes", "scope": "instance", "kind": "member", "___id": "T000002R035794", "___s": true }, { "comment": "/**\r\n * The amount of vertex attribute components of 32 bit length.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLShader#vertexComponentCount\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The amount of vertex attribute components of 32 bit length.", "name": "vertexComponentCount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#vertexComponentCount", "scope": "instance", "kind": "member", "___id": "T000002R035796", "___s": true }, { "comment": "/**\r\n * The size, in bytes, of a single vertex.\r\n *\r\n * This is derived by adding together all of the vertex attributes.\r\n *\r\n * For example, the Multi Pipeline has the following attributes:\r\n *\r\n * inPosition - (size 2 x gl.FLOAT) = 8\r\n * inTexCoord - (size 2 x gl.FLOAT) = 8\r\n * inTexId - (size 1 x gl.FLOAT) = 4\r\n * inTintEffect - (size 1 x gl.FLOAT) = 4\r\n * inTint - (size 4 x gl.UNSIGNED_BYTE) = 4\r\n *\r\n * The total, in this case, is 8 + 8 + 4 + 4 + 4 = 28.\r\n *\r\n * This is calculated automatically during the `createAttributes` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLShader#vertexSize\r\n * @type {number}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The size, in bytes, of a single vertex.\r\rThis is derived by adding together all of the vertex attributes.\r\rFor example, the Multi Pipeline has the following attributes:\r\rinPosition - (size 2 x gl.FLOAT) = 8\rinTexCoord - (size 2 x gl.FLOAT) = 8\rinTexId - (size 1 x gl.FLOAT) = 4\rinTintEffect - (size 1 x gl.FLOAT) = 4\rinTint - (size 4 x gl.UNSIGNED_BYTE) = 4\r\rThe total, in this case, is 8 + 8 + 4 + 4 + 4 = 28.\r\rThis is calculated automatically during the `createAttributes` method.", "name": "vertexSize", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#vertexSize", "scope": "instance", "kind": "member", "___id": "T000002R035798", "___s": true }, { "comment": "/**\r\n * The active uniforms that this shader has.\r\n *\r\n * This is an object that maps the uniform names to their WebGL location and cached values.\r\n *\r\n * It is populated automatically via the `createUniforms` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLShader#uniforms\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineUniformsConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "The active uniforms that this shader has.\r\rThis is an object that maps the uniform names to their WebGL location and cached values.\r\rIt is populated automatically via the `createUniforms` method.", "name": "uniforms", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineUniformsConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineUniformsConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#uniforms", "scope": "instance", "kind": "member", "___id": "T000002R035800", "___s": true }, { "comment": "/**\r\n * Takes the vertex attributes config and parses it, creating the resulting array that is stored\r\n * in this shaders `attributes` property, calculating the offset, normalization and location\r\n * in the process.\r\n *\r\n * Calling this method resets `WebGLShader.attributes`, `WebGLShader.vertexSize` and\r\n * `WebGLShader.vertexComponentCount`.\r\n *\r\n * It is called automatically when this class is created, but can be called manually if required.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#createAttributes\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineAttributeConfig[]} attributes - An array of attributes configs.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Takes the vertex attributes config and parses it, creating the resulting array that is stored\rin this shaders `attributes` property, calculating the offset, normalization and location\rin the process.\r\rCalling this method resets `WebGLShader.attributes`, `WebGLShader.vertexSize` and\r`WebGLShader.vertexComponentCount`.\r\rIt is called automatically when this class is created, but can be called manually if required.", "kind": "function", "name": "createAttributes", "since": "3.50.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineAttributeConfig", "type": "NameExpression" } ] } }, "description": "An array of attributes configs.", "name": "attributes" } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#createAttributes", "scope": "instance", "___id": "T000002R035802", "___s": true }, { "comment": "/**\r\n * Sets the program this shader uses as being the active shader in the WebGL Renderer.\r\n *\r\n * This method is called every time the parent pipeline is made the current active pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#bind\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {boolean} [flush=false] - Flush the pipeline before binding this shader?\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the program this shader uses as being the active shader in the WebGL Renderer.\r\rThis method is called every time the parent pipeline is made the current active pipeline.", "kind": "function", "name": "bind", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Flush the pipeline before binding this shader?", "name": "flush" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#bind", "scope": "instance", "___id": "T000002R035828", "___s": true }, { "comment": "/**\r\n * Sets the program this shader uses as being the active shader in the WebGL Renderer.\r\n *\r\n * Then resets all of the attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#rebind\r\n * @since 3.50.0\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the program this shader uses as being the active shader in the WebGL Renderer.\r\rThen resets all of the attribute pointers.", "kind": "function", "name": "rebind", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#rebind", "scope": "instance", "___id": "T000002R035832", "___s": true }, { "comment": "/**\r\n * Sets the vertex attribute pointers.\r\n *\r\n * This should only be called after the vertex buffer has been bound.\r\n *\r\n * It is called automatically during the `bind` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#setAttribPointers\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [reset=false] - Reset the vertex attribute locations?\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 280, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the vertex attribute pointers.\r\rThis should only be called after the vertex buffer has been bound.\r\rIt is called automatically during the `bind` method.", "kind": "function", "name": "setAttribPointers", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the vertex attribute locations?", "name": "reset" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#setAttribPointers", "scope": "instance", "___id": "T000002R035834", "___s": true }, { "comment": "/**\r\n * Sets up the `WebGLShader.uniforms` object, populating it with the names\r\n * and locations of the shader uniforms this shader requires.\r\n *\r\n * It works by first calling `gl.getProgramParameter(program, gl.ACTIVE_UNIFORMS)` to\r\n * find out how many active uniforms this shader has. It then iterates through them,\r\n * calling `gl.getActiveUniform` to get the WebGL Active Info from each one. Finally,\r\n * the name and location are stored in the local array.\r\n *\r\n * This method is called automatically when this class is created.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#createUniforms\r\n * @since 3.50.0\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 347, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets up the `WebGLShader.uniforms` object, populating it with the names\rand locations of the shader uniforms this shader requires.\r\rIt works by first calling `gl.getProgramParameter(program, gl.ACTIVE_UNIFORMS)` to\rfind out how many active uniforms this shader has. It then iterates through them,\rcalling `gl.getActiveUniform` to get the WebGL Active Info from each one. Finally,\rthe name and location are stored in the local array.\r\rThis method is called automatically when this class is created.", "kind": "function", "name": "createUniforms", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#createUniforms", "scope": "instance", "___id": "T000002R035853", "___s": true }, { "comment": "/**\r\n * Checks to see if the given uniform name exists and is active in this shader.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#hasUniform\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to check for.\r\n *\r\n * @return {boolean} `true` if the uniform exists, otherwise `false`.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 434, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Checks to see if the given uniform name exists and is active in this shader.", "kind": "function", "name": "hasUniform", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to check for.", "name": "name" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the uniform exists, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#hasUniform", "scope": "instance", "___id": "T000002R035883", "___s": true }, { "comment": "/**\r\n * Resets the cached values of the given uniform.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#resetUniform\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to reset.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 449, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Resets the cached values of the given uniform.", "kind": "function", "name": "resetUniform", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to reset.", "name": "name" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#resetUniform", "scope": "instance", "___id": "T000002R035885", "___s": true }, { "comment": "/**\r\n * Sets the given uniform value/s based on the name and GL function.\r\n *\r\n * This method is called internally by other methods such as `set1f` and `set3iv`.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#setUniform1\r\n * @since 3.50.0\r\n *\r\n * @param {function} setter - The GL function to call.\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {(boolean|number|number[]|Float32Array)} value1 - The new value of the uniform.\r\n * @param {boolean} [skipCheck=false] - Skip the value comparison?\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 474, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the given uniform value/s based on the name and GL function.\r\rThis method is called internally by other methods such as `set1f` and `set3iv`.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "setUniform1", "since": "3.50.0", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The GL function to call.", "name": "setter" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean", "number", "Array.", "Float32Array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Float32Array" } ] } }, "description": "The new value of the uniform.", "name": "value1" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip the value comparison?", "name": "skipCheck" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#setUniform1", "scope": "instance", "___id": "T000002R035892", "___s": true }, { "comment": "/**\r\n * Sets the given uniform value/s based on the name and GL function.\r\n *\r\n * This method is called internally by other methods such as `set1f` and `set3iv`.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#setUniform2\r\n * @since 3.50.0\r\n *\r\n * @param {function} setter - The GL function to call.\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {(boolean|number|number[]|Float32Array)} value1 - The new value of the uniform.\r\n * @param {(boolean|number|number[]|Float32Array)} value2 - The new value of the uniform.\r\n * @param {boolean} [skipCheck=false] - Skip the value comparison?\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 518, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the given uniform value/s based on the name and GL function.\r\rThis method is called internally by other methods such as `set1f` and `set3iv`.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "setUniform2", "since": "3.50.0", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The GL function to call.", "name": "setter" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean", "number", "Array.", "Float32Array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Float32Array" } ] } }, "description": "The new value of the uniform.", "name": "value1" }, { "type": { "names": [ "boolean", "number", "Array.", "Float32Array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Float32Array" } ] } }, "description": "The new value of the uniform.", "name": "value2" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip the value comparison?", "name": "skipCheck" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#setUniform2", "scope": "instance", "___id": "T000002R035897", "___s": true }, { "comment": "/**\r\n * Sets the given uniform value/s based on the name and GL function.\r\n *\r\n * This method is called internally by other methods such as `set1f` and `set3iv`.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#setUniform3\r\n * @since 3.50.0\r\n *\r\n * @param {function} setter - The GL function to call.\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {(boolean|number|number[]|Float32Array)} value1 - The new value of the uniform.\r\n * @param {(boolean|number|number[]|Float32Array)} value2 - The new value of the uniform.\r\n * @param {(boolean|number|number[]|Float32Array)} value3 - The new value of the uniform.\r\n * @param {boolean} [skipCheck=false] - Skip the value comparison?\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the given uniform value/s based on the name and GL function.\r\rThis method is called internally by other methods such as `set1f` and `set3iv`.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "setUniform3", "since": "3.50.0", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The GL function to call.", "name": "setter" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean", "number", "Array.", "Float32Array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Float32Array" } ] } }, "description": "The new value of the uniform.", "name": "value1" }, { "type": { "names": [ "boolean", "number", "Array.", "Float32Array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Float32Array" } ] } }, "description": "The new value of the uniform.", "name": "value2" }, { "type": { "names": [ "boolean", "number", "Array.", "Float32Array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Float32Array" } ] } }, "description": "The new value of the uniform.", "name": "value3" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip the value comparison?", "name": "skipCheck" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#setUniform3", "scope": "instance", "___id": "T000002R035903", "___s": true }, { "comment": "/**\r\n * Sets the given uniform value/s based on the name and GL function.\r\n *\r\n * This method is called internally by other methods such as `set1f` and `set3iv`.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#setUniform4\r\n * @since 3.50.0\r\n *\r\n * @param {function} setter - The GL function to call.\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {(boolean|number|number[]|Float32Array)} value1 - The new value of the uniform.\r\n * @param {(boolean|number|number[]|Float32Array)} value2 - The new value of the uniform.\r\n * @param {(boolean|number|number[]|Float32Array)} value3 - The new value of the uniform.\r\n * @param {(boolean|number|number[]|Float32Array)} value4 - The new value of the uniform.\r\n * @param {boolean} [skipCheck=false] - Skip the value comparison?\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 612, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets the given uniform value/s based on the name and GL function.\r\rThis method is called internally by other methods such as `set1f` and `set3iv`.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "setUniform4", "since": "3.50.0", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The GL function to call.", "name": "setter" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean", "number", "Array.", "Float32Array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Float32Array" } ] } }, "description": "The new value of the uniform.", "name": "value1" }, { "type": { "names": [ "boolean", "number", "Array.", "Float32Array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Float32Array" } ] } }, "description": "The new value of the uniform.", "name": "value2" }, { "type": { "names": [ "boolean", "number", "Array.", "Float32Array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Float32Array" } ] } }, "description": "The new value of the uniform.", "name": "value3" }, { "type": { "names": [ "boolean", "number", "Array.", "Float32Array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Float32Array" } ] } }, "description": "The new value of the uniform.", "name": "value4" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip the value comparison?", "name": "skipCheck" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#setUniform4", "scope": "instance", "___id": "T000002R035910", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 662, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a boolean uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "setBoolean", "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#setBoolean", "scope": "instance", "___id": "T000002R035918", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 684, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 1f uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "set1f", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#set1f", "scope": "instance", "___id": "T000002R035920", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 706, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 2f uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "set2f", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#set2f", "scope": "instance", "___id": "T000002R035922", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 729, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 3f uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "set3f", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#set3f", "scope": "instance", "___id": "T000002R035924", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 753, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 4f uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "set4f", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#set4f", "scope": "instance", "___id": "T000002R035926", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 778, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 1fv uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "set1fv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#set1fv", "scope": "instance", "___id": "T000002R035928", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 800, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 2fv uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "set2fv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#set2fv", "scope": "instance", "___id": "T000002R035930", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 822, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 3fv uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "set3fv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#set3fv", "scope": "instance", "___id": "T000002R035932", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 844, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 4fv uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "set4fv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#set4fv", "scope": "instance", "___id": "T000002R035934", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 866, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 1iv uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "set1iv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#set1iv", "scope": "instance", "___id": "T000002R035936", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 888, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 2iv uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "set2iv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#set2iv", "scope": "instance", "___id": "T000002R035938", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 910, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 3iv uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "set3iv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#set3iv", "scope": "instance", "___id": "T000002R035940", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 932, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 4iv uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "set4iv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#set4iv", "scope": "instance", "___id": "T000002R035942", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 1i uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "set1i", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#set1i", "scope": "instance", "___id": "T000002R035944", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 2i uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "set2i", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#set2i", "scope": "instance", "___id": "T000002R035946", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 999, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 3i uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "set3i", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#set3i", "scope": "instance", "___id": "T000002R035948", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 1023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a 4i uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "set4i", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#set4i", "scope": "instance", "___id": "T000002R035950", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 1048, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a matrix 2fv uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "setMatrix2fv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#setMatrix2fv", "scope": "instance", "___id": "T000002R035952", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 1071, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a matrix 3fv uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "setMatrix3fv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#setMatrix3fv", "scope": "instance", "___id": "T000002R035954", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on this shader.\r\n *\r\n * The uniform is only set if the value/s given are different to those previously set.\r\n *\r\n * This method works by first setting this shader as being the current shader within the\r\n * WebGL Renderer, if it isn't already. It also sets this shader as being the current\r\n * one within the pipeline it belongs to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Should the matrix be transpose\r\n * @param {Float32Array} matrix - Matrix data\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 1094, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Sets a matrix 4fv uniform value based on the given name on this shader.\r\rThe uniform is only set if the value/s given are different to those previously set.\r\rThis method works by first setting this shader as being the current shader within the\rWebGL Renderer, if it isn't already. It also sets this shader as being the current\rone within the pipeline it belongs to.", "kind": "function", "name": "setMatrix4fv", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should the matrix be transpose", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "Matrix data", "name": "matrix" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#setMatrix4fv", "scope": "instance", "___id": "T000002R035956", "___s": true }, { "comment": "/**\r\n * This method will create the Shader Program on the current GL context.\r\n *\r\n * If a program already exists, it will be destroyed and the new one will take its place.\r\n *\r\n * After the program is created the uniforms will be reset and\r\n * this shader will be rebound.\r\n *\r\n * This is a very expensive process and if your shader is referenced elsewhere in\r\n * your game those references may then be lost, so be sure to use this carefully.\r\n *\r\n * However, if you need to update say the fragment shader source, then you can pass\r\n * the new source into this method and it'll rebuild the program using it. If you\r\n * don't want to change the vertex shader src, pass `undefined` as the parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#createProgram\r\n * @since 3.60.0\r\n *\r\n * @param {string} [vertSrc] - The source code of the vertex shader. If not given, uses the source already defined in this Shader.\r\n * @param {string} [fragSrc] - The source code of the fragment shader. If not given, uses the source already defined in this Shader.\r\n *\r\n * @return {this} This WebGLShader instance.\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 1117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "This method will create the Shader Program on the current GL context.\r\rIf a program already exists, it will be destroyed and the new one will take its place.\r\rAfter the program is created the uniforms will be reset and\rthis shader will be rebound.\r\rThis is a very expensive process and if your shader is referenced elsewhere in\ryour game those references may then be lost, so be sure to use this carefully.\r\rHowever, if you need to update say the fragment shader source, then you can pass\rthe new source into this method and it'll rebuild the program using it. If you\rdon't want to change the vertex shader src, pass `undefined` as the parameter.", "kind": "function", "name": "createProgram", "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The source code of the vertex shader. If not given, uses the source already defined in this Shader.", "name": "vertSrc" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The source code of the fragment shader. If not given, uses the source already defined in this Shader.", "name": "fragSrc" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLShader instance." } ], "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#createProgram", "scope": "instance", "___id": "T000002R035958", "___s": true }, { "comment": "/**\r\n * Removes all external references from this class and deletes the WebGL program from the WebGL context.\r\n *\r\n * Does not remove this shader from the parent pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLShader#destroy\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLShader.js", "lineno": 1162, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "description": "Removes all external references from this class and deletes the WebGL program from the WebGL context.\r\rDoes not remove this shader from the parent pipeline.", "kind": "function", "name": "destroy", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.WebGLShader", "longname": "Phaser.Renderer.WebGL.WebGLShader#destroy", "scope": "instance", "___id": "T000002R035966", "___s": true }, { "comment": "/**\r\n * Phaser Scale Manager constants for centering the game canvas.\r\n *\r\n * @namespace Phaser.Scale.Center\r\n * @memberof Phaser.Scale\r\n * @since 3.16.0\r\n */", "meta": { "filename": "CENTER_CONST.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "Phaser Scale Manager constants for centering the game canvas.", "kind": "namespace", "name": "Center", "memberof": "Phaser.Scale", "since": "3.16.0", "longname": "Phaser.Scale.Center", "scope": "static", "___id": "T000002R035975", "___s": true }, { "comment": "/**\r\n * Phaser Scale Manager constants for centering the game canvas.\r\n *\r\n * To find out what each mode does please see [Phaser.Scale.Center]{@link Phaser.Scale.Center}.\r\n *\r\n * @typedef {Phaser.Scale.Center} Phaser.Scale.CenterType\r\n * @memberof Phaser.Scale\r\n * @since 3.16.0\r\n */", "meta": { "filename": "CENTER_CONST.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "Phaser Scale Manager constants for centering the game canvas.\r\rTo find out what each mode does please see [Phaser.Scale.Center]{@link Phaser.Scale.Center}.", "kind": "typedef", "name": "CenterType", "type": { "names": [ "Phaser.Scale.Center" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.Center" } }, "memberof": "Phaser.Scale", "since": "3.16.0", "longname": "Phaser.Scale.CenterType", "scope": "static", "___id": "T000002R035976", "___s": true }, { "comment": "/**\r\n * The game canvas is not centered within the parent by Phaser.\r\n * You can still center it yourself via CSS.\r\n *\r\n * @name Phaser.Scale.Center.NO_CENTER\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "CENTER_CONST.js", "lineno": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The game canvas is not centered within the parent by Phaser.\rYou can still center it yourself via CSS.", "name": "NO_CENTER", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale.Center", "longname": "Phaser.Scale.Center.NO_CENTER", "scope": "static", "___id": "T000002R035978", "___s": true }, { "comment": "/**\r\n * The game canvas is centered both horizontally and vertically within the parent.\r\n * To do this, the parent has to have a bounds that can be calculated and not be empty.\r\n *\r\n * Centering is achieved by setting the margin left and top properties of the\r\n * game canvas, and does not factor in any other CSS styles you may have applied.\r\n *\r\n * @name Phaser.Scale.Center.CENTER_BOTH\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "CENTER_CONST.js", "lineno": 38, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The game canvas is centered both horizontally and vertically within the parent.\rTo do this, the parent has to have a bounds that can be calculated and not be empty.\r\rCentering is achieved by setting the margin left and top properties of the\rgame canvas, and does not factor in any other CSS styles you may have applied.", "name": "CENTER_BOTH", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale.Center", "longname": "Phaser.Scale.Center.CENTER_BOTH", "scope": "static", "___id": "T000002R035980", "___s": true }, { "comment": "/**\r\n * The game canvas is centered horizontally within the parent.\r\n * To do this, the parent has to have a bounds that can be calculated and not be empty.\r\n *\r\n * Centering is achieved by setting the margin left and top properties of the\r\n * game canvas, and does not factor in any other CSS styles you may have applied.\r\n *\r\n * @name Phaser.Scale.Center.CENTER_HORIZONTALLY\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "CENTER_CONST.js", "lineno": 52, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The game canvas is centered horizontally within the parent.\rTo do this, the parent has to have a bounds that can be calculated and not be empty.\r\rCentering is achieved by setting the margin left and top properties of the\rgame canvas, and does not factor in any other CSS styles you may have applied.", "name": "CENTER_HORIZONTALLY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale.Center", "longname": "Phaser.Scale.Center.CENTER_HORIZONTALLY", "scope": "static", "___id": "T000002R035982", "___s": true }, { "comment": "/**\r\n * The game canvas is centered both vertically within the parent.\r\n * To do this, the parent has to have a bounds that can be calculated and not be empty.\r\n *\r\n * Centering is achieved by setting the margin left and top properties of the\r\n * game canvas, and does not factor in any other CSS styles you may have applied.\r\n *\r\n * @name Phaser.Scale.Center.CENTER_VERTICALLY\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "CENTER_CONST.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The game canvas is centered both vertically within the parent.\rTo do this, the parent has to have a bounds that can be calculated and not be empty.\r\rCentering is achieved by setting the margin left and top properties of the\rgame canvas, and does not factor in any other CSS styles you may have applied.", "name": "CENTER_VERTICALLY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale.Center", "longname": "Phaser.Scale.Center.CENTER_VERTICALLY", "scope": "static", "___id": "T000002R035984", "___s": true }, { "comment": "/**\r\n * Phaser Scale Manager constants for orientation.\r\n *\r\n * @namespace Phaser.Scale.Orientation\r\n * @memberof Phaser.Scale\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ORIENTATION_CONST.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "Phaser Scale Manager constants for orientation.", "kind": "namespace", "name": "Orientation", "memberof": "Phaser.Scale", "since": "3.16.0", "longname": "Phaser.Scale.Orientation", "scope": "static", "___id": "T000002R035992", "___s": true }, { "comment": "/**\r\n * Phaser Scale Manager constants for orientation.\r\n *\r\n * To find out what each mode does please see [Phaser.Scale.Orientation]{@link Phaser.Scale.Orientation}.\r\n *\r\n * @typedef {Phaser.Scale.Orientation} Phaser.Scale.OrientationType\r\n * @memberof Phaser.Scale\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ORIENTATION_CONST.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "Phaser Scale Manager constants for orientation.\r\rTo find out what each mode does please see [Phaser.Scale.Orientation]{@link Phaser.Scale.Orientation}.", "kind": "typedef", "name": "OrientationType", "type": { "names": [ "Phaser.Scale.Orientation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.Orientation" } }, "memberof": "Phaser.Scale", "since": "3.16.0", "longname": "Phaser.Scale.OrientationType", "scope": "static", "___id": "T000002R035993", "___s": true }, { "comment": "/**\r\n * A landscape orientation.\r\n *\r\n * @name Phaser.Scale.Orientation.LANDSCAPE\r\n * @type {string}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ORIENTATION_CONST.js", "lineno": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "A landscape orientation.", "name": "LANDSCAPE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale.Orientation", "longname": "Phaser.Scale.Orientation.LANDSCAPE", "scope": "static", "___id": "T000002R035995", "___s": true }, { "comment": "/**\r\n * A portrait orientation.\r\n *\r\n * @name Phaser.Scale.Orientation.PORTRAIT\r\n * @type {string}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ORIENTATION_CONST.js", "lineno": 37, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "A portrait orientation.", "name": "PORTRAIT", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale.Orientation", "longname": "Phaser.Scale.Orientation.PORTRAIT", "scope": "static", "___id": "T000002R035997", "___s": true }, { "comment": "/**\r\n * Phaser Scale Manager constants for the different scale modes available.\r\n *\r\n * @namespace Phaser.Scale.ScaleModes\r\n * @memberof Phaser.Scale\r\n * @since 3.16.0\r\n */", "meta": { "filename": "SCALE_MODE_CONST.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "Phaser Scale Manager constants for the different scale modes available.", "kind": "namespace", "name": "ScaleModes", "memberof": "Phaser.Scale", "since": "3.16.0", "longname": "Phaser.Scale.ScaleModes", "scope": "static", "___id": "T000002R035999", "___s": true }, { "comment": "/**\r\n * Phaser Scale Manager constants for the different scale modes available.\r\n *\r\n * To find out what each mode does please see [Phaser.Scale.ScaleModes]{@link Phaser.Scale.ScaleModes}.\r\n *\r\n * @typedef {Phaser.Scale.ScaleModes} Phaser.Scale.ScaleModeType\r\n * @memberof Phaser.Scale\r\n * @since 3.16.0\r\n */", "meta": { "filename": "SCALE_MODE_CONST.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "Phaser Scale Manager constants for the different scale modes available.\r\rTo find out what each mode does please see [Phaser.Scale.ScaleModes]{@link Phaser.Scale.ScaleModes}.", "kind": "typedef", "name": "ScaleModeType", "type": { "names": [ "Phaser.Scale.ScaleModes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.ScaleModes" } }, "memberof": "Phaser.Scale", "since": "3.16.0", "longname": "Phaser.Scale.ScaleModeType", "scope": "static", "___id": "T000002R036000", "___s": true }, { "comment": "/**\r\n * No scaling happens at all. The canvas is set to the size given in the game config and Phaser doesn't change it\r\n * again from that point on. If you change the canvas size, either via CSS, or directly via code, then you need\r\n * to call the Scale Managers `resize` method to give the new dimensions, or input events will stop working.\r\n *\r\n * @name Phaser.Scale.ScaleModes.NONE\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "SCALE_MODE_CONST.js", "lineno": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "No scaling happens at all. The canvas is set to the size given in the game config and Phaser doesn't change it\ragain from that point on. If you change the canvas size, either via CSS, or directly via code, then you need\rto call the Scale Managers `resize` method to give the new dimensions, or input events will stop working.", "name": "NONE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale.ScaleModes", "longname": "Phaser.Scale.ScaleModes.NONE", "scope": "static", "___id": "T000002R036002", "___s": true }, { "comment": "/**\r\n * The height is automatically adjusted based on the width.\r\n *\r\n * @name Phaser.Scale.ScaleModes.WIDTH_CONTROLS_HEIGHT\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "SCALE_MODE_CONST.js", "lineno": 39, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The height is automatically adjusted based on the width.", "name": "WIDTH_CONTROLS_HEIGHT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale.ScaleModes", "longname": "Phaser.Scale.ScaleModes.WIDTH_CONTROLS_HEIGHT", "scope": "static", "___id": "T000002R036004", "___s": true }, { "comment": "/**\r\n * The width is automatically adjusted based on the height.\r\n *\r\n * @name Phaser.Scale.ScaleModes.HEIGHT_CONTROLS_WIDTH\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "SCALE_MODE_CONST.js", "lineno": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The width is automatically adjusted based on the height.", "name": "HEIGHT_CONTROLS_WIDTH", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale.ScaleModes", "longname": "Phaser.Scale.ScaleModes.HEIGHT_CONTROLS_WIDTH", "scope": "static", "___id": "T000002R036006", "___s": true }, { "comment": "/**\r\n * The width and height are automatically adjusted to fit inside the given target area,\r\n * while keeping the aspect ratio. Depending on the aspect ratio there may be some space\r\n * inside the area which is not covered.\r\n *\r\n * @name Phaser.Scale.ScaleModes.FIT\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "SCALE_MODE_CONST.js", "lineno": 59, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The width and height are automatically adjusted to fit inside the given target area,\rwhile keeping the aspect ratio. Depending on the aspect ratio there may be some space\rinside the area which is not covered.", "name": "FIT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale.ScaleModes", "longname": "Phaser.Scale.ScaleModes.FIT", "scope": "static", "___id": "T000002R036008", "___s": true }, { "comment": "/**\r\n * The width and height are automatically adjusted to make the size cover the entire target\r\n * area while keeping the aspect ratio. This may extend further out than the target size.\r\n *\r\n * @name Phaser.Scale.ScaleModes.ENVELOP\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "SCALE_MODE_CONST.js", "lineno": 71, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The width and height are automatically adjusted to make the size cover the entire target\rarea while keeping the aspect ratio. This may extend further out than the target size.", "name": "ENVELOP", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale.ScaleModes", "longname": "Phaser.Scale.ScaleModes.ENVELOP", "scope": "static", "___id": "T000002R036010", "___s": true }, { "comment": "/**\r\n * The Canvas is resized to fit all available _parent_ space, regardless of aspect ratio.\r\n *\r\n * @name Phaser.Scale.ScaleModes.RESIZE\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "SCALE_MODE_CONST.js", "lineno": 82, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The Canvas is resized to fit all available _parent_ space, regardless of aspect ratio.", "name": "RESIZE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale.ScaleModes", "longname": "Phaser.Scale.ScaleModes.RESIZE", "scope": "static", "___id": "T000002R036012", "___s": true }, { "comment": "/**\r\n * Phaser Scale Manager constants for zoom modes.\r\n *\r\n * @namespace Phaser.Scale.Zoom\r\n * @memberof Phaser.Scale\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ZOOM_CONST.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "Phaser Scale Manager constants for zoom modes.", "kind": "namespace", "name": "Zoom", "memberof": "Phaser.Scale", "since": "3.16.0", "longname": "Phaser.Scale.Zoom", "scope": "static", "___id": "T000002R036014", "___s": true }, { "comment": "/**\r\n * Phaser Scale Manager constants for zoom modes.\r\n *\r\n * To find out what each mode does please see [Phaser.Scale.Zoom]{@link Phaser.Scale.Zoom}.\r\n *\r\n * @typedef {Phaser.Scale.Zoom} Phaser.Scale.ZoomType\r\n * @memberof Phaser.Scale\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ZOOM_CONST.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "Phaser Scale Manager constants for zoom modes.\r\rTo find out what each mode does please see [Phaser.Scale.Zoom]{@link Phaser.Scale.Zoom}.", "kind": "typedef", "name": "ZoomType", "type": { "names": [ "Phaser.Scale.Zoom" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.Zoom" } }, "memberof": "Phaser.Scale", "since": "3.16.0", "longname": "Phaser.Scale.ZoomType", "scope": "static", "___id": "T000002R036015", "___s": true }, { "comment": "/**\r\n * The game canvas will not be zoomed by Phaser.\r\n *\r\n * @name Phaser.Scale.Zoom.NO_ZOOM\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ZOOM_CONST.js", "lineno": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The game canvas will not be zoomed by Phaser.", "name": "NO_ZOOM", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale.Zoom", "longname": "Phaser.Scale.Zoom.NO_ZOOM", "scope": "static", "___id": "T000002R036017", "___s": true }, { "comment": "/**\r\n * The game canvas will be 2x zoomed by Phaser.\r\n *\r\n * @name Phaser.Scale.Zoom.ZOOM_2X\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ZOOM_CONST.js", "lineno": 37, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The game canvas will be 2x zoomed by Phaser.", "name": "ZOOM_2X", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale.Zoom", "longname": "Phaser.Scale.Zoom.ZOOM_2X", "scope": "static", "___id": "T000002R036019", "___s": true }, { "comment": "/**\r\n * The game canvas will be 4x zoomed by Phaser.\r\n *\r\n * @name Phaser.Scale.Zoom.ZOOM_4X\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ZOOM_CONST.js", "lineno": 47, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The game canvas will be 4x zoomed by Phaser.", "name": "ZOOM_4X", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale.Zoom", "longname": "Phaser.Scale.Zoom.ZOOM_4X", "scope": "static", "___id": "T000002R036021", "___s": true }, { "comment": "/**\r\n * Calculate the zoom value based on the maximum multiplied game size that will\r\n * fit into the parent, or browser window if no parent is set.\r\n *\r\n * @name Phaser.Scale.Zoom.MAX_ZOOM\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ZOOM_CONST.js", "lineno": 57, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "Calculate the zoom value based on the maximum multiplied game size that will\rfit into the parent, or browser window if no parent is set.", "name": "MAX_ZOOM", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale.Zoom", "longname": "Phaser.Scale.Zoom.MAX_ZOOM", "scope": "static", "___id": "T000002R036023", "___s": true }, { "comment": "/**\r\n * The Scale Manager has successfully entered fullscreen mode.\r\n *\r\n * @event Phaser.Scale.Events#ENTER_FULLSCREEN\r\n * @type {string}\r\n * @since 3.16.1\r\n */", "meta": { "filename": "ENTER_FULLSCREEN_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale\\events", "code": {} }, "description": "The Scale Manager has successfully entered fullscreen mode.", "kind": "event", "name": "ENTER_FULLSCREEN", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.1", "memberof": "Phaser.Scale.Events", "longname": "Phaser.Scale.Events#event:ENTER_FULLSCREEN", "scope": "instance", "___id": "T000002R036025", "___s": true }, { "comment": "/**\r\n * The Scale Manager tried to enter fullscreen mode but failed.\r\n *\r\n * @event Phaser.Scale.Events#FULLSCREEN_FAILED\r\n * @type {string}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "FULLSCREEN_FAILED_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale\\events", "code": {} }, "description": "The Scale Manager tried to enter fullscreen mode but failed.", "kind": "event", "name": "FULLSCREEN_FAILED", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.17.0", "memberof": "Phaser.Scale.Events", "longname": "Phaser.Scale.Events#event:FULLSCREEN_FAILED", "scope": "instance", "___id": "T000002R036027", "___s": true }, { "comment": "/**\r\n * The Scale Manager tried to enter fullscreen mode, but it is unsupported by the browser.\r\n *\r\n * @event Phaser.Scale.Events#FULLSCREEN_UNSUPPORTED\r\n * @type {string}\r\n * @since 3.16.1\r\n */", "meta": { "filename": "FULLSCREEN_UNSUPPORTED_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale\\events", "code": {} }, "description": "The Scale Manager tried to enter fullscreen mode, but it is unsupported by the browser.", "kind": "event", "name": "FULLSCREEN_UNSUPPORTED", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.1", "memberof": "Phaser.Scale.Events", "longname": "Phaser.Scale.Events#event:FULLSCREEN_UNSUPPORTED", "scope": "instance", "___id": "T000002R036029", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Scale.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.Events", "scope": "static", "___id": "T000002R036031", "___s": true }, { "comment": "/**\r\n * The Scale Manager was in fullscreen mode, but has since left, either directly via game code,\r\n * or via a user gestured, such as pressing the ESC key.\r\n *\r\n * @event Phaser.Scale.Events#LEAVE_FULLSCREEN\r\n * @type {string}\r\n * @since 3.16.1\r\n */", "meta": { "filename": "LEAVE_FULLSCREEN_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale\\events", "code": {} }, "description": "The Scale Manager was in fullscreen mode, but has since left, either directly via game code,\ror via a user gestured, such as pressing the ESC key.", "kind": "event", "name": "LEAVE_FULLSCREEN", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.1", "memberof": "Phaser.Scale.Events", "longname": "Phaser.Scale.Events#event:LEAVE_FULLSCREEN", "scope": "instance", "___id": "T000002R036039", "___s": true }, { "comment": "/**\r\n * The Scale Manager Orientation Change Event.\r\n *\r\n * This event is dispatched whenever the Scale Manager detects an orientation change event from the browser.\r\n *\r\n * @event Phaser.Scale.Events#ORIENTATION_CHANGE\r\n * @type {string}\r\n * @since 3.16.1\r\n *\r\n * @param {string} orientation - The new orientation value. Either `Phaser.Scale.Orientation.LANDSCAPE` or `Phaser.Scale.Orientation.PORTRAIT`.\r\n */", "meta": { "filename": "ORIENTATION_CHANGE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale\\events", "code": {} }, "description": "The Scale Manager Orientation Change Event.\r\rThis event is dispatched whenever the Scale Manager detects an orientation change event from the browser.", "kind": "event", "name": "ORIENTATION_CHANGE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.1", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The new orientation value. Either `Phaser.Scale.Orientation.LANDSCAPE` or `Phaser.Scale.Orientation.PORTRAIT`.", "name": "orientation" } ], "memberof": "Phaser.Scale.Events", "longname": "Phaser.Scale.Events#event:ORIENTATION_CHANGE", "scope": "instance", "___id": "T000002R036041", "___s": true }, { "comment": "/**\r\n * The Scale Manager Resize Event.\r\n *\r\n * This event is dispatched whenever the Scale Manager detects a resize event from the browser.\r\n * It sends three parameters to the callback, each of them being Size components. You can read\r\n * the `width`, `height`, `aspectRatio` and other properties of these components to help with\r\n * scaling your own game content.\r\n *\r\n * @event Phaser.Scale.Events#RESIZE\r\n * @type {string}\r\n * @since 3.16.1\r\n *\r\n * @param {Phaser.Structs.Size} gameSize - A reference to the Game Size component. This is the un-scaled size of your game canvas.\r\n * @param {Phaser.Structs.Size} baseSize - A reference to the Base Size component. This is the game size.\r\n * @param {Phaser.Structs.Size} displaySize - A reference to the Display Size component. This is the scaled canvas size, after applying zoom and scale mode.\r\n * @param {number} previousWidth - If the `gameSize` has changed, this value contains its previous width, otherwise it contains the current width.\r\n * @param {number} previousHeight - If the `gameSize` has changed, this value contains its previous height, otherwise it contains the current height.\r\n */", "meta": { "filename": "RESIZE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale\\events", "code": {} }, "description": "The Scale Manager Resize Event.\r\rThis event is dispatched whenever the Scale Manager detects a resize event from the browser.\rIt sends three parameters to the callback, each of them being Size components. You can read\rthe `width`, `height`, `aspectRatio` and other properties of these components to help with\rscaling your own game content.", "kind": "event", "name": "RESIZE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.1", "params": [ { "type": { "names": [ "Phaser.Structs.Size" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Size" } }, "description": "A reference to the Game Size component. This is the un-scaled size of your game canvas.", "name": "gameSize" }, { "type": { "names": [ "Phaser.Structs.Size" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Size" } }, "description": "A reference to the Base Size component. This is the game size.", "name": "baseSize" }, { "type": { "names": [ "Phaser.Structs.Size" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Size" } }, "description": "A reference to the Display Size component. This is the scaled canvas size, after applying zoom and scale mode.", "name": "displaySize" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "If the `gameSize` has changed, this value contains its previous width, otherwise it contains the current width.", "name": "previousWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "If the `gameSize` has changed, this value contains its previous height, otherwise it contains the current height.", "name": "previousHeight" } ], "memberof": "Phaser.Scale.Events", "longname": "Phaser.Scale.Events#event:RESIZE", "scope": "instance", "___id": "T000002R036043", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Scale\r\n *\r\n * @borrows Phaser.Scale.Center.NO_CENTER as NO_CENTER\r\n * @borrows Phaser.Scale.Center.CENTER_BOTH as CENTER_BOTH\r\n * @borrows Phaser.Scale.Center.CENTER_HORIZONTALLY as CENTER_HORIZONTALLY\r\n * @borrows Phaser.Scale.Center.CENTER_VERTICALLY as CENTER_VERTICALLY\r\n *\r\n * @borrows Phaser.Scale.Orientation.LANDSCAPE as LANDSCAPE\r\n * @borrows Phaser.Scale.Orientation.PORTRAIT as PORTRAIT\r\n *\r\n * @borrows Phaser.Scale.ScaleModes.NONE as NONE\r\n * @borrows Phaser.Scale.ScaleModes.WIDTH_CONTROLS_HEIGHT as WIDTH_CONTROLS_HEIGHT\r\n * @borrows Phaser.Scale.ScaleModes.HEIGHT_CONTROLS_WIDTH as HEIGHT_CONTROLS_WIDTH\r\n * @borrows Phaser.Scale.ScaleModes.FIT as FIT\r\n * @borrows Phaser.Scale.ScaleModes.ENVELOP as ENVELOP\r\n * @borrows Phaser.Scale.ScaleModes.RESIZE as RESIZE\r\n *\r\n * @borrows Phaser.Scale.Zoom.NO_ZOOM as NO_ZOOM\r\n * @borrows Phaser.Scale.Zoom.ZOOM_2X as ZOOM_2X\r\n * @borrows Phaser.Scale.Zoom.ZOOM_4X as ZOOM_4X\r\n * @borrows Phaser.Scale.Zoom.MAX_ZOOM as MAX_ZOOM\r\n */", "meta": { "filename": "index.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "kind": "namespace", "name": "Scale", "memberof": "Phaser", "longname": "Phaser.Scale", "scope": "static", "___id": "T000002R036047", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Scale Manager handles the scaling, resizing and alignment of the game canvas.\r\n *\r\n * The way scaling is handled is by setting the game canvas to a fixed size, which is defined in the\r\n * game configuration. You also define the parent container in the game config. If no parent is given,\r\n * it will default to using the document body. The Scale Manager will then look at the available space\r\n * within the _parent_ and scale the canvas accordingly. Scaling is handled by setting the canvas CSS\r\n * width and height properties, leaving the width and height of the canvas element itself untouched.\r\n * Scaling is therefore achieved by keeping the core canvas the same size and 'stretching'\r\n * it via its CSS properties. This gives the same result and speed as using the `transform-scale` CSS\r\n * property, without the need for browser prefix handling.\r\n *\r\n * The calculations for the scale are heavily influenced by the bounding parent size, which is the computed\r\n * dimensions of the canvas's parent. The CSS rules of the parent element play an important role in the\r\n * operation of the Scale Manager. For example, if the parent has no defined width or height, then actions\r\n * like auto-centering will fail to achieve the required result. The Scale Manager works in tandem with the\r\n * CSS you set-up on the page hosting your game, rather than taking control of it.\r\n *\r\n * #### Parent and Display canvas containment guidelines:\r\n *\r\n * - Style the Parent element (of the game canvas) to control the Parent size and thus the games size and layout.\r\n *\r\n * - The Parent element's CSS styles should _effectively_ apply maximum (and minimum) bounding behavior.\r\n *\r\n * - The Parent element should _not_ apply a padding as this is not accounted for.\r\n * If a padding is required apply it to the Parent's parent or apply a margin to the Parent.\r\n * If you need to add a border, margin or any other CSS around your game container, then use a parent element and\r\n * apply the CSS to this instead, otherwise you'll be constantly resizing the shape of the game container.\r\n *\r\n * - The Display canvas layout CSS styles (i.e. margins, size) should not be altered / specified as\r\n * they may be updated by the Scale Manager.\r\n *\r\n * #### Scale Modes\r\n *\r\n * The way the scaling is handled is determined by the `scaleMode` property. The default is `NONE`,\r\n * which prevents Phaser from scaling or touching the canvas, or its parent, at all. In this mode, you are\r\n * responsible for all scaling. The other scaling modes afford you automatic scaling.\r\n *\r\n * If you wish to scale your game so that it always fits into the available space within the parent, you\r\n * should use the scale mode `FIT`. Look at the documentation for other scale modes to see what options are\r\n * available. Here is a basic config showing how to set this scale mode:\r\n *\r\n * ```javascript\r\n * scale: {\r\n * parent: 'yourgamediv',\r\n * mode: Phaser.Scale.FIT,\r\n * width: 800,\r\n * height: 600\r\n * }\r\n * ```\r\n *\r\n * Place the `scale` config object within your game config.\r\n *\r\n * If you wish for the canvas to be resized directly, so that the canvas itself fills the available space\r\n * (i.e. it isn't scaled, it's resized) then use the `RESIZE` scale mode. This will give you a 1:1 mapping\r\n * of canvas pixels to game size. In this mode CSS isn't used to scale the canvas, it's literally adjusted\r\n * to fill all available space within the parent. You should be extremely careful about the size of the\r\n * canvas you're creating when doing this, as the larger the area, the more work the GPU has to do and it's\r\n * very easy to hit fill-rate limits quickly.\r\n *\r\n * For complex, custom-scaling requirements, you should probably consider using the `RESIZE` scale mode,\r\n * with your own limitations in place re: canvas dimensions and managing the scaling with the game scenes\r\n * yourself. For the vast majority of games, however, the `FIT` mode is likely to be the most used.\r\n *\r\n * Please appreciate that the Scale Manager cannot perform miracles. All it does is scale your game canvas\r\n * as best it can, based on what it can infer from its surrounding area. There are all kinds of environments\r\n * where it's up to you to guide and help the canvas position itself, especially when built into rendering\r\n * frameworks like React and Vue. If your page requires meta tags to prevent user scaling gestures, or such\r\n * like, then it's up to you to ensure they are present in the html.\r\n *\r\n * #### Centering\r\n *\r\n * You can also have the game canvas automatically centered. Again, this relies heavily on the parent being\r\n * properly configured and styled, as the centering offsets are based entirely on the available space\r\n * within the parent element. Centering is disabled by default, or can be applied horizontally, vertically,\r\n * or both. Here's an example:\r\n *\r\n * ```javascript\r\n * scale: {\r\n * parent: 'yourgamediv',\r\n * autoCenter: Phaser.Scale.CENTER_BOTH,\r\n * width: 800,\r\n * height: 600\r\n * }\r\n * ```\r\n *\r\n * #### Fullscreen API\r\n *\r\n * If the browser supports it, you can send your game into fullscreen mode. In this mode, the game will fill\r\n * the entire display, removing all browser UI and anything else present on the screen. It will remain in this\r\n * mode until your game either disables it, or until the user tabs out or presses ESCape if on desktop. It's a\r\n * great way to achieve a desktop-game like experience from the browser, but it does require a modern browser\r\n * to handle it. Some mobile browsers also support this.\r\n *\r\n * @class ScaleManager\r\n * @memberof Phaser.Scale\r\n * @extends Phaser.Events.EventEmitter\r\n * @constructor\r\n * @since 3.16.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser.Game instance.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 22, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "classdesc": "The Scale Manager handles the scaling, resizing and alignment of the game canvas.\r\rThe way scaling is handled is by setting the game canvas to a fixed size, which is defined in the\rgame configuration. You also define the parent container in the game config. If no parent is given,\rit will default to using the document body. The Scale Manager will then look at the available space\rwithin the _parent_ and scale the canvas accordingly. Scaling is handled by setting the canvas CSS\rwidth and height properties, leaving the width and height of the canvas element itself untouched.\rScaling is therefore achieved by keeping the core canvas the same size and 'stretching'\rit via its CSS properties. This gives the same result and speed as using the `transform-scale` CSS\rproperty, without the need for browser prefix handling.\r\rThe calculations for the scale are heavily influenced by the bounding parent size, which is the computed\rdimensions of the canvas's parent. The CSS rules of the parent element play an important role in the\roperation of the Scale Manager. For example, if the parent has no defined width or height, then actions\rlike auto-centering will fail to achieve the required result. The Scale Manager works in tandem with the\rCSS you set-up on the page hosting your game, rather than taking control of it.\r\r#### Parent and Display canvas containment guidelines:\r\r- Style the Parent element (of the game canvas) to control the Parent size and thus the games size and layout.\r\r- The Parent element's CSS styles should _effectively_ apply maximum (and minimum) bounding behavior.\r\r- The Parent element should _not_ apply a padding as this is not accounted for.\r If a padding is required apply it to the Parent's parent or apply a margin to the Parent.\r If you need to add a border, margin or any other CSS around your game container, then use a parent element and\r apply the CSS to this instead, otherwise you'll be constantly resizing the shape of the game container.\r\r- The Display canvas layout CSS styles (i.e. margins, size) should not be altered / specified as\r they may be updated by the Scale Manager.\r\r#### Scale Modes\r\rThe way the scaling is handled is determined by the `scaleMode` property. The default is `NONE`,\rwhich prevents Phaser from scaling or touching the canvas, or its parent, at all. In this mode, you are\rresponsible for all scaling. The other scaling modes afford you automatic scaling.\r\rIf you wish to scale your game so that it always fits into the available space within the parent, you\rshould use the scale mode `FIT`. Look at the documentation for other scale modes to see what options are\ravailable. Here is a basic config showing how to set this scale mode:\r\r```javascript\rscale: {\r parent: 'yourgamediv',\r mode: Phaser.Scale.FIT,\r width: 800,\r height: 600\r}\r```\r\rPlace the `scale` config object within your game config.\r\rIf you wish for the canvas to be resized directly, so that the canvas itself fills the available space\r(i.e. it isn't scaled, it's resized) then use the `RESIZE` scale mode. This will give you a 1:1 mapping\rof canvas pixels to game size. In this mode CSS isn't used to scale the canvas, it's literally adjusted\rto fill all available space within the parent. You should be extremely careful about the size of the\rcanvas you're creating when doing this, as the larger the area, the more work the GPU has to do and it's\rvery easy to hit fill-rate limits quickly.\r\rFor complex, custom-scaling requirements, you should probably consider using the `RESIZE` scale mode,\rwith your own limitations in place re: canvas dimensions and managing the scaling with the game scenes\ryourself. For the vast majority of games, however, the `FIT` mode is likely to be the most used.\r\rPlease appreciate that the Scale Manager cannot perform miracles. All it does is scale your game canvas\ras best it can, based on what it can infer from its surrounding area. There are all kinds of environments\rwhere it's up to you to guide and help the canvas position itself, especially when built into rendering\rframeworks like React and Vue. If your page requires meta tags to prevent user scaling gestures, or such\rlike, then it's up to you to ensure they are present in the html.\r\r#### Centering\r\rYou can also have the game canvas automatically centered. Again, this relies heavily on the parent being\rproperly configured and styled, as the centering offsets are based entirely on the available space\rwithin the parent element. Centering is disabled by default, or can be applied horizontally, vertically,\ror both. Here's an example:\r\r```javascript\rscale: {\r parent: 'yourgamediv',\r autoCenter: Phaser.Scale.CENTER_BOTH,\r width: 800,\r height: 600\r}\r```\r\r#### Fullscreen API\r\rIf the browser supports it, you can send your game into fullscreen mode. In this mode, the game will fill\rthe entire display, removing all browser UI and anything else present on the screen. It will remain in this\rmode until your game either disables it, or until the user tabs out or presses ESCape if on desktop. It's a\rgreat way to achieve a desktop-game like experience from the browser, but it does require a modern browser\rto handle it. Some mobile browsers also support this.", "kind": "class", "name": "ScaleManager", "memberof": "Phaser.Scale", "augments": [ "Phaser.Events.EventEmitter" ], "since": "3.16.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "A reference to the Phaser.Game instance.", "name": "game" } ], "scope": "static", "longname": "Phaser.Scale.ScaleManager", "___id": "T000002R036074", "___s": true }, { "comment": "/**\r\n * A reference to the Phaser.Game instance.\r\n *\r\n * @name Phaser.Scale.ScaleManager#game\r\n * @type {Phaser.Game}\r\n * @readonly\r\n * @since 3.15.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 135, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "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.15.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#game", "scope": "instance", "kind": "member", "___id": "T000002R036078", "___s": true }, { "comment": "/**\r\n * A reference to the HTML Canvas Element that Phaser uses to render the game.\r\n *\r\n * @name Phaser.Scale.ScaleManager#canvas\r\n * @type {HTMLCanvasElement}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "A reference to the HTML Canvas Element that Phaser uses to render the game.", "name": "canvas", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#canvas", "scope": "instance", "kind": "member", "___id": "T000002R036080", "___s": true }, { "comment": "/**\r\n * The DOM bounds of the canvas element.\r\n *\r\n * @name Phaser.Scale.ScaleManager#canvasBounds\r\n * @type {Phaser.Geom.Rectangle}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "The DOM bounds of the canvas element.", "name": "canvasBounds", "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#canvasBounds", "scope": "instance", "kind": "member", "___id": "T000002R036082", "___s": true }, { "comment": "/**\r\n * The parent object of the Canvas. Often a div, or the browser window, or nothing in non-browser environments.\r\n *\r\n * This is set in the Game Config as the `parent` property. If undefined (or just not present), it will default\r\n * to use the document body. If specifically set to `null` Phaser will ignore all parent operations.\r\n *\r\n * @name Phaser.Scale.ScaleManager#parent\r\n * @type {?any}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "The parent object of the Canvas. Often a div, or the browser window, or nothing in non-browser environments.\r\rThis is set in the Game Config as the `parent` property. If undefined (or just not present), it will default\rto use the document body. If specifically set to `null` Phaser will ignore all parent operations.", "name": "parent", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "nullable": true } }, "nullable": true, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#parent", "scope": "instance", "kind": "member", "___id": "T000002R036084", "___s": true }, { "comment": "/**\r\n * Is the parent element the browser window?\r\n *\r\n * @name Phaser.Scale.ScaleManager#parentIsWindow\r\n * @type {boolean}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Is the parent element the browser window?", "name": "parentIsWindow", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#parentIsWindow", "scope": "instance", "kind": "member", "___id": "T000002R036086", "___s": true }, { "comment": "/**\r\n * The Parent Size component.\r\n *\r\n * @name Phaser.Scale.ScaleManager#parentSize\r\n * @type {Phaser.Structs.Size}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 184, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "The Parent Size component.", "name": "parentSize", "type": { "names": [ "Phaser.Structs.Size" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Size" } }, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#parentSize", "scope": "instance", "kind": "member", "___id": "T000002R036088", "___s": true }, { "comment": "/**\r\n * The Game Size component.\r\n *\r\n * The un-modified game size, as requested in the game config (the raw width / height),\r\n * as used for world bounds, cameras, etc\r\n *\r\n * @name Phaser.Scale.ScaleManager#gameSize\r\n * @type {Phaser.Structs.Size}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 193, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "The Game Size component.\r\rThe un-modified game size, as requested in the game config (the raw width / height),\ras used for world bounds, cameras, etc", "name": "gameSize", "type": { "names": [ "Phaser.Structs.Size" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Size" } }, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#gameSize", "scope": "instance", "kind": "member", "___id": "T000002R036090", "___s": true }, { "comment": "/**\r\n * The Base Size component.\r\n *\r\n * The modified game size, which is the auto-rounded gameSize, used to set the canvas width and height\r\n * (but not the CSS style)\r\n *\r\n * @name Phaser.Scale.ScaleManager#baseSize\r\n * @type {Phaser.Structs.Size}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 205, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "The Base Size component.\r\rThe modified game size, which is the auto-rounded gameSize, used to set the canvas width and height\r(but not the CSS style)", "name": "baseSize", "type": { "names": [ "Phaser.Structs.Size" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Size" } }, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#baseSize", "scope": "instance", "kind": "member", "___id": "T000002R036092", "___s": true }, { "comment": "/**\r\n * The Display Size component.\r\n *\r\n * The size used for the canvas style, factoring in the scale mode, parent and other values.\r\n *\r\n * @name Phaser.Scale.ScaleManager#displaySize\r\n * @type {Phaser.Structs.Size}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 217, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "The Display Size component.\r\rThe size used for the canvas style, factoring in the scale mode, parent and other values.", "name": "displaySize", "type": { "names": [ "Phaser.Structs.Size" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Size" } }, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#displaySize", "scope": "instance", "kind": "member", "___id": "T000002R036094", "___s": true }, { "comment": "/**\r\n * The game scale mode.\r\n *\r\n * @name Phaser.Scale.ScaleManager#scaleMode\r\n * @type {Phaser.Scale.ScaleModeType}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 228, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "The game scale mode.", "name": "scaleMode", "type": { "names": [ "Phaser.Scale.ScaleModeType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.ScaleModeType" } }, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#scaleMode", "scope": "instance", "kind": "member", "___id": "T000002R036096", "___s": true }, { "comment": "/**\r\n * The game zoom factor.\r\n *\r\n * This value allows you to multiply your games base size by the given zoom factor.\r\n * This is then used when calculating the display size, even in `NONE` situations.\r\n * If you don't want Phaser to touch the canvas style at all, this value should be 1.\r\n *\r\n * Can also be set to `MAX_ZOOM` in which case the zoom value will be derived based\r\n * on the game size and available space within the parent.\r\n *\r\n * @name Phaser.Scale.ScaleManager#zoom\r\n * @type {number}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 237, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "The game zoom factor.\r\rThis value allows you to multiply your games base size by the given zoom factor.\rThis is then used when calculating the display size, even in `NONE` situations.\rIf you don't want Phaser to touch the canvas style at all, this value should be 1.\r\rCan also be set to `MAX_ZOOM` in which case the zoom value will be derived based\ron the game size and available space within the parent.", "name": "zoom", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#zoom", "scope": "instance", "kind": "member", "___id": "T000002R036098", "___s": true }, { "comment": "/**\r\n * Internal flag set when the game zoom factor is modified.\r\n *\r\n * @name Phaser.Scale.ScaleManager#_resetZoom\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.19.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 253, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Internal flag set when the game zoom factor is modified.", "name": "_resetZoom", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.19.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#_resetZoom", "scope": "instance", "kind": "member", "___id": "T000002R036100", "___s": true }, { "comment": "/**\r\n * The scale factor between the baseSize and the canvasBounds.\r\n *\r\n * @name Phaser.Scale.ScaleManager#displayScale\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 263, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "The scale factor between the baseSize and the canvasBounds.", "name": "displayScale", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#displayScale", "scope": "instance", "kind": "member", "___id": "T000002R036102", "___s": true }, { "comment": "/**\r\n * If set, the canvas sizes will be automatically passed through Math.floor.\r\n * This results in rounded pixel display values, which is important for performance on legacy\r\n * and low powered devices, but at the cost of not achieving a 'perfect' fit in some browser windows.\r\n *\r\n * @name Phaser.Scale.ScaleManager#autoRound\r\n * @type {boolean}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 272, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "If set, the canvas sizes will be automatically passed through Math.floor.\rThis results in rounded pixel display values, which is important for performance on legacy\rand low powered devices, but at the cost of not achieving a 'perfect' fit in some browser windows.", "name": "autoRound", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#autoRound", "scope": "instance", "kind": "member", "___id": "T000002R036104", "___s": true }, { "comment": "/**\r\n * Automatically center the canvas within the parent? The different centering modes are:\r\n *\r\n * 1. No centering.\r\n * 2. Center both horizontally and vertically.\r\n * 3. Center horizontally.\r\n * 4. Center vertically.\r\n *\r\n * Please be aware that in order to center the game canvas, you must have specified a parent\r\n * that has a size set, or the canvas parent is the document.body.\r\n *\r\n * @name Phaser.Scale.ScaleManager#autoCenter\r\n * @type {Phaser.Scale.CenterType}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 283, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Automatically center the canvas within the parent? The different centering modes are:\r\r1. No centering.\r2. Center both horizontally and vertically.\r3. Center horizontally.\r4. Center vertically.\r\rPlease be aware that in order to center the game canvas, you must have specified a parent\rthat has a size set, or the canvas parent is the document.body.", "name": "autoCenter", "type": { "names": [ "Phaser.Scale.CenterType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.CenterType" } }, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#autoCenter", "scope": "instance", "kind": "member", "___id": "T000002R036106", "___s": true }, { "comment": "/**\r\n * The current device orientation.\r\n *\r\n * Orientation events are dispatched via the Device Orientation API, typically only on mobile browsers.\r\n *\r\n * @name Phaser.Scale.ScaleManager#orientation\r\n * @type {Phaser.Scale.OrientationType}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 300, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "The current device orientation.\r\rOrientation events are dispatched via the Device Orientation API, typically only on mobile browsers.", "name": "orientation", "type": { "names": [ "Phaser.Scale.OrientationType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.OrientationType" } }, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#orientation", "scope": "instance", "kind": "member", "___id": "T000002R036108", "___s": true }, { "comment": "/**\r\n * A reference to the Device.Fullscreen object.\r\n *\r\n * @name Phaser.Scale.ScaleManager#fullscreen\r\n * @type {Phaser.Device.Fullscreen}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 311, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "A reference to the Device.Fullscreen object.", "name": "fullscreen", "type": { "names": [ "Phaser.Device.Fullscreen" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Device.Fullscreen" } }, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#fullscreen", "scope": "instance", "kind": "member", "___id": "T000002R036110", "___s": true }, { "comment": "/**\r\n * The DOM Element which is sent into fullscreen mode.\r\n *\r\n * @name Phaser.Scale.ScaleManager#fullscreenTarget\r\n * @type {?any}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 320, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "The DOM Element which is sent into fullscreen mode.", "name": "fullscreenTarget", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "nullable": true } }, "nullable": true, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#fullscreenTarget", "scope": "instance", "kind": "member", "___id": "T000002R036112", "___s": true }, { "comment": "/**\r\n * The dirty state of the Scale Manager.\r\n * Set if there is a change between the parent size and the current size.\r\n *\r\n * @name Phaser.Scale.ScaleManager#dirty\r\n * @type {boolean}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 339, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "The dirty state of the Scale Manager.\rSet if there is a change between the parent size and the current size.", "name": "dirty", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#dirty", "scope": "instance", "kind": "member", "___id": "T000002R036116", "___s": true }, { "comment": "/**\r\n * How many milliseconds should elapse before checking if the browser size has changed?\r\n *\r\n * Most modern browsers dispatch a 'resize' event, which the Scale Manager will listen for.\r\n * However, older browsers fail to do this, or do it consistently, so we fall back to a\r\n * more traditional 'size check' based on a time interval. You can control how often it is\r\n * checked here.\r\n *\r\n * @name Phaser.Scale.ScaleManager#resizeInterval\r\n * @type {number}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 349, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "How many milliseconds should elapse before checking if the browser size has changed?\r\rMost modern browsers dispatch a 'resize' event, which the Scale Manager will listen for.\rHowever, older browsers fail to do this, or do it consistently, so we fall back to a\rmore traditional 'size check' based on a time interval. You can control how often it is\rchecked here.", "name": "resizeInterval", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#resizeInterval", "scope": "instance", "kind": "member", "___id": "T000002R036118", "___s": true }, { "comment": "/**\r\n * Called _before_ the canvas object is created and added to the DOM.\r\n *\r\n * @method Phaser.Scale.ScaleManager#preBoot\r\n * @protected\r\n * @listens Phaser.Core.Events#BOOT\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 401, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Called _before_ the canvas object is created and added to the DOM.", "kind": "function", "name": "preBoot", "access": "protected", "listens": [ "Phaser.Core.Events#event:BOOT" ], "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#preBoot", "scope": "instance", "___id": "T000002R036130", "___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 and the canvas has been added to the DOM.\r\n *\r\n * @method Phaser.Scale.ScaleManager#boot\r\n * @protected\r\n * @fires Phaser.Scale.Events#RESIZE\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 417, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "The Boot handler is called by Phaser.Game when it first starts up.\rThe renderer is available by now and the canvas has been added to the DOM.", "kind": "function", "name": "boot", "access": "protected", "fires": [ "Phaser.Scale.Events#event:RESIZE" ], "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#boot", "scope": "instance", "___id": "T000002R036132", "___s": true }, { "comment": "/**\r\n * Parses the game configuration to set-up the scale defaults.\r\n *\r\n * @method Phaser.Scale.ScaleManager#parseConfig\r\n * @protected\r\n * @since 3.16.0\r\n *\r\n * @param {Phaser.Types.Core.GameConfig} config - The Game configuration object.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Parses the game configuration to set-up the scale defaults.", "kind": "function", "name": "parseConfig", "access": "protected", "since": "3.16.0", "params": [ { "type": { "names": [ "Phaser.Types.Core.GameConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.GameConfig" } }, "description": "The Game configuration object.", "name": "config" } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#parseConfig", "scope": "instance", "___id": "T000002R036137", "___s": true }, { "comment": "/**\r\n * Determines the parent element of the game canvas, if any, based on the game configuration.\r\n *\r\n * @method Phaser.Scale.ScaleManager#getParent\r\n * @since 3.16.0\r\n *\r\n * @param {Phaser.Types.Core.GameConfig} config - The Game configuration object.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Determines the parent element of the game canvas, if any, based on the game configuration.", "kind": "function", "name": "getParent", "since": "3.16.0", "params": [ { "type": { "names": [ "Phaser.Types.Core.GameConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.GameConfig" } }, "description": "The Game configuration object.", "name": "config" } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#getParent", "scope": "instance", "___id": "T000002R036166", "___s": true }, { "comment": "/**\r\n * Calculates the size of the parent bounds and updates the `parentSize`\r\n * properties, only if the canvas has a dom parent.\r\n *\r\n * @method Phaser.Scale.ScaleManager#getParentBounds\r\n * @since 3.16.0\r\n *\r\n * @return {boolean} `true` if the parent bounds have changed size or position, otherwise `false`.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 641, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Calculates the size of the parent bounds and updates the `parentSize`\rproperties, only if the canvas has a dom parent.", "kind": "function", "name": "getParentBounds", "since": "3.16.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the parent bounds have changed size or position, otherwise `false`." } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#getParentBounds", "scope": "instance", "___id": "T000002R036179", "___s": true }, { "comment": "/**\r\n * Attempts to lock the orientation of the web browser using the Screen Orientation API.\r\n *\r\n * This API is only available on modern mobile browsers.\r\n * See https://developer.mozilla.org/en-US/docs/Web/API/Screen/lockOrientation for details.\r\n *\r\n * @method Phaser.Scale.ScaleManager#lockOrientation\r\n * @since 3.16.0\r\n *\r\n * @param {string} orientation - The orientation you'd like to lock the browser in. Should be an API string such as 'landscape', 'landscape-primary', 'portrait', etc.\r\n *\r\n * @return {boolean} `true` if the orientation was successfully locked, otherwise `false`.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 696, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Attempts to lock the orientation of the web browser using the Screen Orientation API.\r\rThis API is only available on modern mobile browsers.\rSee https://developer.mozilla.org/en-US/docs/Web/API/Screen/lockOrientation for details.", "kind": "function", "name": "lockOrientation", "since": "3.16.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The orientation you'd like to lock the browser in. Should be an API string such as 'landscape', 'landscape-primary', 'portrait', etc.", "name": "orientation" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the orientation was successfully locked, otherwise `false`." } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#lockOrientation", "scope": "instance", "___id": "T000002R036188", "___s": true }, { "comment": "/**\r\n * This method will set the size of the Parent Size component, which is used in scaling\r\n * and centering calculations. You only need to call this method if you have explicitly\r\n * disabled the use of a parent in your game config, but still wish to take advantage of\r\n * other Scale Manager features.\r\n *\r\n * @method Phaser.Scale.ScaleManager#setParentSize\r\n * @fires Phaser.Scale.Events#RESIZE\r\n * @since 3.16.0\r\n *\r\n * @param {number} width - The new width of the parent.\r\n * @param {number} height - The new height of the parent.\r\n *\r\n * @return {this} The Scale Manager instance.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 721, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "This method will set the size of the Parent Size component, which is used in scaling\rand centering calculations. You only need to call this method if you have explicitly\rdisabled the use of a parent in your game config, but still wish to take advantage of\rother Scale Manager features.", "kind": "function", "name": "setParentSize", "fires": [ "Phaser.Scale.Events#event:RESIZE" ], "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the parent.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of the parent.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Scale Manager instance." } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#setParentSize", "scope": "instance", "___id": "T000002R036191", "___s": true }, { "comment": "/**\r\n * This method will set a new size for your game.\r\n *\r\n * It should only be used if you're looking to change the base size of your game and are using\r\n * one of the Scale Manager scaling modes, i.e. `FIT`. If you're using `NONE` and wish to\r\n * change the game and canvas size directly, then please use the `resize` method instead.\r\n *\r\n * @method Phaser.Scale.ScaleManager#setGameSize\r\n * @fires Phaser.Scale.Events#RESIZE\r\n * @since 3.16.0\r\n *\r\n * @param {number} width - The new width of the game.\r\n * @param {number} height - The new height of the game.\r\n *\r\n * @return {this} The Scale Manager instance.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 743, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "This method will set a new size for your game.\r\rIt should only be used if you're looking to change the base size of your game and are using\rone of the Scale Manager scaling modes, i.e. `FIT`. If you're using `NONE` and wish to\rchange the game and canvas size directly, then please use the `resize` method instead.", "kind": "function", "name": "setGameSize", "fires": [ "Phaser.Scale.Events#event:RESIZE" ], "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the game.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of the game.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Scale Manager instance." } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#setGameSize", "scope": "instance", "___id": "T000002R036193", "___s": true }, { "comment": "/**\r\n * Call this to modify the size of the Phaser canvas element directly.\r\n * You should only use this if you are using the `NONE` scale mode,\r\n * it will update all internal components completely.\r\n *\r\n * If all you want to do is change the size of the parent, see the `setParentSize` method.\r\n *\r\n * If all you want is to change the base size of the game, but still have the Scale Manager\r\n * manage all the scaling (i.e. you're **not** using `NONE`), then see the `setGameSize` method.\r\n *\r\n * This method will set the `gameSize`, `baseSize` and `displaySize` components to the given\r\n * dimensions. It will then resize the canvas width and height to the values given, by\r\n * directly setting the properties. Finally, if you have set the Scale Manager zoom value\r\n * to anything other than 1 (the default), it will set the canvas CSS width and height to\r\n * be the given size multiplied by the zoom factor (the canvas pixel size remains untouched).\r\n *\r\n * If you have enabled `autoCenter`, it is then passed to the `updateCenter` method and\r\n * the margins are set, allowing the canvas to be centered based on its parent element\r\n * alone. Finally, the `displayScale` is adjusted and the RESIZE event dispatched.\r\n *\r\n * @method Phaser.Scale.ScaleManager#resize\r\n * @fires Phaser.Scale.Events#RESIZE\r\n * @since 3.16.0\r\n *\r\n * @param {number} width - The new width of the game.\r\n * @param {number} height - The new height of the game.\r\n *\r\n * @return {this} The Scale Manager instance.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 794, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Call this to modify the size of the Phaser canvas element directly.\rYou should only use this if you are using the `NONE` scale mode,\rit will update all internal components completely.\r\rIf all you want to do is change the size of the parent, see the `setParentSize` method.\r\rIf all you want is to change the base size of the game, but still have the Scale Manager\rmanage all the scaling (i.e. you're **not** using `NONE`), then see the `setGameSize` method.\r\rThis method will set the `gameSize`, `baseSize` and `displaySize` components to the given\rdimensions. It will then resize the canvas width and height to the values given, by\rdirectly setting the properties. Finally, if you have set the Scale Manager zoom value\rto anything other than 1 (the default), it will set the canvas CSS width and height to\rbe the given size multiplied by the zoom factor (the canvas pixel size remains untouched).\r\rIf you have enabled `autoCenter`, it is then passed to the `updateCenter` method and\rthe margins are set, allowing the canvas to be centered based on its parent element\ralone. Finally, the `displayScale` is adjusted and the RESIZE event dispatched.", "kind": "function", "name": "resize", "fires": [ "Phaser.Scale.Events#event:RESIZE" ], "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the game.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of the game.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Scale Manager instance." } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#resize", "scope": "instance", "___id": "T000002R036204", "___s": true }, { "comment": "/**\r\n * Sets the zoom value of the Scale Manager.\r\n *\r\n * @method Phaser.Scale.ScaleManager#setZoom\r\n * @fires Phaser.Scale.Events#RESIZE\r\n * @since 3.16.0\r\n *\r\n * @param {number} value - The new zoom value of the game.\r\n *\r\n * @return {this} The Scale Manager instance.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 876, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Sets the zoom value of the Scale Manager.", "kind": "function", "name": "setZoom", "fires": [ "Phaser.Scale.Events#event:RESIZE" ], "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new zoom value of the game.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Scale Manager instance." } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#setZoom", "scope": "instance", "___id": "T000002R036223", "___s": true }, { "comment": "/**\r\n * Sets the zoom to be the maximum possible based on the _current_ parent size.\r\n *\r\n * @method Phaser.Scale.ScaleManager#setMaxZoom\r\n * @fires Phaser.Scale.Events#RESIZE\r\n * @since 3.16.0\r\n *\r\n * @return {this} The Scale Manager instance.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 895, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Sets the zoom to be the maximum possible based on the _current_ parent size.", "kind": "function", "name": "setMaxZoom", "fires": [ "Phaser.Scale.Events#event:RESIZE" ], "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Scale Manager instance." } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#setMaxZoom", "scope": "instance", "___id": "T000002R036227", "___s": true }, { "comment": "/**\r\n * Refreshes the internal scale values, bounds sizes and orientation checks.\r\n *\r\n * Once finished, dispatches the resize event.\r\n *\r\n * This is called automatically by the Scale Manager when the browser window size changes,\r\n * as long as it is using a Scale Mode other than 'NONE'.\r\n *\r\n * @method Phaser.Scale.ScaleManager#refresh\r\n * @fires Phaser.Scale.Events#RESIZE\r\n * @since 3.16.0\r\n *\r\n * @param {number} [previousWidth] - The previous width of the game. Only set if the gameSize has changed.\r\n * @param {number} [previousHeight] - The previous height of the game. Only set if the gameSize has changed.\r\n *\r\n * @return {this} The Scale Manager instance.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 912, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Refreshes the internal scale values, bounds sizes and orientation checks.\r\rOnce finished, dispatches the resize event.\r\rThis is called automatically by the Scale Manager when the browser window size changes,\ras long as it is using a Scale Mode other than 'NONE'.", "kind": "function", "name": "refresh", "fires": [ "Phaser.Scale.Events#event:RESIZE" ], "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The previous width of the game. Only set if the gameSize has changed.", "name": "previousWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The previous height of the game. Only set if the gameSize has changed.", "name": "previousHeight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Scale Manager instance." } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#refresh", "scope": "instance", "___id": "T000002R036231", "___s": true }, { "comment": "/**\r\n * Internal method that checks the current screen orientation, only if the internal check flag is set.\r\n *\r\n * If the orientation has changed it updates the orientation property and then dispatches the orientation change event.\r\n *\r\n * @method Phaser.Scale.ScaleManager#updateOrientation\r\n * @fires Phaser.Scale.Events#ORIENTATION_CHANGE\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 960, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Internal method that checks the current screen orientation, only if the internal check flag is set.\r\rIf the orientation has changed it updates the orientation property and then dispatches the orientation change event.", "kind": "function", "name": "updateOrientation", "fires": [ "Phaser.Scale.Events#event:ORIENTATION_CHANGE" ], "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#updateOrientation", "scope": "instance", "___id": "T000002R036241", "___s": true }, { "comment": "/**\r\n * Internal method that manages updating the size components based on the scale mode.\r\n *\r\n * @method Phaser.Scale.ScaleManager#updateScale\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 986, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Internal method that manages updating the size components based on the scale mode.", "kind": "function", "name": "updateScale", "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#updateScale", "scope": "instance", "___id": "T000002R036246", "___s": true }, { "comment": "/**\r\n * Calculates and returns the largest possible zoom factor, based on the current\r\n * parent and game sizes. If the parent has no dimensions (i.e. an unstyled div),\r\n * or is smaller than the un-zoomed game, then this will return a value of 1 (no zoom)\r\n *\r\n * @method Phaser.Scale.ScaleManager#getMaxZoom\r\n * @since 3.16.0\r\n *\r\n * @return {number} The maximum possible zoom factor. At a minimum this value is always at least 1.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1075, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Calculates and returns the largest possible zoom factor, based on the current\rparent and game sizes. If the parent has no dimensions (i.e. an unstyled div),\ror is smaller than the un-zoomed game, then this will return a value of 1 (no zoom)", "kind": "function", "name": "getMaxZoom", "since": "3.16.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum possible zoom factor. At a minimum this value is always at least 1." } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#getMaxZoom", "scope": "instance", "___id": "T000002R036274", "___s": true }, { "comment": "/**\r\n * Calculates and updates the canvas CSS style in order to center it within the\r\n * bounds of its parent. If you have explicitly set parent to be `null` in your\r\n * game config then this method will likely give incorrect results unless you have called the\r\n * `setParentSize` method first.\r\n *\r\n * It works by modifying the canvas CSS `marginLeft` and `marginTop` properties.\r\n *\r\n * If they have already been set by your own style sheet, or code, this will overwrite them.\r\n *\r\n * To prevent the Scale Manager from centering the canvas, either do not set the\r\n * `autoCenter` property in your game config, or make sure it is set to `NO_CENTER`.\r\n *\r\n * @method Phaser.Scale.ScaleManager#updateCenter\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1093, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Calculates and updates the canvas CSS style in order to center it within the\rbounds of its parent. If you have explicitly set parent to be `null` in your\rgame config then this method will likely give incorrect results unless you have called the\r`setParentSize` method first.\r\rIt works by modifying the canvas CSS `marginLeft` and `marginTop` properties.\r\rIf they have already been set by your own style sheet, or code, this will overwrite them.\r\rTo prevent the Scale Manager from centering the canvas, either do not set the\r`autoCenter` property in your game config, or make sure it is set to `NO_CENTER`.", "kind": "function", "name": "updateCenter", "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#updateCenter", "scope": "instance", "___id": "T000002R036278", "___s": true }, { "comment": "/**\r\n * Updates the `canvasBounds` rectangle to match the bounding client rectangle of the\r\n * canvas element being used to track input events.\r\n *\r\n * @method Phaser.Scale.ScaleManager#updateBounds\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Updates the `canvasBounds` rectangle to match the bounding client rectangle of the\rcanvas element being used to track input events.", "kind": "function", "name": "updateBounds", "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#updateBounds", "scope": "instance", "___id": "T000002R036292", "___s": true }, { "comment": "/**\r\n * Transforms the pageX value into the scaled coordinate space of the Scale Manager.\r\n *\r\n * @method Phaser.Scale.ScaleManager#transformX\r\n * @since 3.16.0\r\n *\r\n * @param {number} pageX - The DOM pageX value.\r\n *\r\n * @return {number} The translated value.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Transforms the pageX value into the scaled coordinate space of the Scale Manager.", "kind": "function", "name": "transformX", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The DOM pageX value.", "name": "pageX" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The translated value." } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#transformX", "scope": "instance", "___id": "T000002R036300", "___s": true }, { "comment": "/**\r\n * Transforms the pageY value into the scaled coordinate space of the Scale Manager.\r\n *\r\n * @method Phaser.Scale.ScaleManager#transformY\r\n * @since 3.16.0\r\n *\r\n * @param {number} pageY - The DOM pageY value.\r\n *\r\n * @return {number} The translated value.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1179, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Transforms the pageY value into the scaled coordinate space of the Scale Manager.", "kind": "function", "name": "transformY", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The DOM pageY value.", "name": "pageY" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The translated value." } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#transformY", "scope": "instance", "___id": "T000002R036302", "___s": true }, { "comment": "/**\r\n * Sends a request to the browser to ask it to go in to full screen mode, using the {@link https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API Fullscreen API}.\r\n *\r\n * If the browser does not support this, a `FULLSCREEN_UNSUPPORTED` event will be emitted.\r\n *\r\n * This method _must_ be called from a `pointerup` user-input gesture (**not** `pointerdown`). You cannot launch\r\n * games fullscreen without this, as most browsers block it. Games within an iframe will also be blocked\r\n * from fullscreen unless the iframe has the `allowfullscreen` attribute.\r\n *\r\n * On touch devices, such as Android and iOS Safari, you should always use `pointerup` and NOT `pointerdown`,\r\n * otherwise the request will fail unless the document in which your game is embedded has already received\r\n * some form of touch input, which you cannot guarantee. Activating fullscreen via `pointerup` circumvents\r\n * this issue.\r\n *\r\n * Performing an action that navigates to another page, or opens another tab, will automatically cancel\r\n * fullscreen mode, as will the user pressing the ESC key. To cancel fullscreen mode directly from your game,\r\n * i.e. by clicking an icon, call the `stopFullscreen` method.\r\n *\r\n * A browser can only send one DOM element into fullscreen. You can control which element this is by\r\n * setting the `fullscreenTarget` property in your game config, or changing the property in the Scale Manager.\r\n * Note that the game canvas _must_ be a child of the target. If you do not give a target, Phaser will\r\n * automatically create a blank `
` element and move the canvas into it, before going fullscreen.\r\n * When it leaves fullscreen, the div will be removed.\r\n *\r\n * @method Phaser.Scale.ScaleManager#startFullscreen\r\n * @fires Phaser.Scale.Events#ENTER_FULLSCREEN\r\n * @fires Phaser.Scale.Events#FULLSCREEN_FAILED\r\n * @fires Phaser.Scale.Events#FULLSCREEN_UNSUPPORTED\r\n * @fires Phaser.Scale.Events#RESIZE\r\n * @since 3.16.0\r\n *\r\n * @param {object} [fullscreenOptions] - The FullscreenOptions dictionary is used to provide configuration options when entering full screen.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1194, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Sends a request to the browser to ask it to go in to full screen mode, using the {@link https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API Fullscreen API}.\r\rIf the browser does not support this, a `FULLSCREEN_UNSUPPORTED` event will be emitted.\r\rThis method _must_ be called from a `pointerup` user-input gesture (**not** `pointerdown`). You cannot launch\rgames fullscreen without this, as most browsers block it. Games within an iframe will also be blocked\rfrom fullscreen unless the iframe has the `allowfullscreen` attribute.\r\rOn touch devices, such as Android and iOS Safari, you should always use `pointerup` and NOT `pointerdown`,\rotherwise the request will fail unless the document in which your game is embedded has already received\rsome form of touch input, which you cannot guarantee. Activating fullscreen via `pointerup` circumvents\rthis issue.\r\rPerforming an action that navigates to another page, or opens another tab, will automatically cancel\rfullscreen mode, as will the user pressing the ESC key. To cancel fullscreen mode directly from your game,\ri.e. by clicking an icon, call the `stopFullscreen` method.\r\rA browser can only send one DOM element into fullscreen. You can control which element this is by\rsetting the `fullscreenTarget` property in your game config, or changing the property in the Scale Manager.\rNote that the game canvas _must_ be a child of the target. If you do not give a target, Phaser will\rautomatically create a blank `
` element and move the canvas into it, before going fullscreen.\rWhen it leaves fullscreen, the div will be removed.", "kind": "function", "name": "startFullscreen", "fires": [ "Phaser.Scale.Events#event:ENTER_FULLSCREEN", "Phaser.Scale.Events#event:FULLSCREEN_FAILED", "Phaser.Scale.Events#event:FULLSCREEN_UNSUPPORTED", "Phaser.Scale.Events#event:RESIZE" ], "since": "3.16.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The FullscreenOptions dictionary is used to provide configuration options when entering full screen.", "name": "fullscreenOptions" } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#startFullscreen", "scope": "instance", "___id": "T000002R036304", "___s": true }, { "comment": "/**\r\n * An internal method that gets the target element that is used when entering fullscreen mode.\r\n *\r\n * @method Phaser.Scale.ScaleManager#getFullscreenTarget\r\n * @since 3.16.0\r\n *\r\n * @return {object} The fullscreen target element.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1291, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "An internal method that gets the target element that is used when entering fullscreen mode.", "kind": "function", "name": "getFullscreenTarget", "since": "3.16.0", "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The fullscreen target element." } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#getFullscreenTarget", "scope": "instance", "___id": "T000002R036314", "___s": true }, { "comment": "/**\r\n * Removes the fullscreen target that was added to the DOM.\r\n *\r\n * @method Phaser.Scale.ScaleManager#removeFullscreenTarget\r\n * @since 3.17.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1327, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Removes the fullscreen target that was added to the DOM.", "kind": "function", "name": "removeFullscreenTarget", "since": "3.17.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#removeFullscreenTarget", "scope": "instance", "___id": "T000002R036324", "___s": true }, { "comment": "/**\r\n * Calling this method will cancel fullscreen mode, if the browser has entered it.\r\n *\r\n * @method Phaser.Scale.ScaleManager#stopFullscreen\r\n * @fires Phaser.Scale.Events#LEAVE_FULLSCREEN\r\n * @fires Phaser.Scale.Events#FULLSCREEN_UNSUPPORTED\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1350, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Calling this method will cancel fullscreen mode, if the browser has entered it.", "kind": "function", "name": "stopFullscreen", "fires": [ "Phaser.Scale.Events#event:LEAVE_FULLSCREEN", "Phaser.Scale.Events#event:FULLSCREEN_UNSUPPORTED" ], "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#stopFullscreen", "scope": "instance", "___id": "T000002R036328", "___s": true }, { "comment": "/**\r\n * Toggles the fullscreen mode. If already in fullscreen, calling this will cancel it.\r\n * If not in fullscreen, this will request the browser to enter fullscreen mode.\r\n *\r\n * If the browser does not support this, a `FULLSCREEN_UNSUPPORTED` event will be emitted.\r\n *\r\n * This method _must_ be called from a user-input gesture, such as `pointerdown`. You cannot launch\r\n * games fullscreen without this, as most browsers block it. Games within an iframe will also be blocked\r\n * from fullscreen unless the iframe has the `allowfullscreen` attribute.\r\n *\r\n * @method Phaser.Scale.ScaleManager#toggleFullscreen\r\n * @fires Phaser.Scale.Events#ENTER_FULLSCREEN\r\n * @fires Phaser.Scale.Events#LEAVE_FULLSCREEN\r\n * @fires Phaser.Scale.Events#FULLSCREEN_UNSUPPORTED\r\n * @fires Phaser.Scale.Events#RESIZE\r\n * @since 3.16.0\r\n *\r\n * @param {object} [fullscreenOptions] - The FullscreenOptions dictionary is used to provide configuration options when entering full screen.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1384, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Toggles the fullscreen mode. If already in fullscreen, calling this will cancel it.\rIf not in fullscreen, this will request the browser to enter fullscreen mode.\r\rIf the browser does not support this, a `FULLSCREEN_UNSUPPORTED` event will be emitted.\r\rThis method _must_ be called from a user-input gesture, such as `pointerdown`. You cannot launch\rgames fullscreen without this, as most browsers block it. Games within an iframe will also be blocked\rfrom fullscreen unless the iframe has the `allowfullscreen` attribute.", "kind": "function", "name": "toggleFullscreen", "fires": [ "Phaser.Scale.Events#event:ENTER_FULLSCREEN", "Phaser.Scale.Events#event:LEAVE_FULLSCREEN", "Phaser.Scale.Events#event:FULLSCREEN_UNSUPPORTED", "Phaser.Scale.Events#event:RESIZE" ], "since": "3.16.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The FullscreenOptions dictionary is used to provide configuration options when entering full screen.", "name": "fullscreenOptions" } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#toggleFullscreen", "scope": "instance", "___id": "T000002R036331", "___s": true }, { "comment": "/**\r\n * An internal method that starts the different DOM event listeners running.\r\n *\r\n * @method Phaser.Scale.ScaleManager#startListeners\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1415, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "An internal method that starts the different DOM event listeners running.", "kind": "function", "name": "startListeners", "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#startListeners", "scope": "instance", "___id": "T000002R036333", "___s": true }, { "comment": "/**\r\n * Triggered when a fullscreenchange event is dispatched by the DOM.\r\n *\r\n * @method Phaser.Scale.ScaleManager#onFullScreenChange\r\n * @protected\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1472, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Triggered when a fullscreenchange event is dispatched by the DOM.", "kind": "function", "name": "onFullScreenChange", "access": "protected", "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#onFullScreenChange", "scope": "instance", "___id": "T000002R036345", "___s": true }, { "comment": "/**\r\n * Triggered when a fullscreenerror event is dispatched by the DOM.\r\n *\r\n * @method Phaser.Scale.ScaleManager#onFullScreenError\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Triggered when a fullscreenerror event is dispatched by the DOM.", "kind": "function", "name": "onFullScreenError", "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#onFullScreenError", "scope": "instance", "___id": "T000002R036347", "___s": true }, { "comment": "/**\r\n * Get Rectange of visible area.\r\n *\r\n * @method Phaser.Scale.ScaleManager#getViewPort\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The camera this viewport is respond upon.\r\n * @param {Phaser.Geom.Rectangle} [out] - The Rectangle of visible area.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The Rectangle of visible area.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1503, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Get Rectange of visible area.", "kind": "function", "name": "getViewPort", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The camera this viewport is respond upon.", "name": "camera" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "optional": true, "description": "The Rectangle of visible area.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle of visible area." } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#getViewPort", "scope": "instance", "___id": "T000002R036349", "___s": true }, { "comment": "/**\r\n * Internal method, called automatically by the game step.\r\n * Monitors the elapsed time and resize interval to see if a parent bounds check needs to take place.\r\n *\r\n * @method Phaser.Scale.ScaleManager#step\r\n * @since 3.16.0\r\n *\r\n * @param {number} time - The time value from the most recent Game step. Typically a high-resolution timer value, or Date.now().\r\n * @param {number} delta - The delta value since the last frame. This is smoothed to avoid delta spikes by the TimeStep class.\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1569, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Internal method, called automatically by the game step.\rMonitors the elapsed time and resize interval to see if a parent bounds check needs to take place.", "kind": "function", "name": "step", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time value from the most recent Game step. Typically a high-resolution timer value, or Date.now().", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value since the last frame. This is smoothed to avoid delta spikes by the TimeStep class.", "name": "delta" } ], "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#step", "scope": "instance", "___id": "T000002R036370", "___s": true }, { "comment": "/**\r\n * Stops all DOM event listeners.\r\n *\r\n * @method Phaser.Scale.ScaleManager#stopListeners\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1601, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Stops all DOM event listeners.", "kind": "function", "name": "stopListeners", "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#stopListeners", "scope": "instance", "___id": "T000002R036375", "___s": true }, { "comment": "/**\r\n * Destroys this Scale Manager, releasing all references to external resources.\r\n * Once destroyed, the Scale Manager cannot be used again.\r\n *\r\n * @method Phaser.Scale.ScaleManager#destroy\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1627, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Destroys this Scale Manager, releasing all references to external resources.\rOnce destroyed, the Scale Manager cannot be used again.", "kind": "function", "name": "destroy", "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#destroy", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#destroy", "___id": "T000002R036379", "___s": true }, { "comment": "/**\r\n * Is the browser currently in fullscreen mode or not?\r\n *\r\n * @name Phaser.Scale.ScaleManager#isFullscreen\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1652, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Is the browser currently in fullscreen mode or not?", "name": "isFullscreen", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#isFullscreen", "scope": "instance", "kind": "member", "___id": "T000002R036386", "___s": true }, { "comment": "/**\r\n * The game width.\r\n *\r\n * This is typically the size given in the game configuration.\r\n *\r\n * @name Phaser.Scale.ScaleManager#width\r\n * @type {number}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1669, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "The game width.\r\rThis is typically the size given in the game configuration.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#width", "scope": "instance", "kind": "member", "___id": "T000002R036389", "___s": true }, { "comment": "/**\r\n * The game height.\r\n *\r\n * This is typically the size given in the game configuration.\r\n *\r\n * @name Phaser.Scale.ScaleManager#height\r\n * @type {number}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1688, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "The game height.\r\rThis is typically the size given in the game configuration.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#height", "scope": "instance", "kind": "member", "___id": "T000002R036392", "___s": true }, { "comment": "/**\r\n * Is the device in a portrait orientation as reported by the Orientation API?\r\n * This value is usually only available on mobile devices.\r\n *\r\n * @name Phaser.Scale.ScaleManager#isPortrait\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1707, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Is the device in a portrait orientation as reported by the Orientation API?\rThis value is usually only available on mobile devices.", "name": "isPortrait", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#isPortrait", "scope": "instance", "kind": "member", "___id": "T000002R036395", "___s": true }, { "comment": "/**\r\n * Is the device in a landscape orientation as reported by the Orientation API?\r\n * This value is usually only available on mobile devices.\r\n *\r\n * @name Phaser.Scale.ScaleManager#isLandscape\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1725, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Is the device in a landscape orientation as reported by the Orientation API?\rThis value is usually only available on mobile devices.", "name": "isLandscape", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#isLandscape", "scope": "instance", "kind": "member", "___id": "T000002R036398", "___s": true }, { "comment": "/**\r\n * Are the game dimensions portrait? (i.e. taller than they are wide)\r\n *\r\n * This is different to the device itself being in a portrait orientation.\r\n *\r\n * @name Phaser.Scale.ScaleManager#isGamePortrait\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1743, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Are the game dimensions portrait? (i.e. taller than they are wide)\r\rThis is different to the device itself being in a portrait orientation.", "name": "isGamePortrait", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#isGamePortrait", "scope": "instance", "kind": "member", "___id": "T000002R036401", "___s": true }, { "comment": "/**\r\n * Are the game dimensions landscape? (i.e. wider than they are tall)\r\n *\r\n * This is different to the device itself being in a landscape orientation.\r\n *\r\n * @name Phaser.Scale.ScaleManager#isGameLandscape\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ScaleManager.js", "lineno": 1762, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale", "code": {} }, "description": "Are the game dimensions landscape? (i.e. wider than they are tall)\r\rThis is different to the device itself being in a landscape orientation.", "name": "isGameLandscape", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Scale.ScaleManager", "longname": "Phaser.Scale.ScaleManager#isGameLandscape", "scope": "instance", "kind": "member", "___id": "T000002R036404", "___s": true }, { "comment": "/**\r\n * Scene state.\r\n *\r\n * @name Phaser.Scenes.PENDING\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Scene state.", "name": "PENDING", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Scenes", "longname": "Phaser.Scenes.PENDING", "scope": "static", "kind": "member", "___id": "T000002R036409", "___s": true }, { "comment": "/**\r\n * Scene state.\r\n *\r\n * @name Phaser.Scenes.INIT\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 25, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Scene state.", "name": "INIT", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Scenes", "longname": "Phaser.Scenes.INIT", "scope": "static", "kind": "member", "___id": "T000002R036411", "___s": true }, { "comment": "/**\r\n * Scene state.\r\n *\r\n * @name Phaser.Scenes.START\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 35, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Scene state.", "name": "START", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Scenes", "longname": "Phaser.Scenes.START", "scope": "static", "kind": "member", "___id": "T000002R036413", "___s": true }, { "comment": "/**\r\n * Scene state.\r\n *\r\n * @name Phaser.Scenes.LOADING\r\n * @readonly\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\\scene", "code": {} }, "description": "Scene state.", "name": "LOADING", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Scenes", "longname": "Phaser.Scenes.LOADING", "scope": "static", "kind": "member", "___id": "T000002R036415", "___s": true }, { "comment": "/**\r\n * Scene state.\r\n *\r\n * @name Phaser.Scenes.CREATING\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 55, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Scene state.", "name": "CREATING", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Scenes", "longname": "Phaser.Scenes.CREATING", "scope": "static", "kind": "member", "___id": "T000002R036417", "___s": true }, { "comment": "/**\r\n * Scene state.\r\n *\r\n * @name Phaser.Scenes.RUNNING\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 65, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Scene state.", "name": "RUNNING", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Scenes", "longname": "Phaser.Scenes.RUNNING", "scope": "static", "kind": "member", "___id": "T000002R036419", "___s": true }, { "comment": "/**\r\n * Scene state.\r\n *\r\n * @name Phaser.Scenes.PAUSED\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 75, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Scene state.", "name": "PAUSED", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Scenes", "longname": "Phaser.Scenes.PAUSED", "scope": "static", "kind": "member", "___id": "T000002R036421", "___s": true }, { "comment": "/**\r\n * Scene state.\r\n *\r\n * @name Phaser.Scenes.SLEEPING\r\n * @readonly\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\\scene", "code": {} }, "description": "Scene state.", "name": "SLEEPING", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Scenes", "longname": "Phaser.Scenes.SLEEPING", "scope": "static", "kind": "member", "___id": "T000002R036423", "___s": true }, { "comment": "/**\r\n * Scene state.\r\n *\r\n * @name Phaser.Scenes.SHUTDOWN\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 95, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Scene state.", "name": "SHUTDOWN", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Scenes", "longname": "Phaser.Scenes.SHUTDOWN", "scope": "static", "kind": "member", "___id": "T000002R036425", "___s": true }, { "comment": "/**\r\n * Scene state.\r\n *\r\n * @name Phaser.Scenes.DESTROYED\r\n * @readonly\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 105, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Scene state.", "name": "DESTROYED", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Scenes", "longname": "Phaser.Scenes.DESTROYED", "scope": "static", "kind": "member", "___id": "T000002R036427", "___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 from a Scene using `this.events.on('addedtoscene', listener)`.\r\n *\r\n * @event Phaser.Scenes.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\\scene\\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 from a Scene using `this.events.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.Scenes.Events", "longname": "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "scope": "instance", "___id": "T000002R036430", "___s": true }, { "comment": "/**\r\n * The Scene Systems Boot Event.\r\n *\r\n * This event is dispatched by a Scene during the Scene Systems boot process. Primarily used by Scene Plugins.\r\n *\r\n * Listen to it from a Scene using `this.events.on('boot', listener)`.\r\n *\r\n * @event Phaser.Scenes.Events#BOOT\r\n * @type {string}\r\n * @since 3.0.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": "BOOT_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Systems Boot Event.\r\rThis event is dispatched by a Scene during the Scene Systems boot process. Primarily used by Scene Plugins.\r\rListen to it from a Scene using `this.events.on('boot', listener)`.", "kind": "event", "name": "BOOT", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.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.Scenes.Events", "longname": "Phaser.Scenes.Events#event:BOOT", "scope": "instance", "___id": "T000002R036432", "___s": true }, { "comment": "/**\r\n * The Scene Create Event.\r\n *\r\n * This event is dispatched by a Scene after it has been created by the Scene Manager.\r\n *\r\n * If a Scene has a `create` method then this event is emitted _after_ that has run.\r\n *\r\n * If there is a transition, this event will be fired after the `TRANSITION_START` event.\r\n *\r\n * Listen to it from a Scene using `this.events.on('create', listener)`.\r\n *\r\n * @event Phaser.Scenes.Events#CREATE\r\n * @type {string}\r\n * @since 3.17.0\r\n *\r\n * @param {Phaser.Scene} scene - A reference to the Scene that emitted this event.\r\n */", "meta": { "filename": "CREATE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Create Event.\r\rThis event is dispatched by a Scene after it has been created by the Scene Manager.\r\rIf a Scene has a `create` method then this event is emitted _after_ that has run.\r\rIf there is a transition, this event will be fired after the `TRANSITION_START` event.\r\rListen to it from a Scene using `this.events.on('create', listener)`.", "kind": "event", "name": "CREATE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.17.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "A reference to the Scene that emitted this event.", "name": "scene" } ], "memberof": "Phaser.Scenes.Events", "longname": "Phaser.Scenes.Events#event:CREATE", "scope": "instance", "___id": "T000002R036434", "___s": true }, { "comment": "/**\r\n * The Scene Systems Destroy Event.\r\n *\r\n * This event is dispatched by a Scene during the Scene Systems destroy process.\r\n *\r\n * Listen to it from a Scene using `this.events.on('destroy', listener)`.\r\n *\r\n * You should destroy any resources that may be in use by your Scene in this event handler.\r\n *\r\n * @event Phaser.Scenes.Events#DESTROY\r\n * @type {string}\r\n * @since 3.0.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": "DESTROY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Systems Destroy Event.\r\rThis event is dispatched by a Scene during the Scene Systems destroy process.\r\rListen to it from a Scene using `this.events.on('destroy', listener)`.\r\rYou should destroy any resources that may be in use by your Scene in this event handler.", "kind": "event", "name": "DESTROY", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.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.Scenes.Events", "longname": "Phaser.Scenes.Events#event:DESTROY", "scope": "instance", "___id": "T000002R036436", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Scenes.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Scenes", "longname": "Phaser.Scenes.Events", "scope": "static", "___id": "T000002R036438", "___s": true }, { "comment": "/**\r\n * The Scene Systems Pause Event.\r\n *\r\n * This event is dispatched by a Scene when it is paused, either directly via the `pause` method, or as an\r\n * action from another Scene.\r\n *\r\n * Listen to it from a Scene using `this.events.on('pause', listener)`.\r\n *\r\n * @event Phaser.Scenes.Events#PAUSE\r\n * @type {string}\r\n * @since 3.0.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 * @param {any} [data] - An optional data object that was passed to this Scene when it was paused.\r\n */", "meta": { "filename": "PAUSE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Systems Pause Event.\r\rThis event is dispatched by a Scene when it is paused, either directly via the `pause` method, or as an\raction from another Scene.\r\rListen to it from a Scene using `this.events.on('pause', listener)`.", "kind": "event", "name": "PAUSE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.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" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "An optional data object that was passed to this Scene when it was paused.", "name": "data" } ], "memberof": "Phaser.Scenes.Events", "longname": "Phaser.Scenes.Events#event:PAUSE", "scope": "instance", "___id": "T000002R036462", "___s": true }, { "comment": "/**\r\n * The Scene Systems Post Update Event.\r\n *\r\n * This event is dispatched by a Scene during the main game loop step.\r\n *\r\n * The event flow for a single step of a Scene is as follows:\r\n *\r\n * 1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\r\n * 2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\r\n * 3. The `Scene.update` method is called, if it exists\r\n * 4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\r\n * 5. [PRE_RENDER]{@linkcode Phaser.Scenes.Events#event:PRE_RENDER}\r\n * 6. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\r\n *\r\n * Listen to it from a Scene using `this.events.on('postupdate', listener)`.\r\n *\r\n * A Scene will only run its step if it is active.\r\n *\r\n * @event Phaser.Scenes.Events#POST_UPDATE\r\n * @type {string}\r\n * @since 3.0.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 * @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_UPDATE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Systems Post Update Event.\r\rThis event is dispatched by a Scene during the main game loop step.\r\rThe event flow for a single step of a Scene is as follows:\r\r1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\r2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\r3. The `Scene.update` method is called, if it exists\r4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\r5. [PRE_RENDER]{@linkcode Phaser.Scenes.Events#event:PRE_RENDER}\r6. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\r\rListen to it from a Scene using `this.events.on('postupdate', listener)`.\r\rA Scene will only run its step if it is active.", "kind": "event", "name": "POST_UPDATE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.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" }, { "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.Scenes.Events", "longname": "Phaser.Scenes.Events#event:POST_UPDATE", "scope": "instance", "___id": "T000002R036464", "___s": true }, { "comment": "/**\r\n * The Scene Systems Pre-Render Event.\r\n *\r\n * This event is dispatched by a Scene during the main game loop step.\r\n *\r\n * The event flow for a single step of a Scene is as follows:\r\n *\r\n * 1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\r\n * 2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\r\n * 3. The `Scene.update` method is called, if it exists\r\n * 4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\r\n * 5. [PRE_RENDER]{@linkcode Phaser.Scenes.Events#event:PRE_RENDER}\r\n * 6. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\r\n *\r\n * Listen to this event from a Scene using `this.events.on('prerender', listener)`.\r\n *\r\n * A Scene will only render if it is visible.\r\n *\r\n * This event is dispatched after the Scene Display List is sorted and before the Scene is rendered.\r\n *\r\n * @event Phaser.Scenes.Events#PRE_RENDER\r\n * @type {string}\r\n * @since 3.53.0\r\n *\r\n * @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - The renderer that rendered the Scene.\r\n */", "meta": { "filename": "PRE_RENDER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Systems Pre-Render Event.\r\rThis event is dispatched by a Scene during the main game loop step.\r\rThe event flow for a single step of a Scene is as follows:\r\r1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\r2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\r3. The `Scene.update` method is called, if it exists\r4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\r5. [PRE_RENDER]{@linkcode Phaser.Scenes.Events#event:PRE_RENDER}\r6. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\r\rListen to this event from a Scene using `this.events.on('prerender', listener)`.\r\rA Scene will only render if it is visible.\r\rThis event is dispatched after the Scene Display List is sorted and before the Scene is rendered.", "kind": "event", "name": "PRE_RENDER", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.53.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 rendered the Scene.", "name": "renderer" } ], "memberof": "Phaser.Scenes.Events", "longname": "Phaser.Scenes.Events#event:PRE_RENDER", "scope": "instance", "___id": "T000002R036466", "___s": true }, { "comment": "/**\r\n * The Scene Systems Pre Update Event.\r\n *\r\n * This event is dispatched by a Scene during the main game loop step.\r\n *\r\n * The event flow for a single step of a Scene is as follows:\r\n *\r\n * 1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\r\n * 2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\r\n * 3. The `Scene.update` method is called, if it exists\r\n * 4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\r\n * 5. [PRE_RENDER]{@linkcode Phaser.Scenes.Events#event:PRE_RENDER}\r\n * 6. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\r\n *\r\n * Listen to it from a Scene using `this.events.on('preupdate', listener)`.\r\n *\r\n * A Scene will only run its step if it is active.\r\n *\r\n * @event Phaser.Scenes.Events#PRE_UPDATE\r\n * @type {string}\r\n * @since 3.0.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 * @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_UPDATE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Systems Pre Update Event.\r\rThis event is dispatched by a Scene during the main game loop step.\r\rThe event flow for a single step of a Scene is as follows:\r\r1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\r2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\r3. The `Scene.update` method is called, if it exists\r4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\r5. [PRE_RENDER]{@linkcode Phaser.Scenes.Events#event:PRE_RENDER}\r6. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\r\rListen to it from a Scene using `this.events.on('preupdate', listener)`.\r\rA Scene will only run its step if it is active.", "kind": "event", "name": "PRE_UPDATE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.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" }, { "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.Scenes.Events", "longname": "Phaser.Scenes.Events#event:PRE_UPDATE", "scope": "instance", "___id": "T000002R036468", "___s": true }, { "comment": "/**\r\n * The Scene Systems Ready Event.\r\n *\r\n * This event is dispatched by a Scene during the Scene Systems start process.\r\n * By this point in the process the Scene is now fully active and rendering.\r\n * This event is meant for your game code to use, as all plugins have responded to the earlier 'start' event.\r\n *\r\n * Listen to it from a Scene using `this.events.on('ready', listener)`.\r\n *\r\n * @event Phaser.Scenes.Events#READY\r\n * @type {string}\r\n * @since 3.0.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 * @param {any} [data] - An optional data object that was passed to this Scene when it was started.\r\n */", "meta": { "filename": "READY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Systems Ready Event.\r\rThis event is dispatched by a Scene during the Scene Systems start process.\rBy this point in the process the Scene is now fully active and rendering.\rThis event is meant for your game code to use, as all plugins have responded to the earlier 'start' event.\r\rListen to it from a Scene using `this.events.on('ready', listener)`.", "kind": "event", "name": "READY", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.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" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "An optional data object that was passed to this Scene when it was started.", "name": "data" } ], "memberof": "Phaser.Scenes.Events", "longname": "Phaser.Scenes.Events#event:READY", "scope": "instance", "___id": "T000002R036470", "___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 from a Scene using `this.events.on('removedfromscene', listener)`.\r\n *\r\n * @event Phaser.Scenes.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\\scene\\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 from a Scene using `this.events.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.Scenes.Events", "longname": "Phaser.Scenes.Events#event:REMOVED_FROM_SCENE", "scope": "instance", "___id": "T000002R036472", "___s": true }, { "comment": "/**\r\n * The Scene Systems Render Event.\r\n *\r\n * This event is dispatched by a Scene during the main game loop step.\r\n *\r\n * The event flow for a single step of a Scene is as follows:\r\n *\r\n * 1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\r\n * 2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\r\n * 3. The `Scene.update` method is called, if it exists\r\n * 4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\r\n * 5. [PRE_RENDER]{@linkcode Phaser.Scenes.Events#event:PRE_RENDER}\r\n * 6. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\r\n *\r\n * Listen to it from a Scene using `this.events.on('render', listener)`.\r\n *\r\n * A Scene will only render if it is visible.\r\n *\r\n * By the time this event is dispatched, the Scene will have already been rendered.\r\n *\r\n * @event Phaser.Scenes.Events#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 - The renderer that rendered the Scene.\r\n */", "meta": { "filename": "RENDER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Systems Render Event.\r\rThis event is dispatched by a Scene during the main game loop step.\r\rThe event flow for a single step of a Scene is as follows:\r\r1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\r2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\r3. The `Scene.update` method is called, if it exists\r4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\r5. [PRE_RENDER]{@linkcode Phaser.Scenes.Events#event:PRE_RENDER}\r6. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\r\rListen to it from a Scene using `this.events.on('render', listener)`.\r\rA Scene will only render if it is visible.\r\rBy the time this event is dispatched, the Scene will have already been rendered.", "kind": "event", "name": "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": "The renderer that rendered the Scene.", "name": "renderer" } ], "memberof": "Phaser.Scenes.Events", "longname": "Phaser.Scenes.Events#event:RENDER", "scope": "instance", "___id": "T000002R036474", "___s": true }, { "comment": "/**\r\n * The Scene Systems Resume Event.\r\n *\r\n * This event is dispatched by a Scene when it is resumed from a paused state, either directly via the `resume` method,\r\n * or as an action from another Scene.\r\n *\r\n * Listen to it from a Scene using `this.events.on('resume', listener)`.\r\n *\r\n * @event Phaser.Scenes.Events#RESUME\r\n * @type {string}\r\n * @since 3.0.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 * @param {any} [data] - An optional data object that was passed to this Scene when it was resumed.\r\n */", "meta": { "filename": "RESUME_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Systems Resume Event.\r\rThis event is dispatched by a Scene when it is resumed from a paused state, either directly via the `resume` method,\ror as an action from another Scene.\r\rListen to it from a Scene using `this.events.on('resume', listener)`.", "kind": "event", "name": "RESUME", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.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" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "An optional data object that was passed to this Scene when it was resumed.", "name": "data" } ], "memberof": "Phaser.Scenes.Events", "longname": "Phaser.Scenes.Events#event:RESUME", "scope": "instance", "___id": "T000002R036476", "___s": true }, { "comment": "/**\r\n * The Scene Systems Shutdown Event.\r\n *\r\n * This event is dispatched by a Scene during the Scene Systems shutdown process.\r\n *\r\n * Listen to it from a Scene using `this.events.on('shutdown', listener)`.\r\n *\r\n * You should free-up any resources that may be in use by your Scene in this event handler, on the understanding\r\n * that the Scene may, at any time, become active again. A shutdown Scene is not 'destroyed', it's simply not\r\n * currently active. Use the [DESTROY]{@linkcode Phaser.Scenes.Events#event:DESTROY} event to completely clear resources.\r\n *\r\n * @event Phaser.Scenes.Events#SHUTDOWN\r\n * @type {string}\r\n * @since 3.0.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 * @param {any} [data] - An optional data object that was passed to this Scene when it was shutdown.\r\n */", "meta": { "filename": "SHUTDOWN_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Systems Shutdown Event.\r\rThis event is dispatched by a Scene during the Scene Systems shutdown process.\r\rListen to it from a Scene using `this.events.on('shutdown', listener)`.\r\rYou should free-up any resources that may be in use by your Scene in this event handler, on the understanding\rthat the Scene may, at any time, become active again. A shutdown Scene is not 'destroyed', it's simply not\rcurrently active. Use the [DESTROY]{@linkcode Phaser.Scenes.Events#event:DESTROY} event to completely clear resources.", "kind": "event", "name": "SHUTDOWN", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.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" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "An optional data object that was passed to this Scene when it was shutdown.", "name": "data" } ], "memberof": "Phaser.Scenes.Events", "longname": "Phaser.Scenes.Events#event:SHUTDOWN", "scope": "instance", "___id": "T000002R036478", "___s": true }, { "comment": "/**\r\n * The Scene Systems Sleep Event.\r\n *\r\n * This event is dispatched by a Scene when it is sent to sleep, either directly via the `sleep` method,\r\n * or as an action from another Scene.\r\n *\r\n * Listen to it from a Scene using `this.events.on('sleep', listener)`.\r\n *\r\n * @event Phaser.Scenes.Events#SLEEP\r\n * @type {string}\r\n * @since 3.0.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 * @param {any} [data] - An optional data object that was passed to this Scene when it was sent to sleep.\r\n */", "meta": { "filename": "SLEEP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Systems Sleep Event.\r\rThis event is dispatched by a Scene when it is sent to sleep, either directly via the `sleep` method,\ror as an action from another Scene.\r\rListen to it from a Scene using `this.events.on('sleep', listener)`.", "kind": "event", "name": "SLEEP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.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" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "An optional data object that was passed to this Scene when it was sent to sleep.", "name": "data" } ], "memberof": "Phaser.Scenes.Events", "longname": "Phaser.Scenes.Events#event:SLEEP", "scope": "instance", "___id": "T000002R036480", "___s": true }, { "comment": "/**\r\n * The Scene Systems Start Event.\r\n *\r\n * This event is dispatched by a Scene during the Scene Systems start process. Primarily used by Scene Plugins.\r\n *\r\n * Listen to it from a Scene using `this.events.on('start', listener)`.\r\n *\r\n * @event Phaser.Scenes.Events#START\r\n * @type {string}\r\n * @since 3.0.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": "START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Systems Start Event.\r\rThis event is dispatched by a Scene during the Scene Systems start process. Primarily used by Scene Plugins.\r\rListen to it from a Scene using `this.events.on('start', listener)`.", "kind": "event", "name": "START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.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.Scenes.Events", "longname": "Phaser.Scenes.Events#event:START", "scope": "instance", "___id": "T000002R036482", "___s": true }, { "comment": "/**\r\n * The Scene Transition Complete Event.\r\n *\r\n * This event is dispatched by the Target Scene of a transition.\r\n *\r\n * It happens when the transition process has completed. This occurs when the duration timer equals or exceeds the duration\r\n * of the transition.\r\n *\r\n * Listen to it from a Scene using `this.events.on('transitioncomplete', listener)`.\r\n *\r\n * The Scene Transition event flow is as follows:\r\n *\r\n * 1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\r\n * 2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\r\n * 3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\r\n * 4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\r\n * 5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.\r\n *\r\n * @event Phaser.Scenes.Events#TRANSITION_COMPLETE\r\n * @type {string}\r\n * @since 3.5.0\r\n *\r\n * @param {Phaser.Scene} scene -The Scene on which the transitioned completed.\r\n */", "meta": { "filename": "TRANSITION_COMPLETE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Transition Complete Event.\r\rThis event is dispatched by the Target Scene of a transition.\r\rIt happens when the transition process has completed. This occurs when the duration timer equals or exceeds the duration\rof the transition.\r\rListen to it from a Scene using `this.events.on('transitioncomplete', listener)`.\r\rThe Scene Transition event flow is as follows:\r\r1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\r2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\r3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\r4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\r5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.", "kind": "event", "name": "TRANSITION_COMPLETE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.5.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene on which the transitioned completed.", "name": "scene" } ], "memberof": "Phaser.Scenes.Events", "longname": "Phaser.Scenes.Events#event:TRANSITION_COMPLETE", "scope": "instance", "___id": "T000002R036484", "___s": true }, { "comment": "/**\r\n * The Scene Transition Init Event.\r\n *\r\n * This event is dispatched by the Target Scene of a transition.\r\n *\r\n * It happens immediately after the `Scene.init` method is called. If the Scene does not have an `init` method,\r\n * this event is not dispatched.\r\n *\r\n * Listen to it from a Scene using `this.events.on('transitioninit', listener)`.\r\n *\r\n * The Scene Transition event flow is as follows:\r\n *\r\n * 1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\r\n * 2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\r\n * 3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\r\n * 4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\r\n * 5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.\r\n *\r\n * @event Phaser.Scenes.Events#TRANSITION_INIT\r\n * @type {string}\r\n * @since 3.5.0\r\n *\r\n * @param {Phaser.Scene} from - A reference to the Scene that is being transitioned from.\r\n * @param {number} duration - The duration of the transition in ms.\r\n */", "meta": { "filename": "TRANSITION_INIT_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Transition Init Event.\r\rThis event is dispatched by the Target Scene of a transition.\r\rIt happens immediately after the `Scene.init` method is called. If the Scene does not have an `init` method,\rthis event is not dispatched.\r\rListen to it from a Scene using `this.events.on('transitioninit', listener)`.\r\rThe Scene Transition event flow is as follows:\r\r1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\r2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\r3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\r4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\r5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.", "kind": "event", "name": "TRANSITION_INIT", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.5.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "A reference to the Scene that is being transitioned from.", "name": "from" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the transition in ms.", "name": "duration" } ], "memberof": "Phaser.Scenes.Events", "longname": "Phaser.Scenes.Events#event:TRANSITION_INIT", "scope": "instance", "___id": "T000002R036486", "___s": true }, { "comment": "/**\r\n * The Scene Transition Out Event.\r\n *\r\n * This event is dispatched by a Scene when it initiates a transition to another Scene.\r\n *\r\n * Listen to it from a Scene using `this.events.on('transitionout', listener)`.\r\n *\r\n * The Scene Transition event flow is as follows:\r\n *\r\n * 1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\r\n * 2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\r\n * 3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\r\n * 4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\r\n * 5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.\r\n *\r\n * @event Phaser.Scenes.Events#TRANSITION_OUT\r\n * @type {string}\r\n * @since 3.5.0\r\n *\r\n * @param {Phaser.Scene} target - A reference to the Scene that is being transitioned to.\r\n * @param {number} duration - The duration of the transition in ms.\r\n */", "meta": { "filename": "TRANSITION_OUT_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Transition Out Event.\r\rThis event is dispatched by a Scene when it initiates a transition to another Scene.\r\rListen to it from a Scene using `this.events.on('transitionout', listener)`.\r\rThe Scene Transition event flow is as follows:\r\r1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\r2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\r3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\r4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\r5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.", "kind": "event", "name": "TRANSITION_OUT", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.5.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "A reference to the Scene that is being transitioned to.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the transition in ms.", "name": "duration" } ], "memberof": "Phaser.Scenes.Events", "longname": "Phaser.Scenes.Events#event:TRANSITION_OUT", "scope": "instance", "___id": "T000002R036488", "___s": true }, { "comment": "/**\r\n * The Scene Transition Start Event.\r\n *\r\n * This event is dispatched by the Target Scene of a transition, only if that Scene was not asleep.\r\n *\r\n * It happens immediately after the `Scene.create` method is called. If the Scene does not have a `create` method,\r\n * this event is dispatched anyway.\r\n *\r\n * If the Target Scene was sleeping then the [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} event is\r\n * dispatched instead of this event.\r\n *\r\n * Listen to it from a Scene using `this.events.on('transitionstart', listener)`.\r\n *\r\n * The Scene Transition event flow is as follows:\r\n *\r\n * 1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\r\n * 2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\r\n * 3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\r\n * 4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\r\n * 5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.\r\n *\r\n * @event Phaser.Scenes.Events#TRANSITION_START\r\n * @type {string}\r\n * @since 3.5.0\r\n *\r\n * @param {Phaser.Scene} from - A reference to the Scene that is being transitioned from.\r\n * @param {number} duration - The duration of the transition in ms.\r\n */", "meta": { "filename": "TRANSITION_START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Transition Start Event.\r\rThis event is dispatched by the Target Scene of a transition, only if that Scene was not asleep.\r\rIt happens immediately after the `Scene.create` method is called. If the Scene does not have a `create` method,\rthis event is dispatched anyway.\r\rIf the Target Scene was sleeping then the [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} event is\rdispatched instead of this event.\r\rListen to it from a Scene using `this.events.on('transitionstart', listener)`.\r\rThe Scene Transition event flow is as follows:\r\r1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\r2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\r3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\r4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\r5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.", "kind": "event", "name": "TRANSITION_START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.5.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "A reference to the Scene that is being transitioned from.", "name": "from" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the transition in ms.", "name": "duration" } ], "memberof": "Phaser.Scenes.Events", "longname": "Phaser.Scenes.Events#event:TRANSITION_START", "scope": "instance", "___id": "T000002R036490", "___s": true }, { "comment": "/**\r\n * The Scene Transition Wake Event.\r\n *\r\n * This event is dispatched by the Target Scene of a transition, only if that Scene was asleep before\r\n * the transition began. If the Scene was not asleep the [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} event is dispatched instead.\r\n *\r\n * Listen to it from a Scene using `this.events.on('transitionwake', listener)`.\r\n *\r\n * The Scene Transition event flow is as follows:\r\n *\r\n * 1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\r\n * 2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\r\n * 3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\r\n * 4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\r\n * 5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.\r\n *\r\n * @event Phaser.Scenes.Events#TRANSITION_WAKE\r\n * @type {string}\r\n * @since 3.5.0\r\n *\r\n * @param {Phaser.Scene} from - A reference to the Scene that is being transitioned from.\r\n * @param {number} duration - The duration of the transition in ms.\r\n */", "meta": { "filename": "TRANSITION_WAKE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Transition Wake Event.\r\rThis event is dispatched by the Target Scene of a transition, only if that Scene was asleep before\rthe transition began. If the Scene was not asleep the [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} event is dispatched instead.\r\rListen to it from a Scene using `this.events.on('transitionwake', listener)`.\r\rThe Scene Transition event flow is as follows:\r\r1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\r2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\r3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\r4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\r5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.", "kind": "event", "name": "TRANSITION_WAKE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.5.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "A reference to the Scene that is being transitioned from.", "name": "from" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the transition in ms.", "name": "duration" } ], "memberof": "Phaser.Scenes.Events", "longname": "Phaser.Scenes.Events#event:TRANSITION_WAKE", "scope": "instance", "___id": "T000002R036492", "___s": true }, { "comment": "/**\r\n * The Scene Systems Update Event.\r\n *\r\n * This event is dispatched by a Scene during the main game loop step.\r\n *\r\n * The event flow for a single step of a Scene is as follows:\r\n *\r\n * 1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\r\n * 2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\r\n * 3. The `Scene.update` method is called, if it exists and the Scene is in a Running state, otherwise this is skipped.\r\n * 4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\r\n * 5. [PRE_RENDER]{@linkcode Phaser.Scenes.Events#event:PRE_RENDER}\r\n * 6. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\r\n *\r\n * Listen to it from a Scene using `this.events.on('update', listener)`.\r\n *\r\n * A Scene will only run its step if it is active.\r\n *\r\n * @event Phaser.Scenes.Events#UPDATE\r\n * @type {string}\r\n * @since 3.0.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 * @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\\scene\\events", "code": {} }, "description": "The Scene Systems Update Event.\r\rThis event is dispatched by a Scene during the main game loop step.\r\rThe event flow for a single step of a Scene is as follows:\r\r1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\r2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\r3. The `Scene.update` method is called, if it exists and the Scene is in a Running state, otherwise this is skipped.\r4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\r5. [PRE_RENDER]{@linkcode Phaser.Scenes.Events#event:PRE_RENDER}\r6. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\r\rListen to it from a Scene using `this.events.on('update', listener)`.\r\rA Scene will only run its step if it is active.", "kind": "event", "name": "UPDATE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.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" }, { "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.Scenes.Events", "longname": "Phaser.Scenes.Events#event:UPDATE", "scope": "instance", "___id": "T000002R036494", "___s": true }, { "comment": "/**\r\n * The Scene Systems Wake Event.\r\n *\r\n * This event is dispatched by a Scene when it is woken from sleep, either directly via the `wake` method,\r\n * or as an action from another Scene.\r\n *\r\n * Listen to it from a Scene using `this.events.on('wake', listener)`.\r\n *\r\n * @event Phaser.Scenes.Events#WAKE\r\n * @type {string}\r\n * @since 3.0.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 * @param {any} [data] - An optional data object that was passed to this Scene when it was woken up.\r\n */", "meta": { "filename": "WAKE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\events", "code": {} }, "description": "The Scene Systems Wake Event.\r\rThis event is dispatched by a Scene when it is woken from sleep, either directly via the `wake` method,\ror as an action from another Scene.\r\rListen to it from a Scene using `this.events.on('wake', listener)`.", "kind": "event", "name": "WAKE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.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" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "An optional data object that was passed to this Scene when it was woken up.", "name": "data" } ], "memberof": "Phaser.Scenes.Events", "longname": "Phaser.Scenes.Events#event:WAKE", "scope": "instance", "___id": "T000002R036496", "___s": true }, { "comment": "/**\r\n * Builds an array of which physics plugins should be activated for the given Scene.\r\n *\r\n * @function Phaser.Scenes.GetPhysicsPlugins\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scenes.Systems} sys - The scene system to get the physics systems of.\r\n *\r\n * @return {array} An array of Physics systems to start for this Scene.\r\n */", "meta": { "filename": "GetPhysicsPlugins.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Builds an array of which physics plugins should be activated for the given Scene.", "kind": "function", "name": "GetPhysicsPlugins", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "description": "The scene system to get the physics systems of.", "name": "sys" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "An array of Physics systems to start for this Scene." } ], "memberof": "Phaser.Scenes", "longname": "Phaser.Scenes.GetPhysicsPlugins", "scope": "static", "___id": "T000002R036500", "___s": true }, { "comment": "/**\r\n * Builds an array of which plugins (not including physics plugins) should be activated for the given Scene.\r\n *\r\n * @function Phaser.Scenes.GetScenePlugins\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scenes.Systems} sys - The Scene Systems object to check for plugins.\r\n *\r\n * @return {array} An array of all plugins which should be activated, either the default ones or the ones configured in the Scene Systems object.\r\n */", "meta": { "filename": "GetScenePlugins.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Builds an array of which plugins (not including physics plugins) should be activated for the given Scene.", "kind": "function", "name": "GetScenePlugins", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "description": "The Scene Systems object to check for plugins.", "name": "sys" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "An array of all plugins which should be activated, either the default ones or the ones configured in the Scene Systems object." } ], "memberof": "Phaser.Scenes", "longname": "Phaser.Scenes.GetScenePlugins", "scope": "static", "___id": "T000002R036509", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Scenes\r\n */", "meta": { "filename": "index.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "kind": "namespace", "name": "Scenes", "memberof": "Phaser", "longname": "Phaser.Scenes", "scope": "static", "___id": "T000002R036516", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A base Phaser.Scene class which can be extended for your own use.\r\n *\r\n * You can also define the optional methods {@link Phaser.Types.Scenes.SceneInitCallback init()}, {@link Phaser.Types.Scenes.ScenePreloadCallback preload()}, and {@link Phaser.Types.Scenes.SceneCreateCallback create()}.\r\n *\r\n * @class Scene\r\n * @memberof Phaser\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Scenes.SettingsConfig)} [config] - The scene key or scene specific configuration settings.\r\n */", "meta": { "filename": "Scene.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "classdesc": "A base Phaser.Scene class which can be extended for your own use.\r\rYou can also define the optional methods {@link Phaser.Types.Scenes.SceneInitCallback init()}, {@link Phaser.Types.Scenes.ScenePreloadCallback preload()}, and {@link Phaser.Types.Scenes.SceneCreateCallback create()}.", "kind": "class", "name": "Scene", "memberof": "Phaser", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Scenes.SettingsConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Scenes.SettingsConfig" } ] } }, "optional": true, "description": "The scene key or scene specific configuration settings.", "name": "config" } ], "scope": "static", "longname": "Phaser.Scene", "___id": "T000002R036557", "___s": true }, { "comment": "/**\r\n * The Scene Systems. You must never overwrite this property, or all hell will break lose.\r\n *\r\n * @name Phaser.Scene#sys\r\n * @type {Phaser.Scenes.Systems}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Scene Systems. You must never overwrite this property, or all hell will break lose.", "name": "sys", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#sys", "scope": "instance", "kind": "member", "___id": "T000002R036560", "___s": true }, { "comment": "/**\r\n * A reference to the Phaser.Game instance.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map.\r\n *\r\n * @name Phaser.Scene#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the Phaser.Game instance.\r\rThis property will only be available if defined in the Scene Injection Map.", "name": "game", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#game", "scope": "instance", "kind": "member", "___id": "T000002R036562", "___s": true }, { "comment": "/**\r\n * A reference to the global Animation Manager.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map.\r\n *\r\n * @name Phaser.Scene#anims\r\n * @type {Phaser.Animations.AnimationManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the global Animation Manager.\r\rThis property will only be available if defined in the Scene Injection Map.", "name": "anims", "type": { "names": [ "Phaser.Animations.AnimationManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationManager" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#anims", "scope": "instance", "kind": "member", "___id": "T000002R036564", "___s": true }, { "comment": "/**\r\n * A reference to the global Cache.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map.\r\n *\r\n * @name Phaser.Scene#cache\r\n * @type {Phaser.Cache.CacheManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the global Cache.\r\rThis property will only be available if defined in the Scene Injection Map.", "name": "cache", "type": { "names": [ "Phaser.Cache.CacheManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.CacheManager" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#cache", "scope": "instance", "kind": "member", "___id": "T000002R036566", "___s": true }, { "comment": "/**\r\n * A reference to the global Data Manager.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map.\r\n *\r\n * @name Phaser.Scene#registry\r\n * @type {Phaser.Data.DataManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 71, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the global Data Manager.\r\rThis property will only be available if defined in the Scene Injection Map.", "name": "registry", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#registry", "scope": "instance", "kind": "member", "___id": "T000002R036568", "___s": true }, { "comment": "/**\r\n * A reference to the Sound Manager.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map and the plugin is installed.\r\n *\r\n * @name Phaser.Scene#sound\r\n * @type {(Phaser.Sound.NoAudioSoundManager|Phaser.Sound.HTML5AudioSoundManager|Phaser.Sound.WebAudioSoundManager)}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the Sound Manager.\r\rThis property will only be available if defined in the Scene Injection Map and the plugin is installed.", "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.Scene", "longname": "Phaser.Scene#sound", "scope": "instance", "kind": "member", "___id": "T000002R036570", "___s": true }, { "comment": "/**\r\n * A reference to the Texture Manager.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map.\r\n *\r\n * @name Phaser.Scene#textures\r\n * @type {Phaser.Textures.TextureManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the Texture Manager.\r\rThis property will only be available if defined in the Scene Injection Map.", "name": "textures", "type": { "names": [ "Phaser.Textures.TextureManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#textures", "scope": "instance", "kind": "member", "___id": "T000002R036572", "___s": true }, { "comment": "/**\r\n * A Scene specific Event Emitter.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map.\r\n *\r\n * @name Phaser.Scene#events\r\n * @type {Phaser.Events.EventEmitter}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A Scene specific Event Emitter.\r\rThis property will only be available if defined in the Scene Injection Map.", "name": "events", "type": { "names": [ "Phaser.Events.EventEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Events.EventEmitter" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#events", "scope": "instance", "kind": "member", "___id": "T000002R036574", "___s": true }, { "comment": "/**\r\n * The Scene Camera Manager.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map.\r\n *\r\n * @name Phaser.Scene#cameras\r\n * @type {Phaser.Cameras.Scene2D.CameraManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 115, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Scene Camera Manager.\r\rThis property will only be available if defined in the Scene Injection Map.", "name": "cameras", "type": { "names": [ "Phaser.Cameras.Scene2D.CameraManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.CameraManager" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#cameras", "scope": "instance", "kind": "member", "___id": "T000002R036576", "___s": true }, { "comment": "/**\r\n * The Scene Game Object Factory.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map.\r\n *\r\n * @name Phaser.Scene#add\r\n * @type {Phaser.GameObjects.GameObjectFactory}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 126, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Scene Game Object Factory.\r\rThis property will only be available if defined in the Scene Injection Map.", "name": "add", "type": { "names": [ "Phaser.GameObjects.GameObjectFactory" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObjectFactory" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#add", "scope": "instance", "kind": "member", "___id": "T000002R036578", "___s": true }, { "comment": "/**\r\n * The Scene Game Object Creator.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map.\r\n *\r\n * @name Phaser.Scene#make\r\n * @type {Phaser.GameObjects.GameObjectCreator}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 137, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Scene Game Object Creator.\r\rThis property will only be available if defined in the Scene Injection Map.", "name": "make", "type": { "names": [ "Phaser.GameObjects.GameObjectCreator" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObjectCreator" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#make", "scope": "instance", "kind": "member", "___id": "T000002R036580", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Manager Plugin.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map.\r\n *\r\n * @name Phaser.Scene#scene\r\n * @type {Phaser.Scenes.ScenePlugin}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the Scene Manager Plugin.\r\rThis property will only be available if defined in the Scene Injection Map.", "name": "scene", "type": { "names": [ "Phaser.Scenes.ScenePlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.ScenePlugin" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#scene", "scope": "instance", "kind": "member", "___id": "T000002R036582", "___s": true }, { "comment": "/**\r\n * The Game Object Display List belonging to this Scene.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map.\r\n *\r\n * @name Phaser.Scene#children\r\n * @type {Phaser.GameObjects.DisplayList}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Game Object Display List belonging to this Scene.\r\rThis property will only be available if defined in the Scene Injection Map.", "name": "children", "type": { "names": [ "Phaser.GameObjects.DisplayList" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.DisplayList" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#children", "scope": "instance", "kind": "member", "___id": "T000002R036584", "___s": true }, { "comment": "/**\r\n * The Scene Lights Manager Plugin.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map and the plugin is installed.\r\n *\r\n * @name Phaser.Scene#lights\r\n * @type {Phaser.GameObjects.LightsManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 170, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Scene Lights Manager Plugin.\r\rThis property will only be available if defined in the Scene Injection Map and the plugin is installed.", "name": "lights", "type": { "names": [ "Phaser.GameObjects.LightsManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.LightsManager" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#lights", "scope": "instance", "kind": "member", "___id": "T000002R036586", "___s": true }, { "comment": "/**\r\n * A Scene specific Data Manager Plugin.\r\n *\r\n * See the `registry` property for the global Data Manager.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map and the plugin is installed.\r\n *\r\n * @name Phaser.Scene#data\r\n * @type {Phaser.Data.DataManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 181, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A Scene specific Data Manager Plugin.\r\rSee the `registry` property for the global Data Manager.\r\rThis property will only be available if defined in the Scene Injection Map and the plugin is installed.", "name": "data", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#data", "scope": "instance", "kind": "member", "___id": "T000002R036588", "___s": true }, { "comment": "/**\r\n * The Scene Input Manager Plugin.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map and the plugin is installed.\r\n *\r\n * @name Phaser.Scene#input\r\n * @type {Phaser.Input.InputPlugin}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 194, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Scene Input Manager Plugin.\r\rThis property will only be available if defined in the Scene Injection Map and the plugin is installed.", "name": "input", "type": { "names": [ "Phaser.Input.InputPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.InputPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#input", "scope": "instance", "kind": "member", "___id": "T000002R036590", "___s": true }, { "comment": "/**\r\n * The Scene Loader Plugin.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map and the plugin is installed.\r\n *\r\n * @name Phaser.Scene#load\r\n * @type {Phaser.Loader.LoaderPlugin}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 205, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Scene Loader Plugin.\r\rThis property will only be available if defined in the Scene Injection Map and the plugin is installed.", "name": "load", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#load", "scope": "instance", "kind": "member", "___id": "T000002R036592", "___s": true }, { "comment": "/**\r\n * The Scene Time and Clock Plugin.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map and the plugin is installed.\r\n *\r\n * @name Phaser.Scene#time\r\n * @type {Phaser.Time.Clock}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Scene Time and Clock Plugin.\r\rThis property will only be available if defined in the Scene Injection Map and the plugin is installed.", "name": "time", "type": { "names": [ "Phaser.Time.Clock" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Time.Clock" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#time", "scope": "instance", "kind": "member", "___id": "T000002R036594", "___s": true }, { "comment": "/**\r\n * The Scene Tween Manager Plugin.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map and the plugin is installed.\r\n *\r\n * @name Phaser.Scene#tweens\r\n * @type {Phaser.Tweens.TweenManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 227, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Scene Tween Manager Plugin.\r\rThis property will only be available if defined in the Scene Injection Map and the plugin is installed.", "name": "tweens", "type": { "names": [ "Phaser.Tweens.TweenManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.TweenManager" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#tweens", "scope": "instance", "kind": "member", "___id": "T000002R036596", "___s": true }, { "comment": "/**\r\n * The Scene Arcade Physics Plugin.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.\r\n *\r\n * @name Phaser.Scene#physics\r\n * @type {Phaser.Physics.Arcade.ArcadePhysics}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 238, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Scene Arcade Physics Plugin.\r\rThis property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.", "name": "physics", "type": { "names": [ "Phaser.Physics.Arcade.ArcadePhysics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Arcade.ArcadePhysics" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#physics", "scope": "instance", "kind": "member", "___id": "T000002R036598", "___s": true }, { "comment": "/**\r\n * The Scene Matter Physics Plugin.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.\r\n *\r\n * @name Phaser.Scene#matter\r\n * @type {Phaser.Physics.Matter.MatterPhysics}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 249, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Scene Matter Physics Plugin.\r\rThis property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.", "name": "matter", "type": { "names": [ "Phaser.Physics.Matter.MatterPhysics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Physics.Matter.MatterPhysics" } }, "since": "3.0.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#matter", "scope": "instance", "kind": "member", "___id": "T000002R036600", "___s": true }, { "comment": "/**\r\n * The Facebook Instant Games Plugin.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.\r\n *\r\n * @name Phaser.Scene#facebook\r\n * @type {Phaser.FacebookInstantGamesPlugin}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 262, "columnno": 12, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Facebook Instant Games Plugin.\r\rThis property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.", "name": "facebook", "type": { "names": [ "Phaser.FacebookInstantGamesPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FacebookInstantGamesPlugin" } }, "since": "3.12.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#facebook", "scope": "instance", "kind": "member", "___id": "T000002R036602", "___s": true }, { "comment": "/**\r\n * A reference to the global Scale Manager.\r\n *\r\n * This property will only be available if defined in the Scene Injection Map.\r\n *\r\n * @name Phaser.Scene#scale\r\n * @type {Phaser.Scale.ScaleManager}\r\n * @since 3.16.2\r\n */", "meta": { "filename": "Scene.js", "lineno": 274, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the global Scale Manager.\r\rThis property will only be available if defined in the Scene Injection Map.", "name": "scale", "type": { "names": [ "Phaser.Scale.ScaleManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.ScaleManager" } }, "since": "3.16.2", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#scale", "scope": "instance", "kind": "member", "___id": "T000002R036604", "___s": true }, { "comment": "/**\r\n * A reference to the global 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.Scene#plugins\r\n * @type {Phaser.Plugins.PluginManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 285, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the global 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.Scene", "longname": "Phaser.Scene#plugins", "scope": "instance", "kind": "member", "___id": "T000002R036606", "___s": true }, { "comment": "/**\r\n * A reference to the renderer instance Phaser is using, either Canvas Renderer or WebGL Renderer.\r\n *\r\n * @name Phaser.Scene#renderer\r\n * @type {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Scene.js", "lineno": 297, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the renderer instance Phaser is using, either Canvas Renderer or WebGL Renderer.", "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.50.0", "memberof": "Phaser.Scene", "longname": "Phaser.Scene#renderer", "scope": "instance", "kind": "member", "___id": "T000002R036608", "___s": true }, { "comment": "/**\r\n * This method should be overridden by your own Scenes.\r\n *\r\n * This method is called once per game step while the scene is running.\r\n *\r\n * @method Phaser.Scene#update\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": "Scene.js", "lineno": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "This method should be overridden by your own Scenes.\r\rThis method is called once per game step while the scene is running.", "kind": "function", "name": "update", "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.Scene", "longname": "Phaser.Scene#update", "scope": "instance", "___id": "T000002R036610", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Scene Manager.\r\n *\r\n * The Scene Manager is a Game level system, responsible for creating, processing and updating all of the\r\n * Scenes in a Game instance.\r\n *\r\n * You should not usually interact directly with the Scene Manager at all. Instead, you should use\r\n * the Scene Plugin, which is available from every Scene in your game via the `this.scene` property.\r\n *\r\n * Using methods in this Scene Manager directly will break queued operations and can cause runtime\r\n * errors. Instead, go via the Scene Plugin. Every feature this Scene Manager provides is also\r\n * available via the Scene Plugin.\r\n *\r\n * @class SceneManager\r\n * @memberof Phaser.Scenes\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - The Phaser.Game instance this Scene Manager belongs to.\r\n * @param {object} sceneConfig - Scene specific configuration settings.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "classdesc": "The Scene Manager.\r\rThe Scene Manager is a Game level system, responsible for creating, processing and updating all of the\rScenes in a Game instance.\r\rYou should not usually interact directly with the Scene Manager at all. Instead, you should use\rthe Scene Plugin, which is available from every Scene in your game via the `this.scene` property.\r\rUsing methods in this Scene Manager directly will break queued operations and can cause runtime\rerrors. Instead, go via the Scene Plugin. Every feature this Scene Manager provides is also\ravailable via the Scene Plugin.", "kind": "class", "name": "SceneManager", "memberof": "Phaser.Scenes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "The Phaser.Game instance this Scene Manager belongs to.", "name": "game" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "Scene specific configuration settings.", "name": "sceneConfig" } ], "scope": "static", "longname": "Phaser.Scenes.SceneManager", "___id": "T000002R036622", "___s": true }, { "comment": "/**\r\n * The Game that this SceneManager belongs to.\r\n *\r\n * @name Phaser.Scenes.SceneManager#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Game that this SceneManager belongs to.", "name": "game", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#game", "scope": "instance", "kind": "member", "___id": "T000002R036625", "___s": true }, { "comment": "/**\r\n * An object that maps the keys to the scene so we can quickly get a scene from a key without iteration.\r\n *\r\n * @name Phaser.Scenes.SceneManager#keys\r\n * @type {Record}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "An object that maps the keys to the scene so we can quickly get a scene from a key without iteration.", "name": "keys", "type": { "names": [ "Record." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Record" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "since": "3.0.0", "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#keys", "scope": "instance", "kind": "member", "___id": "T000002R036627", "___s": true }, { "comment": "/**\r\n * The array in which all of the scenes are kept.\r\n *\r\n * @name Phaser.Scenes.SceneManager#scenes\r\n * @type {Phaser.Scene[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The array in which all of the scenes are kept.", "name": "scenes", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Scene", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#scenes", "scope": "instance", "kind": "member", "___id": "T000002R036629", "___s": true }, { "comment": "/**\r\n * Is the Scene Manager actively processing the Scenes list?\r\n *\r\n * @name Phaser.Scenes.SceneManager#isProcessing\r\n * @type {boolean}\r\n * @default false\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Is the Scene Manager actively processing the Scenes list?", "name": "isProcessing", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#isProcessing", "scope": "instance", "kind": "member", "___id": "T000002R036639", "___s": true }, { "comment": "/**\r\n * Has the Scene Manager properly started?\r\n *\r\n * @name Phaser.Scenes.SceneManager#isBooted\r\n * @type {boolean}\r\n * @default false\r\n * @readonly\r\n * @since 3.4.0\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Has the Scene Manager properly started?", "name": "isBooted", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "readonly": true, "since": "3.4.0", "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#isBooted", "scope": "instance", "kind": "member", "___id": "T000002R036641", "___s": true }, { "comment": "/**\r\n * Do any of the Cameras in any of the Scenes require a custom viewport?\r\n * If not we can skip scissor tests.\r\n *\r\n * @name Phaser.Scenes.SceneManager#customViewports\r\n * @type {number}\r\n * @default 0\r\n * @since 3.12.0\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 134, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Do any of the Cameras in any of the Scenes require a custom viewport?\rIf not we can skip scissor tests.", "name": "customViewports", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.12.0", "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#customViewports", "scope": "instance", "kind": "member", "___id": "T000002R036643", "___s": true }, { "comment": "/**\r\n * This system Scene is created during `bootQueue` and is a default\r\n * empty Scene that lives outside of the Scene list, but can be used\r\n * by plugins and managers that need access to a live Scene, without\r\n * being tied to one.\r\n *\r\n * @name Phaser.Scenes.SceneManager#systemScene\r\n * @type {Phaser.Scene}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "This system Scene is created during `bootQueue` and is a default\rempty Scene that lives outside of the Scene list, but can be used\rby plugins and managers that need access to a live Scene, without\rbeing tied to one.", "name": "systemScene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.60.0", "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#systemScene", "scope": "instance", "kind": "member", "___id": "T000002R036645", "___s": true }, { "comment": "/**\r\n * Process the Scene operations queue.\r\n *\r\n * @method Phaser.Scenes.SceneManager#processQueue\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 265, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Process the Scene operations queue.", "kind": "function", "name": "processQueue", "since": "3.0.0", "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#processQueue", "scope": "instance", "___id": "T000002R036678", "___s": true }, { "comment": "/**\r\n * Adds a new Scene into the SceneManager.\r\n * You must give each Scene a unique key by which you'll identify it.\r\n *\r\n * The `sceneConfig` can be:\r\n *\r\n * * A `Phaser.Scene` object, or an object that extends it.\r\n * * A plain JavaScript object\r\n * * A JavaScript ES6 Class that extends `Phaser.Scene`\r\n * * A JavaScript ES5 prototype based Class\r\n * * A JavaScript function\r\n *\r\n * If a function is given then a new Scene will be created by calling it.\r\n *\r\n * @method Phaser.Scenes.SceneManager#add\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.\r\n * @param {(Phaser.Types.Scenes.SceneType)} sceneConfig - The config for the Scene\r\n * @param {boolean} [autoStart=false] - If `true` the Scene will be started immediately after being added.\r\n * @param {object} [data] - Optional data object. This will be set as `Scene.settings.data` and passed to `Scene.init`, and `Scene.create`.\r\n *\r\n * @return {?Phaser.Scene} The added Scene, if it was added immediately, otherwise `null`.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Adds a new Scene into the SceneManager.\rYou must give each Scene a unique key by which you'll identify it.\r\rThe `sceneConfig` can be:\r\r* A `Phaser.Scene` object, or an object that extends it.\r* A plain JavaScript object\r* A JavaScript ES6 Class that extends `Phaser.Scene`\r* A JavaScript ES5 prototype based Class\r* A JavaScript function\r\rIf a function is given then a new Scene will be created by calling it.", "kind": "function", "name": "add", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Scenes.SceneType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Scenes.SceneType" } ] } }, "description": "The config for the Scene", "name": "sceneConfig" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true` the Scene will be started immediately after being added.", "name": "autoStart" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional data object. This will be set as `Scene.settings.data` and passed to `Scene.init`, and `Scene.create`.", "name": "data" } ], "returns": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene", "nullable": true } }, "nullable": true, "description": "The added Scene, if it was added immediately, otherwise `null`." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#add", "scope": "instance", "___id": "T000002R036693", "___s": true }, { "comment": "/**\r\n * Removes a Scene from the SceneManager.\r\n *\r\n * The Scene is removed from the local scenes array, it's key is cleared from the keys\r\n * cache and Scene.Systems.destroy is then called on it.\r\n *\r\n * If the SceneManager is processing the Scenes when this method is called it will\r\n * queue the operation for the next update sequence.\r\n *\r\n * @method Phaser.Scenes.SceneManager#remove\r\n * @since 3.2.0\r\n *\r\n * @param {string} key - A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.\r\n *\r\n * @return {this} This Scene Manager instance.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 407, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Removes a Scene from the SceneManager.\r\rThe Scene is removed from the local scenes array, it's key is cleared from the keys\rcache and Scene.Systems.destroy is then called on it.\r\rIf the SceneManager is processing the Scenes when this method is called it will\rqueue the operation for the next update sequence.", "kind": "function", "name": "remove", "since": "3.2.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Manager instance." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#remove", "scope": "instance", "___id": "T000002R036712", "___s": true }, { "comment": "/**\r\n * Updates the Scenes.\r\n *\r\n * @method Phaser.Scenes.SceneManager#update\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - Time elapsed.\r\n * @param {number} delta - Delta time from the last update.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 552, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Updates the Scenes.", "kind": "function", "name": "update", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Time elapsed.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Delta time from the last update.", "name": "delta" } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#update", "scope": "instance", "___id": "T000002R036734", "___s": true }, { "comment": "/**\r\n * Renders the Scenes.\r\n *\r\n * @method Phaser.Scenes.SceneManager#render\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - The renderer to use.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 584, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Renders the Scenes.", "kind": "function", "name": "render", "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 to use.", "name": "renderer" } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#render", "scope": "instance", "___id": "T000002R036739", "___s": true }, { "comment": "/**\r\n * Returns an array of all the current Scenes being managed by this Scene Manager.\r\n *\r\n * You can filter the output by the active state of the Scene and choose to have\r\n * the array returned in normal or reversed order.\r\n *\r\n * @method Phaser.Scenes.SceneManager#getScenes\r\n * @since 3.16.0\r\n *\r\n * @generic {Phaser.Scene[]} T - [$return]\r\n *\r\n * @param {boolean} [isActive=true] - Only include Scene's that are currently active?\r\n * @param {boolean} [inReverse=false] - Return the array of Scenes in reverse?\r\n *\r\n * @return {Phaser.Scene[]} An array containing all of the Scenes in the Scene Manager.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 846, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Returns an array of all the current Scenes being managed by this Scene Manager.\r\rYou can filter the output by the active state of the Scene and choose to have\rthe array returned in normal or reversed order.", "kind": "function", "name": "getScenes", "since": "3.16.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene[]} T - [$return]", "value": "{Phaser.Scene[]} T - [$return]" } ], "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Only include Scene's that are currently active?", "name": "isActive" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Return the array of Scenes in reverse?", "name": "inReverse" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Scene", "type": "NameExpression" } ] } }, "description": "An array containing all of the Scenes in the Scene Manager." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#getScenes", "scope": "instance", "___id": "T000002R036780", "___s": true }, { "comment": "/**\r\n * Retrieves a Scene based on the given key.\r\n *\r\n * If an actual Scene is passed to this method, it can be used to check if\r\n * its currently within the Scene Manager, or not.\r\n *\r\n * @method Phaser.Scenes.SceneManager#getScene\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n * @genericUse {T} - [$return]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The key of the Scene to retrieve.\r\n *\r\n * @return {?Phaser.Scene} The Scene, or `null` if no matching Scene was found.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 883, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Retrieves a Scene based on the given key.\r\rIf an actual Scene is passed to this method, it can be used to check if\rits currently within the Scene Manager, or not.", "kind": "function", "name": "getScene", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$return]", "value": "{T} - [$return]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The key of the Scene to retrieve.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene", "nullable": true } }, "nullable": true, "description": "The Scene, or `null` if no matching Scene was found." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#getScene", "scope": "instance", "___id": "T000002R036788", "___s": true }, { "comment": "/**\r\n * Determines whether a Scene is running.\r\n *\r\n * @method Phaser.Scenes.SceneManager#isActive\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to check.\r\n *\r\n * @return {boolean} Whether the Scene is running, or `null` if no matching Scene was found.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 923, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Determines whether a Scene is running.", "kind": "function", "name": "isActive", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to check.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the Scene is running, or `null` if no matching Scene was found." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#isActive", "scope": "instance", "___id": "T000002R036791", "___s": true }, { "comment": "/**\r\n * Determines whether a Scene is paused.\r\n *\r\n * @method Phaser.Scenes.SceneManager#isPaused\r\n * @since 3.17.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to check.\r\n *\r\n * @return {boolean} Whether the Scene is paused, or `null` if no matching Scene was found.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 948, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Determines whether a Scene is paused.", "kind": "function", "name": "isPaused", "since": "3.17.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to check.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the Scene is paused, or `null` if no matching Scene was found." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#isPaused", "scope": "instance", "___id": "T000002R036794", "___s": true }, { "comment": "/**\r\n * Determines whether a Scene is visible.\r\n *\r\n * @method Phaser.Scenes.SceneManager#isVisible\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to check.\r\n *\r\n * @return {boolean} Whether the Scene is visible, or `null` if no matching Scene was found.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 973, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Determines whether a Scene is visible.", "kind": "function", "name": "isVisible", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to check.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the Scene is visible, or `null` if no matching Scene was found." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#isVisible", "scope": "instance", "___id": "T000002R036797", "___s": true }, { "comment": "/**\r\n * Determines whether a Scene is sleeping.\r\n *\r\n * @method Phaser.Scenes.SceneManager#isSleeping\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to check.\r\n *\r\n * @return {boolean} Whether the Scene is sleeping, or `null` if no matching Scene was found.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 998, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Determines whether a Scene is sleeping.", "kind": "function", "name": "isSleeping", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to check.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the Scene is sleeping, or `null` if no matching Scene was found." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#isSleeping", "scope": "instance", "___id": "T000002R036800", "___s": true }, { "comment": "/**\r\n * Pauses the given Scene.\r\n *\r\n * @method Phaser.Scenes.SceneManager#pause\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to pause.\r\n * @param {object} [data] - An optional data object that will be passed to the Scene and emitted by its pause event.\r\n *\r\n * @return {this} This Scene Manager instance.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Pauses the given Scene.", "kind": "function", "name": "pause", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to pause.", "name": "key" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "An optional data object that will be passed to the Scene and emitted by its pause event.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Manager instance." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#pause", "scope": "instance", "___id": "T000002R036803", "___s": true }, { "comment": "/**\r\n * Resumes the given Scene.\r\n *\r\n * @method Phaser.Scenes.SceneManager#resume\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to resume.\r\n * @param {object} [data] - An optional data object that will be passed to the Scene and emitted by its resume event.\r\n *\r\n * @return {this} This Scene Manager instance.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1049, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Resumes the given Scene.", "kind": "function", "name": "resume", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to resume.", "name": "key" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "An optional data object that will be passed to the Scene and emitted by its resume event.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Manager instance." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#resume", "scope": "instance", "___id": "T000002R036806", "___s": true }, { "comment": "/**\r\n * Puts the given Scene to sleep.\r\n *\r\n * @method Phaser.Scenes.SceneManager#sleep\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to put to sleep.\r\n * @param {object} [data] - An optional data object that will be passed to the Scene and emitted by its sleep event.\r\n *\r\n * @return {this} This Scene Manager instance.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1075, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Puts the given Scene to sleep.", "kind": "function", "name": "sleep", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to put to sleep.", "name": "key" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "An optional data object that will be passed to the Scene and emitted by its sleep event.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Manager instance." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#sleep", "scope": "instance", "___id": "T000002R036809", "___s": true }, { "comment": "/**\r\n * Awakens the given Scene.\r\n *\r\n * @method Phaser.Scenes.SceneManager#wake\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to wake up.\r\n * @param {object} [data] - An optional data object that will be passed to the Scene and emitted by its wake event.\r\n *\r\n * @return {this} This Scene Manager instance.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1101, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Awakens the given Scene.", "kind": "function", "name": "wake", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to wake up.", "name": "key" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "An optional data object that will be passed to the Scene and emitted by its wake event.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Manager instance." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#wake", "scope": "instance", "___id": "T000002R036812", "___s": true }, { "comment": "/**\r\n * Runs the given Scene.\r\n *\r\n * If the given Scene is paused, it will resume it. If sleeping, it will wake it.\r\n * If not running at all, it will be started.\r\n *\r\n * Use this if you wish to open a modal Scene by calling `pause` on the current\r\n * Scene, then `run` on the modal Scene.\r\n *\r\n * @method Phaser.Scenes.SceneManager#run\r\n * @since 3.10.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to run.\r\n * @param {object} [data] - A data object that will be passed to the Scene on start, wake, or resume.\r\n *\r\n * @return {this} This Scene Manager instance.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1127, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Runs the given Scene.\r\rIf the given Scene is paused, it will resume it. If sleeping, it will wake it.\rIf not running at all, it will be started.\r\rUse this if you wish to open a modal Scene by calling `pause` on the current\rScene, then `run` on the modal Scene.", "kind": "function", "name": "run", "since": "3.10.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to run.", "name": "key" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "A data object that will be passed to the Scene on start, wake, or resume.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Manager instance." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#run", "scope": "instance", "___id": "T000002R036815", "___s": true }, { "comment": "/**\r\n * Starts the given Scene, if it is not starting, loading, or creating.\r\n *\r\n * If the Scene is running, paused, or sleeping, it will be shutdown and then started.\r\n *\r\n * @method Phaser.Scenes.SceneManager#start\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to start.\r\n * @param {object} [data] - Optional data object to pass to `Scene.Settings` and `Scene.init`, and `Scene.create`.\r\n *\r\n * @return {this} This Scene Manager instance.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1181, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Starts the given Scene, if it is not starting, loading, or creating.\r\rIf the Scene is running, paused, or sleeping, it will be shutdown and then started.", "kind": "function", "name": "start", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to start.", "name": "key" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional data object to pass to `Scene.Settings` and `Scene.init`, and `Scene.create`.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Manager instance." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#start", "scope": "instance", "___id": "T000002R036819", "___s": true }, { "comment": "/**\r\n * Stops the given Scene.\r\n *\r\n * @method Phaser.Scenes.SceneManager#stop\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to stop.\r\n * @param {object} [data] - Optional data object to pass to Scene.shutdown.\r\n *\r\n * @return {this} This Scene Manager instance.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1277, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Stops the given Scene.", "kind": "function", "name": "stop", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to stop.", "name": "key" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional data object to pass to Scene.shutdown.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Manager instance." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#stop", "scope": "instance", "___id": "T000002R036833", "___s": true }, { "comment": "/**\r\n * Sleeps one one Scene and starts the other.\r\n *\r\n * @method Phaser.Scenes.SceneManager#switch\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [from,to]\r\n *\r\n * @param {(string|Phaser.Scene)} from - The Scene to sleep.\r\n * @param {(string|Phaser.Scene)} to - The Scene to start.\r\n *\r\n * @return {this} This Scene Manager instance.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1311, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Sleeps one one Scene and starts the other.", "kind": "function", "name": "switch", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [from,to]", "value": "{(T|string)} - [from,to]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to sleep.", "name": "from" }, { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to start.", "name": "to" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Manager instance." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#switch", "scope": "instance", "___id": "T000002R036837", "___s": true }, { "comment": "/**\r\n * Retrieves a Scene by numeric index.\r\n *\r\n * @method Phaser.Scenes.SceneManager#getAt\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {T} - [$return]\r\n *\r\n * @param {number} index - The index of the Scene to retrieve.\r\n *\r\n * @return {(Phaser.Scene|undefined)} The Scene.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1347, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Retrieves a Scene by numeric index.", "kind": "function", "name": "getAt", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$return]", "value": "{T} - [$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the Scene to retrieve.", "name": "index" } ], "returns": [ { "type": { "names": [ "Phaser.Scene", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Scene" }, { "type": "UndefinedLiteral" } ] } }, "description": "The Scene." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#getAt", "scope": "instance", "___id": "T000002R036841", "___s": true }, { "comment": "/**\r\n * Retrieves the numeric index of a Scene.\r\n *\r\n * @method Phaser.Scenes.SceneManager#getIndex\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The key of the Scene.\r\n *\r\n * @return {number} The index of the Scene.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1365, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Retrieves the numeric index of a Scene.", "kind": "function", "name": "getIndex", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The key of the Scene.", "name": "key" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the Scene." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#getIndex", "scope": "instance", "___id": "T000002R036843", "___s": true }, { "comment": "/**\r\n * Brings a Scene to the top of the Scenes list.\r\n *\r\n * This means it will render above all other Scenes.\r\n *\r\n * @method Phaser.Scenes.SceneManager#bringToTop\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to move.\r\n *\r\n * @return {this} This Scene Manager instance.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1385, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Brings a Scene to the top of the Scenes list.\r\rThis means it will render above all other Scenes.", "kind": "function", "name": "bringToTop", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to move.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Manager instance." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#bringToTop", "scope": "instance", "___id": "T000002R036846", "___s": true }, { "comment": "/**\r\n * Sends a Scene to the back of the Scenes list.\r\n *\r\n * This means it will render below all other Scenes.\r\n *\r\n * @method Phaser.Scenes.SceneManager#sendToBack\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to move.\r\n *\r\n * @return {this} This Scene Manager instance.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1422, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Sends a Scene to the back of the Scenes list.\r\rThis means it will render below all other Scenes.", "kind": "function", "name": "sendToBack", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to move.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Manager instance." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#sendToBack", "scope": "instance", "___id": "T000002R036853", "___s": true }, { "comment": "/**\r\n * Moves a Scene down one position in the Scenes list.\r\n *\r\n * @method Phaser.Scenes.SceneManager#moveDown\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to move.\r\n *\r\n * @return {this} This Scene Manager instance.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1459, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Moves a Scene down one position in the Scenes list.", "kind": "function", "name": "moveDown", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to move.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Manager instance." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#moveDown", "scope": "instance", "___id": "T000002R036860", "___s": true }, { "comment": "/**\r\n * Moves a Scene up one position in the Scenes list.\r\n *\r\n * @method Phaser.Scenes.SceneManager#moveUp\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to move.\r\n *\r\n * @return {this} This Scene Manager instance.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1496, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Moves a Scene up one position in the Scenes list.", "kind": "function", "name": "moveUp", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to move.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Manager instance." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#moveUp", "scope": "instance", "___id": "T000002R036871", "___s": true }, { "comment": "/**\r\n * Moves a Scene so it is immediately above another Scene in the Scenes list.\r\n *\r\n * This means it will render over the top of the other Scene.\r\n *\r\n * @method Phaser.Scenes.SceneManager#moveAbove\r\n * @since 3.2.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [keyA,keyB]\r\n *\r\n * @param {(string|Phaser.Scene)} keyA - The Scene that Scene B will be moved above.\r\n * @param {(string|Phaser.Scene)} keyB - The Scene to be moved.\r\n *\r\n * @return {this} This Scene Manager instance.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1533, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Moves a Scene so it is immediately above another Scene in the Scenes list.\r\rThis means it will render over the top of the other Scene.", "kind": "function", "name": "moveAbove", "since": "3.2.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [keyA,keyB]", "value": "{(T|string)} - [keyA,keyB]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene that Scene B will be moved above.", "name": "keyA" }, { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to be moved.", "name": "keyB" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Manager instance." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#moveAbove", "scope": "instance", "___id": "T000002R036882", "___s": true }, { "comment": "/**\r\n * Moves a Scene so it is immediately below another Scene in the Scenes list.\r\n *\r\n * This means it will render behind the other Scene.\r\n *\r\n * @method Phaser.Scenes.SceneManager#moveBelow\r\n * @since 3.2.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [keyA,keyB]\r\n *\r\n * @param {(string|Phaser.Scene)} keyA - The Scene that Scene B will be moved below.\r\n * @param {(string|Phaser.Scene)} keyB - The Scene to be moved.\r\n *\r\n * @return {this} This Scene Manager instance.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1580, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Moves a Scene so it is immediately below another Scene in the Scenes list.\r\rThis means it will render behind the other Scene.", "kind": "function", "name": "moveBelow", "since": "3.2.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [keyA,keyB]", "value": "{(T|string)} - [keyA,keyB]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene that Scene B will be moved below.", "name": "keyA" }, { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to be moved.", "name": "keyB" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Manager instance." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#moveBelow", "scope": "instance", "___id": "T000002R036890", "___s": true }, { "comment": "/**\r\n * Swaps the positions of two Scenes in the Scenes list.\r\n *\r\n * @method Phaser.Scenes.SceneManager#swapPosition\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [keyA,keyB]\r\n *\r\n * @param {(string|Phaser.Scene)} keyA - The first Scene to swap.\r\n * @param {(string|Phaser.Scene)} keyB - The second Scene to swap.\r\n *\r\n * @return {this} This Scene Manager instance.\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1654, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Swaps the positions of two Scenes in the Scenes list.", "kind": "function", "name": "swapPosition", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [keyA,keyB]", "value": "{(T|string)} - [keyA,keyB]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The first Scene to swap.", "name": "keyA" }, { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The second Scene to swap.", "name": "keyB" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Manager instance." } ], "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#swapPosition", "scope": "instance", "___id": "T000002R036903", "___s": true }, { "comment": "/**\r\n * Dumps debug information about each Scene to the developer console.\r\n *\r\n * @method Phaser.Scenes.SceneManager#dump\r\n * @since 3.2.0\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1696, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Dumps debug information about each Scene to the developer console.", "kind": "function", "name": "dump", "since": "3.2.0", "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#dump", "scope": "instance", "___id": "T000002R036913", "___s": true }, { "comment": "/**\r\n * Destroy this Scene Manager and all of its systems.\r\n *\r\n * This process cannot be reversed.\r\n *\r\n * This method is called automatically when a Phaser Game instance is destroyed.\r\n *\r\n * @method Phaser.Scenes.SceneManager#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SceneManager.js", "lineno": 1720, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Destroy this Scene Manager and all of its systems.\r\rThis process cannot be reversed.\r\rThis method is called automatically when a Phaser Game instance is destroyed.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Scenes.SceneManager", "longname": "Phaser.Scenes.SceneManager#destroy", "scope": "instance", "___id": "T000002R036921", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Scene Plugin is the main interface to the Scene Manager and allows you to control\r\n * any Scene running in your game. You should always use this plugin. By default, it is\r\n * mapped to the Scene property `this.scene`. Meaning, from within a Scene, you can call\r\n * methods such as `this.scene.start()`.\r\n *\r\n * Note that nearly all methods in this class are run on a queue-basis and not\r\n * immediately. For example, calling `this.scene.launch('SceneB')` will try to\r\n * launch SceneB when the Scene Manager next updates, which is at the start of the game\r\n * step. All operations are queued and run in the order in which they are invoked here.\r\n *\r\n * @class ScenePlugin\r\n * @memberof Phaser.Scenes\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene that this ScenePlugin belongs to.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "classdesc": "The Scene Plugin is the main interface to the Scene Manager and allows you to control\rany Scene running in your game. You should always use this plugin. By default, it is\rmapped to the Scene property `this.scene`. Meaning, from within a Scene, you can call\rmethods such as `this.scene.start()`.\r\rNote that nearly all methods in this class are run on a queue-basis and not\rimmediately. For example, calling `this.scene.launch('SceneB')` will try to\rlaunch SceneB when the Scene Manager next updates, which is at the start of the game\rstep. All operations are queued and run in the order in which they are invoked here.", "kind": "class", "name": "ScenePlugin", "memberof": "Phaser.Scenes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene that this ScenePlugin belongs to.", "name": "scene" } ], "scope": "static", "longname": "Phaser.Scenes.ScenePlugin", "___id": "T000002R036938", "___s": true }, { "comment": "/**\r\n * The Scene that this ScenePlugin belongs to.\r\n *\r\n * @name Phaser.Scenes.ScenePlugin#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Scene that this ScenePlugin belongs to.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#scene", "scope": "instance", "kind": "member", "___id": "T000002R036941", "___s": true }, { "comment": "/**\r\n * The Scene Systems instance of the Scene that this ScenePlugin belongs to.\r\n *\r\n * @name Phaser.Scenes.ScenePlugin#systems\r\n * @type {Phaser.Scenes.Systems}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Scene Systems instance of the Scene that this ScenePlugin belongs to.", "name": "systems", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#systems", "scope": "instance", "kind": "member", "___id": "T000002R036943", "___s": true }, { "comment": "/**\r\n * The settings of the Scene this ScenePlugin belongs to.\r\n *\r\n * @name Phaser.Scenes.ScenePlugin#settings\r\n * @type {Phaser.Types.Scenes.SettingsObject}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 56, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The settings of the Scene this ScenePlugin belongs to.", "name": "settings", "type": { "names": [ "Phaser.Types.Scenes.SettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Scenes.SettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#settings", "scope": "instance", "kind": "member", "___id": "T000002R036945", "___s": true }, { "comment": "/**\r\n * The key of the Scene this ScenePlugin belongs to.\r\n *\r\n * @name Phaser.Scenes.ScenePlugin#key\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The key of the Scene this ScenePlugin belongs to.", "name": "key", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#key", "scope": "instance", "kind": "member", "___id": "T000002R036947", "___s": true }, { "comment": "/**\r\n * The Game's SceneManager.\r\n *\r\n * @name Phaser.Scenes.ScenePlugin#manager\r\n * @type {Phaser.Scenes.SceneManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Game's SceneManager.", "name": "manager", "type": { "names": [ "Phaser.Scenes.SceneManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.SceneManager" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#manager", "scope": "instance", "kind": "member", "___id": "T000002R036949", "___s": true }, { "comment": "/**\r\n * If this Scene is currently transitioning to another, this holds\r\n * the current percentage of the transition progress, between 0 and 1.\r\n *\r\n * @name Phaser.Scenes.ScenePlugin#transitionProgress\r\n * @type {number}\r\n * @since 3.5.0\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "If this Scene is currently transitioning to another, this holds\rthe current percentage of the transition progress, between 0 and 1.", "name": "transitionProgress", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.5.0", "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#transitionProgress", "scope": "instance", "kind": "member", "___id": "T000002R036951", "___s": true }, { "comment": "/**\r\n * Shutdown this Scene and run the given one.\r\n *\r\n * This will happen at the next Scene Manager update, not immediately.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#start\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to start.\r\n * @param {object} [data] - The Scene data. If no value is given it will not overwrite any previous data that may exist.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 196, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Shutdown this Scene and run the given one.\r\rThis will happen at the next Scene Manager update, not immediately.", "kind": "function", "name": "start", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to start.", "name": "key" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The Scene data. If no value is given it will not overwrite any previous data that may exist.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#start", "scope": "instance", "___id": "T000002R036972", "___s": true }, { "comment": "/**\r\n * Restarts this Scene.\r\n *\r\n * This will happen at the next Scene Manager update, not immediately.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#restart\r\n * @since 3.4.0\r\n *\r\n * @param {object} [data] - The Scene data. If no value is given it will not overwrite any previous data that may exist.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 222, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Restarts this Scene.\r\rThis will happen at the next Scene Manager update, not immediately.", "kind": "function", "name": "restart", "since": "3.4.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The Scene data. If no value is given it will not overwrite any previous data that may exist.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#restart", "scope": "instance", "___id": "T000002R036975", "___s": true }, { "comment": "/**\r\n * This will start a transition from the current Scene to the target Scene given.\r\n *\r\n * The target Scene cannot be the same as the current Scene.\r\n *\r\n * The transition will last for the duration specified in milliseconds.\r\n *\r\n * You can have the target Scene moved above or below this one in the display list.\r\n *\r\n * You can specify an update callback. This callback will be invoked _every frame_ for the duration\r\n * of the transition.\r\n *\r\n * This Scene can either be sent to sleep at the end of the transition, or stopped. The default is to stop.\r\n *\r\n * There are also 5 transition related events: This scene will emit the event `transitionout` when\r\n * the transition begins, which is typically the frame after calling this method.\r\n *\r\n * The target Scene will emit the event `transitioninit` when that Scene's `init` method is called.\r\n * It will then emit the event `transitionstart` when its `create` method is called.\r\n * If the Scene was sleeping and has been woken up, it will emit the event `transitionwake` instead of these two,\r\n * as the Scenes `init` and `create` methods are not invoked when a Scene wakes up.\r\n *\r\n * When the duration of the transition has elapsed it will emit the event `transitioncomplete`.\r\n * These events are cleared of all listeners when the Scene shuts down, but not if it is sent to sleep.\r\n *\r\n * It's important to understand that the duration of the transition begins the moment you call this method.\r\n * If the Scene you are transitioning to includes delayed processes, such as waiting for files to load, the\r\n * time still counts down even while that is happening. If the game itself pauses, or something else causes\r\n * this Scenes update loop to stop, then the transition will also pause for that duration. There are\r\n * checks in place to prevent you accidentally stopping a transitioning Scene but if you've got code to\r\n * override this understand that until the target Scene completes it might never be unlocked for input events.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#transition\r\n * @fires Phaser.Scenes.Events#TRANSITION_OUT\r\n * @since 3.5.0\r\n *\r\n * @param {Phaser.Types.Scenes.SceneTransitionConfig} config - The transition configuration object.\r\n *\r\n * @return {boolean} `true` is the transition was started, otherwise `false`.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 244, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "This will start a transition from the current Scene to the target Scene given.\r\rThe target Scene cannot be the same as the current Scene.\r\rThe transition will last for the duration specified in milliseconds.\r\rYou can have the target Scene moved above or below this one in the display list.\r\rYou can specify an update callback. This callback will be invoked _every frame_ for the duration\rof the transition.\r\rThis Scene can either be sent to sleep at the end of the transition, or stopped. The default is to stop.\r\rThere are also 5 transition related events: This scene will emit the event `transitionout` when\rthe transition begins, which is typically the frame after calling this method.\r\rThe target Scene will emit the event `transitioninit` when that Scene's `init` method is called.\rIt will then emit the event `transitionstart` when its `create` method is called.\rIf the Scene was sleeping and has been woken up, it will emit the event `transitionwake` instead of these two,\ras the Scenes `init` and `create` methods are not invoked when a Scene wakes up.\r\rWhen the duration of the transition has elapsed it will emit the event `transitioncomplete`.\rThese events are cleared of all listeners when the Scene shuts down, but not if it is sent to sleep.\r\rIt's important to understand that the duration of the transition begins the moment you call this method.\rIf the Scene you are transitioning to includes delayed processes, such as waiting for files to load, the\rtime still counts down even while that is happening. If the game itself pauses, or something else causes\rthis Scenes update loop to stop, then the transition will also pause for that duration. There are\rchecks in place to prevent you accidentally stopping a transitioning Scene but if you've got code to\roverride this understand that until the target Scene completes it might never be unlocked for input events.", "kind": "function", "name": "transition", "fires": [ "Phaser.Scenes.Events#event:TRANSITION_OUT" ], "since": "3.5.0", "params": [ { "type": { "names": [ "Phaser.Types.Scenes.SceneTransitionConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Scenes.SceneTransitionConfig" } }, "description": "The transition configuration object.", "name": "config" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` is the transition was started, otherwise `false`." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#transition", "scope": "instance", "___id": "T000002R036978", "___s": true }, { "comment": "/**\r\n * Add the Scene into the Scene Manager and start it if 'autoStart' is true or the Scene config 'active' property is set.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#add\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.\r\n * @param {(Phaser.Types.Scenes.SceneType)} sceneConfig - The config for the Scene\r\n * @param {boolean} [autoStart=false] - If `true` the Scene will be started immediately after being added.\r\n * @param {object} [data] - Optional data object. This will be set as `Scene.settings.data` and passed to `Scene.init`, and `Scene.create`.\r\n *\r\n * @return {?Phaser.Scene} The added Scene, if it was added immediately, otherwise `null`.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 447, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Add the Scene into the Scene Manager and start it if 'autoStart' is true or the Scene config 'active' property is set.", "kind": "function", "name": "add", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Scenes.SceneType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Scenes.SceneType" } ] } }, "description": "The config for the Scene", "name": "sceneConfig" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true` the Scene will be started immediately after being added.", "name": "autoStart" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional data object. This will be set as `Scene.settings.data` and passed to `Scene.init`, and `Scene.create`.", "name": "data" } ], "returns": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene", "nullable": true } }, "nullable": true, "description": "The added Scene, if it was added immediately, otherwise `null`." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#add", "scope": "instance", "___id": "T000002R037017", "___s": true }, { "comment": "/**\r\n * Launch the given Scene and run it in parallel with this one.\r\n *\r\n * This will happen at the next Scene Manager update, not immediately.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#launch\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to launch.\r\n * @param {object} [data] - The Scene data.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 465, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Launch the given Scene and run it in parallel with this one.\r\rThis will happen at the next Scene Manager update, not immediately.", "kind": "function", "name": "launch", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to launch.", "name": "key" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The Scene data.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#launch", "scope": "instance", "___id": "T000002R037019", "___s": true }, { "comment": "/**\r\n * Runs the given Scene, but does not change the state of this Scene.\r\n *\r\n * This will happen at the next Scene Manager update, not immediately.\r\n *\r\n * If the given Scene is paused, it will resume it. If sleeping, it will wake it.\r\n * If not running at all, it will be started.\r\n *\r\n * Use this if you wish to open a modal Scene by calling `pause` on the current\r\n * Scene, then `run` on the modal Scene.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#run\r\n * @since 3.10.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to run.\r\n * @param {object} [data] - A data object that will be passed to the Scene and emitted in its ready, wake, or resume events.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 491, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Runs the given Scene, but does not change the state of this Scene.\r\rThis will happen at the next Scene Manager update, not immediately.\r\rIf the given Scene is paused, it will resume it. If sleeping, it will wake it.\rIf not running at all, it will be started.\r\rUse this if you wish to open a modal Scene by calling `pause` on the current\rScene, then `run` on the modal Scene.", "kind": "function", "name": "run", "since": "3.10.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to run.", "name": "key" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "A data object that will be passed to the Scene and emitted in its ready, wake, or resume events.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#run", "scope": "instance", "___id": "T000002R037021", "___s": true }, { "comment": "/**\r\n * Pause the Scene - this stops the update step from happening but it still renders.\r\n *\r\n * This will happen at the next Scene Manager update, not immediately.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#pause\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to pause.\r\n * @param {object} [data] - An optional data object that will be passed to the Scene and emitted in its pause event.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Pause the Scene - this stops the update step from happening but it still renders.\r\rThis will happen at the next Scene Manager update, not immediately.", "kind": "function", "name": "pause", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to pause.", "name": "key" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "An optional data object that will be passed to the Scene and emitted in its pause event.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#pause", "scope": "instance", "___id": "T000002R037023", "___s": true }, { "comment": "/**\r\n * Resume the Scene - starts the update loop again.\r\n *\r\n * This will happen at the next Scene Manager update, not immediately.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#resume\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to resume.\r\n * @param {object} [data] - An optional data object that will be passed to the Scene and emitted in its resume event.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 548, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Resume the Scene - starts the update loop again.\r\rThis will happen at the next Scene Manager update, not immediately.", "kind": "function", "name": "resume", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to resume.", "name": "key" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "An optional data object that will be passed to the Scene and emitted in its resume event.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#resume", "scope": "instance", "___id": "T000002R037026", "___s": true }, { "comment": "/**\r\n * Makes the Scene sleep (no update, no render) but doesn't shutdown.\r\n *\r\n * This will happen at the next Scene Manager update, not immediately.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#sleep\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to put to sleep.\r\n * @param {object} [data] - An optional data object that will be passed to the Scene and emitted in its sleep event.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 573, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Makes the Scene sleep (no update, no render) but doesn't shutdown.\r\rThis will happen at the next Scene Manager update, not immediately.", "kind": "function", "name": "sleep", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to put to sleep.", "name": "key" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "An optional data object that will be passed to the Scene and emitted in its sleep event.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#sleep", "scope": "instance", "___id": "T000002R037029", "___s": true }, { "comment": "/**\r\n * Makes the Scene wake-up (starts update and render)\r\n *\r\n * This will happen at the next Scene Manager update, not immediately.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#wake\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to wake up.\r\n * @param {object} [data] - An optional data object that will be passed to the Scene and emitted in its wake event.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 598, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Makes the Scene wake-up (starts update and render)\r\rThis will happen at the next Scene Manager update, not immediately.", "kind": "function", "name": "wake", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to wake up.", "name": "key" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "An optional data object that will be passed to the Scene and emitted in its wake event.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#wake", "scope": "instance", "___id": "T000002R037032", "___s": true }, { "comment": "/**\r\n * Makes this Scene sleep then starts the Scene given.\r\n *\r\n * This will happen at the next Scene Manager update, not immediately.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#switch\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to start.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 623, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Makes this Scene sleep then starts the Scene given.\r\rThis will happen at the next Scene Manager update, not immediately.", "kind": "function", "name": "switch", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to start.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#switch", "scope": "instance", "___id": "T000002R037035", "___s": true }, { "comment": "/**\r\n * Shutdown the Scene, clearing display list, timers, etc.\r\n *\r\n * This happens at the next Scene Manager update, not immediately.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#stop\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to stop.\r\n * @param {any} [data] - Optional data object to pass to Scene.Systems.shutdown.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 648, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Shutdown the Scene, clearing display list, timers, etc.\r\rThis happens at the next Scene Manager update, not immediately.", "kind": "function", "name": "stop", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to stop.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Optional data object to pass to Scene.Systems.shutdown.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#stop", "scope": "instance", "___id": "T000002R037037", "___s": true }, { "comment": "/**\r\n * Sets the active state of the given Scene.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#setActive\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {boolean} value - If `true` the Scene will be resumed. If `false` it will be paused.\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to set the active state of.\r\n * @param {object} [data] - An optional data object that will be passed to the Scene and emitted with its events.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Sets the active state of the given Scene.", "kind": "function", "name": "setActive", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If `true` the Scene will be resumed. If `false` it will be paused.", "name": "value" }, { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to set the active state of.", "name": "key" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "An optional data object that will be passed to the Scene and emitted with its events.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#setActive", "scope": "instance", "___id": "T000002R037040", "___s": true }, { "comment": "/**\r\n * Sets the visible state of the given Scene.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#setVisible\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {boolean} value - The visible value.\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to set the visible state for.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 702, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Sets the visible state of the given Scene.", "kind": "function", "name": "setVisible", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible value.", "name": "value" }, { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to set the visible state for.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#setVisible", "scope": "instance", "___id": "T000002R037044", "___s": true }, { "comment": "/**\r\n * Checks if the given Scene is sleeping or not?\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#isSleeping\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to check.\r\n *\r\n * @return {boolean} Whether the Scene is sleeping, or `null` if no matching Scene was found.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 730, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Checks if the given Scene is sleeping or not?", "kind": "function", "name": "isSleeping", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to check.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the Scene is sleeping, or `null` if no matching Scene was found." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#isSleeping", "scope": "instance", "___id": "T000002R037048", "___s": true }, { "comment": "/**\r\n * Checks if the given Scene is running or not?\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#isActive\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to check.\r\n *\r\n * @return {boolean} Whether the Scene is running, or `null` if no matching Scene was found.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 750, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Checks if the given Scene is running or not?", "kind": "function", "name": "isActive", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to check.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the Scene is running, or `null` if no matching Scene was found." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#isActive", "scope": "instance", "___id": "T000002R037051", "___s": true }, { "comment": "/**\r\n * Checks if the given Scene is paused or not?\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#isPaused\r\n * @since 3.17.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to check.\r\n *\r\n * @return {boolean} Whether the Scene is paused, or `null` if no matching Scene was found.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 770, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Checks if the given Scene is paused or not?", "kind": "function", "name": "isPaused", "since": "3.17.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to check.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the Scene is paused, or `null` if no matching Scene was found." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#isPaused", "scope": "instance", "___id": "T000002R037054", "___s": true }, { "comment": "/**\r\n * Checks if the given Scene is visible or not?\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#isVisible\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to check.\r\n *\r\n * @return {boolean} Whether the Scene is visible, or `null` if no matching Scene was found.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 790, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Checks if the given Scene is visible or not?", "kind": "function", "name": "isVisible", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to check.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the Scene is visible, or `null` if no matching Scene was found." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#isVisible", "scope": "instance", "___id": "T000002R037057", "___s": true }, { "comment": "/**\r\n * Swaps the position of two scenes in the Scenes list.\r\n *\r\n * This controls the order in which they are rendered and updated.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#swapPosition\r\n * @since 3.2.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [keyA,keyB]\r\n *\r\n * @param {(string|Phaser.Scene)} keyA - The first Scene to swap.\r\n * @param {(string|Phaser.Scene)} [keyB] - The second Scene to swap. If none is given it defaults to this Scene.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Swaps the position of two scenes in the Scenes list.\r\rThis controls the order in which they are rendered and updated.", "kind": "function", "name": "swapPosition", "since": "3.2.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [keyA,keyB]", "value": "{(T|string)} - [keyA,keyB]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The first Scene to swap.", "name": "keyA" }, { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The second Scene to swap. If none is given it defaults to this Scene.", "name": "keyB" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#swapPosition", "scope": "instance", "___id": "T000002R037060", "___s": true }, { "comment": "/**\r\n * Swaps the position of two scenes in the Scenes list, so that Scene B is directly above Scene A.\r\n *\r\n * This controls the order in which they are rendered and updated.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#moveAbove\r\n * @since 3.2.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [keyA,keyB]\r\n *\r\n * @param {(string|Phaser.Scene)} keyA - The Scene that Scene B will be moved to be above.\r\n * @param {(string|Phaser.Scene)} [keyB] - The Scene to be moved. If none is given it defaults to this Scene.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 838, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Swaps the position of two scenes in the Scenes list, so that Scene B is directly above Scene A.\r\rThis controls the order in which they are rendered and updated.", "kind": "function", "name": "moveAbove", "since": "3.2.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [keyA,keyB]", "value": "{(T|string)} - [keyA,keyB]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene that Scene B will be moved to be above.", "name": "keyA" }, { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to be moved. If none is given it defaults to this Scene.", "name": "keyB" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#moveAbove", "scope": "instance", "___id": "T000002R037063", "___s": true }, { "comment": "/**\r\n * Swaps the position of two scenes in the Scenes list, so that Scene B is directly below Scene A.\r\n *\r\n * This controls the order in which they are rendered and updated.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#moveBelow\r\n * @since 3.2.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [keyA,keyB]\r\n *\r\n * @param {(string|Phaser.Scene)} keyA - The Scene that Scene B will be moved to be below.\r\n * @param {(string|Phaser.Scene)} [keyB] - The Scene to be moved. If none is given it defaults to this Scene.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 866, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Swaps the position of two scenes in the Scenes list, so that Scene B is directly below Scene A.\r\rThis controls the order in which they are rendered and updated.", "kind": "function", "name": "moveBelow", "since": "3.2.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [keyA,keyB]", "value": "{(T|string)} - [keyA,keyB]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene that Scene B will be moved to be below.", "name": "keyA" }, { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to be moved. If none is given it defaults to this Scene.", "name": "keyB" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#moveBelow", "scope": "instance", "___id": "T000002R037066", "___s": true }, { "comment": "/**\r\n * Removes a Scene from the SceneManager.\r\n *\r\n * The Scene is removed from the local scenes array, it's key is cleared from the keys\r\n * cache and Scene.Systems.destroy is then called on it.\r\n *\r\n * If the SceneManager is processing the Scenes when this method is called it will\r\n * queue the operation for the next update sequence.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#remove\r\n * @since 3.2.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to be removed.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 894, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Removes a Scene from the SceneManager.\r\rThe Scene is removed from the local scenes array, it's key is cleared from the keys\rcache and Scene.Systems.destroy is then called on it.\r\rIf the SceneManager is processing the Scenes when this method is called it will\rqueue the operation for the next update sequence.", "kind": "function", "name": "remove", "since": "3.2.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to be removed.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#remove", "scope": "instance", "___id": "T000002R037069", "___s": true }, { "comment": "/**\r\n * Moves a Scene up one position in the Scenes list.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#moveUp\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to move.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 922, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Moves a Scene up one position in the Scenes list.", "kind": "function", "name": "moveUp", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to move.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#moveUp", "scope": "instance", "___id": "T000002R037072", "___s": true }, { "comment": "/**\r\n * Moves a Scene down one position in the Scenes list.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#moveDown\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to move.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 944, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Moves a Scene down one position in the Scenes list.", "kind": "function", "name": "moveDown", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to move.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#moveDown", "scope": "instance", "___id": "T000002R037075", "___s": true }, { "comment": "/**\r\n * Brings a Scene to the top of the Scenes list.\r\n *\r\n * This means it will render above all other Scenes.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#bringToTop\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to move.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 966, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Brings a Scene to the top of the Scenes list.\r\rThis means it will render above all other Scenes.", "kind": "function", "name": "bringToTop", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to move.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#bringToTop", "scope": "instance", "___id": "T000002R037078", "___s": true }, { "comment": "/**\r\n * Sends a Scene to the back of the Scenes list.\r\n *\r\n * This means it will render below all other Scenes.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#sendToBack\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to move.\r\n *\r\n * @return {this} This Scene Plugin instance.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 990, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Sends a Scene to the back of the Scenes list.\r\rThis means it will render below all other Scenes.", "kind": "function", "name": "sendToBack", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to move.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Scene Plugin instance." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#sendToBack", "scope": "instance", "___id": "T000002R037081", "___s": true }, { "comment": "/**\r\n * Retrieve a Scene.\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n * @genericUse {T} - [$return]\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#get\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to retrieve.\r\n *\r\n * @return {Phaser.Scene} The Scene.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 1014, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Retrieve a Scene.", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$return]", "value": "{T} - [$return]" } ], "kind": "function", "name": "get", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to retrieve.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#get", "scope": "instance", "___id": "T000002R037084", "___s": true }, { "comment": "/**\r\n * Return the status of the Scene.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#getStatus\r\n * @since 3.60.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} key - The Scene to get the status from.\r\n *\r\n * @return {number} The Scene status. This maps to the `Phaser.Scene` constants, such as `Phaser.Scene.LOADING`.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 1033, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Return the status of the Scene.", "kind": "function", "name": "getStatus", "since": "3.60.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "description": "The Scene to get the status from.", "name": "key" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Scene status. This maps to the `Phaser.Scene` constants, such as `Phaser.Scene.LOADING`." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#getStatus", "scope": "instance", "___id": "T000002R037086", "___s": true }, { "comment": "/**\r\n * Retrieves the numeric index of a Scene in the Scenes list.\r\n *\r\n * @method Phaser.Scenes.ScenePlugin#getIndex\r\n * @since 3.7.0\r\n *\r\n * @generic {Phaser.Scene} T\r\n * @genericUse {(T|string)} - [key]\r\n *\r\n * @param {(string|Phaser.Scene)} [key] - The Scene to get the index of.\r\n *\r\n * @return {number} The index of the Scene.\r\n */", "meta": { "filename": "ScenePlugin.js", "lineno": 1056, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Retrieves the numeric index of a Scene in the Scenes list.", "kind": "function", "name": "getIndex", "since": "3.7.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Scene} T", "value": "{Phaser.Scene} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|string)} - [key]", "value": "{(T|string)} - [key]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Scene" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Scene" } ] } }, "optional": true, "description": "The Scene to get the index of.", "name": "key" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the Scene." } ], "memberof": "Phaser.Scenes.ScenePlugin", "longname": "Phaser.Scenes.ScenePlugin#getIndex", "scope": "instance", "___id": "T000002R037089", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Scenes.Settings\r\n */", "meta": { "filename": "Settings.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "kind": "namespace", "name": "Settings", "memberof": "Phaser.Scenes", "longname": "Phaser.Scenes.Settings", "scope": "static", "___id": "T000002R037106", "___s": true }, { "comment": "/**\r\n * Takes a Scene configuration object and returns a fully formed System Settings object.\r\n *\r\n * @function Phaser.Scenes.Settings.create\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Scenes.SettingsConfig)} config - The Scene configuration object used to create this Scene Settings.\r\n *\r\n * @return {Phaser.Types.Scenes.SettingsObject} The Scene Settings object created as a result of the config and default settings.\r\n */", "meta": { "filename": "Settings.js", "lineno": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Takes a Scene configuration object and returns a fully formed System Settings object.", "kind": "function", "name": "create", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Scenes.SettingsConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Scenes.SettingsConfig" } ] } }, "description": "The Scene configuration object used to create this Scene Settings.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Scenes.SettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Scenes.SettingsObject" } }, "description": "The Scene Settings object created as a result of the config and default settings." } ], "memberof": "Phaser.Scenes.Settings", "longname": "Phaser.Scenes.Settings.create", "scope": "static", "___id": "T000002R037108", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Scene Systems class.\r\n *\r\n * This class is available from within a Scene under the property `sys`.\r\n * It is responsible for managing all of the plugins a Scene has running, including the display list, and\r\n * handling the update step and renderer. It also contains references to global systems belonging to Game.\r\n *\r\n * @class Systems\r\n * @memberof Phaser.Scenes\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene that owns this Systems instance.\r\n * @param {(string|Phaser.Types.Scenes.SettingsConfig)} config - Scene specific configuration settings.\r\n */", "meta": { "filename": "Systems.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "classdesc": "The Scene Systems class.\r\rThis class is available from within a Scene under the property `sys`.\rIt is responsible for managing all of the plugins a Scene has running, including the display list, and\rhandling the update step and renderer. It also contains references to global systems belonging to Game.", "kind": "class", "name": "Systems", "memberof": "Phaser.Scenes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene that owns this Systems instance.", "name": "scene" }, { "type": { "names": [ "string", "Phaser.Types.Scenes.SettingsConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Scenes.SettingsConfig" } ] } }, "description": "Scene specific configuration settings.", "name": "config" } ], "scope": "static", "longname": "Phaser.Scenes.Systems", "___id": "T000002R037139", "___s": true }, { "comment": "/**\r\n * A reference to the Scene that these Systems belong to.\r\n *\r\n * @name Phaser.Scenes.Systems#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the Scene that these Systems belong to.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#scene", "scope": "instance", "kind": "member", "___id": "T000002R037142", "___s": true }, { "comment": "/**\r\n * A reference to the Phaser Game instance.\r\n *\r\n * @name Phaser.Scenes.Systems#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the Phaser Game instance.", "name": "game", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#game", "scope": "instance", "kind": "member", "___id": "T000002R037144", "___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.Scenes.Systems#renderer\r\n * @type {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 56, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "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.17.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#renderer", "scope": "instance", "kind": "member", "___id": "T000002R037146", "___s": true }, { "comment": "/**\r\n * The Facebook Instant Games Plugin.\r\n *\r\n * @name Phaser.Scenes.Systems#facebook\r\n * @type {Phaser.FacebookInstantGamesPlugin}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 67, "columnno": 12, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Facebook Instant Games Plugin.", "name": "facebook", "type": { "names": [ "Phaser.FacebookInstantGamesPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FacebookInstantGamesPlugin" } }, "since": "3.12.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#facebook", "scope": "instance", "kind": "member", "___id": "T000002R037148", "___s": true }, { "comment": "/**\r\n * The Scene Configuration object, as passed in when creating the Scene.\r\n *\r\n * @name Phaser.Scenes.Systems#config\r\n * @type {(string|Phaser.Types.Scenes.SettingsConfig)}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Scene Configuration object, as passed in when creating the Scene.", "name": "config", "type": { "names": [ "string", "Phaser.Types.Scenes.SettingsConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Scenes.SettingsConfig" } ] } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#config", "scope": "instance", "kind": "member", "___id": "T000002R037150", "___s": true }, { "comment": "/**\r\n * The Scene Settings. This is the parsed output based on the Scene configuration.\r\n *\r\n * @name Phaser.Scenes.Systems#settings\r\n * @type {Phaser.Types.Scenes.SettingsObject}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "The Scene Settings. This is the parsed output based on the Scene configuration.", "name": "settings", "type": { "names": [ "Phaser.Types.Scenes.SettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Scenes.SettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#settings", "scope": "instance", "kind": "member", "___id": "T000002R037152", "___s": true }, { "comment": "/**\r\n * A handy reference to the Scene canvas / context.\r\n *\r\n * @name Phaser.Scenes.Systems#canvas\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A handy reference to the Scene canvas / context.", "name": "canvas", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#canvas", "scope": "instance", "kind": "member", "___id": "T000002R037154", "___s": true }, { "comment": "/**\r\n * A reference to the Canvas Rendering Context being used by the renderer.\r\n *\r\n * @name Phaser.Scenes.Systems#context\r\n * @type {CanvasRenderingContext2D}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the Canvas Rendering Context being used by the renderer.", "name": "context", "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#context", "scope": "instance", "kind": "member", "___id": "T000002R037156", "___s": true }, { "comment": "/**\r\n * A reference to the global Animations Manager.\r\n *\r\n * In the default set-up you can access this from within a Scene via the `this.anims` property.\r\n *\r\n * @name Phaser.Scenes.Systems#anims\r\n * @type {Phaser.Animations.AnimationManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 115, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the global Animations Manager.\r\rIn the default set-up you can access this from within a Scene via the `this.anims` property.", "name": "anims", "type": { "names": [ "Phaser.Animations.AnimationManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationManager" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#anims", "scope": "instance", "kind": "member", "___id": "T000002R037158", "___s": true }, { "comment": "/**\r\n * A reference to the global Cache. The Cache stores all files bought in to Phaser via\r\n * the Loader, with the exception of images. Images are stored in the Texture Manager.\r\n *\r\n * In the default set-up you can access this from within a Scene via the `this.cache` property.\r\n *\r\n * @name Phaser.Scenes.Systems#cache\r\n * @type {Phaser.Cache.CacheManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 126, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the global Cache. The Cache stores all files bought in to Phaser via\rthe Loader, with the exception of images. Images are stored in the Texture Manager.\r\rIn the default set-up you can access this from within a Scene via the `this.cache` property.", "name": "cache", "type": { "names": [ "Phaser.Cache.CacheManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.CacheManager" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#cache", "scope": "instance", "kind": "member", "___id": "T000002R037160", "___s": true }, { "comment": "/**\r\n * A reference to the global Plugins Manager.\r\n *\r\n * In the default set-up you can access this from within a Scene via the `this.plugins` property.\r\n *\r\n * @name Phaser.Scenes.Systems#plugins\r\n * @type {Phaser.Plugins.PluginManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 138, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the global Plugins Manager.\r\rIn the default set-up you can access this from within a Scene via the `this.plugins` property.", "name": "plugins", "type": { "names": [ "Phaser.Plugins.PluginManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Plugins.PluginManager" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#plugins", "scope": "instance", "kind": "member", "___id": "T000002R037162", "___s": true }, { "comment": "/**\r\n * A reference to the global registry. This is a game-wide instance of the Data Manager, allowing\r\n * you to exchange data between Scenes via a universal and shared point.\r\n *\r\n * In the default set-up you can access this from within a Scene via the `this.registry` property.\r\n *\r\n * @name Phaser.Scenes.Systems#registry\r\n * @type {Phaser.Data.DataManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the global registry. This is a game-wide instance of the Data Manager, allowing\ryou to exchange data between Scenes via a universal and shared point.\r\rIn the default set-up you can access this from within a Scene via the `this.registry` property.", "name": "registry", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#registry", "scope": "instance", "kind": "member", "___id": "T000002R037164", "___s": true }, { "comment": "/**\r\n * A reference to the global Scale Manager.\r\n *\r\n * In the default set-up you can access this from within a Scene via the `this.scale` property.\r\n *\r\n * @name Phaser.Scenes.Systems#scale\r\n * @type {Phaser.Scale.ScaleManager}\r\n * @since 3.15.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the global Scale Manager.\r\rIn the default set-up you can access this from within a Scene via the `this.scale` property.", "name": "scale", "type": { "names": [ "Phaser.Scale.ScaleManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.ScaleManager" } }, "since": "3.15.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#scale", "scope": "instance", "kind": "member", "___id": "T000002R037166", "___s": true }, { "comment": "/**\r\n * A reference to the global Sound Manager.\r\n *\r\n * In the default set-up you can access this from within a Scene via the `this.sound` property.\r\n *\r\n * @name Phaser.Scenes.Systems#sound\r\n * @type {(Phaser.Sound.NoAudioSoundManager|Phaser.Sound.HTML5AudioSoundManager|Phaser.Sound.WebAudioSoundManager)}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 172, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the global Sound Manager.\r\rIn the default set-up you can access this from within a Scene via the `this.sound` property.", "name": "sound", "type": { "names": [ "Phaser.Sound.NoAudioSoundManager", "Phaser.Sound.HTML5AudioSoundManager", "Phaser.Sound.WebAudioSoundManager" ], "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.Scenes.Systems", "longname": "Phaser.Scenes.Systems#sound", "scope": "instance", "kind": "member", "___id": "T000002R037168", "___s": true }, { "comment": "/**\r\n * A reference to the global Texture Manager.\r\n *\r\n * In the default set-up you can access this from within a Scene via the `this.textures` property.\r\n *\r\n * @name Phaser.Scenes.Systems#textures\r\n * @type {Phaser.Textures.TextureManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 183, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the global Texture Manager.\r\rIn the default set-up you can access this from within a Scene via the `this.textures` property.", "name": "textures", "type": { "names": [ "Phaser.Textures.TextureManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#textures", "scope": "instance", "kind": "member", "___id": "T000002R037170", "___s": true }, { "comment": "/**\r\n * A reference to the Scene's Game Object Factory.\r\n *\r\n * Use this to quickly and easily create new Game Object's.\r\n *\r\n * In the default set-up you can access this from within a Scene via the `this.add` property.\r\n *\r\n * @name Phaser.Scenes.Systems#add\r\n * @type {Phaser.GameObjects.GameObjectFactory}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the Scene's Game Object Factory.\r\rUse this to quickly and easily create new Game Object's.\r\rIn the default set-up you can access this from within a Scene via the `this.add` property.", "name": "add", "type": { "names": [ "Phaser.GameObjects.GameObjectFactory" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObjectFactory" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#add", "scope": "instance", "kind": "member", "___id": "T000002R037172", "___s": true }, { "comment": "/**\r\n * A reference to the Scene's Camera Manager.\r\n *\r\n * Use this to manipulate and create Cameras for this specific Scene.\r\n *\r\n * In the default set-up you can access this from within a Scene via the `this.cameras` property.\r\n *\r\n * @name Phaser.Scenes.Systems#cameras\r\n * @type {Phaser.Cameras.Scene2D.CameraManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 209, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the Scene's Camera Manager.\r\rUse this to manipulate and create Cameras for this specific Scene.\r\rIn the default set-up you can access this from within a Scene via the `this.cameras` property.", "name": "cameras", "type": { "names": [ "Phaser.Cameras.Scene2D.CameraManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.CameraManager" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#cameras", "scope": "instance", "kind": "member", "___id": "T000002R037174", "___s": true }, { "comment": "/**\r\n * A reference to the Scene's Display List.\r\n *\r\n * Use this to organize the children contained in the display list.\r\n *\r\n * In the default set-up you can access this from within a Scene via the `this.children` property.\r\n *\r\n * @name Phaser.Scenes.Systems#displayList\r\n * @type {Phaser.GameObjects.DisplayList}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 222, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the Scene's Display List.\r\rUse this to organize the children contained in the display list.\r\rIn the default set-up you can access this from within a Scene via the `this.children` property.", "name": "displayList", "type": { "names": [ "Phaser.GameObjects.DisplayList" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.DisplayList" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#displayList", "scope": "instance", "kind": "member", "___id": "T000002R037176", "___s": true }, { "comment": "/**\r\n * A reference to the Scene's Event Manager.\r\n *\r\n * Use this to listen for Scene specific events, such as `pause` and `shutdown`.\r\n *\r\n * In the default set-up you can access this from within a Scene via the `this.events` property.\r\n *\r\n * @name Phaser.Scenes.Systems#events\r\n * @type {Phaser.Events.EventEmitter}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 235, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the Scene's Event Manager.\r\rUse this to listen for Scene specific events, such as `pause` and `shutdown`.\r\rIn the default set-up you can access this from within a Scene via the `this.events` property.", "name": "events", "type": { "names": [ "Phaser.Events.EventEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Events.EventEmitter" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#events", "scope": "instance", "kind": "member", "___id": "T000002R037178", "___s": true }, { "comment": "/**\r\n * A reference to the Scene's Game Object Creator.\r\n *\r\n * Use this to quickly and easily create new Game Object's. The difference between this and the\r\n * Game Object Factory, is that the Creator just creates and returns Game Object instances, it\r\n * doesn't then add them to the Display List or Update List.\r\n *\r\n * In the default set-up you can access this from within a Scene via the `this.make` property.\r\n *\r\n * @name Phaser.Scenes.Systems#make\r\n * @type {Phaser.GameObjects.GameObjectCreator}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 248, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the Scene's Game Object Creator.\r\rUse this to quickly and easily create new Game Object's. The difference between this and the\rGame Object Factory, is that the Creator just creates and returns Game Object instances, it\rdoesn't then add them to the Display List or Update List.\r\rIn the default set-up you can access this from within a Scene via the `this.make` property.", "name": "make", "type": { "names": [ "Phaser.GameObjects.GameObjectCreator" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObjectCreator" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#make", "scope": "instance", "kind": "member", "___id": "T000002R037180", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Manager Plugin.\r\n *\r\n * Use this to manipulate both this and other Scene's in your game, for example to launch a parallel Scene,\r\n * or pause or resume a Scene, or switch from this Scene to another.\r\n *\r\n * In the default set-up you can access this from within a Scene via the `this.scene` property.\r\n *\r\n * @name Phaser.Scenes.Systems#scenePlugin\r\n * @type {Phaser.Scenes.ScenePlugin}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 263, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the Scene Manager Plugin.\r\rUse this to manipulate both this and other Scene's in your game, for example to launch a parallel Scene,\ror pause or resume a Scene, or switch from this Scene to another.\r\rIn the default set-up you can access this from within a Scene via the `this.scene` property.", "name": "scenePlugin", "type": { "names": [ "Phaser.Scenes.ScenePlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.ScenePlugin" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#scenePlugin", "scope": "instance", "kind": "member", "___id": "T000002R037182", "___s": true }, { "comment": "/**\r\n * A reference to the Scene's Update List.\r\n *\r\n * Use this to organize the children contained in the update list.\r\n *\r\n * The Update List is responsible for managing children that need their `preUpdate` methods called,\r\n * in order to process so internal components, such as Sprites with Animations.\r\n *\r\n * In the default set-up there is no reference to this from within the Scene itself.\r\n *\r\n * @name Phaser.Scenes.Systems#updateList\r\n * @type {Phaser.GameObjects.UpdateList}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 277, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A reference to the Scene's Update List.\r\rUse this to organize the children contained in the update list.\r\rThe Update List is responsible for managing children that need their `preUpdate` methods called,\rin order to process so internal components, such as Sprites with Animations.\r\rIn the default set-up there is no reference to this from within the Scene itself.", "name": "updateList", "type": { "names": [ "Phaser.GameObjects.UpdateList" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.UpdateList" } }, "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#updateList", "scope": "instance", "kind": "member", "___id": "T000002R037184", "___s": true }, { "comment": "/**\r\n * This method is called only once by the Scene Manager when the Scene is instantiated.\r\n * It is responsible for setting up all of the Scene plugins and references.\r\n * It should never be called directly.\r\n *\r\n * @method Phaser.Scenes.Systems#init\r\n * @protected\r\n * @fires Phaser.Scenes.Events#BOOT\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": "Systems.js", "lineno": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "This method is called only once by the Scene Manager when the Scene is instantiated.\rIt is responsible for setting up all of the Scene plugins and references.\rIt should never be called directly.", "kind": "function", "name": "init", "access": "protected", "fires": [ "Phaser.Scenes.Events#event:BOOT" ], "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" } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#init", "scope": "instance", "___id": "T000002R037188", "___s": true }, { "comment": "/**\r\n * A single game step. Called automatically by the Scene Manager as a result of a Request Animation\r\n * Frame or Set Timeout call to the main Game instance.\r\n *\r\n * @method Phaser.Scenes.Systems#step\r\n * @fires Phaser.Scenes.Events#PRE_UPDATE\r\n * @fires Phaser.Scenes.Events#UPDATE\r\n * @fires Phaser.Scenes.Events#POST_UPDATE\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The time value from the most recent Game step. Typically a high-resolution timer value, or Date.now().\r\n * @param {number} delta - The delta value since the last frame. This is smoothed to avoid delta spikes by the TimeStep class.\r\n */", "meta": { "filename": "Systems.js", "lineno": 343, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "A single game step. Called automatically by the Scene Manager as a result of a Request Animation\rFrame or Set Timeout call to the main Game instance.", "kind": "function", "name": "step", "fires": [ "Phaser.Scenes.Events#event:PRE_UPDATE", "Phaser.Scenes.Events#event:UPDATE", "Phaser.Scenes.Events#event:POST_UPDATE" ], "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time value from the most recent Game step. Typically a high-resolution timer value, or Date.now().", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value since the last frame. This is smoothed to avoid delta spikes by the TimeStep class.", "name": "delta" } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#step", "scope": "instance", "___id": "T000002R037199", "___s": true }, { "comment": "/**\r\n * Called automatically by the Scene Manager.\r\n * Instructs the Scene to render itself via its Camera Manager to the renderer given.\r\n *\r\n * @method Phaser.Scenes.Systems#render\r\n * @fires Phaser.Scenes.Events#PRE_RENDER\r\n * @fires Phaser.Scenes.Events#RENDER\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - The renderer that invoked the render call.\r\n */", "meta": { "filename": "Systems.js", "lineno": 369, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Called automatically by the Scene Manager.\rInstructs the Scene to render itself via its Camera Manager to the renderer given.", "kind": "function", "name": "render", "fires": [ "Phaser.Scenes.Events#event:PRE_RENDER", "Phaser.Scenes.Events#event:RENDER" ], "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 invoked the render call.", "name": "renderer" } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#render", "scope": "instance", "___id": "T000002R037202", "___s": true }, { "comment": "/**\r\n * Force a sort of the display list on the next render.\r\n *\r\n * @method Phaser.Scenes.Systems#queueDepthSort\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Force a sort of the display list on the next render.", "kind": "function", "name": "queueDepthSort", "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#queueDepthSort", "scope": "instance", "___id": "T000002R037205", "___s": true }, { "comment": "/**\r\n * Immediately sorts the display list if the flag is set.\r\n *\r\n * @method Phaser.Scenes.Systems#depthSort\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Systems.js", "lineno": 404, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Immediately sorts the display list if the flag is set.", "kind": "function", "name": "depthSort", "since": "3.0.0", "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#depthSort", "scope": "instance", "___id": "T000002R037207", "___s": true }, { "comment": "/**\r\n * Pause this Scene.\r\n *\r\n * A paused Scene still renders, it just doesn't run any of its update handlers or systems.\r\n *\r\n * @method Phaser.Scenes.Systems#pause\r\n * @fires Phaser.Scenes.Events#PAUSE\r\n * @since 3.0.0\r\n *\r\n * @param {object} [data] - A data object that will be passed in the 'pause' event.\r\n *\r\n * @return {Phaser.Scenes.Systems} This Systems object.\r\n */", "meta": { "filename": "Systems.js", "lineno": 415, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Pause this Scene.\r\rA paused Scene still renders, it just doesn't run any of its update handlers or systems.", "kind": "function", "name": "pause", "fires": [ "Phaser.Scenes.Events#event:PAUSE" ], "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "A data object that will be passed in the 'pause' event.", "name": "data" } ], "returns": [ { "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "description": "This Systems object." } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#pause", "scope": "instance", "___id": "T000002R037209", "___s": true }, { "comment": "/**\r\n * Resume this Scene from a paused state.\r\n *\r\n * @method Phaser.Scenes.Systems#resume\r\n * @fires Phaser.Scenes.Events#RESUME\r\n * @since 3.0.0\r\n *\r\n * @param {object} [data] - A data object that will be passed in the 'resume' event.\r\n *\r\n * @return {Phaser.Scenes.Systems} This Systems object.\r\n */", "meta": { "filename": "Systems.js", "lineno": 449, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Resume this Scene from a paused state.", "kind": "function", "name": "resume", "fires": [ "Phaser.Scenes.Events#event:RESUME" ], "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "A data object that will be passed in the 'resume' event.", "name": "data" } ], "returns": [ { "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "description": "This Systems object." } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#resume", "scope": "instance", "___id": "T000002R037215", "___s": true }, { "comment": "/**\r\n * Send this Scene to sleep.\r\n *\r\n * A sleeping Scene doesn't run its update step or render anything, but it also isn't shut down\r\n * or has any of its systems or children removed, meaning it can be re-activated at any point and\r\n * will carry on from where it left off. It also keeps everything in memory and events and callbacks\r\n * from other Scenes may still invoke changes within it, so be careful what is left active.\r\n *\r\n * @method Phaser.Scenes.Systems#sleep\r\n * @fires Phaser.Scenes.Events#SLEEP\r\n * @since 3.0.0\r\n *\r\n * @param {object} [data] - A data object that will be passed in the 'sleep' event.\r\n *\r\n * @return {Phaser.Scenes.Systems} This Systems object.\r\n */", "meta": { "filename": "Systems.js", "lineno": 477, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Send this Scene to sleep.\r\rA sleeping Scene doesn't run its update step or render anything, but it also isn't shut down\ror has any of its systems or children removed, meaning it can be re-activated at any point and\rwill carry on from where it left off. It also keeps everything in memory and events and callbacks\rfrom other Scenes may still invoke changes within it, so be careful what is left active.", "kind": "function", "name": "sleep", "fires": [ "Phaser.Scenes.Events#event:SLEEP" ], "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "A data object that will be passed in the 'sleep' event.", "name": "data" } ], "returns": [ { "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "description": "This Systems object." } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#sleep", "scope": "instance", "___id": "T000002R037221", "___s": true }, { "comment": "/**\r\n * Wake-up this Scene if it was previously asleep.\r\n *\r\n * @method Phaser.Scenes.Systems#wake\r\n * @fires Phaser.Scenes.Events#WAKE\r\n * @since 3.0.0\r\n *\r\n * @param {object} [data] - A data object that will be passed in the 'wake' event.\r\n *\r\n * @return {Phaser.Scenes.Systems} This Systems object.\r\n */", "meta": { "filename": "Systems.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Wake-up this Scene if it was previously asleep.", "kind": "function", "name": "wake", "fires": [ "Phaser.Scenes.Events#event:WAKE" ], "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "A data object that will be passed in the 'wake' event.", "name": "data" } ], "returns": [ { "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "description": "This Systems object." } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#wake", "scope": "instance", "___id": "T000002R037228", "___s": true }, { "comment": "/**\r\n * Returns any data that was sent to this Scene by another Scene.\r\n *\r\n * The data is also passed to `Scene.init` and in various Scene events, but\r\n * you can access it at any point via this method.\r\n *\r\n * @method Phaser.Scenes.Systems#getData\r\n * @since 3.22.0\r\n *\r\n * @return {any} The Scene Data.\r\n */", "meta": { "filename": "Systems.js", "lineno": 546, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Returns any data that was sent to this Scene by another Scene.\r\rThe data is also passed to `Scene.init` and in various Scene events, but\ryou can access it at any point via this method.", "kind": "function", "name": "getData", "since": "3.22.0", "returns": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The Scene Data." } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#getData", "scope": "instance", "___id": "T000002R037235", "___s": true }, { "comment": "/**\r\n * Returns the current status of this Scene.\r\n *\r\n * @method Phaser.Scenes.Systems#getStatus\r\n * @since 3.60.0\r\n *\r\n * @return {number} The status of this Scene. One of the `Phaser.Scene` constants.\r\n */", "meta": { "filename": "Systems.js", "lineno": 562, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Returns the current status of this Scene.", "kind": "function", "name": "getStatus", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The status of this Scene. One of the `Phaser.Scene` constants." } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#getStatus", "scope": "instance", "___id": "T000002R037237", "___s": true }, { "comment": "/**\r\n * Can this Scene receive Input events?\r\n *\r\n * @method Phaser.Scenes.Systems#canInput\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Scene can receive Input events.\r\n */", "meta": { "filename": "Systems.js", "lineno": 575, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Can this Scene receive Input events?", "kind": "function", "name": "canInput", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Scene can receive Input events." } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#canInput", "scope": "instance", "___id": "T000002R037239", "___s": true }, { "comment": "/**\r\n * Is this Scene sleeping?\r\n *\r\n * @method Phaser.Scenes.Systems#isSleeping\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if this Scene is asleep, otherwise `false`.\r\n */", "meta": { "filename": "Systems.js", "lineno": 590, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Is this Scene sleeping?", "kind": "function", "name": "isSleeping", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Scene is asleep, otherwise `false`." } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#isSleeping", "scope": "instance", "___id": "T000002R037242", "___s": true }, { "comment": "/**\r\n * Is this Scene running?\r\n *\r\n * @method Phaser.Scenes.Systems#isActive\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if this Scene is running, otherwise `false`.\r\n */", "meta": { "filename": "Systems.js", "lineno": 603, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Is this Scene running?", "kind": "function", "name": "isActive", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Scene is running, otherwise `false`." } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#isActive", "scope": "instance", "___id": "T000002R037244", "___s": true }, { "comment": "/**\r\n * Is this Scene paused?\r\n *\r\n * @method Phaser.Scenes.Systems#isPaused\r\n * @since 3.13.0\r\n *\r\n * @return {boolean} `true` if this Scene is paused, otherwise `false`.\r\n */", "meta": { "filename": "Systems.js", "lineno": 616, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Is this Scene paused?", "kind": "function", "name": "isPaused", "since": "3.13.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Scene is paused, otherwise `false`." } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#isPaused", "scope": "instance", "___id": "T000002R037246", "___s": true }, { "comment": "/**\r\n * Is this Scene currently transitioning out to, or in from another Scene?\r\n *\r\n * @method Phaser.Scenes.Systems#isTransitioning\r\n * @since 3.5.0\r\n *\r\n * @return {boolean} `true` if this Scene is currently transitioning, otherwise `false`.\r\n */", "meta": { "filename": "Systems.js", "lineno": 629, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Is this Scene currently transitioning out to, or in from another Scene?", "kind": "function", "name": "isTransitioning", "since": "3.5.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Scene is currently transitioning, otherwise `false`." } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#isTransitioning", "scope": "instance", "___id": "T000002R037248", "___s": true }, { "comment": "/**\r\n * Is this Scene currently transitioning out from itself to another Scene?\r\n *\r\n * @method Phaser.Scenes.Systems#isTransitionOut\r\n * @since 3.5.0\r\n *\r\n * @return {boolean} `true` if this Scene is in transition to another Scene, otherwise `false`.\r\n */", "meta": { "filename": "Systems.js", "lineno": 642, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Is this Scene currently transitioning out from itself to another Scene?", "kind": "function", "name": "isTransitionOut", "since": "3.5.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Scene is in transition to another Scene, otherwise `false`." } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#isTransitionOut", "scope": "instance", "___id": "T000002R037250", "___s": true }, { "comment": "/**\r\n * Is this Scene currently transitioning in from another Scene?\r\n *\r\n * @method Phaser.Scenes.Systems#isTransitionIn\r\n * @since 3.5.0\r\n *\r\n * @return {boolean} `true` if this Scene is transitioning in from another Scene, otherwise `false`.\r\n */", "meta": { "filename": "Systems.js", "lineno": 655, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Is this Scene currently transitioning in from another Scene?", "kind": "function", "name": "isTransitionIn", "since": "3.5.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Scene is transitioning in from another Scene, otherwise `false`." } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#isTransitionIn", "scope": "instance", "___id": "T000002R037252", "___s": true }, { "comment": "/**\r\n * Is this Scene visible and rendering?\r\n *\r\n * @method Phaser.Scenes.Systems#isVisible\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if this Scene is visible, otherwise `false`.\r\n */", "meta": { "filename": "Systems.js", "lineno": 668, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Is this Scene visible and rendering?", "kind": "function", "name": "isVisible", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Scene is visible, otherwise `false`." } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#isVisible", "scope": "instance", "___id": "T000002R037254", "___s": true }, { "comment": "/**\r\n * Sets the visible state of this Scene.\r\n * An invisible Scene will not render, but will still process updates.\r\n *\r\n * @method Phaser.Scenes.Systems#setVisible\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to render this Scene, otherwise `false`.\r\n *\r\n * @return {Phaser.Scenes.Systems} This Systems object.\r\n */", "meta": { "filename": "Systems.js", "lineno": 681, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Sets the visible state of this Scene.\rAn invisible Scene will not render, but will still process updates.", "kind": "function", "name": "setVisible", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to render this Scene, otherwise `false`.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "description": "This Systems object." } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#setVisible", "scope": "instance", "___id": "T000002R037256", "___s": true }, { "comment": "/**\r\n * Set the active state of this Scene.\r\n *\r\n * An active Scene will run its core update loop.\r\n *\r\n * @method Phaser.Scenes.Systems#setActive\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - If `true` the Scene will be resumed, if previously paused. If `false` it will be paused.\r\n * @param {object} [data] - A data object that will be passed in the 'resume' or 'pause' events.\r\n *\r\n * @return {Phaser.Scenes.Systems} This Systems object.\r\n */", "meta": { "filename": "Systems.js", "lineno": 699, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Set the active state of this Scene.\r\rAn active Scene will run its core update loop.", "kind": "function", "name": "setActive", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If `true` the Scene will be resumed, if previously paused. If `false` it will be paused.", "name": "value" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "A data object that will be passed in the 'resume' or 'pause' events.", "name": "data" } ], "returns": [ { "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "description": "This Systems object." } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#setActive", "scope": "instance", "___id": "T000002R037259", "___s": true }, { "comment": "/**\r\n * Start this Scene running and rendering.\r\n * Called automatically by the SceneManager.\r\n *\r\n * @method Phaser.Scenes.Systems#start\r\n * @fires Phaser.Scenes.Events#START\r\n * @fires Phaser.Scenes.Events#READY\r\n * @since 3.0.0\r\n *\r\n * @param {object} data - Optional data object that may have been passed to this Scene from another.\r\n */", "meta": { "filename": "Systems.js", "lineno": 724, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Start this Scene running and rendering.\rCalled automatically by the SceneManager.", "kind": "function", "name": "start", "fires": [ "Phaser.Scenes.Events#event:START", "Phaser.Scenes.Events#event:READY" ], "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "Optional data object that may have been passed to this Scene from another.", "name": "data" } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#start", "scope": "instance", "___id": "T000002R037261", "___s": true }, { "comment": "/**\r\n * Shutdown this Scene and send a shutdown event to all of its systems.\r\n * A Scene that has been shutdown will not run its update loop or render, but it does\r\n * not destroy any of its plugins or references. It is put into hibernation for later use.\r\n * If you don't ever plan to use this Scene again, then it should be destroyed instead\r\n * to free-up resources.\r\n *\r\n * @method Phaser.Scenes.Systems#shutdown\r\n * @fires Phaser.Scenes.Events#SHUTDOWN\r\n * @since 3.0.0\r\n *\r\n * @param {object} [data] - A data object that will be passed in the 'shutdown' event.\r\n */", "meta": { "filename": "Systems.js", "lineno": 757, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scene", "code": {} }, "description": "Shutdown this Scene and send a shutdown event to all of its systems.\rA Scene that has been shutdown will not run its update loop or render, but it does\rnot destroy any of its plugins or references. It is put into hibernation for later use.\rIf you don't ever plan to use this Scene again, then it should be destroyed instead\rto free-up resources.", "kind": "function", "name": "shutdown", "fires": [ "Phaser.Scenes.Events#event:SHUTDOWN" ], "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "A data object that will be passed in the 'shutdown' event.", "name": "data" } ], "memberof": "Phaser.Scenes.Systems", "longname": "Phaser.Scenes.Systems#shutdown", "scope": "instance", "___id": "T000002R037269", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Scenes.CreateSceneFromObjectConfig\r\n * @since 3.17.0\r\n *\r\n * @property {Phaser.Types.Scenes.SceneInitCallback} [init] - The scene's init callback.\r\n * @property {Phaser.Types.Scenes.ScenePreloadCallback} [preload] - The scene's preload callback.\r\n * @property {Phaser.Types.Scenes.SceneCreateCallback} [create] - The scene's create callback.\r\n * @property {Phaser.Types.Scenes.SceneUpdateCallback} [update] - The scene's update callback. See {@link Phaser.Scene#update}.\r\n * @property {any} [extend] - Any additional properties, which will be copied to the Scene after it's created (except `data` or `sys`).\r\n * @property {any} [extend.data] - Any values, which will be merged into the Scene's Data Manager store.\r\n */", "meta": { "filename": "CreateSceneFromObjectConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\typedefs", "code": {} }, "kind": "typedef", "name": "CreateSceneFromObjectConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.17.0", "properties": [ { "type": { "names": [ "Phaser.Types.Scenes.SceneInitCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Scenes.SceneInitCallback" } }, "optional": true, "description": "The scene's init callback.", "name": "init" }, { "type": { "names": [ "Phaser.Types.Scenes.ScenePreloadCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Scenes.ScenePreloadCallback" } }, "optional": true, "description": "The scene's preload callback.", "name": "preload" }, { "type": { "names": [ "Phaser.Types.Scenes.SceneCreateCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Scenes.SceneCreateCallback" } }, "optional": true, "description": "The scene's create callback.", "name": "create" }, { "type": { "names": [ "Phaser.Types.Scenes.SceneUpdateCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Scenes.SceneUpdateCallback" } }, "optional": true, "description": "The scene's update callback. See {@link Phaser.Scene#update}.", "name": "update" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Any additional properties, which will be copied to the Scene after it's created (except `data` or `sys`).", "name": "extend" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Any values, which will be merged into the Scene's Data Manager store.", "name": "extend.data" } ], "memberof": "Phaser.Types.Scenes", "longname": "Phaser.Types.Scenes.CreateSceneFromObjectConfig", "scope": "static", "___id": "T000002R037287", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Scenes\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\typedefs", "code": {} }, "kind": "namespace", "name": "Scenes", "memberof": "Phaser.Types", "longname": "Phaser.Types.Scenes", "scope": "static", "___id": "T000002R037288", "___s": true }, { "comment": "/**\r\n * Can be defined on your own Scenes. Use it to create your game objects.\r\n * This method is called by the Scene Manager when the scene starts, after `init()` and `preload()`.\r\n * If the LoaderPlugin started after `preload()`, then this method is called only after loading is complete.\r\n *\r\n * @callback Phaser.Types.Scenes.SceneCreateCallback\r\n * @since 3.0.0\r\n *\r\n * @this Phaser.Scene\r\n * @param {object} data - Any data passed via `ScenePlugin.add()` or `ScenePlugin.start()`. Same as Scene.settings.data.\r\n */", "meta": { "filename": "SceneCreateCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\typedefs", "code": {} }, "description": "Can be defined on your own Scenes. Use it to create your game objects.\rThis method is called by the Scene Manager when the scene starts, after `init()` and `preload()`.\rIf the LoaderPlugin started after `preload()`, then this method is called only after loading is complete.", "kind": "typedef", "name": "SceneCreateCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "this": "Phaser.Scene", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "Any data passed via `ScenePlugin.add()` or `ScenePlugin.start()`. Same as Scene.settings.data.", "name": "data" } ], "memberof": "Phaser.Types.Scenes", "longname": "Phaser.Types.Scenes.SceneCreateCallback", "scope": "static", "___id": "T000002R037289", "___s": true }, { "comment": "/**\r\n * Can be defined on your own Scenes.\r\n * This method is called by the Scene Manager when the scene starts, before `preload()` and `create()`.\r\n *\r\n * @callback Phaser.Types.Scenes.SceneInitCallback\r\n * @since 3.0.0\r\n *\r\n * @this Phaser.Scene\r\n * @param {object} data - Any data passed via `ScenePlugin.add()` or `ScenePlugin.start()`. Same as Scene.settings.data.\r\n */", "meta": { "filename": "SceneInitCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\typedefs", "code": {} }, "description": "Can be defined on your own Scenes.\rThis method is called by the Scene Manager when the scene starts, before `preload()` and `create()`.", "kind": "typedef", "name": "SceneInitCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "this": "Phaser.Scene", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "Any data passed via `ScenePlugin.add()` or `ScenePlugin.start()`. Same as Scene.settings.data.", "name": "data" } ], "memberof": "Phaser.Types.Scenes", "longname": "Phaser.Types.Scenes.SceneInitCallback", "scope": "static", "___id": "T000002R037290", "___s": true }, { "comment": "/**\r\n * Can be defined on your own Scenes. Use it to load assets.\r\n * This method is called by the Scene Manager, after `init()` and before `create()`, only if the Scene has a LoaderPlugin.\r\n * After this method completes, if the LoaderPlugin's queue isn't empty, the LoaderPlugin will start automatically.\r\n *\r\n * @callback Phaser.Types.Scenes.ScenePreloadCallback\r\n * @since 3.0.0\r\n *\r\n * @this Phaser.Scene\r\n */", "meta": { "filename": "ScenePreloadCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\typedefs", "code": {} }, "description": "Can be defined on your own Scenes. Use it to load assets.\rThis method is called by the Scene Manager, after `init()` and before `create()`, only if the Scene has a LoaderPlugin.\rAfter this method completes, if the LoaderPlugin's queue isn't empty, the LoaderPlugin will start automatically.", "kind": "typedef", "name": "ScenePreloadCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "this": "Phaser.Scene", "memberof": "Phaser.Types.Scenes", "longname": "Phaser.Types.Scenes.ScenePreloadCallback", "scope": "static", "___id": "T000002R037291", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Scenes.SceneTransitionConfig\r\n * @since 3.5.0\r\n *\r\n * @property {string} target - The Scene key to transition to.\r\n * @property {number} [duration=1000] - The duration, in ms, for the transition to last.\r\n * @property {boolean} [sleep=false] - Will the Scene responsible for the transition be sent to sleep on completion (`true`), or stopped? (`false`)\r\n * @property {boolean} [remove=false] - Will the Scene responsible for the transition be removed from the Scene Manager after the transition completes?\r\n * @property {boolean} [allowInput=false] - Will the Scenes Input system be able to process events while it is transitioning in or out?\r\n * @property {boolean} [moveAbove] - Move the target Scene to be above this one before the transition starts.\r\n * @property {boolean} [moveBelow] - Move the target Scene to be below this one before the transition starts.\r\n * @property {function} [onUpdate] - This callback is invoked every frame for the duration of the transition.\r\n * @property {any} [onUpdateScope] - The context in which the callback is invoked.\r\n * @property {Phaser.Types.Scenes.SceneTransitionOnStartCallback} [onStart] - This callback is invoked when transition starting.\r\n * @property {any} [onStartScope] - The context in which the callback is invoked.\r\n * @property {any} [data] - An object containing any data you wish to be passed to the target scene's init / create methods (if sleep is false) or to the target scene's wake event callback (if sleep is true).\r\n */", "meta": { "filename": "SceneTransitionConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\typedefs", "code": {} }, "kind": "typedef", "name": "SceneTransitionConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.5.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The Scene key to transition to.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration, in ms, for the transition to last.", "name": "duration" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Will the Scene responsible for the transition be sent to sleep on completion (`true`), or stopped? (`false`)", "name": "sleep" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Will the Scene responsible for the transition be removed from the Scene Manager after the transition completes?", "name": "remove" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Will the Scenes Input system be able to process events while it is transitioning in or out?", "name": "allowInput" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Move the target Scene to be above this one before the transition starts.", "name": "moveAbove" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Move the target Scene to be below this one before the transition starts.", "name": "moveBelow" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "This callback is invoked every frame for the duration of the transition.", "name": "onUpdate" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The context in which the callback is invoked.", "name": "onUpdateScope" }, { "type": { "names": [ "Phaser.Types.Scenes.SceneTransitionOnStartCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Scenes.SceneTransitionOnStartCallback" } }, "optional": true, "description": "This callback is invoked when transition starting.", "name": "onStart" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The context in which the callback is invoked.", "name": "onStartScope" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "An object containing any data you wish to be passed to the target scene's init / create methods (if sleep is false) or to the target scene's wake event callback (if sleep is true).", "name": "data" } ], "memberof": "Phaser.Types.Scenes", "longname": "Phaser.Types.Scenes.SceneTransitionConfig", "scope": "static", "___id": "T000002R037292", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Scenes.SceneTransitionOnStartCallback\r\n * @since 3.60.0\r\n *\r\n * @this Phaser.Scene\r\n * @param {Phaser.Scene} fromScene - Scene instance to transition from.\r\n * @param {Phaser.Scene} toScene - Scene instance to transition to.\r\n * @property {number} [duration=1000] - The duration, in ms, for the transition to last.\r\n */", "meta": { "filename": "SceneTransitionStartCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\typedefs", "code": {} }, "kind": "typedef", "name": "SceneTransitionOnStartCallback", "type": { "names": [ "function" ] }, "since": "3.60.0", "this": "Phaser.Scene", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "Scene instance to transition from.", "name": "fromScene" }, { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "Scene instance to transition to.", "name": "toScene" } ], "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration, in ms, for the transition to last.", "name": "duration" } ], "memberof": "Phaser.Types.Scenes", "longname": "Phaser.Types.Scenes.SceneTransitionOnStartCallback", "scope": "static", "___id": "T000002R037293", "___s": true }, { "comment": "/**\r\n * @typedef {(Phaser.Scene|Phaser.Types.Scenes.SettingsConfig|Phaser.Types.Scenes.CreateSceneFromObjectConfig|function)} Phaser.Types.Scenes.SceneType\r\n * @since 3.60.0\r\n */", "meta": { "filename": "SceneType.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\typedefs", "code": {} }, "kind": "typedef", "name": "SceneType", "type": { "names": [ "Phaser.Scene", "Phaser.Types.Scenes.SettingsConfig", "Phaser.Types.Scenes.CreateSceneFromObjectConfig", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Scene" }, { "type": "NameExpression", "name": "Phaser.Types.Scenes.SettingsConfig" }, { "type": "NameExpression", "name": "Phaser.Types.Scenes.CreateSceneFromObjectConfig" }, { "type": "FunctionType", "params": [] } ] } }, "since": "3.60.0", "memberof": "Phaser.Types.Scenes", "longname": "Phaser.Types.Scenes.SceneType", "scope": "static", "___id": "T000002R037294", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Scenes.SceneUpdateCallback\r\n * @since 3.0.0\r\n *\r\n * @this Phaser.Scene\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": "SceneUpdateCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\typedefs", "code": {} }, "kind": "typedef", "name": "SceneUpdateCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "this": "Phaser.Scene", "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.Types.Scenes", "longname": "Phaser.Types.Scenes.SceneUpdateCallback", "scope": "static", "___id": "T000002R037295", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Scenes.SettingsConfig\r\n * @since 3.0.0\r\n *\r\n * @property {string} [key] - The unique key of this Scene. Must be unique within the entire Game instance.\r\n * @property {boolean} [active=false] - Does the Scene start as active or not? An active Scene updates each step.\r\n * @property {boolean} [visible=true] - Does the Scene start as visible or not? A visible Scene renders each step.\r\n * @property {(false|Phaser.Types.Loader.FileTypes.PackFileSection)} [pack=false] - Files to be loaded before the Scene begins.\r\n * @property {?(Phaser.Types.Cameras.Scene2D.CameraConfig|Phaser.Types.Cameras.Scene2D.CameraConfig[])} [cameras=null] - An optional Camera configuration object.\r\n * @property {Object.} [map] - Overwrites the default injection map for a scene.\r\n * @property {Object.} [mapAdd] - Extends the injection map for a scene.\r\n * @property {Phaser.Types.Core.PhysicsConfig} [physics={}] - The physics configuration object for the Scene.\r\n * @property {Phaser.Types.Core.LoaderConfig} [loader={}] - The loader configuration object for the Scene.\r\n * @property {(false|*)} [plugins=false] - The plugin configuration object for the Scene.\r\n */", "meta": { "filename": "SettingsConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\typedefs", "code": {} }, "kind": "typedef", "name": "SettingsConfig", "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 unique key of this Scene. Must be unique within the entire Game instance.", "name": "key" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does the Scene start as active or not? An active Scene updates each step.", "name": "active" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Does the Scene start as visible or not? A visible Scene renders each step.", "name": "visible" }, { "type": { "names": [ "false", "Phaser.Types.Loader.FileTypes.PackFileSection" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "false", "reservedWord": true }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.PackFileSection" } ] } }, "optional": true, "defaultvalue": false, "description": "Files to be loaded before the Scene begins.", "name": "pack" }, { "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" } ] } ], "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": null, "description": "An optional Camera configuration object.", "name": "cameras" }, { "type": { "names": [ "Object." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "Overwrites the default injection map for a scene.", "name": "map" }, { "type": { "names": [ "Object." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "Extends the injection map for a scene.", "name": "mapAdd" }, { "type": { "names": [ "Phaser.Types.Core.PhysicsConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.PhysicsConfig" } }, "optional": true, "defaultvalue": "{}", "description": "The physics configuration object for the Scene.", "name": "physics" }, { "type": { "names": [ "Phaser.Types.Core.LoaderConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.LoaderConfig" } }, "optional": true, "defaultvalue": "{}", "description": "The loader configuration object for the Scene.", "name": "loader" }, { "type": { "names": [ "false", "*" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "false", "reservedWord": true }, { "type": "AllLiteral" } ] } }, "optional": true, "defaultvalue": false, "description": "The plugin configuration object for the Scene.", "name": "plugins" } ], "memberof": "Phaser.Types.Scenes", "longname": "Phaser.Types.Scenes.SettingsConfig", "scope": "static", "___id": "T000002R037296", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Scenes.SettingsObject\r\n * @since 3.0.0\r\n *\r\n * @property {number} status - The current status of the Scene. Maps to the Scene constants.\r\n * @property {string} key - The unique key of this Scene. Unique within the entire Game instance.\r\n * @property {boolean} active - The active state of this Scene. An active Scene updates each step.\r\n * @property {boolean} visible - The visible state of this Scene. A visible Scene renders each step.\r\n * @property {boolean} isBooted - Has the Scene finished booting?\r\n * @property {boolean} isTransition - Is the Scene in a state of transition?\r\n * @property {?Phaser.Scene} transitionFrom - The Scene this Scene is transitioning from, if set.\r\n * @property {number} transitionDuration - The duration of the transition, if set.\r\n * @property {boolean} transitionAllowInput - Is this Scene allowed to receive input during transitions?\r\n * @property {object} data - a data bundle passed to this Scene from the Scene Manager.\r\n * @property {(false|Phaser.Types.Loader.FileTypes.PackFileSection)} pack - Files to be loaded before the Scene begins.\r\n * @property {?(Phaser.Types.Cameras.Scene2D.CameraConfig|Phaser.Types.Cameras.Scene2D.CameraConfig[])} cameras - The Camera configuration object.\r\n * @property {Object.} map - The Scene's Injection Map.\r\n * @property {Phaser.Types.Core.PhysicsConfig} physics - The physics configuration object for the Scene.\r\n * @property {Phaser.Types.Core.LoaderConfig} loader - The loader configuration object for the Scene.\r\n * @property {(false|*)} plugins - The plugin configuration object for the Scene.\r\n */", "meta": { "filename": "SettingsObject.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\scene\\typedefs", "code": {} }, "kind": "typedef", "name": "SettingsObject", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current status of the Scene. Maps to the Scene constants.", "name": "status" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of this Scene. Unique within the entire Game instance.", "name": "key" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The active state of this Scene. An active Scene updates each step.", "name": "active" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of this Scene. A visible Scene renders each step.", "name": "visible" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Has the Scene finished booting?", "name": "isBooted" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is the Scene in a state of transition?", "name": "isTransition" }, { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene", "nullable": true } }, "nullable": true, "description": "The Scene this Scene is transitioning from, if set.", "name": "transitionFrom" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the transition, if set.", "name": "transitionDuration" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this Scene allowed to receive input during transitions?", "name": "transitionAllowInput" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "a data bundle passed to this Scene from the Scene Manager.", "name": "data" }, { "type": { "names": [ "false", "Phaser.Types.Loader.FileTypes.PackFileSection" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "false", "reservedWord": true }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.PackFileSection" } ] } }, "description": "Files to be loaded before the Scene begins.", "name": "pack" }, { "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" } ] } ], "nullable": true } }, "nullable": true, "description": "The Camera configuration object.", "name": "cameras" }, { "type": { "names": [ "Object." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The Scene's Injection Map.", "name": "map" }, { "type": { "names": [ "Phaser.Types.Core.PhysicsConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.PhysicsConfig" } }, "description": "The physics configuration object for the Scene.", "name": "physics" }, { "type": { "names": [ "Phaser.Types.Core.LoaderConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.LoaderConfig" } }, "description": "The loader configuration object for the Scene.", "name": "loader" }, { "type": { "names": [ "false", "*" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "false", "reservedWord": true }, { "type": "AllLiteral" } ] } }, "description": "The plugin configuration object for the Scene.", "name": "plugins" } ], "memberof": "Phaser.Types.Scenes", "longname": "Phaser.Types.Scenes.SettingsObject", "scope": "static", "___id": "T000002R037297", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Class containing all the shared state and behavior of a sound object, independent of the implementation.\r\n *\r\n * @class BaseSound\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Sound\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Sound.BaseSoundManager} manager - Reference to the current sound manager instance.\r\n * @param {string} key - Asset key for the sound.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config] - An optional config object containing default sound settings.\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "classdesc": "Class containing all the shared state and behavior of a sound object, independent of the implementation.", "kind": "class", "name": "BaseSound", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Sound", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.BaseSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSoundManager" } }, "description": "Reference to the current sound manager instance.", "name": "manager" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "An optional config object containing default sound settings.", "name": "config" } ], "scope": "static", "longname": "Phaser.Sound.BaseSound", "___id": "T000002R037303", "___s": true }, { "comment": "/**\r\n * Local reference to the sound manager.\r\n *\r\n * @name Phaser.Sound.BaseSound#manager\r\n * @type {Phaser.Sound.BaseSoundManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Local reference to the sound manager.", "name": "manager", "type": { "names": [ "Phaser.Sound.BaseSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSoundManager" } }, "since": "3.0.0", "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#manager", "scope": "instance", "kind": "member", "___id": "T000002R037307", "___s": true }, { "comment": "/**\r\n * Asset key for the sound.\r\n *\r\n * @name Phaser.Sound.BaseSound#key\r\n * @type {string}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Asset key for the sound.", "name": "key", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#key", "scope": "instance", "kind": "member", "___id": "T000002R037309", "___s": true }, { "comment": "/**\r\n * Flag indicating if sound is currently playing.\r\n *\r\n * @name Phaser.Sound.BaseSound#isPlaying\r\n * @type {boolean}\r\n * @default false\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Flag indicating if sound is currently playing.", "name": "isPlaying", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#isPlaying", "scope": "instance", "kind": "member", "___id": "T000002R037311", "___s": true }, { "comment": "/**\r\n * Flag indicating if sound is currently paused.\r\n *\r\n * @name Phaser.Sound.BaseSound#isPaused\r\n * @type {boolean}\r\n * @default false\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Flag indicating if sound is currently paused.", "name": "isPaused", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#isPaused", "scope": "instance", "kind": "member", "___id": "T000002R037313", "___s": true }, { "comment": "/**\r\n * A property that holds the value of sound's actual playback rate,\r\n * after its rate and detune values has been combined with global\r\n * rate and detune values.\r\n *\r\n * @name Phaser.Sound.BaseSound#totalRate\r\n * @type {number}\r\n * @default 1\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "A property that holds the value of sound's actual playback rate,\rafter its rate and detune values has been combined with global\rrate and detune values.", "name": "totalRate", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#totalRate", "scope": "instance", "kind": "member", "___id": "T000002R037315", "___s": true }, { "comment": "/**\r\n * A value representing the duration, in seconds.\r\n * It could be total sound duration or a marker duration.\r\n *\r\n * @name Phaser.Sound.BaseSound#duration\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "A value representing the duration, in seconds.\rIt could be total sound duration or a marker duration.", "name": "duration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#duration", "scope": "instance", "kind": "member", "___id": "T000002R037317", "___s": true }, { "comment": "/**\r\n * The total duration of the sound in seconds.\r\n *\r\n * @name Phaser.Sound.BaseSound#totalDuration\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 103, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "The total duration of the sound in seconds.", "name": "totalDuration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#totalDuration", "scope": "instance", "kind": "member", "___id": "T000002R037319", "___s": true }, { "comment": "/**\r\n * Object containing markers definitions.\r\n *\r\n * @name Phaser.Sound.BaseSound#markers\r\n * @type {Object.}\r\n * @default {}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Object containing markers definitions.", "name": "markers", "type": { "names": [ "Object." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } ] } }, "defaultvalue": "{}", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#markers", "scope": "instance", "kind": "member", "___id": "T000002R037334", "___s": true }, { "comment": "/**\r\n * Currently playing marker.\r\n * 'null' if whole sound is playing.\r\n *\r\n * @name Phaser.Sound.BaseSound#currentMarker\r\n * @type {Phaser.Types.Sound.SoundMarker}\r\n * @default null\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Currently playing marker.\r'null' if whole sound is playing.", "name": "currentMarker", "type": { "names": [ "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } }, "defaultvalue": "null", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#currentMarker", "scope": "instance", "kind": "member", "___id": "T000002R037336", "___s": true }, { "comment": "/**\r\n * Flag indicating if destroy method was called on this sound.\r\n *\r\n * @name Phaser.Sound.BaseSound#pendingRemove\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 171, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Flag indicating if destroy method was called on this sound.", "name": "pendingRemove", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#pendingRemove", "scope": "instance", "kind": "member", "___id": "T000002R037338", "___s": true }, { "comment": "/**\r\n * Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object.\r\n * This allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.\r\n *\r\n * @method Phaser.Sound.BaseSound#addMarker\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Sound.SoundMarker} marker - Marker object.\r\n *\r\n * @return {boolean} Whether the marker was added successfully.\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object.\rThis allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.", "kind": "function", "name": "addMarker", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } }, "description": "Marker object.", "name": "marker" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the marker was added successfully." } ], "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#addMarker", "scope": "instance", "___id": "T000002R037340", "___s": true }, { "comment": "/**\r\n * Updates previously added marker.\r\n *\r\n * @method Phaser.Sound.BaseSound#updateMarker\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Sound.SoundMarker} marker - Marker object with updated values.\r\n *\r\n * @return {boolean} Whether the marker was updated successfully.\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 229, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Updates previously added marker.", "kind": "function", "name": "updateMarker", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } }, "description": "Marker object with updated values.", "name": "marker" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the marker was updated successfully." } ], "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#updateMarker", "scope": "instance", "___id": "T000002R037356", "___s": true }, { "comment": "/**\r\n * Removes a marker from the sound.\r\n *\r\n * @method Phaser.Sound.BaseSound#removeMarker\r\n * @since 3.0.0\r\n *\r\n * @param {string} markerName - The name of the marker to remove.\r\n *\r\n * @return {?Phaser.Types.Sound.SoundMarker} Removed marker object or 'null' if there was no marker with provided name.\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 259, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Removes a marker from the sound.", "kind": "function", "name": "removeMarker", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the marker to remove.", "name": "markerName" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker", "nullable": true } }, "nullable": true, "description": "Removed marker object or 'null' if there was no marker with provided name." } ], "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#removeMarker", "scope": "instance", "___id": "T000002R037359", "___s": true }, { "comment": "/**\r\n * Play this sound, or a marked section of it.\r\n *\r\n * It always plays the sound from the start. If you want to start playback from a specific time\r\n * you can set 'seek' setting of the config object, provided to this call, to that value.\r\n *\r\n * @method Phaser.Sound.BaseSound#play\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Sound.SoundConfig)} [markerName=''] - If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config] - Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.\r\n *\r\n * @return {boolean} Whether the sound started playing successfully.\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 283, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Play this sound, or a marked section of it.\r\rIt always plays the sound from the start. If you want to start playback from a specific time\ryou can set 'seek' setting of the config object, provided to this call, to that value.", "kind": "function", "name": "play", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } ] } }, "optional": true, "defaultvalue": "''", "description": "If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.", "name": "markerName" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.", "name": "config" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound started playing successfully." } ], "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#play", "scope": "instance", "___id": "T000002R037363", "___s": true }, { "comment": "/**\r\n * Pauses the sound. This only works if the sound is currently playing.\r\n *\r\n * You can inspect the `isPlaying` and `isPaused` properties to check the state.\r\n *\r\n * @method Phaser.Sound.BaseSound#pause\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} Whether the sound was paused successfully.\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 343, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Pauses the sound. This only works if the sound is currently playing.\r\rYou can inspect the `isPlaying` and `isPaused` properties to check the state.", "kind": "function", "name": "pause", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound was paused successfully." } ], "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#pause", "scope": "instance", "___id": "T000002R037377", "___s": true }, { "comment": "/**\r\n * Resumes the sound. This only works if the sound is paused and not already playing.\r\n *\r\n * You can inspect the `isPlaying` and `isPaused` properties to check the state.\r\n *\r\n * @method Phaser.Sound.BaseSound#resume\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} Whether the sound was resumed successfully.\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 366, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Resumes the sound. This only works if the sound is paused and not already playing.\r\rYou can inspect the `isPlaying` and `isPaused` properties to check the state.", "kind": "function", "name": "resume", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound was resumed successfully." } ], "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#resume", "scope": "instance", "___id": "T000002R037381", "___s": true }, { "comment": "/**\r\n * Stop playing this sound.\r\n *\r\n * @method Phaser.Sound.BaseSound#stop\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} Whether the sound was stopped successfully.\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 389, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Stop playing this sound.", "kind": "function", "name": "stop", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound was stopped successfully." } ], "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#stop", "scope": "instance", "___id": "T000002R037385", "___s": true }, { "comment": "/**\r\n * Method used internally for applying config values to some of the sound properties.\r\n *\r\n * @method Phaser.Sound.BaseSound#applyConfig\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Method used internally for applying config values to some of the sound properties.", "kind": "function", "name": "applyConfig", "since": "3.0.0", "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#applyConfig", "scope": "instance", "___id": "T000002R037389", "___s": true }, { "comment": "/**\r\n * Method used internally for resetting values of some of the config properties.\r\n *\r\n * @method Phaser.Sound.BaseSound#resetConfig\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 428, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Method used internally for resetting values of some of the config properties.", "kind": "function", "name": "resetConfig", "since": "3.0.0", "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#resetConfig", "scope": "instance", "___id": "T000002R037397", "___s": true }, { "comment": "/**\r\n * Update method called automatically by sound manager on every game step.\r\n *\r\n * @method Phaser.Sound.BaseSound#update\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 elapsed since the last frame.\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 440, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Update method called automatically by sound manager on every game step.", "kind": "function", "name": "update", "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 elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#update", "scope": "instance", "___id": "T000002R037401", "___s": true }, { "comment": "/**\r\n * Method used internally to calculate total playback rate of the sound.\r\n *\r\n * @method Phaser.Sound.BaseSound#calculateRate\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 451, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Method used internally to calculate total playback rate of the sound.", "kind": "function", "name": "calculateRate", "since": "3.0.0", "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#calculateRate", "scope": "instance", "___id": "T000002R037403", "___s": true }, { "comment": "/**\r\n * Destroys this sound and all associated events and marks it for removal from the sound manager.\r\n *\r\n * @method Phaser.Sound.BaseSound#destroy\r\n * @fires Phaser.Sound.Events#DESTROY\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 466, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Destroys this sound and all associated events and marks it for removal from the sound manager.", "kind": "function", "name": "destroy", "fires": [ "Phaser.Sound.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.Sound.BaseSound", "longname": "Phaser.Sound.BaseSound#destroy", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#destroy", "___id": "T000002R037409", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Base class for other Sound Manager classes.\r\n *\r\n * @class BaseSoundManager\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Sound\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - Reference to the current game instance.\r\n *\r\n * @see Phaser.Sound.HTML5AudioSoundManager\r\n * @see Phaser.Sound.NoAudioSoundManager\r\n * @see Phaser.Sound.WebAudioSoundManager\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 18, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "classdesc": "Base class for other Sound Manager classes.", "kind": "class", "name": "BaseSoundManager", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Sound", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "Reference to the current game instance.", "name": "game" } ], "see": [ "Phaser.Sound.HTML5AudioSoundManager", "Phaser.Sound.NoAudioSoundManager", "Phaser.Sound.WebAudioSoundManager" ], "scope": "static", "longname": "Phaser.Sound.BaseSoundManager", "___id": "T000002R037427", "___s": true }, { "comment": "/**\r\n * Local reference to game.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#game\r\n * @type {Phaser.Game}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Local reference to game.", "name": "game", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#game", "scope": "instance", "kind": "member", "___id": "T000002R037431", "___s": true }, { "comment": "/**\r\n * Local reference to the JSON Cache, as used by Audio Sprites.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#jsonCache\r\n * @type {Phaser.Cache.BaseCache}\r\n * @readonly\r\n * @since 3.7.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Local reference to the JSON Cache, as used by Audio Sprites.", "name": "jsonCache", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "readonly": true, "since": "3.7.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#jsonCache", "scope": "instance", "kind": "member", "___id": "T000002R037433", "___s": true }, { "comment": "/**\r\n * Global mute setting.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#mute\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Global mute setting.", "name": "mute", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#mute", "scope": "instance", "kind": "member", "___id": "T000002R037437", "___s": true }, { "comment": "/**\r\n * Global volume setting.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#volume\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Global volume setting.", "name": "volume", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#volume", "scope": "instance", "kind": "member", "___id": "T000002R037439", "___s": true }, { "comment": "/**\r\n * Flag indicating if sounds should be paused when game looses focus,\r\n * for instance when user switches to another tab/program/app.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#pauseOnBlur\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Flag indicating if sounds should be paused when game looses focus,\rfor instance when user switches to another tab/program/app.", "name": "pauseOnBlur", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#pauseOnBlur", "scope": "instance", "kind": "member", "___id": "T000002R037441", "___s": true }, { "comment": "/**\r\n * Mobile devices require sounds to be triggered from an explicit user action,\r\n * such as a tap, before any sound can be loaded/played on a web page.\r\n * Set to true if the audio system is currently locked awaiting user interaction.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#locked\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 128, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Mobile devices require sounds to be triggered from an explicit user action,\rsuch as a tap, before any sound can be loaded/played on a web page.\rSet to true if the audio system is currently locked awaiting user interaction.", "name": "locked", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#locked", "scope": "instance", "kind": "member", "___id": "T000002R037447", "___s": true }, { "comment": "/**\r\n * Flag used to track if the game has lost focus.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#gameLostFocus\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Flag used to track if the game has lost focus.", "name": "gameLostFocus", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#gameLostFocus", "scope": "instance", "kind": "member", "___id": "T000002R037451", "___s": true }, { "comment": "/**\r\n * The Spatial Audio listener position.\r\n *\r\n * Only available with WebAudio.\r\n *\r\n * You can modify the x/y properties of this Vec2 directly to\r\n * adjust the listener position within the game world.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#listenerPosition\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 162, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "The Spatial Audio listener position.\r\rOnly available with WebAudio.\r\rYou can modify the x/y properties of this Vec2 directly to\radjust the listener position within the game world.", "name": "listenerPosition", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.60.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#listenerPosition", "scope": "instance", "kind": "member", "___id": "T000002R037453", "___s": true }, { "comment": "/**\r\n * Adds a new sound into the sound manager.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#add\r\n * @override\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - Asset key for the sound.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config] - An optional config object containing default sound settings.\r\n *\r\n * @return {Phaser.Sound.BaseSound} The new sound instance.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Adds a new sound into the sound manager.", "kind": "function", "name": "add", "override": true, "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "An optional config object containing default sound settings.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Sound.BaseSound" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSound" } }, "description": "The new sound instance." } ], "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#add", "scope": "instance", "___id": "T000002R037455", "___s": true }, { "comment": "/**\r\n * Adds a new audio sprite sound into the sound manager.\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 * @method Phaser.Sound.BaseSoundManager#addAudioSprite\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - Asset key for the sound.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config] - An optional config object containing default sound settings.\r\n *\r\n * @return {(Phaser.Sound.NoAudioSound|Phaser.Sound.HTML5AudioSound|Phaser.Sound.WebAudioSound)} The new audio sprite sound instance.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 196, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Adds a new audio sprite sound into the sound manager.\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", "kind": "function", "name": "addAudioSprite", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "An optional config object containing default sound settings.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Sound.NoAudioSound", "Phaser.Sound.HTML5AudioSound", "Phaser.Sound.WebAudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.NoAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" } ] } }, "description": "The new audio sprite sound instance." } ], "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#addAudioSprite", "scope": "instance", "___id": "T000002R037457", "___s": true }, { "comment": "/**\r\n * Gets the first sound in this Sound Manager that matches the given key.\r\n * If none can be found it returns `null`.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#get\r\n * @since 3.23.0\r\n *\r\n * @generic {Phaser.Sound.BaseSound} T\r\n * @genericUse {T} - [$return]\r\n *\r\n * @param {string} key - Sound asset key.\r\n *\r\n * @return {?Phaser.Sound.BaseSound} - The sound, or null.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 241, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Gets the first sound in this Sound Manager that matches the given key.\rIf none can be found it returns `null`.", "kind": "function", "name": "get", "since": "3.23.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Sound.BaseSound} T", "value": "{Phaser.Sound.BaseSound} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$return]", "value": "{T} - [$return]" } ], "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Sound asset key.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Sound.BaseSound" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSound", "nullable": true } }, "nullable": true, "description": "- The sound, or null." } ], "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#get", "scope": "instance", "___id": "T000002R037470", "___s": true }, { "comment": "/**\r\n * Gets all sounds in this Sound Manager.\r\n *\r\n * You can optionally specify a key, in which case only Sound instances that match the given key\r\n * will be returned.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#getAll\r\n * @since 3.23.0\r\n *\r\n * @generic {Phaser.Sound.BaseSound} T\r\n * @genericUse {T[]} - [$return]\r\n *\r\n * @param {string} [key] - Optional asset key. If given, only Sound instances with this key will be returned.\r\n *\r\n * @return {Phaser.Sound.BaseSound[]} - The sounds, or an empty array.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 260, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Gets all sounds in this Sound Manager.\r\rYou can optionally specify a key, in which case only Sound instances that match the given key\rwill be returned.", "kind": "function", "name": "getAll", "since": "3.23.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Sound.BaseSound} T", "value": "{Phaser.Sound.BaseSound} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [$return]", "value": "{T[]} - [$return]" } ], "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional asset key. If given, only Sound instances with this key will be returned.", "name": "key" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Sound.BaseSound", "type": "NameExpression" } ] } }, "description": "- The sounds, or an empty array." } ], "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#getAll", "scope": "instance", "___id": "T000002R037472", "___s": true }, { "comment": "/**\r\n * Returns all sounds from this Sound Manager that are currently\r\n * playing. That is, Sound instances that have their `isPlaying`\r\n * property set to `true`.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#getAllPlaying\r\n * @since 3.60.0\r\n *\r\n * @generic {Phaser.Sound.BaseSound} T\r\n * @genericUse {T[]} - [$return]\r\n *\r\n * @return {Phaser.Sound.BaseSound[]} - All currently playing sounds, or an empty array.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Returns all sounds from this Sound Manager that are currently\rplaying. That is, Sound instances that have their `isPlaying`\rproperty set to `true`.", "kind": "function", "name": "getAllPlaying", "since": "3.60.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Sound.BaseSound} T", "value": "{Phaser.Sound.BaseSound} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [$return]", "value": "{T[]} - [$return]" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Sound.BaseSound", "type": "NameExpression" } ] } }, "description": "- All currently playing sounds, or an empty array." } ], "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#getAllPlaying", "scope": "instance", "___id": "T000002R037474", "___s": true }, { "comment": "/**\r\n * Adds a new sound to the sound manager and plays it.\r\n *\r\n * The sound will be automatically removed (destroyed) once playback ends.\r\n *\r\n * This lets you play a new sound on the fly without the need to keep a reference to it.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#play\r\n * @listens Phaser.Sound.Events#COMPLETE\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - Asset key for the sound.\r\n * @param {(Phaser.Types.Sound.SoundConfig|Phaser.Types.Sound.SoundMarker)} [extra] - An optional additional object containing settings to be applied to the sound. It could be either config or marker object.\r\n *\r\n * @return {boolean} Whether the sound started playing successfully.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 306, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Adds a new sound to the sound manager and plays it.\r\rThe sound will be automatically removed (destroyed) once playback ends.\r\rThis lets you play a new sound on the fly without the need to keep a reference to it.", "kind": "function", "name": "play", "listens": [ "Phaser.Sound.Events#event:COMPLETE" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig", "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" }, { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } ] } }, "optional": true, "description": "An optional additional object containing settings to be applied to the sound. It could be either config or marker object.", "name": "extra" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound started playing successfully." } ], "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#play", "scope": "instance", "___id": "T000002R037476", "___s": true }, { "comment": "/**\r\n * Adds a new audio sprite sound to the sound manager and plays it.\r\n * The sprite will be automatically removed (destroyed) once playback ends.\r\n * This lets you play a new sound on the fly without the need to keep a reference to it.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#playAudioSprite\r\n * @listens Phaser.Sound.Events#COMPLETE\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - Asset key for the sound.\r\n * @param {string} spriteName - The name of the sound sprite to play.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config] - An optional config object containing default sound settings.\r\n *\r\n * @return {boolean} Whether the audio sprite sound started playing successfully.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 347, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Adds a new audio sprite sound to the sound manager and plays it.\rThe sprite will be automatically removed (destroyed) once playback ends.\rThis lets you play a new sound on the fly without the need to keep a reference to it.", "kind": "function", "name": "playAudioSprite", "listens": [ "Phaser.Sound.Events#event:COMPLETE" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the sound sprite to play.", "name": "spriteName" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "An optional config object containing default sound settings.", "name": "config" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the audio sprite sound started playing successfully." } ], "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#playAudioSprite", "scope": "instance", "___id": "T000002R037479", "___s": true }, { "comment": "/**\r\n * Removes a sound from the sound manager.\r\n * The removed sound is destroyed before removal.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#remove\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Sound.BaseSound} sound - The sound object to remove.\r\n *\r\n * @return {boolean} True if the sound was removed successfully, otherwise false.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 371, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Removes a sound from the sound manager.\rThe removed sound is destroyed before removal.", "kind": "function", "name": "remove", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.BaseSound" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSound" } }, "description": "The sound object to remove.", "name": "sound" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the sound was removed successfully, otherwise false." } ], "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#remove", "scope": "instance", "___id": "T000002R037482", "___s": true }, { "comment": "/**\r\n * Removes all sounds from the manager, destroying the sounds.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#removeAll\r\n * @since 3.23.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 398, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Removes all sounds from the manager, destroying the sounds.", "kind": "function", "name": "removeAll", "since": "3.23.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#removeAll", "scope": "instance", "___id": "T000002R037485", "___s": true }, { "comment": "/**\r\n * Removes all sounds from the sound manager that have an asset key matching the given value.\r\n * The removed sounds are destroyed before removal.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#removeByKey\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key to match when removing sound objects.\r\n *\r\n * @return {number} The number of matching sound objects that were removed.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 414, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Removes all sounds from the sound manager that have an asset key matching the given value.\rThe removed sounds are destroyed before removal.", "kind": "function", "name": "removeByKey", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to match when removing sound objects.", "name": "key" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of matching sound objects that were removed." } ], "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#removeByKey", "scope": "instance", "___id": "T000002R037488", "___s": true }, { "comment": "/**\r\n * Pauses all the sounds in the game.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#pauseAll\r\n * @fires Phaser.Sound.Events#PAUSE_ALL\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 446, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Pauses all the sounds in the game.", "kind": "function", "name": "pauseAll", "fires": [ "Phaser.Sound.Events#event:PAUSE_ALL" ], "since": "3.0.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#pauseAll", "scope": "instance", "___id": "T000002R037493", "___s": true }, { "comment": "/**\r\n * Resumes all the sounds in the game.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#resumeAll\r\n * @fires Phaser.Sound.Events#RESUME_ALL\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Resumes all the sounds in the game.", "kind": "function", "name": "resumeAll", "fires": [ "Phaser.Sound.Events#event:RESUME_ALL" ], "since": "3.0.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#resumeAll", "scope": "instance", "___id": "T000002R037495", "___s": true }, { "comment": "/**\r\n * Sets the X and Y position of the Spatial Audio listener on this Web Audios context.\r\n *\r\n * If you call this method with no parameters it will default to the center-point of\r\n * the game canvas. Depending on the type of game you're making, you may need to call\r\n * this method constantly to reset the listener position as the camera scrolls.\r\n *\r\n * Calling this method does nothing on HTML5Audio.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#setListenerPosition\r\n * @since 3.60.0\r\n *\r\n * @param {number} [x] - The x position of the Spatial Audio listener.\r\n * @param {number} [y] - The y position of the Spatial Audio listener.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 480, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Sets the X and Y position of the Spatial Audio listener on this Web Audios context.\r\rIf you call this method with no parameters it will default to the center-point of\rthe game canvas. Depending on the type of game you're making, you may need to call\rthis method constantly to reset the listener position as the camera scrolls.\r\rCalling this method does nothing on HTML5Audio.", "kind": "function", "name": "setListenerPosition", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The x position of the Spatial Audio listener.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y position of the Spatial Audio listener.", "name": "y" } ], "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#setListenerPosition", "scope": "instance", "___id": "T000002R037497", "___s": true }, { "comment": "/**\r\n * Stops all the sounds in the game.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#stopAll\r\n * @fires Phaser.Sound.Events#STOP_ALL\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 497, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Stops all the sounds in the game.", "kind": "function", "name": "stopAll", "fires": [ "Phaser.Sound.Events#event:STOP_ALL" ], "since": "3.0.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#stopAll", "scope": "instance", "___id": "T000002R037499", "___s": true }, { "comment": "/**\r\n * Stops any sounds matching the given key.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#stopByKey\r\n * @since 3.23.0\r\n *\r\n * @param {string} key - Sound asset key.\r\n *\r\n * @return {number} - How many sounds were stopped.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 514, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Stops any sounds matching the given key.", "kind": "function", "name": "stopByKey", "since": "3.23.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Sound asset key.", "name": "key" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "- How many sounds were stopped." } ], "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#stopByKey", "scope": "instance", "___id": "T000002R037501", "___s": true }, { "comment": "/**\r\n * Method used internally for unlocking audio playback on devices that\r\n * require user interaction before any sound can be played on a web page.\r\n *\r\n * Read more about how this issue is handled here in [this article](https://medium.com/@pgoloskokovic/unlocking-web-audio-the-smarter-way-8858218c0e09).\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#unlock\r\n * @override\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 536, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Method used internally for unlocking audio playback on devices that\rrequire user interaction before any sound can be played on a web page.\r\rRead more about how this issue is handled here in [this article](https://medium.com/@pgoloskokovic/unlocking-web-audio-the-smarter-way-8858218c0e09).", "kind": "function", "name": "unlock", "override": true, "access": "protected", "since": "3.0.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#unlock", "scope": "instance", "___id": "T000002R037504", "___s": true }, { "comment": "/**\r\n * Method used internally for pausing sound manager if\r\n * Phaser.Sound.BaseSoundManager#pauseOnBlur is set to true.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#onBlur\r\n * @override\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Method used internally for pausing sound manager if\rPhaser.Sound.BaseSoundManager#pauseOnBlur is set to true.", "kind": "function", "name": "onBlur", "override": true, "access": "protected", "since": "3.0.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#onBlur", "scope": "instance", "___id": "T000002R037506", "___s": true }, { "comment": "/**\r\n * Method used internally for resuming sound manager if\r\n * Phaser.Sound.BaseSoundManager#pauseOnBlur is set to true.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#onFocus\r\n * @override\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 560, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Method used internally for resuming sound manager if\rPhaser.Sound.BaseSoundManager#pauseOnBlur is set to true.", "kind": "function", "name": "onFocus", "override": true, "access": "protected", "since": "3.0.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#onFocus", "scope": "instance", "___id": "T000002R037508", "___s": true }, { "comment": "/**\r\n * Update method called on every game step.\r\n * Removes destroyed sounds and updates every active sound in the game.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#update\r\n * @protected\r\n * @fires Phaser.Sound.Events#UNLOCKED\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 elapsed since the last frame.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 605, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Update method called on every game step.\rRemoves destroyed sounds and updates every active sound in the game.", "kind": "function", "name": "update", "access": "protected", "fires": [ "Phaser.Sound.Events#event:UNLOCKED" ], "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 elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#update", "scope": "instance", "___id": "T000002R037516", "___s": true }, { "comment": "/**\r\n * Destroys all the sounds in the game and all associated events.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 641, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Destroys all the sounds in the game and all associated events.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#destroy", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#destroy", "___id": "T000002R037521", "___s": true }, { "comment": "/**\r\n * Sets the global playback rate at which all the sounds will be played.\r\n *\r\n * For example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\r\n * and 2.0 doubles the audios playback speed.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#setRate\r\n * @fires Phaser.Sound.Events#GLOBAL_RATE\r\n * @since 3.3.0\r\n *\r\n * @param {number} value - Global playback rate at which all the sounds will be played.\r\n *\r\n * @return {this} This Sound Manager.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 686, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Sets the global playback rate at which all the sounds will be played.\r\rFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\rand 2.0 doubles the audios playback speed.", "kind": "function", "name": "setRate", "fires": [ "Phaser.Sound.Events#event:GLOBAL_RATE" ], "since": "3.3.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Global playback rate at which all the sounds will be played.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound Manager." } ], "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#setRate", "scope": "instance", "___id": "T000002R037530", "___s": true }, { "comment": "/**\r\n * Global playback rate at which all the sounds will be played.\r\n * Value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\r\n * and 2.0 doubles the audio's playback speed.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#rate\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 707, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Global playback rate at which all the sounds will be played.\rValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\rand 2.0 doubles the audio's playback speed.", "name": "rate", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#rate", "scope": "instance", "kind": "member", "___id": "T000002R037533", "___s": true }, { "comment": "/**\r\n * Sets the global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\r\n * The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#setDetune\r\n * @fires Phaser.Sound.Events#GLOBAL_DETUNE\r\n * @since 3.3.0\r\n *\r\n * @param {number} value - The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @return {this} This Sound Manager.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 738, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Sets the global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\rThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "kind": "function", "name": "setDetune", "fires": [ "Phaser.Sound.Events#event:GLOBAL_DETUNE" ], "since": "3.3.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound Manager." } ], "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#setDetune", "scope": "instance", "___id": "T000002R037538", "___s": true }, { "comment": "/**\r\n * Global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\r\n * The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#detune\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 757, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\rThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "name": "detune", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Sound.BaseSoundManager", "longname": "Phaser.Sound.BaseSoundManager#detune", "scope": "instance", "kind": "member", "___id": "T000002R037541", "___s": true }, { "comment": "/**\r\n * The Sound Complete Event.\r\n *\r\n * This event is dispatched by both Web Audio and HTML5 Audio Sound objects when they complete playback.\r\n *\r\n * Listen to it from a Sound instance using `Sound.on('complete', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var music = this.sound.add('key');\r\n * music.on('complete', listener);\r\n * music.play();\r\n * ```\r\n *\r\n * @event Phaser.Sound.Events#COMPLETE\r\n * @type {string}\r\n * @since 3.16.1\r\n *\r\n * @param {(Phaser.Sound.WebAudioSound|Phaser.Sound.HTML5AudioSound)} sound - A reference to the Sound that emitted the event.\r\n */", "meta": { "filename": "COMPLETE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Complete Event.\r\rThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they complete playback.\r\rListen to it from a Sound instance using `Sound.on('complete', listener)`, i.e.:\r\r```javascript\rvar music = this.sound.add('key');\rmusic.on('complete', listener);\rmusic.play();\r```", "kind": "event", "name": "COMPLETE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.1", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSound", "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } ] } }, "description": "A reference to the Sound that emitted the event.", "name": "sound" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:COMPLETE", "scope": "instance", "___id": "T000002R037547", "___s": true }, { "comment": "/**\r\n * The Audio Data Decoded All Event.\r\n *\r\n * This event is dispatched by the Web Audio Sound Manager as a result of calling the `decodeAudio` method,\r\n * once all files passed to the method have been decoded (or errored).\r\n *\r\n * Use `Phaser.Sound.Events#DECODED` to listen for single sounds being decoded, and `DECODED_ALL` to\r\n * listen for them all completing.\r\n *\r\n * Listen to it from the Sound Manager in a Scene using `this.sound.on('decodedall', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * this.sound.once('decodedall', handler);\r\n * this.sound.decodeAudio([ audioFiles ]);\r\n * ```\r\n *\r\n * @event Phaser.Sound.Events#DECODED_ALL\r\n * @type {string}\r\n * @since 3.18.0\r\n */", "meta": { "filename": "DECODED_ALL_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Audio Data Decoded All Event.\r\rThis event is dispatched by the Web Audio Sound Manager as a result of calling the `decodeAudio` method,\ronce all files passed to the method have been decoded (or errored).\r\rUse `Phaser.Sound.Events#DECODED` to listen for single sounds being decoded, and `DECODED_ALL` to\rlisten for them all completing.\r\rListen to it from the Sound Manager in a Scene using `this.sound.on('decodedall', listener)`, i.e.:\r\r```javascript\rthis.sound.once('decodedall', handler);\rthis.sound.decodeAudio([ audioFiles ]);\r```", "kind": "event", "name": "DECODED_ALL", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.18.0", "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:DECODED_ALL", "scope": "instance", "___id": "T000002R037549", "___s": true }, { "comment": "/**\r\n * The Audio Data Decoded Event.\r\n *\r\n * This event is dispatched by the Web Audio Sound Manager as a result of calling the `decodeAudio` method.\r\n *\r\n * Listen to it from the Sound Manager in a Scene using `this.sound.on('decoded', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * this.sound.on('decoded', handler);\r\n * this.sound.decodeAudio(key, audioData);\r\n * ```\r\n *\r\n * @event Phaser.Sound.Events#DECODED\r\n * @type {string}\r\n * @since 3.18.0\r\n *\r\n * @param {string} key - The key of the audio file that was decoded and added to the audio cache.\r\n */", "meta": { "filename": "DECODED_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Audio Data Decoded Event.\r\rThis event is dispatched by the Web Audio Sound Manager as a result of calling the `decodeAudio` method.\r\rListen to it from the Sound Manager in a Scene using `this.sound.on('decoded', listener)`, i.e.:\r\r```javascript\rthis.sound.on('decoded', handler);\rthis.sound.decodeAudio(key, audioData);\r```", "kind": "event", "name": "DECODED", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.18.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the audio file that was decoded and added to the audio cache.", "name": "key" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:DECODED", "scope": "instance", "___id": "T000002R037551", "___s": true }, { "comment": "/**\r\n * The Sound Destroy Event.\r\n *\r\n * This event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are destroyed, either\r\n * directly or via a Sound Manager.\r\n *\r\n * Listen to it from a Sound instance using `Sound.on('destroy', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var music = this.sound.add('key');\r\n * music.on('destroy', listener);\r\n * music.destroy();\r\n * ```\r\n *\r\n * @event Phaser.Sound.Events#DESTROY\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Sound.WebAudioSound|Phaser.Sound.HTML5AudioSound)} sound - A reference to the Sound that emitted the event.\r\n */", "meta": { "filename": "DESTROY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Destroy Event.\r\rThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are destroyed, either\rdirectly or via a Sound Manager.\r\rListen to it from a Sound instance using `Sound.on('destroy', listener)`, i.e.:\r\r```javascript\rvar music = this.sound.add('key');\rmusic.on('destroy', listener);\rmusic.destroy();\r```", "kind": "event", "name": "DESTROY", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSound", "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } ] } }, "description": "A reference to the Sound that emitted the event.", "name": "sound" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:DESTROY", "scope": "instance", "___id": "T000002R037553", "___s": true }, { "comment": "/**\r\n * The Sound Detune Event.\r\n *\r\n * This event is dispatched by both Web Audio and HTML5 Audio Sound objects when their detune value changes.\r\n *\r\n * Listen to it from a Sound instance using `Sound.on('detune', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var music = this.sound.add('key');\r\n * music.on('detune', listener);\r\n * music.play();\r\n * music.setDetune(200);\r\n * ```\r\n *\r\n * @event Phaser.Sound.Events#DETUNE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Sound.WebAudioSound|Phaser.Sound.HTML5AudioSound)} sound - A reference to the Sound that emitted the event.\r\n * @param {number} detune - The new detune value of the Sound.\r\n */", "meta": { "filename": "DETUNE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Detune Event.\r\rThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when their detune value changes.\r\rListen to it from a Sound instance using `Sound.on('detune', listener)`, i.e.:\r\r```javascript\rvar music = this.sound.add('key');\rmusic.on('detune', listener);\rmusic.play();\rmusic.setDetune(200);\r```", "kind": "event", "name": "DETUNE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSound", "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } ] } }, "description": "A reference to the Sound that emitted the event.", "name": "sound" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new detune value of the Sound.", "name": "detune" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:DETUNE", "scope": "instance", "___id": "T000002R037555", "___s": true }, { "comment": "/**\r\n * The Sound Manager Global Detune Event.\r\n *\r\n * This event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\r\n * or the HTML5 Audio Manager. It is dispatched when the `detune` property of the Sound Manager is changed, which globally\r\n * adjusts the detuning of all active sounds.\r\n *\r\n * Listen to it from a Scene using: `this.sound.on('rate', listener)`.\r\n *\r\n * @event Phaser.Sound.Events#GLOBAL_DETUNE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Sound.BaseSoundManager} soundManager - A reference to the sound manager that emitted the event.\r\n * @param {number} detune - The updated detune value.\r\n */", "meta": { "filename": "GLOBAL_DETUNE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Manager Global Detune Event.\r\rThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\ror the HTML5 Audio Manager. It is dispatched when the `detune` property of the Sound Manager is changed, which globally\radjusts the detuning of all active sounds.\r\rListen to it from a Scene using: `this.sound.on('rate', listener)`.", "kind": "event", "name": "GLOBAL_DETUNE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.BaseSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSoundManager" } }, "description": "A reference to the sound manager that emitted the event.", "name": "soundManager" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The updated detune value.", "name": "detune" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:GLOBAL_DETUNE", "scope": "instance", "___id": "T000002R037557", "___s": true }, { "comment": "/**\r\n * The Sound Manager Global Mute Event.\r\n *\r\n * This event is dispatched by the Sound Manager when its `mute` property is changed, either directly\r\n * or via the `setMute` method. This changes the mute state of all active sounds.\r\n *\r\n * Listen to it from a Scene using: `this.sound.on('mute', listener)`.\r\n *\r\n * @event Phaser.Sound.Events#GLOBAL_MUTE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Sound.WebAudioSoundManager|Phaser.Sound.HTML5AudioSoundManager)} soundManager - A reference to the Sound Manager that emitted the event.\r\n * @param {boolean} mute - The mute value. `true` if the Sound Manager is now muted, otherwise `false`.\r\n */", "meta": { "filename": "GLOBAL_MUTE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Manager Global Mute Event.\r\rThis event is dispatched by the Sound Manager when its `mute` property is changed, either directly\ror via the `setMute` method. This changes the mute state of all active sounds.\r\rListen to it from a Scene using: `this.sound.on('mute', listener)`.", "kind": "event", "name": "GLOBAL_MUTE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSoundManager", "Phaser.Sound.HTML5AudioSoundManager" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSoundManager" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSoundManager" } ] } }, "description": "A reference to the Sound Manager that emitted the event.", "name": "soundManager" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The mute value. `true` if the Sound Manager is now muted, otherwise `false`.", "name": "mute" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:GLOBAL_MUTE", "scope": "instance", "___id": "T000002R037559", "___s": true }, { "comment": "/**\r\n * The Sound Manager Global Rate Event.\r\n *\r\n * This event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\r\n * or the HTML5 Audio Manager. It is dispatched when the `rate` property of the Sound Manager is changed, which globally\r\n * adjusts the playback rate of all active sounds.\r\n *\r\n * Listen to it from a Scene using: `this.sound.on('rate', listener)`.\r\n *\r\n * @event Phaser.Sound.Events#GLOBAL_RATE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Sound.BaseSoundManager} soundManager - A reference to the sound manager that emitted the event.\r\n * @param {number} rate - The updated rate value.\r\n */", "meta": { "filename": "GLOBAL_RATE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Manager Global Rate Event.\r\rThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\ror the HTML5 Audio Manager. It is dispatched when the `rate` property of the Sound Manager is changed, which globally\radjusts the playback rate of all active sounds.\r\rListen to it from a Scene using: `this.sound.on('rate', listener)`.", "kind": "event", "name": "GLOBAL_RATE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.BaseSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSoundManager" } }, "description": "A reference to the sound manager that emitted the event.", "name": "soundManager" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The updated rate value.", "name": "rate" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:GLOBAL_RATE", "scope": "instance", "___id": "T000002R037561", "___s": true }, { "comment": "/**\r\n * The Sound Manager Global Volume Event.\r\n *\r\n * This event is dispatched by the Sound Manager when its `volume` property is changed, either directly\r\n * or via the `setVolume` method. This changes the volume of all active sounds.\r\n *\r\n * Listen to it from a Scene using: `this.sound.on('volume', listener)`.\r\n *\r\n * @event Phaser.Sound.Events#GLOBAL_VOLUME\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Sound.WebAudioSoundManager|Phaser.Sound.HTML5AudioSoundManager)} soundManager - A reference to the sound manager that emitted the event.\r\n * @param {number} volume - The new global volume of the Sound Manager.\r\n */", "meta": { "filename": "GLOBAL_VOLUME_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Manager Global Volume Event.\r\rThis event is dispatched by the Sound Manager when its `volume` property is changed, either directly\ror via the `setVolume` method. This changes the volume of all active sounds.\r\rListen to it from a Scene using: `this.sound.on('volume', listener)`.", "kind": "event", "name": "GLOBAL_VOLUME", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSoundManager", "Phaser.Sound.HTML5AudioSoundManager" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSoundManager" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSoundManager" } ] } }, "description": "A reference to the sound manager that emitted the event.", "name": "soundManager" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new global volume of the Sound Manager.", "name": "volume" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:GLOBAL_VOLUME", "scope": "instance", "___id": "T000002R037563", "___s": true }, { "comment": "/**\n * @namespace Phaser.Sound.Events\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Sound", "longname": "Phaser.Sound.Events", "scope": "static", "___id": "T000002R037565", "___s": true }, { "comment": "/**\r\n * The Sound Looped Event.\r\n *\r\n * This event is dispatched by both Web Audio and HTML5 Audio Sound objects when they loop during playback.\r\n *\r\n * Listen to it from a Sound instance using `Sound.on('looped', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var music = this.sound.add('key');\r\n * music.on('looped', listener);\r\n * music.setLoop(true);\r\n * music.play();\r\n * ```\r\n *\r\n * This is not to be confused with the [LOOP]{@linkcode Phaser.Sound.Events#event:LOOP} event, which only emits when the loop state of a Sound is changed.\r\n *\r\n * @event Phaser.Sound.Events#LOOPED\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Sound.WebAudioSound|Phaser.Sound.HTML5AudioSound)} sound - A reference to the Sound that emitted the event.\r\n */", "meta": { "filename": "LOOPED_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Looped Event.\r\rThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they loop during playback.\r\rListen to it from a Sound instance using `Sound.on('looped', listener)`, i.e.:\r\r```javascript\rvar music = this.sound.add('key');\rmusic.on('looped', listener);\rmusic.setLoop(true);\rmusic.play();\r```\r\rThis is not to be confused with the [LOOP]{@linkcode Phaser.Sound.Events#event:LOOP} event, which only emits when the loop state of a Sound is changed.", "kind": "event", "name": "LOOPED", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSound", "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } ] } }, "description": "A reference to the Sound that emitted the event.", "name": "sound" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:LOOPED", "scope": "instance", "___id": "T000002R037591", "___s": true }, { "comment": "/**\r\n * The Sound Loop Event.\r\n *\r\n * This event is dispatched by both Web Audio and HTML5 Audio Sound objects when their loop state is changed.\r\n *\r\n * Listen to it from a Sound instance using `Sound.on('loop', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var music = this.sound.add('key');\r\n * music.on('loop', listener);\r\n * music.setLoop(true);\r\n * ```\r\n *\r\n * This is not to be confused with the [LOOPED]{@linkcode Phaser.Sound.Events#event:LOOPED} event, which emits each time a Sound loops during playback.\r\n *\r\n * @event Phaser.Sound.Events#LOOP\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Sound.WebAudioSound|Phaser.Sound.HTML5AudioSound)} sound - A reference to the Sound that emitted the event.\r\n * @param {boolean} loop - The new loop value. `true` if the Sound will loop, otherwise `false`.\r\n */", "meta": { "filename": "LOOP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Loop Event.\r\rThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when their loop state is changed.\r\rListen to it from a Sound instance using `Sound.on('loop', listener)`, i.e.:\r\r```javascript\rvar music = this.sound.add('key');\rmusic.on('loop', listener);\rmusic.setLoop(true);\r```\r\rThis is not to be confused with the [LOOPED]{@linkcode Phaser.Sound.Events#event:LOOPED} event, which emits each time a Sound loops during playback.", "kind": "event", "name": "LOOP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSound", "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } ] } }, "description": "A reference to the Sound that emitted the event.", "name": "sound" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new loop value. `true` if the Sound will loop, otherwise `false`.", "name": "loop" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:LOOP", "scope": "instance", "___id": "T000002R037593", "___s": true }, { "comment": "/**\r\n * The Sound Mute Event.\r\n *\r\n * This event is dispatched by both Web Audio and HTML5 Audio Sound objects when their mute state changes.\r\n *\r\n * Listen to it from a Sound instance using `Sound.on('mute', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var music = this.sound.add('key');\r\n * music.on('mute', listener);\r\n * music.play();\r\n * music.setMute(true);\r\n * ```\r\n *\r\n * @event Phaser.Sound.Events#MUTE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Sound.WebAudioSound|Phaser.Sound.HTML5AudioSound)} sound - A reference to the Sound that emitted the event.\r\n * @param {boolean} mute - The mute value. `true` if the Sound is now muted, otherwise `false`.\r\n */", "meta": { "filename": "MUTE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Mute Event.\r\rThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when their mute state changes.\r\rListen to it from a Sound instance using `Sound.on('mute', listener)`, i.e.:\r\r```javascript\rvar music = this.sound.add('key');\rmusic.on('mute', listener);\rmusic.play();\rmusic.setMute(true);\r```", "kind": "event", "name": "MUTE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSound", "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } ] } }, "description": "A reference to the Sound that emitted the event.", "name": "sound" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The mute value. `true` if the Sound is now muted, otherwise `false`.", "name": "mute" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:MUTE", "scope": "instance", "___id": "T000002R037595", "___s": true }, { "comment": "/**\r\n * The Sound Pan Event.\r\n *\r\n * This event is dispatched by both Web Audio and HTML5 Audio Sound objects when their pan changes.\r\n *\r\n * Listen to it from a Sound instance using `Sound.on('pan', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var sound = this.sound.add('key');\r\n * sound.on('pan', listener);\r\n * sound.play();\r\n * sound.setPan(0.5);\r\n * ```\r\n *\r\n * @event Phaser.Sound.Events#PAN\r\n * @type {string}\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.Sound.WebAudioSound|Phaser.Sound.HTML5AudioSound)} sound - A reference to the Sound that emitted the event.\r\n * @param {number} pan - The new pan of the Sound.\r\n */", "meta": { "filename": "PAN_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Pan Event.\r\rThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when their pan changes.\r\rListen to it from a Sound instance using `Sound.on('pan', listener)`, i.e.:\r\r```javascript\rvar sound = this.sound.add('key');\rsound.on('pan', listener);\rsound.play();\rsound.setPan(0.5);\r```", "kind": "event", "name": "PAN", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSound", "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } ] } }, "description": "A reference to the Sound that emitted the event.", "name": "sound" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new pan of the Sound.", "name": "pan" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:PAN", "scope": "instance", "___id": "T000002R037597", "___s": true }, { "comment": "/**\r\n * The Pause All Sounds Event.\r\n *\r\n * This event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\r\n * or the HTML5 Audio Manager. It is dispatched when the `pauseAll` method is invoked and after all current Sounds\r\n * have been paused.\r\n *\r\n * Listen to it from a Scene using: `this.sound.on('pauseall', listener)`.\r\n *\r\n * @event Phaser.Sound.Events#PAUSE_ALL\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Sound.BaseSoundManager} soundManager - A reference to the sound manager that emitted the event.\r\n */", "meta": { "filename": "PAUSE_ALL_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Pause All Sounds Event.\r\rThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\ror the HTML5 Audio Manager. It is dispatched when the `pauseAll` method is invoked and after all current Sounds\rhave been paused.\r\rListen to it from a Scene using: `this.sound.on('pauseall', listener)`.", "kind": "event", "name": "PAUSE_ALL", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.BaseSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSoundManager" } }, "description": "A reference to the sound manager that emitted the event.", "name": "soundManager" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:PAUSE_ALL", "scope": "instance", "___id": "T000002R037599", "___s": true }, { "comment": "/**\r\n * The Sound Pause Event.\r\n *\r\n * This event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are paused.\r\n *\r\n * Listen to it from a Sound instance using `Sound.on('pause', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var music = this.sound.add('key');\r\n * music.on('pause', listener);\r\n * music.play();\r\n * music.pause();\r\n * ```\r\n *\r\n * @event Phaser.Sound.Events#PAUSE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Sound.WebAudioSound|Phaser.Sound.HTML5AudioSound)} sound - A reference to the Sound that emitted the event.\r\n */", "meta": { "filename": "PAUSE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Pause Event.\r\rThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are paused.\r\rListen to it from a Sound instance using `Sound.on('pause', listener)`, i.e.:\r\r```javascript\rvar music = this.sound.add('key');\rmusic.on('pause', listener);\rmusic.play();\rmusic.pause();\r```", "kind": "event", "name": "PAUSE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSound", "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } ] } }, "description": "A reference to the Sound that emitted the event.", "name": "sound" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:PAUSE", "scope": "instance", "___id": "T000002R037601", "___s": true }, { "comment": "/**\r\n * The Sound Play Event.\r\n *\r\n * This event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are played.\r\n *\r\n * Listen to it from a Sound instance using `Sound.on('play', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var music = this.sound.add('key');\r\n * music.on('play', listener);\r\n * music.play();\r\n * ```\r\n *\r\n * @event Phaser.Sound.Events#PLAY\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Sound.WebAudioSound|Phaser.Sound.HTML5AudioSound)} sound - A reference to the Sound that emitted the event.\r\n */", "meta": { "filename": "PLAY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Play Event.\r\rThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are played.\r\rListen to it from a Sound instance using `Sound.on('play', listener)`, i.e.:\r\r```javascript\rvar music = this.sound.add('key');\rmusic.on('play', listener);\rmusic.play();\r```", "kind": "event", "name": "PLAY", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSound", "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } ] } }, "description": "A reference to the Sound that emitted the event.", "name": "sound" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:PLAY", "scope": "instance", "___id": "T000002R037603", "___s": true }, { "comment": "/**\r\n * The Sound Rate Change Event.\r\n *\r\n * This event is dispatched by both Web Audio and HTML5 Audio Sound objects when their rate changes.\r\n *\r\n * Listen to it from a Sound instance using `Sound.on('rate', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var music = this.sound.add('key');\r\n * music.on('rate', listener);\r\n * music.play();\r\n * music.setRate(0.5);\r\n * ```\r\n *\r\n * @event Phaser.Sound.Events#RATE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Sound.WebAudioSound|Phaser.Sound.HTML5AudioSound)} sound - A reference to the Sound that emitted the event.\r\n * @param {number} rate - The new rate of the Sound.\r\n */", "meta": { "filename": "RATE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Rate Change Event.\r\rThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when their rate changes.\r\rListen to it from a Sound instance using `Sound.on('rate', listener)`, i.e.:\r\r```javascript\rvar music = this.sound.add('key');\rmusic.on('rate', listener);\rmusic.play();\rmusic.setRate(0.5);\r```", "kind": "event", "name": "RATE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSound", "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } ] } }, "description": "A reference to the Sound that emitted the event.", "name": "sound" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new rate of the Sound.", "name": "rate" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:RATE", "scope": "instance", "___id": "T000002R037605", "___s": true }, { "comment": "/**\r\n * The Resume All Sounds Event.\r\n *\r\n * This event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\r\n * or the HTML5 Audio Manager. It is dispatched when the `resumeAll` method is invoked and after all current Sounds\r\n * have been resumed.\r\n *\r\n * Listen to it from a Scene using: `this.sound.on('resumeall', listener)`.\r\n *\r\n * @event Phaser.Sound.Events#RESUME_ALL\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Sound.BaseSoundManager} soundManager - A reference to the sound manager that emitted the event.\r\n */", "meta": { "filename": "RESUME_ALL_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Resume All Sounds Event.\r\rThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\ror the HTML5 Audio Manager. It is dispatched when the `resumeAll` method is invoked and after all current Sounds\rhave been resumed.\r\rListen to it from a Scene using: `this.sound.on('resumeall', listener)`.", "kind": "event", "name": "RESUME_ALL", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.BaseSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSoundManager" } }, "description": "A reference to the sound manager that emitted the event.", "name": "soundManager" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:RESUME_ALL", "scope": "instance", "___id": "T000002R037607", "___s": true }, { "comment": "/**\r\n * The Sound Resume Event.\r\n *\r\n * This event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are resumed from a paused state.\r\n *\r\n * Listen to it from a Sound instance using `Sound.on('resume', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var music = this.sound.add('key');\r\n * music.on('resume', listener);\r\n * music.play();\r\n * music.pause();\r\n * music.resume();\r\n * ```\r\n *\r\n * @event Phaser.Sound.Events#RESUME\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Sound.WebAudioSound|Phaser.Sound.HTML5AudioSound)} sound - A reference to the Sound that emitted the event.\r\n */", "meta": { "filename": "RESUME_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Resume Event.\r\rThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are resumed from a paused state.\r\rListen to it from a Sound instance using `Sound.on('resume', listener)`, i.e.:\r\r```javascript\rvar music = this.sound.add('key');\rmusic.on('resume', listener);\rmusic.play();\rmusic.pause();\rmusic.resume();\r```", "kind": "event", "name": "RESUME", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSound", "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } ] } }, "description": "A reference to the Sound that emitted the event.", "name": "sound" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:RESUME", "scope": "instance", "___id": "T000002R037609", "___s": true }, { "comment": "/**\r\n * The Sound Seek Event.\r\n *\r\n * This event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are seeked to a new position.\r\n *\r\n * Listen to it from a Sound instance using `Sound.on('seek', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var music = this.sound.add('key');\r\n * music.on('seek', listener);\r\n * music.play();\r\n * music.setSeek(5000);\r\n * ```\r\n *\r\n * @event Phaser.Sound.Events#SEEK\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Sound.WebAudioSound|Phaser.Sound.HTML5AudioSound)} sound - A reference to the Sound that emitted the event.\r\n * @param {number} detune - The new detune value of the Sound.\r\n */", "meta": { "filename": "SEEK_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Seek Event.\r\rThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are seeked to a new position.\r\rListen to it from a Sound instance using `Sound.on('seek', listener)`, i.e.:\r\r```javascript\rvar music = this.sound.add('key');\rmusic.on('seek', listener);\rmusic.play();\rmusic.setSeek(5000);\r```", "kind": "event", "name": "SEEK", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSound", "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } ] } }, "description": "A reference to the Sound that emitted the event.", "name": "sound" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new detune value of the Sound.", "name": "detune" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:SEEK", "scope": "instance", "___id": "T000002R037611", "___s": true }, { "comment": "/**\r\n * The Stop All Sounds Event.\r\n *\r\n * This event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\r\n * or the HTML5 Audio Manager. It is dispatched when the `stopAll` method is invoked and after all current Sounds\r\n * have been stopped.\r\n *\r\n * Listen to it from a Scene using: `this.sound.on('stopall', listener)`.\r\n *\r\n * @event Phaser.Sound.Events#STOP_ALL\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Sound.BaseSoundManager} soundManager - A reference to the sound manager that emitted the event.\r\n */", "meta": { "filename": "STOP_ALL_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Stop All Sounds Event.\r\rThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\ror the HTML5 Audio Manager. It is dispatched when the `stopAll` method is invoked and after all current Sounds\rhave been stopped.\r\rListen to it from a Scene using: `this.sound.on('stopall', listener)`.", "kind": "event", "name": "STOP_ALL", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.BaseSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSoundManager" } }, "description": "A reference to the sound manager that emitted the event.", "name": "soundManager" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:STOP_ALL", "scope": "instance", "___id": "T000002R037613", "___s": true }, { "comment": "/**\r\n * The Sound Stop Event.\r\n *\r\n * This event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are stopped.\r\n *\r\n * Listen to it from a Sound instance using `Sound.on('stop', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var music = this.sound.add('key');\r\n * music.on('stop', listener);\r\n * music.play();\r\n * music.stop();\r\n * ```\r\n *\r\n * @event Phaser.Sound.Events#STOP\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Sound.WebAudioSound|Phaser.Sound.HTML5AudioSound)} sound - A reference to the Sound that emitted the event.\r\n */", "meta": { "filename": "STOP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Stop Event.\r\rThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are stopped.\r\rListen to it from a Sound instance using `Sound.on('stop', listener)`, i.e.:\r\r```javascript\rvar music = this.sound.add('key');\rmusic.on('stop', listener);\rmusic.play();\rmusic.stop();\r```", "kind": "event", "name": "STOP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSound", "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } ] } }, "description": "A reference to the Sound that emitted the event.", "name": "sound" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:STOP", "scope": "instance", "___id": "T000002R037615", "___s": true }, { "comment": "/**\r\n * The Sound Manager Unlocked Event.\r\n *\r\n * This event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\r\n * or the HTML5 Audio Manager. It is dispatched during the update loop when the Sound Manager becomes unlocked. For\r\n * Web Audio this is on the first user gesture on the page.\r\n *\r\n * Listen to it from a Scene using: `this.sound.on('unlocked', listener)`.\r\n *\r\n * @event Phaser.Sound.Events#UNLOCKED\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Sound.BaseSoundManager} soundManager - A reference to the sound manager that emitted the event.\r\n */", "meta": { "filename": "UNLOCKED_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Manager Unlocked Event.\r\rThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\ror the HTML5 Audio Manager. It is dispatched during the update loop when the Sound Manager becomes unlocked. For\rWeb Audio this is on the first user gesture on the page.\r\rListen to it from a Scene using: `this.sound.on('unlocked', listener)`.", "kind": "event", "name": "UNLOCKED", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.BaseSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSoundManager" } }, "description": "A reference to the sound manager that emitted the event.", "name": "soundManager" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:UNLOCKED", "scope": "instance", "___id": "T000002R037617", "___s": true }, { "comment": "/**\r\n * The Sound Volume Event.\r\n *\r\n * This event is dispatched by both Web Audio and HTML5 Audio Sound objects when their volume changes.\r\n *\r\n * Listen to it from a Sound instance using `Sound.on('volume', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var music = this.sound.add('key');\r\n * music.on('volume', listener);\r\n * music.play();\r\n * music.setVolume(0.5);\r\n * ```\r\n *\r\n * @event Phaser.Sound.Events#VOLUME\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Sound.WebAudioSound|Phaser.Sound.HTML5AudioSound)} sound - A reference to the Sound that emitted the event.\r\n * @param {number} volume - The new volume of the Sound.\r\n */", "meta": { "filename": "VOLUME_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\events", "code": {} }, "description": "The Sound Volume Event.\r\rThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when their volume changes.\r\rListen to it from a Sound instance using `Sound.on('volume', listener)`, i.e.:\r\r```javascript\rvar music = this.sound.add('key');\rmusic.on('volume', listener);\rmusic.play();\rmusic.setVolume(0.5);\r```", "kind": "event", "name": "VOLUME", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSound", "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } ] } }, "description": "A reference to the Sound that emitted the event.", "name": "sound" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new volume of the Sound.", "name": "volume" } ], "memberof": "Phaser.Sound.Events", "longname": "Phaser.Sound.Events#event:VOLUME", "scope": "instance", "___id": "T000002R037619", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * HTML5 Audio implementation of the sound.\r\n *\r\n * @class HTML5AudioSound\r\n * @extends Phaser.Sound.BaseSound\r\n * @memberof Phaser.Sound\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Sound.HTML5AudioSoundManager} manager - Reference to the current sound manager instance.\r\n * @param {string} key - Asset key for the sound.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config={}] - An optional config object containing default sound settings.\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "classdesc": "HTML5 Audio implementation of the sound.", "kind": "class", "name": "HTML5AudioSound", "augments": [ "Phaser.Sound.BaseSound" ], "memberof": "Phaser.Sound", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.HTML5AudioSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSoundManager" } }, "description": "Reference to the current sound manager instance.", "name": "manager" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "defaultvalue": "{}", "description": "An optional config object containing default sound settings.", "name": "config" } ], "scope": "static", "longname": "Phaser.Sound.HTML5AudioSound", "___id": "T000002R037625", "___s": true }, { "comment": "/**\r\n * An array containing all HTML5 Audio tags that could be used for individual\r\n * sound playback. Number of instances depends on the config value passed\r\n * to the `Loader#audio` method call, default is 1.\r\n *\r\n * @name Phaser.Sound.HTML5AudioSound#tags\r\n * @type {HTMLAudioElement[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 37, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "An array containing all HTML5 Audio tags that could be used for individual\rsound playback. Number of instances depends on the config value passed\rto the `Loader#audio` method call, default is 1.", "name": "tags", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLAudioElement", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#tags", "scope": "instance", "kind": "member", "___id": "T000002R037630", "___s": true }, { "comment": "/**\r\n * Reference to an HTML5 Audio tag used for playing sound.\r\n *\r\n * @name Phaser.Sound.HTML5AudioSound#audio\r\n * @type {HTMLAudioElement}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Reference to an HTML5 Audio tag used for playing sound.", "name": "audio", "type": { "names": [ "HTMLAudioElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLAudioElement" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#audio", "scope": "instance", "kind": "member", "___id": "T000002R037632", "___s": true }, { "comment": "/**\r\n * Timestamp as generated by the Request Animation Frame or SetTimeout\r\n * representing the time at which the delayed sound playback should start.\r\n * Set to 0 if sound playback is not delayed.\r\n *\r\n * @name Phaser.Sound.HTML5AudioSound#startTime\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Timestamp as generated by the Request Animation Frame or SetTimeout\rrepresenting the time at which the delayed sound playback should start.\rSet to 0 if sound playback is not delayed.", "name": "startTime", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#startTime", "scope": "instance", "kind": "member", "___id": "T000002R037634", "___s": true }, { "comment": "/**\r\n * Audio tag's playback position recorded on previous\r\n * update method call. Set to 0 if sound is not playing.\r\n *\r\n * @name Phaser.Sound.HTML5AudioSound#previousTime\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Audio tag's playback position recorded on previous\rupdate method call. Set to 0 if sound is not playing.", "name": "previousTime", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#previousTime", "scope": "instance", "kind": "member", "___id": "T000002R037636", "___s": true }, { "comment": "/**\r\n * Play this sound, or a marked section of it.\r\n *\r\n * It always plays the sound from the start. If you want to start playback from a specific time\r\n * you can set 'seek' setting of the config object, provided to this call, to that value.\r\n *\r\n * If you want to play the same sound simultaneously, then you need to create another instance\r\n * of it and play that Sound. For HTML5 Audio this also requires creating multiple audio instances\r\n * when loading the audio files.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#play\r\n * @fires Phaser.Sound.Events#PLAY\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Sound.SoundConfig)} [markerName=''] - If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config] - Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.\r\n *\r\n * @return {boolean} Whether the sound started playing successfully.\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 93, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Play this sound, or a marked section of it.\r\rIt always plays the sound from the start. If you want to start playback from a specific time\ryou can set 'seek' setting of the config object, provided to this call, to that value.\r\rIf you want to play the same sound simultaneously, then you need to create another instance\rof it and play that Sound. For HTML5 Audio this also requires creating multiple audio instances\rwhen loading the audio files.", "kind": "function", "name": "play", "fires": [ "Phaser.Sound.Events#event:PLAY" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } ] } }, "optional": true, "defaultvalue": "''", "description": "If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.", "name": "markerName" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.", "name": "config" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound started playing successfully." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#play", "scope": "instance", "overrides": "Phaser.Sound.BaseSound#play", "___id": "T000002R037640", "___s": true }, { "comment": "/**\r\n * Pauses the sound.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#pause\r\n * @fires Phaser.Sound.Events#PAUSE\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} Whether the sound was paused successfully.\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 135, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Pauses the sound.", "kind": "function", "name": "pause", "fires": [ "Phaser.Sound.Events#event:PAUSE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound was paused successfully." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#pause", "scope": "instance", "overrides": "Phaser.Sound.BaseSound#pause", "___id": "T000002R037642", "___s": true }, { "comment": "/**\r\n * Resumes the sound.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#resume\r\n * @fires Phaser.Sound.Events#RESUME\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} Whether the sound was resumed successfully.\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 171, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Resumes the sound.", "kind": "function", "name": "resume", "fires": [ "Phaser.Sound.Events#event:RESUME" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound was resumed successfully." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#resume", "scope": "instance", "overrides": "Phaser.Sound.BaseSound#resume", "___id": "T000002R037645", "___s": true }, { "comment": "/**\r\n * Stop playing this sound.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#stop\r\n * @fires Phaser.Sound.Events#STOP\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} Whether the sound was stopped successfully.\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 208, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Stop playing this sound.", "kind": "function", "name": "stop", "fires": [ "Phaser.Sound.Events#event:STOP" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound was stopped successfully." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#stop", "scope": "instance", "overrides": "Phaser.Sound.BaseSound#stop", "___id": "T000002R037647", "___s": true }, { "comment": "/**\r\n * This method is used internally to pick and play the next available audio tag.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#pickAndPlayAudioTag\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} Whether the sound was assigned an audio tag successfully.\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "This method is used internally to pick and play the next available audio tag.", "kind": "function", "name": "pickAndPlayAudioTag", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound was assigned an audio tag successfully." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#pickAndPlayAudioTag", "scope": "instance", "___id": "T000002R037649", "___s": true }, { "comment": "/**\r\n * This method performs the audio tag pooling logic. It first looks for\r\n * unused audio tag to assign to this sound object. If there are no unused\r\n * audio tags, based on HTML5AudioSoundManager#override property value, it\r\n * looks for sound with most advanced playback and hijacks its audio tag or\r\n * does nothing.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#pickAudioTag\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} Whether the sound was assigned an audio tag successfully.\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 286, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "This method performs the audio tag pooling logic. It first looks for\runused audio tag to assign to this sound object. If there are no unused\raudio tags, based on HTML5AudioSoundManager#override property value, it\rlooks for sound with most advanced playback and hijacks its audio tag or\rdoes nothing.", "kind": "function", "name": "pickAudioTag", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound was assigned an audio tag successfully." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#pickAudioTag", "scope": "instance", "___id": "T000002R037658", "___s": true }, { "comment": "/**\r\n * Method used for playing audio tag and catching possible exceptions\r\n * thrown from rejected Promise returned from play method call.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#playCatchPromise\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 354, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Method used for playing audio tag and catching possible exceptions\rthrown from rejected Promise returned from play method call.", "kind": "function", "name": "playCatchPromise", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#playCatchPromise", "scope": "instance", "___id": "T000002R037670", "___s": true }, { "comment": "/**\r\n * This method is used internally to stop and release the current audio tag.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#stopAndReleaseAudioTag\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 375, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "This method is used internally to stop and release the current audio tag.", "kind": "function", "name": "stopAndReleaseAudioTag", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#stopAndReleaseAudioTag", "scope": "instance", "___id": "T000002R037673", "___s": true }, { "comment": "/**\r\n * Method used internally to reset sound state, usually when stopping sound\r\n * or when hijacking audio tag from another sound.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#reset\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Method used internally to reset sound state, usually when stopping sound\ror when hijacking audio tag from another sound.", "kind": "function", "name": "reset", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#reset", "scope": "instance", "___id": "T000002R037679", "___s": true }, { "comment": "/**\r\n * Method used internally by sound manager for pausing sound if\r\n * Phaser.Sound.HTML5AudioSoundManager#pauseOnBlur is set to true.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#onBlur\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 406, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Method used internally by sound manager for pausing sound if\rPhaser.Sound.HTML5AudioSoundManager#pauseOnBlur is set to true.", "kind": "function", "name": "onBlur", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#onBlur", "scope": "instance", "___id": "T000002R037681", "___s": true }, { "comment": "/**\r\n * Method used internally by sound manager for resuming sound if\r\n * Phaser.Sound.HTML5AudioSoundManager#pauseOnBlur is set to true.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#onFocus\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 425, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Method used internally by sound manager for resuming sound if\rPhaser.Sound.HTML5AudioSoundManager#pauseOnBlur is set to true.", "kind": "function", "name": "onFocus", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#onFocus", "scope": "instance", "___id": "T000002R037687", "___s": true }, { "comment": "/**\r\n * Update method called automatically by sound manager on every game step.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#update\r\n * @fires Phaser.Sound.Events#COMPLETE\r\n * @fires Phaser.Sound.Events#LOOPED\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 */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 439, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Update method called automatically by sound manager on every game step.", "kind": "function", "name": "update", "fires": [ "Phaser.Sound.Events#event:COMPLETE", "Phaser.Sound.Events#event:LOOPED" ], "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" } ], "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#update", "scope": "instance", "overrides": "Phaser.Sound.BaseSound#update", "___id": "T000002R037691", "___s": true }, { "comment": "/**\r\n * Calls Phaser.Sound.BaseSound#destroy method\r\n * and cleans up all HTML5 Audio related stuff.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 507, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Calls Phaser.Sound.BaseSound#destroy method\rand cleans up all HTML5 Audio related stuff.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#destroy", "scope": "instance", "overrides": "Phaser.Sound.BaseSound#destroy", "___id": "T000002R037704", "___s": true }, { "comment": "/**\r\n * This method is used internally to update the mute setting of this sound.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#updateMute\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 526, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "This method is used internally to update the mute setting of this sound.", "kind": "function", "name": "updateMute", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#updateMute", "scope": "instance", "___id": "T000002R037707", "___s": true }, { "comment": "/**\r\n * This method is used internally to update the volume of this sound.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#updateVolume\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "This method is used internally to update the volume of this sound.", "kind": "function", "name": "updateVolume", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#updateVolume", "scope": "instance", "___id": "T000002R037710", "___s": true }, { "comment": "/**\r\n * This method is used internally to update the playback rate of this sound.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#calculateRate\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 554, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "This method is used internally to update the playback rate of this sound.", "kind": "function", "name": "calculateRate", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#calculateRate", "scope": "instance", "overrides": "Phaser.Sound.BaseSound#calculateRate", "___id": "T000002R037713", "___s": true }, { "comment": "/**\r\n * Boolean indicating whether the sound is muted or not.\r\n * Gets or sets the muted state of this sound.\r\n *\r\n * @name Phaser.Sound.HTML5AudioSound#mute\r\n * @type {boolean}\r\n * @default false\r\n * @fires Phaser.Sound.Events#MUTE\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 570, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Boolean indicating whether the sound is muted or not.\rGets or sets the muted state of this sound.", "name": "mute", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "fires": [ "Phaser.Sound.Events#event:MUTE" ], "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#mute", "scope": "instance", "kind": "member", "___id": "T000002R037716", "___s": true }, { "comment": "/**\r\n * Sets the muted state of this Sound.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#setMute\r\n * @fires Phaser.Sound.Events#MUTE\r\n * @since 3.4.0\r\n *\r\n * @param {boolean} value - `true` to mute this sound, `false` to unmute it.\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 602, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Sets the muted state of this Sound.", "kind": "function", "name": "setMute", "fires": [ "Phaser.Sound.Events#event:MUTE" ], "since": "3.4.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to mute this sound, `false` to unmute it.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#setMute", "scope": "instance", "___id": "T000002R037721", "___s": true }, { "comment": "/**\r\n * Gets or sets the volume of this sound, a value between 0 (silence) and 1 (full volume).\r\n *\r\n * @name Phaser.Sound.HTML5AudioSound#volume\r\n * @type {number}\r\n * @default 1\r\n * @fires Phaser.Sound.Events#VOLUME\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 620, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Gets or sets the volume of this sound, a value between 0 (silence) and 1 (full volume).", "name": "volume", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "fires": [ "Phaser.Sound.Events#event:VOLUME" ], "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#volume", "scope": "instance", "kind": "member", "___id": "T000002R037724", "___s": true }, { "comment": "/**\r\n * Sets the volume of this Sound.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#setVolume\r\n * @fires Phaser.Sound.Events#VOLUME\r\n * @since 3.4.0\r\n *\r\n * @param {number} value - The volume of the sound.\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 651, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Sets the volume of this Sound.", "kind": "function", "name": "setVolume", "fires": [ "Phaser.Sound.Events#event:VOLUME" ], "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The volume of the sound.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#setVolume", "scope": "instance", "___id": "T000002R037729", "___s": true }, { "comment": "/**\r\n * Rate at which this Sound will be played.\r\n * Value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\r\n * and 2.0 doubles the audios playback speed.\r\n *\r\n * @name Phaser.Sound.HTML5AudioSound#rate\r\n * @type {number}\r\n * @default 1\r\n * @fires Phaser.Sound.Events#RATE\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 669, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Rate at which this Sound will be played.\rValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\rand 2.0 doubles the audios playback speed.", "name": "rate", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "fires": [ "Phaser.Sound.Events#event:RATE" ], "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#rate", "scope": "instance", "kind": "member", "___id": "T000002R037732", "___s": true }, { "comment": "/**\r\n * Sets the playback rate of this Sound.\r\n *\r\n * For example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\r\n * and 2.0 doubles the audios playback speed.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#setRate\r\n * @fires Phaser.Sound.Events#RATE\r\n * @since 3.3.0\r\n *\r\n * @param {number} value - The playback rate at of this Sound.\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 705, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Sets the playback rate of this Sound.\r\rFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\rand 2.0 doubles the audios playback speed.", "kind": "function", "name": "setRate", "fires": [ "Phaser.Sound.Events#event:RATE" ], "since": "3.3.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The playback rate at of this Sound.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#setRate", "scope": "instance", "___id": "T000002R037737", "___s": true }, { "comment": "/**\r\n * The detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\r\n * The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @name Phaser.Sound.HTML5AudioSound#detune\r\n * @type {number}\r\n * @default 0\r\n * @fires Phaser.Sound.Events#DETUNE\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 726, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "The detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\rThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "name": "detune", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "fires": [ "Phaser.Sound.Events#event:DETUNE" ], "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#detune", "scope": "instance", "kind": "member", "___id": "T000002R037740", "___s": true }, { "comment": "/**\r\n * Sets the detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\r\n * The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#setDetune\r\n * @fires Phaser.Sound.Events#DETUNE\r\n * @since 3.3.0\r\n *\r\n * @param {number} value - The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 761, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Sets the detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\rThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "kind": "function", "name": "setDetune", "fires": [ "Phaser.Sound.Events#event:DETUNE" ], "since": "3.3.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#setDetune", "scope": "instance", "___id": "T000002R037745", "___s": true }, { "comment": "/**\r\n * Property representing the position of playback for this sound, in seconds.\r\n * Setting it to a specific value moves current playback to that position.\r\n * The value given is clamped to the range 0 to current marker duration.\r\n * Setting seek of a stopped sound has no effect.\r\n *\r\n * @name Phaser.Sound.HTML5AudioSound#seek\r\n * @type {number}\r\n * @fires Phaser.Sound.Events#SEEK\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 780, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Property representing the position of playback for this sound, in seconds.\rSetting it to a specific value moves current playback to that position.\rThe value given is clamped to the range 0 to current marker duration.\rSetting seek of a stopped sound has no effect.", "name": "seek", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "fires": [ "Phaser.Sound.Events#event:SEEK" ], "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#seek", "scope": "instance", "kind": "member", "___id": "T000002R037748", "___s": true }, { "comment": "/**\r\n * Seeks to a specific point in this sound.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#setSeek\r\n * @fires Phaser.Sound.Events#SEEK\r\n * @since 3.4.0\r\n *\r\n * @param {number} value - The point in the sound to seek to.\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 840, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Seeks to a specific point in this sound.", "kind": "function", "name": "setSeek", "fires": [ "Phaser.Sound.Events#event:SEEK" ], "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The point in the sound to seek to.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#setSeek", "scope": "instance", "___id": "T000002R037756", "___s": true }, { "comment": "/**\r\n * Flag indicating whether or not the sound or current sound marker will loop.\r\n *\r\n * @name Phaser.Sound.HTML5AudioSound#loop\r\n * @type {boolean}\r\n * @default false\r\n * @fires Phaser.Sound.Events#LOOP\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 858, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Flag indicating whether or not the sound or current sound marker will loop.", "name": "loop", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "fires": [ "Phaser.Sound.Events#event:LOOP" ], "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#loop", "scope": "instance", "kind": "member", "___id": "T000002R037759", "___s": true }, { "comment": "/**\r\n * Sets the loop state of this Sound.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#setLoop\r\n * @fires Phaser.Sound.Events#LOOP\r\n * @since 3.4.0\r\n *\r\n * @param {boolean} value - `true` to loop this sound, `false` to not loop it.\r\n *\r\n * @return {Phaser.Sound.HTML5AudioSound} This Sound instance.\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 893, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Sets the loop state of this Sound.", "kind": "function", "name": "setLoop", "fires": [ "Phaser.Sound.Events#event:LOOP" ], "since": "3.4.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to loop this sound, `false` to not loop it.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#setLoop", "scope": "instance", "___id": "T000002R037765", "___s": true }, { "comment": "/**\r\n * Gets or sets the pan of this sound, a value between -1 (full left pan) and 1 (full right pan).\r\n *\r\n * Has no audible effect on HTML5 Audio Sound, but still generates the PAN Event.\r\n *\r\n * @name Phaser.Sound.HTML5AudioSound#pan\r\n * @type {number}\r\n * @default 0\r\n * @fires Phaser.Sound.Events#PAN\r\n * @since 3.50.0\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 911, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Gets or sets the pan of this sound, a value between -1 (full left pan) and 1 (full right pan).\r\rHas no audible effect on HTML5 Audio Sound, but still generates the PAN Event.", "name": "pan", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "fires": [ "Phaser.Sound.Events#event:PAN" ], "since": "3.50.0", "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#pan", "scope": "instance", "kind": "member", "___id": "T000002R037768", "___s": true }, { "comment": "/**\r\n * Sets the pan of this sound, a value between -1 (full left pan) and 1 (full right pan).\r\n *\r\n * Has no audible effect on HTML5 Audio Sound, but still generates the PAN Event.\r\n *\r\n * @method Phaser.Sound.HTML5AudioSound#setPan\r\n * @fires Phaser.Sound.Events#PAN\r\n * @since 3.50.0\r\n *\r\n * @param {number} value - The pan of the sound. A value between -1 (full left pan) and 1 (full right pan).\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "HTML5AudioSound.js", "lineno": 937, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Sets the pan of this sound, a value between -1 (full left pan) and 1 (full right pan).\r\rHas no audible effect on HTML5 Audio Sound, but still generates the PAN Event.", "kind": "function", "name": "setPan", "fires": [ "Phaser.Sound.Events#event:PAN" ], "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The pan of the sound. A value between -1 (full left pan) and 1 (full right pan).", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "longname": "Phaser.Sound.HTML5AudioSound#setPan", "scope": "instance", "___id": "T000002R037773", "___s": true }, { "comment": "/**\n * HTML5 Audio implementation of the Sound Manager.\n *\n * To play multiple instances of the same HTML5 Audio sound, you need to provide an `instances` value when\n * loading the sound with the Loader:\n *\n * ```javascript\n * this.load.audio('explosion', 'explosion.mp3', {\n * instances: 2\n * });\n * ```\n *\n * Not all browsers can play all audio formats.\n *\n * There is a good guide to what's supported: [Cross-browser audio basics: Audio codec support](https://developer.mozilla.org/en-US/Apps/Fundamentals/Audio_and_video_delivery/Cross-browser_audio_basics#Audio_Codec_Support).\n *\n * @class HTML5AudioSoundManager\n * @extends Phaser.Sound.BaseSoundManager\n * @memberof Phaser.Sound\n * @constructor\n * @since 3.0.0\n *\n * @param {Phaser.Game} game - Reference to the current game instance.\n */", "meta": { "range": [ 1257, 12985 ], "filename": "HTML5AudioSoundManager.js", "lineno": 37, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": { "id": "astnode100316026", "name": "HTML5AudioSoundManager", "type": "NewExpression", "value": "" } }, "description": "HTML5 Audio implementation of the Sound Manager.\n\nTo play multiple instances of the same HTML5 Audio sound, you need to provide an `instances` value when\nloading the sound with the Loader:\n\n```javascript\nthis.load.audio('explosion', 'explosion.mp3', {\n instances: 2\n});\n```\n\nNot all browsers can play all audio formats.\n\nThere is a good guide to what's supported: [Cross-browser audio basics: Audio codec support](https://developer.mozilla.org/en-US/Apps/Fundamentals/Audio_and_video_delivery/Cross-browser_audio_basics#Audio_Codec_Support).", "kind": "class", "classdesc": "HTML5AudioSoundManager", "augments": [ "Phaser.Sound.BaseSoundManager" ], "memberof": "Phaser.Sound", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "Reference to the current game instance.", "name": "game" } ], "name": "HTML5AudioSoundManager", "longname": "Phaser.Sound.HTML5AudioSoundManager", "scope": "static", "___id": "T000002R037781", "___s": true }, { "comment": "/**\n * Flag indicating whether if there are no idle instances of HTML5 Audio tag,\n * for any particular sound, if one of the used tags should be hijacked and used\n * for succeeding playback or if succeeding Phaser.Sound.HTML5AudioSound#play\n * call should be ignored.\n *\n * @name Phaser.Sound.HTML5AudioSoundManager#override\n * @type {boolean}\n * @default true\n * @since 3.0.0\n */", "meta": { "filename": "HTML5AudioSoundManager.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Flag indicating whether if there are no idle instances of HTML5 Audio tag,\nfor any particular sound, if one of the used tags should be hijacked and used\nfor succeeding playback or if succeeding Phaser.Sound.HTML5AudioSound#play\ncall should be ignored.", "name": "override", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "longname": "Phaser.Sound.HTML5AudioSoundManager#override", "scope": "instance", "kind": "member", "___id": "T000002R037784", "___s": true }, { "comment": "/**\n * Value representing time difference, in seconds, between calling\n * play method on an audio tag and when it actually starts playing.\n * It is used to achieve more accurate delayed sound playback.\n *\n * You might need to tweak this value to get the desired results\n * since audio play delay varies depending on the browser/platform.\n *\n * @name Phaser.Sound.HTML5AudioSoundManager#audioPlayDelay\n * @type {number}\n * @default 0.1\n * @since 3.0.0\n */", "meta": { "filename": "HTML5AudioSoundManager.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Value representing time difference, in seconds, between calling\nplay method on an audio tag and when it actually starts playing.\nIt is used to achieve more accurate delayed sound playback.\n\nYou might need to tweak this value to get the desired results\nsince audio play delay varies depending on the browser/platform.", "name": "audioPlayDelay", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.1", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "longname": "Phaser.Sound.HTML5AudioSoundManager#audioPlayDelay", "scope": "instance", "kind": "member", "___id": "T000002R037786", "___s": true }, { "comment": "/**\n * A value by which we should offset the loop end marker of the\n * looping sound to compensate for lag, caused by changing audio\n * tag playback position, in order to achieve gapless looping.\n *\n * You might need to tweak this value to get the desired results\n * since loop lag varies depending on the browser/platform.\n *\n * @name Phaser.Sound.HTML5AudioSoundManager#loopEndOffset\n * @type {number}\n * @default 0.05\n * @since 3.0.0\n */", "meta": { "filename": "HTML5AudioSoundManager.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "A value by which we should offset the loop end marker of the\nlooping sound to compensate for lag, caused by changing audio\ntag playback position, in order to achieve gapless looping.\n\nYou might need to tweak this value to get the desired results\nsince loop lag varies depending on the browser/platform.", "name": "loopEndOffset", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.05", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "longname": "Phaser.Sound.HTML5AudioSoundManager#loopEndOffset", "scope": "instance", "kind": "member", "___id": "T000002R037788", "___s": true }, { "comment": "/**\n * Adds a new sound into the sound manager.\n *\n * @method Phaser.Sound.HTML5AudioSoundManager#add\n * @since 3.0.0\n *\n * @param {string} key - Asset key for the sound.\n * @param {Phaser.Types.Sound.SoundConfig} [config] - An optional config object containing default sound settings.\n *\n * @return {Phaser.Sound.HTML5AudioSound} The new sound instance.\n */", "meta": { "filename": "HTML5AudioSoundManager.js", "lineno": 142, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Adds a new sound into the sound manager.", "kind": "function", "name": "add", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "An optional config object containing default sound settings.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } }, "description": "The new sound instance." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "longname": "Phaser.Sound.HTML5AudioSoundManager#add", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#add", "___id": "T000002R037799", "___s": true }, { "comment": "/**\n * Unlocks HTML5 Audio loading and playback on mobile\n * devices on the initial explicit user interaction.\n *\n * @method Phaser.Sound.HTML5AudioSoundManager#unlock\n * @since 3.0.0\n */", "meta": { "filename": "HTML5AudioSoundManager.js", "lineno": 162, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Unlocks HTML5 Audio loading and playback on mobile\ndevices on the initial explicit user interaction.", "kind": "function", "name": "unlock", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "longname": "Phaser.Sound.HTML5AudioSoundManager#unlock", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#unlock", "___id": "T000002R037802", "___s": true }, { "comment": "/**\n * Method used internally for pausing sound manager if\n * Phaser.Sound.HTML5AudioSoundManager#pauseOnBlur is set to true.\n *\n * @method Phaser.Sound.HTML5AudioSoundManager#onBlur\n * @protected\n * @since 3.0.0\n */", "meta": { "filename": "HTML5AudioSoundManager.js", "lineno": 287, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Method used internally for pausing sound manager if\nPhaser.Sound.HTML5AudioSoundManager#pauseOnBlur is set to true.", "kind": "function", "name": "onBlur", "access": "protected", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "longname": "Phaser.Sound.HTML5AudioSoundManager#onBlur", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#onBlur", "___id": "T000002R037825", "___s": true }, { "comment": "/**\n * Method used internally for resuming sound manager if\n * Phaser.Sound.HTML5AudioSoundManager#pauseOnBlur is set to true.\n *\n * @method Phaser.Sound.HTML5AudioSoundManager#onFocus\n * @protected\n * @since 3.0.0\n */", "meta": { "filename": "HTML5AudioSoundManager.js", "lineno": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Method used internally for resuming sound manager if\nPhaser.Sound.HTML5AudioSoundManager#pauseOnBlur is set to true.", "kind": "function", "name": "onFocus", "access": "protected", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "longname": "Phaser.Sound.HTML5AudioSoundManager#onFocus", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#onFocus", "___id": "T000002R037827", "___s": true }, { "comment": "/**\n * Calls Phaser.Sound.BaseSoundManager#destroy method\n * and cleans up all HTML5 Audio related stuff.\n *\n * @method Phaser.Sound.HTML5AudioSoundManager#destroy\n * @since 3.0.0\n */", "meta": { "filename": "HTML5AudioSoundManager.js", "lineno": 325, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Calls Phaser.Sound.BaseSoundManager#destroy method\nand cleans up all HTML5 Audio related stuff.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "longname": "Phaser.Sound.HTML5AudioSoundManager#destroy", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#destroy", "___id": "T000002R037830", "___s": true }, { "comment": "/**\n * Method used internally by Phaser.Sound.HTML5AudioSound class methods and property setters\n * to check if sound manager is locked and then either perform action immediately or queue it\n * to be performed once the sound manager gets unlocked.\n *\n * @method Phaser.Sound.HTML5AudioSoundManager#isLocked\n * @protected\n * @since 3.0.0\n *\n * @param {Phaser.Sound.HTML5AudioSound} sound - Sound object on which to perform queued action.\n * @param {string} prop - Name of the method to be called or property to be assigned a value to.\n * @param {*} [value] - An optional parameter that either holds an array of arguments to be passed to the method call or value to be set to the property.\n *\n * @return {boolean} Whether the sound manager is locked.\n */", "meta": { "filename": "HTML5AudioSoundManager.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Method used internally by Phaser.Sound.HTML5AudioSound class methods and property setters\nto check if sound manager is locked and then either perform action immediately or queue it\nto be performed once the sound manager gets unlocked.", "kind": "function", "name": "isLocked", "access": "protected", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.HTML5AudioSound" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" } }, "description": "Sound object on which to perform queued action.", "name": "sound" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Name of the method to be called or property to be assigned a value to.", "name": "prop" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "An optional parameter that either holds an array of arguments to be passed to the method call or value to be set to the property.", "name": "value" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound manager is locked." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "longname": "Phaser.Sound.HTML5AudioSoundManager#isLocked", "scope": "instance", "___id": "T000002R037834", "___s": true }, { "comment": "/**\n * Sets the muted state of all this Sound Manager.\n *\n * @method Phaser.Sound.HTML5AudioSoundManager#setMute\n * @fires Phaser.Sound.Events#GLOBAL_MUTE\n * @since 3.3.0\n *\n * @param {boolean} value - `true` to mute all sounds, `false` to unmute them.\n *\n * @return {Phaser.Sound.HTML5AudioSoundManager} This Sound Manager.\n */", "meta": { "filename": "HTML5AudioSoundManager.js", "lineno": 371, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Sets the muted state of all this Sound Manager.", "kind": "function", "name": "setMute", "fires": [ "Phaser.Sound.Events#event:GLOBAL_MUTE" ], "since": "3.3.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to mute all sounds, `false` to unmute them.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Sound.HTML5AudioSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSoundManager" } }, "description": "This Sound Manager." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "longname": "Phaser.Sound.HTML5AudioSoundManager#setMute", "scope": "instance", "___id": "T000002R037839", "___s": true }, { "comment": "/**\n * @name Phaser.Sound.HTML5AudioSoundManager#mute\n * @type {boolean}\n * @fires Phaser.Sound.Events#GLOBAL_MUTE\n * @since 3.0.0\n */", "meta": { "filename": "HTML5AudioSoundManager.js", "lineno": 389, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "name": "mute", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "fires": [ "Phaser.Sound.Events#event:GLOBAL_MUTE" ], "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "longname": "Phaser.Sound.HTML5AudioSoundManager#mute", "scope": "instance", "kind": "member", "overrides": "Phaser.Sound.BaseSoundManager#mute", "___id": "T000002R037842", "___s": true }, { "comment": "/**\n * Sets the volume of this Sound Manager.\n *\n * @method Phaser.Sound.HTML5AudioSoundManager#setVolume\n * @fires Phaser.Sound.Events#GLOBAL_VOLUME\n * @since 3.3.0\n *\n * @param {number} value - The global volume of this Sound Manager.\n *\n * @return {Phaser.Sound.HTML5AudioSoundManager} This Sound Manager.\n */", "meta": { "filename": "HTML5AudioSoundManager.js", "lineno": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "description": "Sets the volume of this Sound Manager.", "kind": "function", "name": "setVolume", "fires": [ "Phaser.Sound.Events#event:GLOBAL_VOLUME" ], "since": "3.3.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The global volume of this Sound Manager.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Sound.HTML5AudioSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSoundManager" } }, "description": "This Sound Manager." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "longname": "Phaser.Sound.HTML5AudioSoundManager#setVolume", "scope": "instance", "___id": "T000002R037847", "___s": true }, { "comment": "/**\n * @name Phaser.Sound.HTML5AudioSoundManager#volume\n * @type {number}\n * @fires Phaser.Sound.Events#GLOBAL_VOLUME\n * @since 3.0.0\n */", "meta": { "filename": "HTML5AudioSoundManager.js", "lineno": 434, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\html5", "code": {} }, "name": "volume", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "fires": [ "Phaser.Sound.Events#event:GLOBAL_VOLUME" ], "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "longname": "Phaser.Sound.HTML5AudioSoundManager#volume", "scope": "instance", "kind": "member", "overrides": "Phaser.Sound.BaseSoundManager#volume", "___id": "T000002R037850", "___s": true }, { "comment": "/**\n * @namespace Phaser.Sound\n */", "meta": { "filename": "index.js", "lineno": 8, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "kind": "namespace", "name": "Sound", "memberof": "Phaser", "longname": "Phaser.Sound", "scope": "static", "___id": "T000002R037856", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * No audio implementation of the sound. It is used if audio has been\r\n * disabled in the game config or the device doesn't support any audio.\r\n *\r\n * It represents a graceful degradation of sound logic that provides\r\n * minimal functionality and prevents Phaser projects that use audio from\r\n * breaking on devices that don't support any audio playback technologies.\r\n *\r\n * @class NoAudioSound\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Sound\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Sound.NoAudioSoundManager} manager - Reference to the current sound manager instance.\r\n * @param {string} key - Asset key for the sound.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config={}] - An optional config object containing default sound settings.\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 29, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "classdesc": "No audio implementation of the sound. It is used if audio has been\rdisabled in the game config or the device doesn't support any audio.\r\rIt represents a graceful degradation of sound logic that provides\rminimal functionality and prevents Phaser projects that use audio from\rbreaking on devices that don't support any audio playback technologies.", "kind": "class", "name": "NoAudioSound", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Sound", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.NoAudioSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.NoAudioSoundManager" } }, "description": "Reference to the current sound manager instance.", "name": "manager" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "defaultvalue": "{}", "description": "An optional config object containing default sound settings.", "name": "config" } ], "scope": "static", "longname": "Phaser.Sound.NoAudioSound", "___id": "T000002R037876", "___s": true }, { "comment": "/**\r\n * Local reference to the sound manager.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#manager\r\n * @type {Phaser.Sound.BaseSoundManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Local reference to the sound manager.", "name": "manager", "type": { "names": [ "Phaser.Sound.BaseSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSoundManager" } }, "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#manager", "scope": "instance", "kind": "member", "___id": "T000002R037881", "___s": true }, { "comment": "/**\r\n * Asset key for the sound.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#key\r\n * @type {string}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 69, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Asset key for the sound.", "name": "key", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#key", "scope": "instance", "kind": "member", "___id": "T000002R037883", "___s": true }, { "comment": "/**\r\n * Flag indicating if sound is currently playing.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#isPlaying\r\n * @type {boolean}\r\n * @default false\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Flag indicating if sound is currently playing.", "name": "isPlaying", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#isPlaying", "scope": "instance", "kind": "member", "___id": "T000002R037885", "___s": true }, { "comment": "/**\r\n * Flag indicating if sound is currently paused.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#isPaused\r\n * @type {boolean}\r\n * @default false\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 90, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Flag indicating if sound is currently paused.", "name": "isPaused", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#isPaused", "scope": "instance", "kind": "member", "___id": "T000002R037887", "___s": true }, { "comment": "/**\r\n * A property that holds the value of sound's actual playback rate,\r\n * after its rate and detune values has been combined with global\r\n * rate and detune values.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#totalRate\r\n * @type {number}\r\n * @default 1\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 101, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "A property that holds the value of sound's actual playback rate,\rafter its rate and detune values has been combined with global\rrate and detune values.", "name": "totalRate", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#totalRate", "scope": "instance", "kind": "member", "___id": "T000002R037889", "___s": true }, { "comment": "/**\r\n * A value representing the duration, in seconds.\r\n * It could be total sound duration or a marker duration.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#duration\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "A value representing the duration, in seconds.\rIt could be total sound duration or a marker duration.", "name": "duration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#duration", "scope": "instance", "kind": "member", "___id": "T000002R037891", "___s": true }, { "comment": "/**\r\n * The total duration of the sound in seconds.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#totalDuration\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "The total duration of the sound in seconds.", "name": "totalDuration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#totalDuration", "scope": "instance", "kind": "member", "___id": "T000002R037893", "___s": true }, { "comment": "/**\r\n * A config object used to store default sound settings' values.\r\n * Default values will be set by properties' setters.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#config\r\n * @type {Phaser.Types.Sound.SoundConfig}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 135, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "A config object used to store default sound settings' values.\rDefault values will be set by properties' setters.", "name": "config", "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#config", "scope": "instance", "kind": "member", "___id": "T000002R037895", "___s": true }, { "comment": "/**\r\n * Reference to the currently used config.\r\n * It could be default config or marker config.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#currentConfig\r\n * @type {Phaser.Types.Sound.SoundConfig}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Reference to the currently used config.\rIt could be default config or marker config.", "name": "currentConfig", "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#currentConfig", "scope": "instance", "kind": "member", "___id": "T000002R037905", "___s": true }, { "comment": "/**\r\n * Boolean indicating whether the sound is muted or not.\r\n * Gets or sets the muted state of this sound.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#mute\r\n * @type {boolean}\r\n * @default false\r\n * @fires Phaser.Sound.Events#MUTE\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 164, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Boolean indicating whether the sound is muted or not.\rGets or sets the muted state of this sound.", "name": "mute", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "fires": [ "Phaser.Sound.Events#event:MUTE" ], "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#mute", "scope": "instance", "kind": "member", "___id": "T000002R037907", "___s": true }, { "comment": "/**\r\n * Gets or sets the volume of this sound, a value between 0 (silence) and 1 (full volume).\r\n *\r\n * @name Phaser.Sound.NoAudioSound#volume\r\n * @type {number}\r\n * @default 1\r\n * @fires Phaser.Sound.Events#VOLUME\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Gets or sets the volume of this sound, a value between 0 (silence) and 1 (full volume).", "name": "volume", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "fires": [ "Phaser.Sound.Events#event:VOLUME" ], "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#volume", "scope": "instance", "kind": "member", "___id": "T000002R037909", "___s": true }, { "comment": "/**\r\n * Rate at which this Sound will be played.\r\n * Value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\r\n * and 2.0 doubles the audios playback speed.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#rate\r\n * @type {number}\r\n * @default 1\r\n * @fires Phaser.Sound.Events#RATE\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Rate at which this Sound will be played.\rValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\rand 2.0 doubles the audios playback speed.", "name": "rate", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "fires": [ "Phaser.Sound.Events#event:RATE" ], "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#rate", "scope": "instance", "kind": "member", "___id": "T000002R037911", "___s": true }, { "comment": "/**\r\n * The detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\r\n * The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @name Phaser.Sound.NoAudioSound#detune\r\n * @type {number}\r\n * @default 0\r\n * @fires Phaser.Sound.Events#DETUNE\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 200, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "The detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\rThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "name": "detune", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "fires": [ "Phaser.Sound.Events#event:DETUNE" ], "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#detune", "scope": "instance", "kind": "member", "___id": "T000002R037913", "___s": true }, { "comment": "/**\r\n * Property representing the position of playback for this sound, in seconds.\r\n * Setting it to a specific value moves current playback to that position.\r\n * The value given is clamped to the range 0 to current marker duration.\r\n * Setting seek of a stopped sound has no effect.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#seek\r\n * @type {number}\r\n * @fires Phaser.Sound.Events#SEEK\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 212, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Property representing the position of playback for this sound, in seconds.\rSetting it to a specific value moves current playback to that position.\rThe value given is clamped to the range 0 to current marker duration.\rSetting seek of a stopped sound has no effect.", "name": "seek", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "fires": [ "Phaser.Sound.Events#event:SEEK" ], "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#seek", "scope": "instance", "kind": "member", "___id": "T000002R037915", "___s": true }, { "comment": "/**\r\n * Flag indicating whether or not the sound or current sound marker will loop.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#loop\r\n * @type {boolean}\r\n * @default false\r\n * @fires Phaser.Sound.Events#LOOP\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Flag indicating whether or not the sound or current sound marker will loop.", "name": "loop", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "fires": [ "Phaser.Sound.Events#event:LOOP" ], "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#loop", "scope": "instance", "kind": "member", "___id": "T000002R037917", "___s": true }, { "comment": "/**\r\n * Gets or sets the pan of this sound, a value between -1 (full left pan) and 1 (full right pan).\r\n *\r\n * Always returns zero on iOS / Safari as it doesn't support the stereo panner node.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#pan\r\n * @type {number}\r\n * @default 0\r\n * @fires Phaser.Sound.Events#PAN\r\n * @since 3.50.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 236, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Gets or sets the pan of this sound, a value between -1 (full left pan) and 1 (full right pan).\r\rAlways returns zero on iOS / Safari as it doesn't support the stereo panner node.", "name": "pan", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "fires": [ "Phaser.Sound.Events#event:PAN" ], "since": "3.50.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#pan", "scope": "instance", "kind": "member", "___id": "T000002R037919", "___s": true }, { "comment": "/**\r\n * Object containing markers definitions.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#markers\r\n * @type {Object.}\r\n * @default {}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 249, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Object containing markers definitions.", "name": "markers", "type": { "names": [ "Object." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } ] } }, "defaultvalue": "{}", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#markers", "scope": "instance", "kind": "member", "___id": "T000002R037921", "___s": true }, { "comment": "/**\r\n * Currently playing marker.\r\n * 'null' if whole sound is playing.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#currentMarker\r\n * @type {Phaser.Types.Sound.SoundMarker}\r\n * @default null\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 260, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Currently playing marker.\r'null' if whole sound is playing.", "name": "currentMarker", "type": { "names": [ "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } }, "defaultvalue": "null", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#currentMarker", "scope": "instance", "kind": "member", "___id": "T000002R037923", "___s": true }, { "comment": "/**\r\n * Flag indicating if destroy method was called on this sound.\r\n *\r\n * @name Phaser.Sound.NoAudioSound#pendingRemove\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 272, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Flag indicating if destroy method was called on this sound.", "name": "pendingRemove", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#pendingRemove", "scope": "instance", "kind": "member", "___id": "T000002R037925", "___s": true }, { "comment": "/**\r\n * @method Phaser.Sound.NoAudioSound#addMarker\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Sound.SoundMarker} marker - Marker object.\r\n *\r\n * @return {boolean} false\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 283, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "kind": "function", "name": "addMarker", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } }, "description": "Marker object.", "name": "marker" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "false" } ], "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#addMarker", "scope": "instance", "___id": "T000002R037927", "___s": true }, { "comment": "/**\r\n * @method Phaser.Sound.NoAudioSound#updateMarker\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Sound.SoundMarker} marker - Marker object with updated values.\r\n *\r\n * @return {boolean} false\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 293, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "kind": "function", "name": "updateMarker", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } }, "description": "Marker object with updated values.", "name": "marker" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "false" } ], "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#updateMarker", "scope": "instance", "___id": "T000002R037929", "___s": true }, { "comment": "/**\r\n * @method Phaser.Sound.NoAudioSound#removeMarker\r\n * @since 3.0.0\r\n *\r\n * @param {string} markerName - The name of the marker to remove.\r\n *\r\n * @return {null} null\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 303, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "kind": "function", "name": "removeMarker", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the marker to remove.", "name": "markerName" } ], "returns": [ { "type": { "names": [ "null" ], "parsedType": { "type": "NullLiteral" } }, "description": "null" } ], "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#removeMarker", "scope": "instance", "___id": "T000002R037931", "___s": true }, { "comment": "/**\r\n * @method Phaser.Sound.NoAudioSound#play\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Sound.SoundConfig)} [markerName=''] - If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config] - Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.\r\n *\r\n * @return {boolean} false\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 313, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "kind": "function", "name": "play", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } ] } }, "optional": true, "defaultvalue": "''", "description": "If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.", "name": "markerName" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.", "name": "config" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "false" } ], "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#play", "scope": "instance", "___id": "T000002R037933", "___s": true }, { "comment": "/**\r\n * @method Phaser.Sound.NoAudioSound#pause\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} false\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 324, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "kind": "function", "name": "pause", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "false" } ], "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#pause", "scope": "instance", "___id": "T000002R037935", "___s": true }, { "comment": "/**\r\n * Resumes the sound.\r\n *\r\n * @method Phaser.Sound.NoAudioSound#resume\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} false\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Resumes the sound.", "kind": "function", "name": "resume", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "false" } ], "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#resume", "scope": "instance", "___id": "T000002R037937", "___s": true }, { "comment": "/**\r\n * Stop playing this sound.\r\n *\r\n * @method Phaser.Sound.NoAudioSound#stop\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} false\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 342, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Stop playing this sound.", "kind": "function", "name": "stop", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "false" } ], "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#stop", "scope": "instance", "___id": "T000002R037939", "___s": true }, { "comment": "/**\r\n * Sets the muted state of this Sound.\r\n *\r\n * @method Phaser.Sound.NoAudioSound#setMute\r\n * @since 3.4.0\r\n *\r\n * @param {boolean} value - `true` to mute this sound, `false` to unmute it.\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 352, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Sets the muted state of this Sound.", "kind": "function", "name": "setMute", "since": "3.4.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to mute this sound, `false` to unmute it.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#setMute", "scope": "instance", "___id": "T000002R037941", "___s": true }, { "comment": "/**\r\n * Sets the volume of this Sound.\r\n *\r\n * @method Phaser.Sound.NoAudioSound#setVolume\r\n * @since 3.4.0\r\n *\r\n * @param {number} value - The volume of the sound.\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 364, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Sets the volume of this Sound.", "kind": "function", "name": "setVolume", "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The volume of the sound.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#setVolume", "scope": "instance", "___id": "T000002R037943", "___s": true }, { "comment": "/**\r\n * Sets the playback rate of this Sound.\r\n *\r\n * For example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\r\n * and 2.0 doubles the audios playback speed.\r\n *\r\n * @method Phaser.Sound.NoAudioSound#setRate\r\n * @since 3.3.0\r\n *\r\n * @param {number} value - The playback rate at of this Sound.\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 376, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Sets the playback rate of this Sound.\r\rFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\rand 2.0 doubles the audios playback speed.", "kind": "function", "name": "setRate", "since": "3.3.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The playback rate at of this Sound.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#setRate", "scope": "instance", "___id": "T000002R037945", "___s": true }, { "comment": "/**\r\n * Sets the detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\r\n * The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @method Phaser.Sound.NoAudioSound#setDetune\r\n * @since 3.3.0\r\n *\r\n * @param {number} value - The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 391, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Sets the detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\rThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "kind": "function", "name": "setDetune", "since": "3.3.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#setDetune", "scope": "instance", "___id": "T000002R037947", "___s": true }, { "comment": "/**\r\n * Seeks to a specific point in this sound.\r\n *\r\n * @method Phaser.Sound.NoAudioSound#setSeek\r\n * @since 3.4.0\r\n *\r\n * @param {number} value - The point in the sound to seek to.\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 404, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Seeks to a specific point in this sound.", "kind": "function", "name": "setSeek", "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The point in the sound to seek to.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#setSeek", "scope": "instance", "___id": "T000002R037949", "___s": true }, { "comment": "/**\r\n * Sets the loop state of this Sound.\r\n *\r\n * @method Phaser.Sound.NoAudioSound#setLoop\r\n * @since 3.4.0\r\n *\r\n * @param {boolean} value - `true` to loop this sound, `false` to not loop it.\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Sets the loop state of this Sound.", "kind": "function", "name": "setLoop", "since": "3.4.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to loop this sound, `false` to not loop it.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#setLoop", "scope": "instance", "___id": "T000002R037951", "___s": true }, { "comment": "/**\r\n * Sets the pan of this sound, a value between -1 (full left pan) and 1 (full right pan).\r\n *\r\n * Note: iOS / Safari doesn't support the stereo panner node.\r\n *\r\n * @method Phaser.Sound.NoAudioSound#setPan\r\n * @since 3.50.0\r\n *\r\n * @param {number} value - The pan of the sound. A value between -1 (full left pan) and 1 (full right pan).\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 428, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Sets the pan of this sound, a value between -1 (full left pan) and 1 (full right pan).\r\rNote: iOS / Safari doesn't support the stereo panner node.", "kind": "function", "name": "setPan", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The pan of the sound. A value between -1 (full left pan) and 1 (full right pan).", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#setPan", "scope": "instance", "___id": "T000002R037953", "___s": true }, { "comment": "/**\r\n * Method used internally for applying config values to some of the sound properties.\r\n *\r\n * @method Phaser.Sound.NoAudioSound#applyConfig\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 442, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Method used internally for applying config values to some of the sound properties.", "kind": "function", "name": "applyConfig", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#applyConfig", "scope": "instance", "___id": "T000002R037955", "___s": true }, { "comment": "/**\r\n * Method used internally for resetting values of some of the config properties.\r\n *\r\n * @method Phaser.Sound.NoAudioSound#resetConfig\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 450, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Method used internally for resetting values of some of the config properties.", "kind": "function", "name": "resetConfig", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#resetConfig", "scope": "instance", "___id": "T000002R037957", "___s": true }, { "comment": "/**\r\n * Update method called automatically by sound manager on every game step.\r\n *\r\n * @method Phaser.Sound.NoAudioSound#update\r\n * @override\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 elapsed since the last frame.\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 458, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Update method called automatically by sound manager on every game step.", "kind": "function", "name": "update", "override": true, "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 elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#update", "scope": "instance", "___id": "T000002R037959", "___s": true }, { "comment": "/**\r\n * Method used internally to calculate total playback rate of the sound.\r\n *\r\n * @method Phaser.Sound.NoAudioSound#calculateRate\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 470, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Method used internally to calculate total playback rate of the sound.", "kind": "function", "name": "calculateRate", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#calculateRate", "scope": "instance", "___id": "T000002R037961", "___s": true }, { "comment": "/**\r\n * Destroys this sound and all associated events and marks it for removal from the sound manager.\r\n *\r\n * @method Phaser.Sound.NoAudioSound#destroy\r\n * @fires Phaser.Sound.Events#DESTROY\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSound.js", "lineno": 478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Destroys this sound and all associated events and marks it for removal from the sound manager.", "kind": "function", "name": "destroy", "fires": [ "Phaser.Sound.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "longname": "Phaser.Sound.NoAudioSound#destroy", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#destroy", "___id": "T000002R037963", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * No-audio implementation of the Sound Manager. It is used if audio has been\r\n * disabled in the game config or the device doesn't support any audio.\r\n *\r\n * It represents a graceful degradation of Sound Manager logic that provides\r\n * minimal functionality and prevents Phaser projects that use audio from\r\n * breaking on devices that don't support any audio playback technologies.\r\n *\r\n * @class NoAudioSoundManager\r\n * @extends Phaser.Sound.BaseSoundManager\r\n * @memberof Phaser.Sound\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - Reference to the current game instance.\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "classdesc": "No-audio implementation of the Sound Manager. It is used if audio has been\rdisabled in the game config or the device doesn't support any audio.\r\rIt represents a graceful degradation of Sound Manager logic that provides\rminimal functionality and prevents Phaser projects that use audio from\rbreaking on devices that don't support any audio playback technologies.", "kind": "class", "name": "NoAudioSoundManager", "augments": [ "Phaser.Sound.BaseSoundManager" ], "memberof": "Phaser.Sound", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "Reference to the current game instance.", "name": "game" } ], "scope": "static", "longname": "Phaser.Sound.NoAudioSoundManager", "___id": "T000002R037971", "___s": true }, { "comment": "/**\r\n * Adds a new sound into the sound manager.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#add\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - Asset key for the sound.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config] - An optional config object containing default sound settings.\r\n *\r\n * @return {Phaser.Sound.NoAudioSound} The new sound instance.\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 51, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Adds a new sound into the sound manager.", "kind": "function", "name": "add", "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "An optional config object containing default sound settings.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Sound.NoAudioSound" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.NoAudioSound" } }, "description": "The new sound instance." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#add", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#add", "___id": "T000002R037983", "___s": true }, { "comment": "/**\r\n * Adds a new audio sprite sound into the sound manager.\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 * @method Phaser.Sound.NoAudioSoundManager#addAudioSprite\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - Asset key for the sound.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config] - An optional config object containing default sound settings.\r\n *\r\n * @return {Phaser.Sound.NoAudioSound} The new audio sprite sound instance.\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 71, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Adds a new audio sprite sound into the sound manager.\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", "kind": "function", "name": "addAudioSprite", "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "An optional config object containing default sound settings.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Sound.NoAudioSound" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.NoAudioSound" } }, "description": "The new audio sprite sound instance." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#addAudioSprite", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#addAudioSprite", "___id": "T000002R037986", "___s": true }, { "comment": "/**\r\n * Gets the first sound in the manager matching the given key, if any.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#get\r\n * @since 3.23.0\r\n *\r\n * @generic {Phaser.Sound.BaseSound} T\r\n * @genericUse {T} - [$return]\r\n *\r\n * @param {string} key - Sound asset key.\r\n *\r\n * @return {?Phaser.Sound.BaseSound} - The sound, or null.\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 93, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Gets the first sound in the manager matching the given key, if any.", "kind": "function", "name": "get", "since": "3.23.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Sound.BaseSound} T", "value": "{Phaser.Sound.BaseSound} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$return]", "value": "{T} - [$return]" } ], "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Sound asset key.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Sound.BaseSound" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSound", "nullable": true } }, "nullable": true, "description": "- The sound, or null." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#get", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#get", "___id": "T000002R037990", "___s": true }, { "comment": "/**\r\n * Gets any sounds in the manager matching the given key.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#getAll\r\n * @since 3.23.0\r\n *\r\n * @generic {Phaser.Sound.BaseSound} T\r\n * @genericUse {T[]} - [$return]\r\n *\r\n * @param {string} key - Sound asset key.\r\n *\r\n * @return {Phaser.Sound.BaseSound[]} - The sounds, or an empty array.\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 111, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Gets any sounds in the manager matching the given key.", "kind": "function", "name": "getAll", "since": "3.23.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Sound.BaseSound} T", "value": "{Phaser.Sound.BaseSound} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [$return]", "value": "{T[]} - [$return]" } ], "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Sound asset key.", "name": "key" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Sound.BaseSound", "type": "NameExpression" } ] } }, "description": "- The sounds, or an empty array." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#getAll", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#getAll", "___id": "T000002R037992", "___s": true }, { "comment": "/**\r\n * This method does nothing but return 'false' for the No Audio Sound Manager, to maintain\r\n * compatibility with the other Sound Managers.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#play\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - Asset key for the sound.\r\n * @param {(Phaser.Types.Sound.SoundConfig|Phaser.Types.Sound.SoundMarker)} [extra] - An optional additional object containing settings to be applied to the sound. It could be either config or marker object.\r\n *\r\n * @return {boolean} Always 'false' for the No Audio Sound Manager.\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "This method does nothing but return 'false' for the No Audio Sound Manager, to maintain\rcompatibility with the other Sound Managers.", "kind": "function", "name": "play", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig", "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" }, { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } ] } }, "optional": true, "description": "An optional additional object containing settings to be applied to the sound. It could be either config or marker object.", "name": "extra" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Always 'false' for the No Audio Sound Manager." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#play", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#play", "___id": "T000002R037994", "___s": true }, { "comment": "/**\r\n * This method does nothing but return 'false' for the No Audio Sound Manager, to maintain\r\n * compatibility with the other Sound Managers.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#playAudioSprite\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - Asset key for the sound.\r\n * @param {string} spriteName - The name of the sound sprite to play.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config] - An optional config object containing default sound settings.\r\n *\r\n * @return {boolean} Always 'false' for the No Audio Sound Manager.\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 147, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "This method does nothing but return 'false' for the No Audio Sound Manager, to maintain\rcompatibility with the other Sound Managers.", "kind": "function", "name": "playAudioSprite", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the sound sprite to play.", "name": "spriteName" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "An optional config object containing default sound settings.", "name": "config" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Always 'false' for the No Audio Sound Manager." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#playAudioSprite", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#playAudioSprite", "___id": "T000002R037996", "___s": true }, { "comment": "/**\r\n * Removes a sound from the sound manager.\r\n * The removed sound is destroyed before removal.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#remove\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Sound.BaseSound} sound - The sound object to remove.\r\n *\r\n * @return {boolean} True if the sound was removed successfully, otherwise false.\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Removes a sound from the sound manager.\rThe removed sound is destroyed before removal.", "kind": "function", "name": "remove", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.BaseSound" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSound" } }, "description": "The sound object to remove.", "name": "sound" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the sound was removed successfully, otherwise false." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#remove", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#remove", "___id": "T000002R037998", "___s": true }, { "comment": "/**\r\n * Removes all sounds from the manager, destroying the sounds.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#removeAll\r\n * @since 3.23.0\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Removes all sounds from the manager, destroying the sounds.", "kind": "function", "name": "removeAll", "since": "3.23.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#removeAll", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#removeAll", "___id": "T000002R038000", "___s": true }, { "comment": "/**\r\n * Removes all sounds from the sound manager that have an asset key matching the given value.\r\n * The removed sounds are destroyed before removal.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#removeByKey\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key to match when removing sound objects.\r\n *\r\n * @return {number} The number of matching sound objects that were removed.\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 193, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Removes all sounds from the sound manager that have an asset key matching the given value.\rThe removed sounds are destroyed before removal.", "kind": "function", "name": "removeByKey", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to match when removing sound objects.", "name": "key" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of matching sound objects that were removed." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#removeByKey", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#removeByKey", "___id": "T000002R038002", "___s": true }, { "comment": "/**\r\n * Stops any sounds matching the given key.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#stopByKey\r\n * @since 3.23.0\r\n *\r\n * @param {string} key - Sound asset key.\r\n *\r\n * @return {number} - How many sounds were stopped.\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 209, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Stops any sounds matching the given key.", "kind": "function", "name": "stopByKey", "since": "3.23.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Sound asset key.", "name": "key" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "- How many sounds were stopped." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#stopByKey", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#stopByKey", "___id": "T000002R038004", "___s": true }, { "comment": "/**\r\n * Empty function for the No Audio Sound Manager.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#onBlur\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 224, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Empty function for the No Audio Sound Manager.", "kind": "function", "name": "onBlur", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#onBlur", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#onBlur", "___id": "T000002R038006", "___s": true }, { "comment": "/**\r\n * Empty function for the No Audio Sound Manager.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#onFocus\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 232, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Empty function for the No Audio Sound Manager.", "kind": "function", "name": "onFocus", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#onFocus", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#onFocus", "___id": "T000002R038008", "___s": true }, { "comment": "/**\r\n * Empty function for the No Audio Sound Manager.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#onGameBlur\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 240, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Empty function for the No Audio Sound Manager.", "kind": "function", "name": "onGameBlur", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#onGameBlur", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#onGameBlur", "___id": "T000002R038010", "___s": true }, { "comment": "/**\r\n * Empty function for the No Audio Sound Manager.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#onGameFocus\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 248, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Empty function for the No Audio Sound Manager.", "kind": "function", "name": "onGameFocus", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#onGameFocus", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#onGameFocus", "___id": "T000002R038012", "___s": true }, { "comment": "/**\r\n * Empty function for the No Audio Sound Manager.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#pauseAll\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 256, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Empty function for the No Audio Sound Manager.", "kind": "function", "name": "pauseAll", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#pauseAll", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#pauseAll", "___id": "T000002R038014", "___s": true }, { "comment": "/**\r\n * Empty function for the No Audio Sound Manager.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#resumeAll\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 264, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Empty function for the No Audio Sound Manager.", "kind": "function", "name": "resumeAll", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#resumeAll", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#resumeAll", "___id": "T000002R038016", "___s": true }, { "comment": "/**\r\n * Empty function for the No Audio Sound Manager.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#stopAll\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Empty function for the No Audio Sound Manager.", "kind": "function", "name": "stopAll", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#stopAll", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#stopAll", "___id": "T000002R038018", "___s": true }, { "comment": "/**\r\n * Empty function for the No Audio Sound Manager.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#update\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 280, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Empty function for the No Audio Sound Manager.", "kind": "function", "name": "update", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#update", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#update", "___id": "T000002R038020", "___s": true }, { "comment": "/**\r\n * Empty function for the No Audio Sound Manager.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#setRate\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Sound Manager.\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Empty function for the No Audio Sound Manager.", "kind": "function", "name": "setRate", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound Manager." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#setRate", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#setRate", "___id": "T000002R038022", "___s": true }, { "comment": "/**\r\n * Empty function for the No Audio Sound Manager.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#setDetune\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Sound Manager.\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 298, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Empty function for the No Audio Sound Manager.", "kind": "function", "name": "setDetune", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound Manager." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#setDetune", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#setDetune", "___id": "T000002R038024", "___s": true }, { "comment": "/**\r\n * Empty function for the No Audio Sound Manager.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#setMute\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 308, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Empty function for the No Audio Sound Manager.", "kind": "function", "name": "setMute", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#setMute", "scope": "instance", "___id": "T000002R038026", "___s": true }, { "comment": "/**\r\n * Empty function for the No Audio Sound Manager.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#setVolume\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Empty function for the No Audio Sound Manager.", "kind": "function", "name": "setVolume", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#setVolume", "scope": "instance", "___id": "T000002R038028", "___s": true }, { "comment": "/**\r\n * Empty function for the No Audio Sound Manager.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#unlock\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 324, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Empty function for the No Audio Sound Manager.", "kind": "function", "name": "unlock", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#unlock", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#unlock", "___id": "T000002R038030", "___s": true }, { "comment": "/**\r\n * Destroys all the sounds in the game and all associated events.\r\n *\r\n * @method Phaser.Sound.NoAudioSoundManager#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NoAudioSoundManager.js", "lineno": 347, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\noaudio", "code": {} }, "description": "Destroys all the sounds in the game and all associated events.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "longname": "Phaser.Sound.NoAudioSoundManager#destroy", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#destroy", "___id": "T000002R038034", "___s": true }, { "comment": "/**\n * Creates a Web Audio, HTML5 Audio or No Audio Sound Manager based on config and device settings.\n *\n * Be aware of https://developers.google.com/web/updates/2017/09/autoplay-policy-changes\n *\n * @function Phaser.Sound.SoundManagerCreator\n * @since 3.0.0\n *\n * @param {Phaser.Game} game - Reference to the current game instance.\n *\n * @return {(Phaser.Sound.HTML5AudioSoundManager|Phaser.Sound.WebAudioSoundManager|Phaser.Sound.NoAudioSoundManager)} The Sound Manager instance that was created.\n */", "meta": { "filename": "SoundManagerCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "description": "Creates a Web Audio, HTML5 Audio or No Audio Sound Manager based on config and device settings.\n\nBe aware of https://developers.google.com/web/updates/2017/09/autoplay-policy-changes", "kind": "function", "name": "SoundManagerCreator", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "Reference to the current game instance.", "name": "game" } ], "returns": [ { "type": { "names": [ "Phaser.Sound.HTML5AudioSoundManager", "Phaser.Sound.WebAudioSoundManager", "Phaser.Sound.NoAudioSoundManager" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSoundManager" }, { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSoundManager" }, { "type": "NameExpression", "name": "Phaser.Sound.NoAudioSoundManager" } ] } }, "description": "The Sound Manager instance that was created." } ], "memberof": "Phaser.Sound", "longname": "Phaser.Sound.SoundManagerCreator", "scope": "static", "___id": "T000002R038040", "___s": true }, { "comment": "/**\n * Audio sprite sound type.\n *\n * @typedef {object} Phaser.Types.Sound.AudioSpriteSound\n * @since 3.0.0\n *\n * @property {object} spritemap - Local reference to 'spritemap' object form json file generated by audiosprite tool.\n */", "meta": { "filename": "AudioSpriteSound.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\typedefs", "code": {} }, "description": "Audio sprite sound type.", "kind": "typedef", "name": "AudioSpriteSound", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "Local reference to 'spritemap' object form json file generated by audiosprite tool.", "name": "spritemap" } ], "memberof": "Phaser.Types.Sound", "longname": "Phaser.Types.Sound.AudioSpriteSound", "scope": "static", "___id": "T000002R038046", "___s": true }, { "comment": "/**\n * A Audio Data object.\n * \n * You can pass an array of these objects to the WebAudioSoundManager `decodeAudio` method to have it decode\n * them all at once.\n *\n * @typedef {object} Phaser.Types.Sound.DecodeAudioConfig\n * @since 3.18.0\n *\n * @property {string} key - The string-based key to be used to reference the decoded audio in the audio cache.\n * @property {(ArrayBuffer|string)} data - The audio data, either a base64 encoded string, an audio media-type data uri, or an ArrayBuffer instance.\n */", "meta": { "filename": "DecodeAudioConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\typedefs", "code": {} }, "description": "A Audio Data object.\n\nYou can pass an array of these objects to the WebAudioSoundManager `decodeAudio` method to have it decode\nthem all at once.", "kind": "typedef", "name": "DecodeAudioConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.18.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based key to be used to reference the decoded audio in the audio cache.", "name": "key" }, { "type": { "names": [ "ArrayBuffer", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "ArrayBuffer" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The audio data, either a base64 encoded string, an audio media-type data uri, or an ArrayBuffer instance.", "name": "data" } ], "memberof": "Phaser.Types.Sound", "longname": "Phaser.Types.Sound.DecodeAudioConfig", "scope": "static", "___id": "T000002R038047", "___s": true }, { "comment": "/**\n * @callback Phaser.Types.Sound.EachActiveSoundCallback\n * @since 3.0.0\n *\n * @param {Phaser.Sound.BaseSoundManager} manager - The SoundManager\n * @param {Phaser.Sound.BaseSound} sound - The current active Sound\n * @param {number} index - The index of the current active Sound\n * @param {Phaser.Sound.BaseSound[]} sounds - All sounds\n */", "meta": { "filename": "EachActiveSoundCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\typedefs", "code": {} }, "kind": "typedef", "name": "EachActiveSoundCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.BaseSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSoundManager" } }, "description": "The SoundManager", "name": "manager" }, { "type": { "names": [ "Phaser.Sound.BaseSound" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSound" } }, "description": "The current active Sound", "name": "sound" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the current active Sound", "name": "index" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Sound.BaseSound", "type": "NameExpression" } ] } }, "description": "All sounds", "name": "sounds" } ], "memberof": "Phaser.Types.Sound", "longname": "Phaser.Types.Sound.EachActiveSoundCallback", "scope": "static", "___id": "T000002R038048", "___s": true }, { "comment": "/**\n * @namespace Phaser.Types.Sound\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\typedefs", "code": {} }, "kind": "namespace", "name": "Sound", "memberof": "Phaser.Types", "longname": "Phaser.Types.Sound", "scope": "static", "___id": "T000002R038049", "___s": true }, { "comment": "/**\r\n * Config object containing various sound settings.\r\n *\r\n * @typedef {object} Phaser.Types.Sound.SoundConfig\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} [mute=false] - Boolean indicating whether the sound should be muted or not.\r\n * @property {number} [volume=1] - A value between 0 (silence) and 1 (full volume).\r\n * @property {number} [rate=1] - Defines the speed at which the sound should be played.\r\n * @property {number} [detune=0] - Represents detuning of sound in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\r\n * @property {number} [seek=0] - Position of playback for this sound, in seconds.\r\n * @property {boolean} [loop=false] - Whether or not the sound or current sound marker should loop.\r\n * @property {number} [delay=0] - Time, in seconds, that should elapse before the sound actually starts its playback.\r\n * @property {number} [pan=0] - A value between -1 (full left pan) and 1 (full right pan). 0 means no pan.\r\n * @property {Phaser.Types.Sound.SpatialSoundConfig} [source=null] - An optional config object containing default spatial sound settings.\r\n */", "meta": { "filename": "SoundConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\typedefs", "code": {} }, "description": "Config object containing various sound settings.", "kind": "typedef", "name": "SoundConfig", "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": "Boolean indicating whether the sound should be muted or not.", "name": "mute" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "A value between 0 (silence) and 1 (full volume).", "name": "volume" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Defines the speed at which the sound should be played.", "name": "rate" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Represents detuning of sound in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).", "name": "detune" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Position of playback for this sound, in seconds.", "name": "seek" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether or not the sound or current sound marker should loop.", "name": "loop" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Time, in seconds, that should elapse before the sound actually starts its playback.", "name": "delay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "A value between -1 (full left pan) and 1 (full right pan). 0 means no pan.", "name": "pan" }, { "type": { "names": [ "Phaser.Types.Sound.SpatialSoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SpatialSoundConfig" } }, "optional": true, "defaultvalue": null, "description": "An optional config object containing default spatial sound settings.", "name": "source" } ], "memberof": "Phaser.Types.Sound", "longname": "Phaser.Types.Sound.SoundConfig", "scope": "static", "___id": "T000002R038050", "___s": true }, { "comment": "/**\n * Marked section of a sound represented by name, and optionally start time, duration, and config object.\n *\n * @typedef {object} Phaser.Types.Sound.SoundMarker\n * @since 3.0.0\n *\n * @property {string} name - Unique identifier of a sound marker.\n * @property {number} [start=0] - Sound position offset at witch playback should start.\n * @property {number} [duration] - Playback duration of this marker.\n * @property {Phaser.Types.Sound.SoundConfig} [config] - An optional config object containing default marker settings.\n */", "meta": { "filename": "SoundMarker.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\typedefs", "code": {} }, "description": "Marked section of a sound represented by name, and optionally start time, duration, and config object.", "kind": "typedef", "name": "SoundMarker", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Unique identifier of a sound marker.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Sound position offset at witch playback should start.", "name": "start" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Playback duration of this marker.", "name": "duration" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "An optional config object containing default marker settings.", "name": "config" } ], "memberof": "Phaser.Types.Sound", "longname": "Phaser.Types.Sound.SoundMarker", "scope": "static", "___id": "T000002R038051", "___s": true }, { "comment": "/**\r\n * Config object containing settings for the source of the spatial sound.\r\n *\r\n * See https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Web_audio_spatialization_basics\r\n *\r\n * @typedef {object} Phaser.Types.Sound.SpatialSoundConfig\r\n * @since 3.60.0\r\n *\r\n * @property {number} [x=0] - The horizontal position of the audio in a right-hand Cartesian coordinate system.\r\n * @property {number} [y=0] - The vertical position of the audio in a right-hand Cartesian coordinate system.\r\n * @property {number} [z=0] - Represents the longitudinal (back and forth) position of the audio in a right-hand Cartesian coordinate system.\r\n * @property {('equalpower'|'HRTF')} [panningModel='equalpower'] - An enumerated value determining which spatialization algorithm to use to position the audio in 3D space.\r\n * @property {('linear'|'inverse'|'exponential')} [distanceModel='inverse'] - Which algorithm to use to reduce the volume of the audio source as it moves away from the listener. Possible values are \"linear\", \"inverse\" and \"exponential\". The default value is \"inverse\".\r\n * @property {number} [orientationX=0] - The horizontal position of the audio source's vector in a right-hand Cartesian coordinate system.\r\n * @property {number} [orientationY=0] - The vertical position of the audio source's vector in a right-hand Cartesian coordinate system.\r\n * @property {number} [orientationZ=-1] - Represents the longitudinal (back and forth) position of the audio source's vector in a right-hand Cartesian coordinate system.\r\n * @property {number} [refDistance=1] - A double value representing the reference distance for reducing volume as the audio source moves further from the listener. For distances greater than this the volume will be reduced based on `rolloffFactor` and `distanceModel`.\r\n * @property {number} [maxDistance=10000] - The maximum distance between the audio source and the listener, after which the volume is not reduced any further.\r\n * @property {number} [rolloffFactor=1] - A double value describing how quickly the volume is reduced as the source moves away from the listener. This value is used by all distance models.\r\n * @property {number} [coneInnerAngle=360] - The angle, in degrees, of a cone inside of which there will be no volume reduction.\r\n * @property {number} [coneOuterAngle=0] - The angle, in degrees, of a cone outside of which the volume will be reduced by a constant value, defined by the `coneOuterGain` property.\r\n * @property {number} [coneOuterGain=0] - The amount of volume reduction outside the cone defined by the `coneOuterAngle` attribute. Its default value is 0, meaning that no sound can be heard. A value between 0 and 1.\r\n * @property {Phaser.Types.Math.Vector2Like} [follow] - Set this Sound object to automatically track the x/y position of this object. Can be a Phaser Game Object, Vec2 or anything that exposes public x/y properties.\r\n */", "meta": { "filename": "SpatialSoundConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\typedefs", "code": {} }, "description": "Config object containing settings for the source of the spatial sound.\r\rSee https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Web_audio_spatialization_basics", "kind": "typedef", "name": "SpatialSoundConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the audio in a right-hand Cartesian coordinate system.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the audio in a right-hand Cartesian coordinate system.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Represents the longitudinal (back and forth) position of the audio in a right-hand Cartesian coordinate system.", "name": "z" }, { "type": { "names": [ "'equalpower'", "'HRTF'" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "'equalpower'" }, { "type": "NameExpression", "name": "'HRTF'" } ] } }, "optional": true, "defaultvalue": "'equalpower'", "description": "An enumerated value determining which spatialization algorithm to use to position the audio in 3D space.", "name": "panningModel" }, { "type": { "names": [ "'linear'", "'inverse'", "'exponential'" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "'linear'" }, { "type": "NameExpression", "name": "'inverse'" }, { "type": "NameExpression", "name": "'exponential'" } ] } }, "optional": true, "defaultvalue": "'inverse'", "description": "Which algorithm to use to reduce the volume of the audio source as it moves away from the listener. Possible values are \"linear\", \"inverse\" and \"exponential\". The default value is \"inverse\".", "name": "distanceModel" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the audio source's vector in a right-hand Cartesian coordinate system.", "name": "orientationX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the audio source's vector in a right-hand Cartesian coordinate system.", "name": "orientationY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": -1, "description": "Represents the longitudinal (back and forth) position of the audio source's vector in a right-hand Cartesian coordinate system.", "name": "orientationZ" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "A double value representing the reference distance for reducing volume as the audio source moves further from the listener. For distances greater than this the volume will be reduced based on `rolloffFactor` and `distanceModel`.", "name": "refDistance" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10000, "description": "The maximum distance between the audio source and the listener, after which the volume is not reduced any further.", "name": "maxDistance" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "A double value describing how quickly the volume is reduced as the source moves away from the listener. This value is used by all distance models.", "name": "rolloffFactor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 360, "description": "The angle, in degrees, of a cone inside of which there will be no volume reduction.", "name": "coneInnerAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The angle, in degrees, of a cone outside of which the volume will be reduced by a constant value, defined by the `coneOuterGain` property.", "name": "coneOuterAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount of volume reduction outside the cone defined by the `coneOuterAngle` attribute. Its default value is 0, meaning that no sound can be heard. A value between 0 and 1.", "name": "coneOuterGain" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "Set this Sound object to automatically track the x/y position of this object. Can be a Phaser Game Object, Vec2 or anything that exposes public x/y properties.", "name": "follow" } ], "memberof": "Phaser.Types.Sound", "longname": "Phaser.Types.Sound.SpatialSoundConfig", "scope": "static", "___id": "T000002R038052", "___s": true }, { "comment": "/**\r\n * An entry in the Web Audio Decoding Queue.\r\n *\r\n * @typedef {object} Phaser.Types.Sound.WebAudioDecodeEntry\r\n * @since 3.60.0\r\n *\r\n * @property {string} key - The key of the sound.\r\n * @property {function} success - The callback to invoke on successful decoding.\r\n * @property {function} failure - The callback to invoke if the decoding fails.\r\n * @property {boolean} decoding - Has the decoding of this sound file started?\r\n */", "meta": { "filename": "WebAudioDecodeEntry.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\typedefs", "code": {} }, "description": "An entry in the Web Audio Decoding Queue.", "kind": "typedef", "name": "WebAudioDecodeEntry", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the sound.", "name": "key" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke on successful decoding.", "name": "success" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke if the decoding fails.", "name": "failure" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Has the decoding of this sound file started?", "name": "decoding" } ], "memberof": "Phaser.Types.Sound", "longname": "Phaser.Types.Sound.WebAudioDecodeEntry", "scope": "static", "___id": "T000002R038053", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Web Audio API implementation of the sound.\r\n *\r\n * @class WebAudioSound\r\n * @extends Phaser.Sound.BaseSound\r\n * @memberof Phaser.Sound\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Sound.WebAudioSoundManager} manager - Reference to the WebAudio Sound Manager that owns this Sound instance.\r\n * @param {string} key - Asset key for the sound.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config={}] - An optional config object containing default sound settings.\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "classdesc": "Web Audio API implementation of the sound.", "kind": "class", "name": "WebAudioSound", "augments": [ "Phaser.Sound.BaseSound" ], "memberof": "Phaser.Sound", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Sound.WebAudioSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSoundManager" } }, "description": "Reference to the WebAudio Sound Manager that owns this Sound instance.", "name": "manager" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "defaultvalue": "{}", "description": "An optional config object containing default sound settings.", "name": "config" } ], "scope": "static", "longname": "Phaser.Sound.WebAudioSound", "___id": "T000002R038058", "___s": true }, { "comment": "/**\r\n * Audio buffer containing decoded data of the audio asset to be played.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#audioBuffer\r\n * @type {AudioBuffer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 37, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Audio buffer containing decoded data of the audio asset to be played.", "name": "audioBuffer", "type": { "names": [ "AudioBuffer" ], "parsedType": { "type": "NameExpression", "name": "AudioBuffer" } }, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#audioBuffer", "scope": "instance", "kind": "member", "___id": "T000002R038063", "___s": true }, { "comment": "/**\r\n * A reference to an audio source node used for playing back audio from\r\n * audio data stored in Phaser.Sound.WebAudioSound#audioBuffer.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#source\r\n * @type {AudioBufferSourceNode}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 51, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "A reference to an audio source node used for playing back audio from\raudio data stored in Phaser.Sound.WebAudioSound#audioBuffer.", "name": "source", "type": { "names": [ "AudioBufferSourceNode" ], "parsedType": { "type": "NameExpression", "name": "AudioBufferSourceNode" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#source", "scope": "instance", "kind": "member", "___id": "T000002R038065", "___s": true }, { "comment": "/**\r\n * A reference to a second audio source used for gapless looped playback.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#loopSource\r\n * @type {AudioBufferSourceNode}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "A reference to a second audio source used for gapless looped playback.", "name": "loopSource", "type": { "names": [ "AudioBufferSourceNode" ], "parsedType": { "type": "NameExpression", "name": "AudioBufferSourceNode" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#loopSource", "scope": "instance", "kind": "member", "___id": "T000002R038067", "___s": true }, { "comment": "/**\r\n * Gain node responsible for controlling this sound's muting.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#muteNode\r\n * @type {GainNode}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Gain node responsible for controlling this sound's muting.", "name": "muteNode", "type": { "names": [ "GainNode" ], "parsedType": { "type": "NameExpression", "name": "GainNode" } }, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#muteNode", "scope": "instance", "kind": "member", "___id": "T000002R038069", "___s": true }, { "comment": "/**\r\n * Gain node responsible for controlling this sound's volume.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#volumeNode\r\n * @type {GainNode}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 81, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Gain node responsible for controlling this sound's volume.", "name": "volumeNode", "type": { "names": [ "GainNode" ], "parsedType": { "type": "NameExpression", "name": "GainNode" } }, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#volumeNode", "scope": "instance", "kind": "member", "___id": "T000002R038071", "___s": true }, { "comment": "/**\r\n * Panner node responsible for controlling this sound's pan.\r\n *\r\n * Doesn't work on iOS / Safari.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#pannerNode\r\n * @type {StereoPannerNode}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 90, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Panner node responsible for controlling this sound's pan.\r\rDoesn't work on iOS / Safari.", "name": "pannerNode", "type": { "names": [ "StereoPannerNode" ], "parsedType": { "type": "NameExpression", "name": "StereoPannerNode" } }, "since": "3.50.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#pannerNode", "scope": "instance", "kind": "member", "___id": "T000002R038073", "___s": true }, { "comment": "/**\r\n * The Stereo Spatial Panner node.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#spatialNode\r\n * @type {PannerNode}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 101, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "The Stereo Spatial Panner node.", "name": "spatialNode", "type": { "names": [ "PannerNode" ], "parsedType": { "type": "NameExpression", "name": "PannerNode" } }, "since": "3.60.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#spatialNode", "scope": "instance", "kind": "member", "___id": "T000002R038075", "___s": true }, { "comment": "/**\r\n * If the Spatial Panner node has been set to track a vector or\r\n * Game Object, this retains a reference to it.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#spatialSource\r\n * @type {Phaser.Types.Math.Vector2Like}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "If the Spatial Panner node has been set to track a vector or\rGame Object, this retains a reference to it.", "name": "spatialSource", "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "since": "3.60.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#spatialSource", "scope": "instance", "kind": "member", "___id": "T000002R038077", "___s": true }, { "comment": "/**\r\n * The time at which the sound should have started playback from the beginning.\r\n *\r\n * Treat this property as read-only.\r\n *\r\n * Based on `BaseAudioContext.currentTime` value.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#playTime\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "The time at which the sound should have started playback from the beginning.\r\rTreat this property as read-only.\r\rBased on `BaseAudioContext.currentTime` value.", "name": "playTime", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#playTime", "scope": "instance", "kind": "member", "___id": "T000002R038079", "___s": true }, { "comment": "/**\r\n * The time at which the sound source should have actually started playback.\r\n *\r\n * Treat this property as read-only.\r\n *\r\n * Based on `BaseAudioContext.currentTime` value.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#startTime\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 134, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "The time at which the sound source should have actually started playback.\r\rTreat this property as read-only.\r\rBased on `BaseAudioContext.currentTime` value.", "name": "startTime", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#startTime", "scope": "instance", "kind": "member", "___id": "T000002R038081", "___s": true }, { "comment": "/**\r\n * The time at which the sound loop source should actually start playback.\r\n *\r\n * Based on `BaseAudioContext.currentTime` value.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#loopTime\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "The time at which the sound loop source should actually start playback.\r\rBased on `BaseAudioContext.currentTime` value.", "name": "loopTime", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#loopTime", "scope": "instance", "kind": "member", "___id": "T000002R038083", "___s": true }, { "comment": "/**\r\n * An array where we keep track of all rate updates during playback.\r\n *\r\n * Treat this property as read-only.\r\n *\r\n * Array of object types: `{ time: number, rate: number }`\r\n *\r\n * @name Phaser.Sound.WebAudioSound#rateUpdates\r\n * @type {array}\r\n * @default []\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "An array where we keep track of all rate updates during playback.\r\rTreat this property as read-only.\r\rArray of object types: `{ time: number, rate: number }`", "name": "rateUpdates", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#rateUpdates", "scope": "instance", "kind": "member", "___id": "T000002R038085", "___s": true }, { "comment": "/**\r\n * Used for keeping track when sound source playback has ended\r\n * so its state can be updated accordingly.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#hasEnded\r\n * @type {boolean}\r\n * @readonly\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Used for keeping track when sound source playback has ended\rso its state can be updated accordingly.", "name": "hasEnded", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#hasEnded", "scope": "instance", "kind": "member", "___id": "T000002R038087", "___s": true }, { "comment": "/**\r\n * Used for keeping track when sound source has looped\r\n * so its state can be updated accordingly.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#hasLooped\r\n * @type {boolean}\r\n * @readonly\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Used for keeping track when sound source has looped\rso its state can be updated accordingly.", "name": "hasLooped", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#hasLooped", "scope": "instance", "kind": "member", "___id": "T000002R038089", "___s": true }, { "comment": "/**\r\n * Play this sound, or a marked section of it.\r\n *\r\n * It always plays the sound from the start. If you want to start playback from a specific time\r\n * you can set 'seek' setting of the config object, provided to this call, to that value.\r\n *\r\n * If you want to play the same sound simultaneously, then you need to create another instance\r\n * of it and play that Sound.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#play\r\n * @fires Phaser.Sound.Events#PLAY\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Sound.SoundConfig)} [markerName=''] - If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config] - Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.\r\n *\r\n * @return {boolean} Whether the sound started playing successfully.\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 238, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Play this sound, or a marked section of it.\r\rIt always plays the sound from the start. If you want to start playback from a specific time\ryou can set 'seek' setting of the config object, provided to this call, to that value.\r\rIf you want to play the same sound simultaneously, then you need to create another instance\rof it and play that Sound.", "kind": "function", "name": "play", "fires": [ "Phaser.Sound.Events#event:PLAY" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } ] } }, "optional": true, "defaultvalue": "''", "description": "If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.", "name": "markerName" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.", "name": "config" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound started playing successfully." } ], "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#play", "scope": "instance", "overrides": "Phaser.Sound.BaseSound#play", "___id": "T000002R038095", "___s": true }, { "comment": "/**\r\n * Pauses the sound.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#pause\r\n * @fires Phaser.Sound.Events#PAUSE\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} Whether the sound was paused successfully.\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Pauses the sound.", "kind": "function", "name": "pause", "fires": [ "Phaser.Sound.Events#event:PAUSE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound was paused successfully." } ], "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#pause", "scope": "instance", "overrides": "Phaser.Sound.BaseSound#pause", "___id": "T000002R038097", "___s": true }, { "comment": "/**\r\n * Resumes the sound.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#resume\r\n * @fires Phaser.Sound.Events#RESUME\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} Whether the sound was resumed successfully.\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 302, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Resumes the sound.", "kind": "function", "name": "resume", "fires": [ "Phaser.Sound.Events#event:RESUME" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound was resumed successfully." } ], "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#resume", "scope": "instance", "overrides": "Phaser.Sound.BaseSound#resume", "___id": "T000002R038100", "___s": true }, { "comment": "/**\r\n * Stop playing this sound.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#stop\r\n * @fires Phaser.Sound.Events#STOP\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} Whether the sound was stopped successfully.\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 331, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Stop playing this sound.", "kind": "function", "name": "stop", "fires": [ "Phaser.Sound.Events#event:STOP" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound was stopped successfully." } ], "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#stop", "scope": "instance", "overrides": "Phaser.Sound.BaseSound#stop", "___id": "T000002R038102", "___s": true }, { "comment": "/**\r\n * This method is only used internally and it creates a looping buffer source.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#createAndStartLoopBufferSource\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 381, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "This method is only used internally and it creates a looping buffer source.", "kind": "function", "name": "createAndStartLoopBufferSource", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#createAndStartLoopBufferSource", "scope": "instance", "___id": "T000002R038114", "___s": true }, { "comment": "/**\r\n * This method is only used internally and it creates a buffer source.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#createBufferSource\r\n * @since 3.0.0\r\n *\r\n * @return {AudioBufferSourceNode}\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 399, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "This method is only used internally and it creates a buffer source.", "kind": "function", "name": "createBufferSource", "since": "3.0.0", "returns": [ { "type": { "names": [ "AudioBufferSourceNode" ], "parsedType": { "type": "NameExpression", "name": "AudioBufferSourceNode" } } } ], "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#createBufferSource", "scope": "instance", "___id": "T000002R038121", "___s": true }, { "comment": "/**\r\n * This method is only used internally and it stops and removes a buffer source.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#stopAndRemoveBufferSource\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "This method is only used internally and it stops and removes a buffer source.", "kind": "function", "name": "stopAndRemoveBufferSource", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#stopAndRemoveBufferSource", "scope": "instance", "___id": "T000002R038129", "___s": true }, { "comment": "/**\r\n * This method is only used internally and it stops and removes a looping buffer source.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#stopAndRemoveLoopBufferSource\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 458, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "This method is only used internally and it stops and removes a looping buffer source.", "kind": "function", "name": "stopAndRemoveLoopBufferSource", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#stopAndRemoveLoopBufferSource", "scope": "instance", "___id": "T000002R038134", "___s": true }, { "comment": "/**\r\n * Method used internally for applying config values to some of the sound properties.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#applyConfig\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 476, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Method used internally for applying config values to some of the sound properties.", "kind": "function", "name": "applyConfig", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#applyConfig", "scope": "instance", "overrides": "Phaser.Sound.BaseSound#applyConfig", "___id": "T000002R038138", "___s": true }, { "comment": "/**\r\n * Sets the x position of this Sound in Spatial Audio space.\r\n *\r\n * This only has any effect if the sound was created with a SpatialSoundConfig object.\r\n *\r\n * Also see the `WebAudioSoundManager.setListenerPosition` method.\r\n *\r\n * If you find that the sound becomes too quiet, too quickly, as it moves away from\r\n * the listener, then try different `refDistance` property values when configuring\r\n * the spatial sound.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#x\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 522, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Sets the x position of this Sound in Spatial Audio space.\r\rThis only has any effect if the sound was created with a SpatialSoundConfig object.\r\rAlso see the `WebAudioSoundManager.setListenerPosition` method.\r\rIf you find that the sound becomes too quiet, too quickly, as it moves away from\rthe listener, then try different `refDistance` property values when configuring\rthe spatial sound.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#x", "scope": "instance", "kind": "member", "___id": "T000002R038160", "___s": true }, { "comment": "/**\r\n * Sets the y position of this Sound in Spatial Audio space.\r\n *\r\n * This only has any effect if the sound was created with a SpatialSoundConfig object.\r\n *\r\n * Also see the `WebAudioSoundManager.setListenerPosition` method.\r\n *\r\n * If you find that the sound becomes too quiet, too quickly, as it moves away from\r\n * the listener, then try different `refDistance` property values when configuring\r\n * the spatial sound.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#y\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 560, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Sets the y position of this Sound in Spatial Audio space.\r\rThis only has any effect if the sound was created with a SpatialSoundConfig object.\r\rAlso see the `WebAudioSoundManager.setListenerPosition` method.\r\rIf you find that the sound becomes too quiet, too quickly, as it moves away from\rthe listener, then try different `refDistance` property values when configuring\rthe spatial sound.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#y", "scope": "instance", "kind": "member", "___id": "T000002R038165", "___s": true }, { "comment": "/**\r\n * Update method called automatically by sound manager on every game step.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#update\r\n * @fires Phaser.Sound.Events#COMPLETE\r\n * @fires Phaser.Sound.Events#LOOPED\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 598, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Update method called automatically by sound manager on every game step.", "kind": "function", "name": "update", "fires": [ "Phaser.Sound.Events#event:COMPLETE", "Phaser.Sound.Events#event:LOOPED" ], "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#update", "scope": "instance", "overrides": "Phaser.Sound.BaseSound#update", "___id": "T000002R038170", "___s": true }, { "comment": "/**\r\n * Calls Phaser.Sound.BaseSound#destroy method\r\n * and cleans up all Web Audio API related stuff.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 652, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Calls Phaser.Sound.BaseSound#destroy method\rand cleans up all Web Audio API related stuff.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#destroy", "scope": "instance", "overrides": "Phaser.Sound.BaseSound#destroy", "___id": "T000002R038187", "___s": true }, { "comment": "/**\r\n * Method used internally to calculate total playback rate of the sound.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#calculateRate\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 692, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Method used internally to calculate total playback rate of the sound.", "kind": "function", "name": "calculateRate", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#calculateRate", "scope": "instance", "overrides": "Phaser.Sound.BaseSound#calculateRate", "___id": "T000002R038197", "___s": true }, { "comment": "/**\r\n * Method used internally for calculating current playback time of a playing sound.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#getCurrentTime\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 724, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Method used internally for calculating current playback time of a playing sound.", "kind": "function", "name": "getCurrentTime", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#getCurrentTime", "scope": "instance", "___id": "T000002R038202", "___s": true }, { "comment": "/**\r\n * Method used internally for calculating the time\r\n * at witch the loop source should start playing.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#getLoopTime\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 753, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Method used internally for calculating the time\rat witch the loop source should start playing.", "kind": "function", "name": "getLoopTime", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#getLoopTime", "scope": "instance", "___id": "T000002R038210", "___s": true }, { "comment": "/**\r\n * Rate at which this Sound will be played.\r\n * Value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\r\n * and 2.0 doubles the audios playback speed.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#rate\r\n * @type {number}\r\n * @default 1\r\n * @fires Phaser.Sound.Events#RATE\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 774, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Rate at which this Sound will be played.\rValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\rand 2.0 doubles the audios playback speed.", "name": "rate", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "fires": [ "Phaser.Sound.Events#event:RATE" ], "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#rate", "scope": "instance", "kind": "member", "___id": "T000002R038216", "___s": true }, { "comment": "/**\r\n * Sets the playback rate of this Sound.\r\n *\r\n * For example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\r\n * and 2.0 doubles the audios playback speed.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#setRate\r\n * @fires Phaser.Sound.Events#RATE\r\n * @since 3.3.0\r\n *\r\n * @param {number} value - The playback rate at of this Sound.\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 803, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Sets the playback rate of this Sound.\r\rFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\rand 2.0 doubles the audios playback speed.", "kind": "function", "name": "setRate", "fires": [ "Phaser.Sound.Events#event:RATE" ], "since": "3.3.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The playback rate at of this Sound.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#setRate", "scope": "instance", "___id": "T000002R038221", "___s": true }, { "comment": "/**\r\n * The detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\r\n * The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @name Phaser.Sound.WebAudioSound#detune\r\n * @type {number}\r\n * @default 0\r\n * @fires Phaser.Sound.Events#DETUNE\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 824, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "The detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\rThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "name": "detune", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "fires": [ "Phaser.Sound.Events#event:DETUNE" ], "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#detune", "scope": "instance", "kind": "member", "___id": "T000002R038224", "___s": true }, { "comment": "/**\r\n * Sets the detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\r\n * The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @method Phaser.Sound.WebAudioSound#setDetune\r\n * @fires Phaser.Sound.Events#DETUNE\r\n * @since 3.3.0\r\n *\r\n * @param {number} value - The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 852, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Sets the detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\rThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "kind": "function", "name": "setDetune", "fires": [ "Phaser.Sound.Events#event:DETUNE" ], "since": "3.3.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#setDetune", "scope": "instance", "___id": "T000002R038229", "___s": true }, { "comment": "/**\r\n * Boolean indicating whether the sound is muted or not.\r\n * Gets or sets the muted state of this sound.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#mute\r\n * @type {boolean}\r\n * @default false\r\n * @fires Phaser.Sound.Events#MUTE\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 871, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Boolean indicating whether the sound is muted or not.\rGets or sets the muted state of this sound.", "name": "mute", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "fires": [ "Phaser.Sound.Events#event:MUTE" ], "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#mute", "scope": "instance", "kind": "member", "___id": "T000002R038232", "___s": true }, { "comment": "/**\r\n * Sets the muted state of this Sound.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#setMute\r\n * @fires Phaser.Sound.Events#MUTE\r\n * @since 3.4.0\r\n *\r\n * @param {boolean} value - `true` to mute this sound, `false` to unmute it.\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 898, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Sets the muted state of this Sound.", "kind": "function", "name": "setMute", "fires": [ "Phaser.Sound.Events#event:MUTE" ], "since": "3.4.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to mute this sound, `false` to unmute it.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#setMute", "scope": "instance", "___id": "T000002R038237", "___s": true }, { "comment": "/**\r\n * Gets or sets the volume of this sound, a value between 0 (silence) and 1 (full volume).\r\n *\r\n * @name Phaser.Sound.WebAudioSound#volume\r\n * @type {number}\r\n * @default 1\r\n * @fires Phaser.Sound.Events#VOLUME\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 916, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Gets or sets the volume of this sound, a value between 0 (silence) and 1 (full volume).", "name": "volume", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "fires": [ "Phaser.Sound.Events#event:VOLUME" ], "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#volume", "scope": "instance", "kind": "member", "___id": "T000002R038240", "___s": true }, { "comment": "/**\r\n * Sets the volume of this Sound.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#setVolume\r\n * @fires Phaser.Sound.Events#VOLUME\r\n * @since 3.4.0\r\n *\r\n * @param {number} value - The volume of the sound.\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 941, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Sets the volume of this Sound.", "kind": "function", "name": "setVolume", "fires": [ "Phaser.Sound.Events#event:VOLUME" ], "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The volume of the sound.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#setVolume", "scope": "instance", "___id": "T000002R038245", "___s": true }, { "comment": "/**\r\n * Property representing the position of playback for this sound, in seconds.\r\n * Setting it to a specific value moves current playback to that position.\r\n * The value given is clamped to the range 0 to current marker duration.\r\n * Setting seek of a stopped sound has no effect.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#seek\r\n * @type {number}\r\n * @fires Phaser.Sound.Events#SEEK\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Property representing the position of playback for this sound, in seconds.\rSetting it to a specific value moves current playback to that position.\rThe value given is clamped to the range 0 to current marker duration.\rSetting seek of a stopped sound has no effect.", "name": "seek", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "fires": [ "Phaser.Sound.Events#event:SEEK" ], "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#seek", "scope": "instance", "kind": "member", "___id": "T000002R038248", "___s": true }, { "comment": "/**\r\n * Seeks to a specific point in this sound.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#setSeek\r\n * @fires Phaser.Sound.Events#SEEK\r\n * @since 3.4.0\r\n *\r\n * @param {number} value - The point in the sound to seek to.\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 1017, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Seeks to a specific point in this sound.", "kind": "function", "name": "setSeek", "fires": [ "Phaser.Sound.Events#event:SEEK" ], "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The point in the sound to seek to.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#setSeek", "scope": "instance", "___id": "T000002R038254", "___s": true }, { "comment": "/**\r\n * Flag indicating whether or not the sound or current sound marker will loop.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#loop\r\n * @type {boolean}\r\n * @default false\r\n * @fires Phaser.Sound.Events#LOOP\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 1035, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Flag indicating whether or not the sound or current sound marker will loop.", "name": "loop", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "fires": [ "Phaser.Sound.Events#event:LOOP" ], "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#loop", "scope": "instance", "kind": "member", "___id": "T000002R038257", "___s": true }, { "comment": "/**\r\n * Sets the loop state of this Sound.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#setLoop\r\n * @fires Phaser.Sound.Events#LOOP\r\n * @since 3.4.0\r\n *\r\n * @param {boolean} value - `true` to loop this sound, `false` to not loop it.\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 1069, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Sets the loop state of this Sound.", "kind": "function", "name": "setLoop", "fires": [ "Phaser.Sound.Events#event:LOOP" ], "since": "3.4.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to loop this sound, `false` to not loop it.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#setLoop", "scope": "instance", "___id": "T000002R038262", "___s": true }, { "comment": "/**\r\n * Gets or sets the pan of this sound, a value between -1 (full left pan) and 1 (full right pan).\r\n *\r\n * Always returns zero on iOS / Safari as it doesn't support the stereo panner node.\r\n *\r\n * @name Phaser.Sound.WebAudioSound#pan\r\n * @type {number}\r\n * @default 0\r\n * @fires Phaser.Sound.Events#PAN\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 1087, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Gets or sets the pan of this sound, a value between -1 (full left pan) and 1 (full right pan).\r\rAlways returns zero on iOS / Safari as it doesn't support the stereo panner node.", "name": "pan", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "fires": [ "Phaser.Sound.Events#event:PAN" ], "since": "3.50.0", "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#pan", "scope": "instance", "kind": "member", "___id": "T000002R038265", "___s": true }, { "comment": "/**\r\n * Sets the pan of this sound, a value between -1 (full left pan) and 1 (full right pan).\r\n *\r\n * Note: iOS / Safari doesn't support the stereo panner node.\r\n *\r\n * @method Phaser.Sound.WebAudioSound#setPan\r\n * @fires Phaser.Sound.Events#PAN\r\n * @since 3.50.0\r\n *\r\n * @param {number} value - The pan of the sound. A value between -1 (full left pan) and 1 (full right pan).\r\n *\r\n * @return {this} This Sound instance.\r\n */", "meta": { "filename": "WebAudioSound.js", "lineno": 1125, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Sets the pan of this sound, a value between -1 (full left pan) and 1 (full right pan).\r\rNote: iOS / Safari doesn't support the stereo panner node.", "kind": "function", "name": "setPan", "fires": [ "Phaser.Sound.Events#event:PAN" ], "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The pan of the sound. A value between -1 (full left pan) and 1 (full right pan).", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound instance." } ], "memberof": "Phaser.Sound.WebAudioSound", "longname": "Phaser.Sound.WebAudioSound#setPan", "scope": "instance", "___id": "T000002R038270", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Web Audio API implementation of the Sound Manager.\r\n *\r\n * Not all browsers can play all audio formats.\r\n *\r\n * There is a good guide to what's supported: [Cross-browser audio basics: Audio codec support](https://developer.mozilla.org/en-US/Apps/Fundamentals/Audio_and_video_delivery/Cross-browser_audio_basics#Audio_Codec_Support).\r\n *\r\n * @class WebAudioSoundManager\r\n * @extends Phaser.Sound.BaseSoundManager\r\n * @memberof Phaser.Sound\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - Reference to the current game instance.\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "classdesc": "Web Audio API implementation of the Sound Manager.\r\rNot all browsers can play all audio formats.\r\rThere is a good guide to what's supported: [Cross-browser audio basics: Audio codec support](https://developer.mozilla.org/en-US/Apps/Fundamentals/Audio_and_video_delivery/Cross-browser_audio_basics#Audio_Codec_Support).", "kind": "class", "name": "WebAudioSoundManager", "augments": [ "Phaser.Sound.BaseSoundManager" ], "memberof": "Phaser.Sound", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "Reference to the current game instance.", "name": "game" } ], "scope": "static", "longname": "Phaser.Sound.WebAudioSoundManager", "___id": "T000002R038281", "___s": true }, { "comment": "/**\r\n * The AudioContext being used for playback.\r\n *\r\n * @name Phaser.Sound.WebAudioSoundManager#context\r\n * @type {AudioContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 40, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "The AudioContext being used for playback.", "name": "context", "type": { "names": [ "AudioContext" ], "parsedType": { "type": "NameExpression", "name": "AudioContext" } }, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#context", "scope": "instance", "kind": "member", "___id": "T000002R038285", "___s": true }, { "comment": "/**\r\n * Gain node responsible for controlling global muting.\r\n *\r\n * @name Phaser.Sound.WebAudioSoundManager#masterMuteNode\r\n * @type {GainNode}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Gain node responsible for controlling global muting.", "name": "masterMuteNode", "type": { "names": [ "GainNode" ], "parsedType": { "type": "NameExpression", "name": "GainNode" } }, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#masterMuteNode", "scope": "instance", "kind": "member", "___id": "T000002R038287", "___s": true }, { "comment": "/**\r\n * Gain node responsible for controlling global volume.\r\n *\r\n * @name Phaser.Sound.WebAudioSoundManager#masterVolumeNode\r\n * @type {GainNode}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Gain node responsible for controlling global volume.", "name": "masterVolumeNode", "type": { "names": [ "GainNode" ], "parsedType": { "type": "NameExpression", "name": "GainNode" } }, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#masterVolumeNode", "scope": "instance", "kind": "member", "___id": "T000002R038289", "___s": true }, { "comment": "/**\r\n * Destination node for connecting individual sounds to.\r\n *\r\n * @name Phaser.Sound.WebAudioSoundManager#destination\r\n * @type {AudioNode}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 71, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Destination node for connecting individual sounds to.", "name": "destination", "type": { "names": [ "AudioNode" ], "parsedType": { "type": "NameExpression", "name": "AudioNode" } }, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#destination", "scope": "instance", "kind": "member", "___id": "T000002R038291", "___s": true }, { "comment": "/**\r\n * Method responsible for instantiating and returning AudioContext instance.\r\n * If an instance of an AudioContext class was provided through the game config,\r\n * that instance will be returned instead. This can come in handy if you are reloading\r\n * a Phaser game on a page that never properly refreshes (such as in an SPA project)\r\n * and you want to reuse already instantiated AudioContext.\r\n *\r\n * @method Phaser.Sound.WebAudioSoundManager#createAudioContext\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - Reference to the current game instance.\r\n *\r\n * @return {AudioContext} The AudioContext instance to be used for playback.\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 94, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Method responsible for instantiating and returning AudioContext instance.\rIf an instance of an AudioContext class was provided through the game config,\rthat instance will be returned instead. This can come in handy if you are reloading\ra Phaser game on a page that never properly refreshes (such as in an SPA project)\rand you want to reuse already instantiated AudioContext.", "kind": "function", "name": "createAudioContext", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "Reference to the current game instance.", "name": "game" } ], "returns": [ { "type": { "names": [ "AudioContext" ], "parsedType": { "type": "NameExpression", "name": "AudioContext" } }, "description": "The AudioContext instance to be used for playback." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#createAudioContext", "scope": "instance", "___id": "T000002R038294", "___s": true }, { "comment": "/**\r\n * This method takes a new AudioContext reference and then sets\r\n * this Sound Manager to use that context for all playback.\r\n *\r\n * As part of this call it also disconnects the master mute and volume\r\n * nodes and then re-creates them on the new given context.\r\n *\r\n * @method Phaser.Sound.WebAudioSoundManager#setAudioContext\r\n * @since 3.21.0\r\n *\r\n * @param {AudioContext} context - Reference to an already created AudioContext instance.\r\n *\r\n * @return {this} The WebAudioSoundManager instance.\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "This method takes a new AudioContext reference and then sets\rthis Sound Manager to use that context for all playback.\r\rAs part of this call it also disconnects the master mute and volume\rnodes and then re-creates them on the new given context.", "kind": "function", "name": "setAudioContext", "since": "3.21.0", "params": [ { "type": { "names": [ "AudioContext" ], "parsedType": { "type": "NameExpression", "name": "AudioContext" } }, "description": "Reference to an already created AudioContext instance.", "name": "context" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The WebAudioSoundManager instance." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#setAudioContext", "scope": "instance", "___id": "T000002R038297", "___s": true }, { "comment": "/**\r\n * Adds a new sound into the sound manager.\r\n *\r\n * @method Phaser.Sound.WebAudioSoundManager#add\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - Asset key for the sound.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config] - An optional config object containing default sound settings.\r\n *\r\n * @return {Phaser.Sound.WebAudioSound} The new sound instance.\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 173, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Adds a new sound into the sound manager.", "kind": "function", "name": "add", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "An optional config object containing default sound settings.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Sound.WebAudioSound" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" } }, "description": "The new sound instance." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#add", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#add", "___id": "T000002R038303", "___s": true }, { "comment": "/**\r\n * Decode audio data into a format ready for playback via Web Audio.\r\n *\r\n * The audio data can be a base64 encoded string, an audio media-type data uri, or an ArrayBuffer instance.\r\n *\r\n * The `audioKey` is the key that will be used to save the decoded audio to the audio cache.\r\n *\r\n * Instead of passing a single entry you can instead pass an array of `Phaser.Types.Sound.DecodeAudioConfig`\r\n * objects as the first and only argument.\r\n *\r\n * Decoding is an async process, so be sure to listen for the events to know when decoding has completed.\r\n *\r\n * Once the audio has decoded it can be added to the Sound Manager or played via its key.\r\n *\r\n * @method Phaser.Sound.WebAudioSoundManager#decodeAudio\r\n * @fires Phaser.Sound.Events#DECODED\r\n * @fires Phaser.Sound.Events#DECODED_ALL\r\n * @since 3.18.0\r\n *\r\n * @param {(Phaser.Types.Sound.DecodeAudioConfig[]|string)} [audioKey] - The string-based key to be used to reference the decoded audio in the audio cache, or an array of audio config objects.\r\n * @param {(ArrayBuffer|string)} [audioData] - The audio data, either a base64 encoded string, an audio media-type data uri, or an ArrayBuffer instance.\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 193, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Decode audio data into a format ready for playback via Web Audio.\r\rThe audio data can be a base64 encoded string, an audio media-type data uri, or an ArrayBuffer instance.\r\rThe `audioKey` is the key that will be used to save the decoded audio to the audio cache.\r\rInstead of passing a single entry you can instead pass an array of `Phaser.Types.Sound.DecodeAudioConfig`\robjects as the first and only argument.\r\rDecoding is an async process, so be sure to listen for the events to know when decoding has completed.\r\rOnce the audio has decoded it can be added to the Sound Manager or played via its key.", "kind": "function", "name": "decodeAudio", "fires": [ "Phaser.Sound.Events#event:DECODED", "Phaser.Sound.Events#event:DECODED_ALL" ], "since": "3.18.0", "params": [ { "type": { "names": [ "Array.", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Sound.DecodeAudioConfig", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The string-based key to be used to reference the decoded audio in the audio cache, or an array of audio config objects.", "name": "audioKey" }, { "type": { "names": [ "ArrayBuffer", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "ArrayBuffer" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The audio data, either a base64 encoded string, an audio media-type data uri, or an ArrayBuffer instance.", "name": "audioData" } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#decodeAudio", "scope": "instance", "___id": "T000002R038306", "___s": true }, { "comment": "/**\r\n * Sets the X and Y position of the Spatial Audio listener on this Web Audios context.\r\n *\r\n * If you call this method with no parameters it will default to the center-point of\r\n * the game canvas. Depending on the type of game you're making, you may need to call\r\n * this method constantly to reset the listener position as the camera scrolls.\r\n *\r\n * Calling this method does nothing on HTML5Audio.\r\n *\r\n * @method Phaser.Sound.WebAudioSoundManager#setListenerPosition\r\n * @since 3.60.0\r\n *\r\n * @param {number} [x] - The x position of the Spatial Audio listener.\r\n * @param {number} [y] - The y position of the Spatial Audio listener.\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 274, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Sets the X and Y position of the Spatial Audio listener on this Web Audios context.\r\rIf you call this method with no parameters it will default to the center-point of\rthe game canvas. Depending on the type of game you're making, you may need to call\rthis method constantly to reset the listener position as the camera scrolls.\r\rCalling this method does nothing on HTML5Audio.", "kind": "function", "name": "setListenerPosition", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The x position of the Spatial Audio listener.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y position of the Spatial Audio listener.", "name": "y" } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#setListenerPosition", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#setListenerPosition", "___id": "T000002R038322", "___s": true }, { "comment": "/**\r\n * Unlocks Web Audio API on the initial input event.\r\n *\r\n * Read more about how this issue is handled here in [this article](https://medium.com/@pgoloskokovic/unlocking-web-audio-the-smarter-way-8858218c0e09).\r\n *\r\n * @method Phaser.Sound.WebAudioSoundManager#unlock\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Unlocks Web Audio API on the initial input event.\r\rRead more about how this issue is handled here in [this article](https://medium.com/@pgoloskokovic/unlocking-web-audio-the-smarter-way-8858218c0e09).", "kind": "function", "name": "unlock", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#unlock", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#unlock", "___id": "T000002R038326", "___s": true }, { "comment": "/**\r\n * Method used internally for pausing sound manager if\r\n * Phaser.Sound.WebAudioSoundManager#pauseOnBlur is set to true.\r\n *\r\n * @method Phaser.Sound.WebAudioSoundManager#onBlur\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 346, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Method used internally for pausing sound manager if\rPhaser.Sound.WebAudioSoundManager#pauseOnBlur is set to true.", "kind": "function", "name": "onBlur", "access": "protected", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#onBlur", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#onBlur", "___id": "T000002R038333", "___s": true }, { "comment": "/**\r\n * Method used internally for resuming sound manager if\r\n * Phaser.Sound.WebAudioSoundManager#pauseOnBlur is set to true.\r\n *\r\n * @method Phaser.Sound.WebAudioSoundManager#onFocus\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 362, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Method used internally for resuming sound manager if\rPhaser.Sound.WebAudioSoundManager#pauseOnBlur is set to true.", "kind": "function", "name": "onFocus", "access": "protected", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#onFocus", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#onFocus", "___id": "T000002R038335", "___s": true }, { "comment": "/**\r\n * Update method called on every game step.\r\n *\r\n * Removes destroyed sounds and updates every active sound in the game.\r\n *\r\n * @method Phaser.Sound.WebAudioSoundManager#update\r\n * @protected\r\n * @fires Phaser.Sound.Events#UNLOCKED\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 elapsed since the last frame.\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Update method called on every game step.\r\rRemoves destroyed sounds and updates every active sound in the game.", "kind": "function", "name": "update", "access": "protected", "fires": [ "Phaser.Sound.Events#event:UNLOCKED" ], "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 elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#update", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#update", "___id": "T000002R038338", "___s": true }, { "comment": "/**\r\n * Calls Phaser.Sound.BaseSoundManager#destroy method\r\n * and cleans up all Web Audio API related stuff.\r\n *\r\n * @method Phaser.Sound.WebAudioSoundManager#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 421, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Calls Phaser.Sound.BaseSoundManager#destroy method\rand cleans up all Web Audio API related stuff.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#destroy", "scope": "instance", "overrides": "Phaser.Sound.BaseSoundManager#destroy", "___id": "T000002R038347", "___s": true }, { "comment": "/**\r\n * Sets the muted state of all this Sound Manager.\r\n *\r\n * @method Phaser.Sound.WebAudioSoundManager#setMute\r\n * @fires Phaser.Sound.Events#GLOBAL_MUTE\r\n * @since 3.3.0\r\n *\r\n * @param {boolean} value - `true` to mute all sounds, `false` to unmute them.\r\n *\r\n * @return {Phaser.Sound.WebAudioSoundManager} This Sound Manager.\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 453, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Sets the muted state of all this Sound Manager.", "kind": "function", "name": "setMute", "fires": [ "Phaser.Sound.Events#event:GLOBAL_MUTE" ], "since": "3.3.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to mute all sounds, `false` to unmute them.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Sound.WebAudioSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSoundManager" } }, "description": "This Sound Manager." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#setMute", "scope": "instance", "___id": "T000002R038354", "___s": true }, { "comment": "/**\r\n * @name Phaser.Sound.WebAudioSoundManager#mute\r\n * @type {boolean}\r\n * @fires Phaser.Sound.Events#GLOBAL_MUTE\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 471, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "name": "mute", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "fires": [ "Phaser.Sound.Events#event:GLOBAL_MUTE" ], "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#mute", "scope": "instance", "kind": "member", "overrides": "Phaser.Sound.BaseSoundManager#mute", "___id": "T000002R038357", "___s": true }, { "comment": "/**\r\n * Sets the volume of this Sound Manager.\r\n *\r\n * @method Phaser.Sound.WebAudioSoundManager#setVolume\r\n * @fires Phaser.Sound.Events#GLOBAL_VOLUME\r\n * @since 3.3.0\r\n *\r\n * @param {number} value - The global volume of this Sound Manager.\r\n *\r\n * @return {Phaser.Sound.WebAudioSoundManager} This Sound Manager.\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 493, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "description": "Sets the volume of this Sound Manager.", "kind": "function", "name": "setVolume", "fires": [ "Phaser.Sound.Events#event:GLOBAL_VOLUME" ], "since": "3.3.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The global volume of this Sound Manager.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Sound.WebAudioSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSoundManager" } }, "description": "This Sound Manager." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#setVolume", "scope": "instance", "___id": "T000002R038361", "___s": true }, { "comment": "/**\r\n * @name Phaser.Sound.WebAudioSoundManager#volume\r\n * @type {number}\r\n * @fires Phaser.Sound.Events#GLOBAL_VOLUME\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebAudioSoundManager.js", "lineno": 511, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound\\webaudio", "code": {} }, "name": "volume", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "fires": [ "Phaser.Sound.Events#event:GLOBAL_VOLUME" ], "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "longname": "Phaser.Sound.WebAudioSoundManager#volume", "scope": "instance", "kind": "member", "overrides": "Phaser.Sound.BaseSoundManager#volume", "___id": "T000002R038364", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Structs.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Structs", "longname": "Phaser.Structs.Events", "scope": "static", "___id": "T000002R038369", "___s": true }, { "comment": "/**\r\n * The Process Queue Add Event.\r\n *\r\n * This event is dispatched by a Process Queue when a new item is successfully moved to its active list.\r\n *\r\n * You will most commonly see this used by a Scene's Update List when a new Game Object has been added.\r\n *\r\n * In that instance, listen to this event from within a Scene using: `this.sys.updateList.on('add', listener)`.\r\n *\r\n * @event Phaser.Structs.Events#PROCESS_QUEUE_ADD\r\n * @type {string}\r\n * @since 3.20.0\r\n *\r\n * @param {*} item - The item that was added to the Process Queue.\r\n */", "meta": { "filename": "PROCESS_QUEUE_ADD_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs\\events", "code": {} }, "description": "The Process Queue Add Event.\r\rThis event is dispatched by a Process Queue when a new item is successfully moved to its active list.\r\rYou will most commonly see this used by a Scene's Update List when a new Game Object has been added.\r\rIn that instance, listen to this event from within a Scene using: `this.sys.updateList.on('add', listener)`.", "kind": "event", "name": "PROCESS_QUEUE_ADD", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item that was added to the Process Queue.", "name": "item" } ], "memberof": "Phaser.Structs.Events", "longname": "Phaser.Structs.Events#event:PROCESS_QUEUE_ADD", "scope": "instance", "___id": "T000002R038373", "___s": true }, { "comment": "/**\r\n * The Process Queue Remove Event.\r\n *\r\n * This event is dispatched by a Process Queue when a new item is successfully removed from its active list.\r\n *\r\n * You will most commonly see this used by a Scene's Update List when a Game Object has been removed.\r\n *\r\n * In that instance, listen to this event from within a Scene using: `this.sys.updateList.on('remove', listener)`.\r\n *\r\n * @event Phaser.Structs.Events#PROCESS_QUEUE_REMOVE\r\n * @type {string}\r\n * @since 3.20.0\r\n *\r\n * @param {*} item - The item that was removed from the Process Queue.\r\n */", "meta": { "filename": "PROCESS_QUEUE_REMOVE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs\\events", "code": {} }, "description": "The Process Queue Remove Event.\r\rThis event is dispatched by a Process Queue when a new item is successfully removed from its active list.\r\rYou will most commonly see this used by a Scene's Update List when a Game Object has been removed.\r\rIn that instance, listen to this event from within a Scene using: `this.sys.updateList.on('remove', listener)`.", "kind": "event", "name": "PROCESS_QUEUE_REMOVE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item that was removed from the Process Queue.", "name": "item" } ], "memberof": "Phaser.Structs.Events", "longname": "Phaser.Structs.Events#event:PROCESS_QUEUE_REMOVE", "scope": "instance", "___id": "T000002R038375", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Structs\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "kind": "namespace", "name": "Structs", "memberof": "Phaser", "longname": "Phaser.Structs", "scope": "static", "___id": "T000002R038377", "___s": true }, { "comment": "/**\r\n * @callback EachListCallback\r\n *\r\n * @param {I} item - The item which is currently being processed.\r\n * @param {...*} [args] - Additional arguments that will be passed to the callback, after the child.\r\n */", "meta": { "filename": "List.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "kind": "typedef", "name": "EachListCallback", "type": { "names": [ "function" ] }, "params": [ { "type": { "names": [ "I" ], "parsedType": { "type": "NameExpression", "name": "I" } }, "description": "The item which is currently being processed.", "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": "EachListCallback", "scope": "global", "___id": "T000002R038390", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * List is a generic implementation of an ordered list which contains utility methods for retrieving, manipulating, and iterating items.\r\n *\r\n * @class List\r\n * @memberof Phaser.Structs\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @generic T\r\n *\r\n * @param {*} parent - The parent of this list.\r\n */", "meta": { "filename": "List.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "classdesc": "List is a generic implementation of an ordered list which contains utility methods for retrieving, manipulating, and iterating items.", "kind": "class", "name": "List", "memberof": "Phaser.Structs", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The parent of this list.", "name": "parent" } ], "scope": "static", "longname": "Phaser.Structs.List", "___id": "T000002R038391", "___s": true }, { "comment": "/**\r\n * The parent of this list.\r\n *\r\n * @name Phaser.Structs.List#parent\r\n * @type {*}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "List.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The parent of this list.", "name": "parent", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#parent", "scope": "instance", "kind": "member", "___id": "T000002R038394", "___s": true }, { "comment": "/**\r\n * The objects that belong to this collection.\r\n *\r\n * @genericUse {T[]} - [$type]\r\n *\r\n * @name Phaser.Structs.List#list\r\n * @type {Array.<*>}\r\n * @default []\r\n * @since 3.0.0\r\n */", "meta": { "filename": "List.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The objects that belong to this collection.", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [$type]", "value": "{T[]} - [$type]" } ], "name": "list", "type": { "names": [ "Array.<*>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "AllLiteral" } ] } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#list", "scope": "instance", "kind": "member", "___id": "T000002R038396", "___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 #get}, and {@link #previous} properties.\r\n *\r\n * @name Phaser.Structs.List#position\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "List.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "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 #get}, and {@link #previous} properties.", "name": "position", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#position", "scope": "instance", "kind": "member", "___id": "T000002R038398", "___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.Structs.List#addCallback\r\n * @type {function}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "List.js", "lineno": 71, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "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.Structs.List", "longname": "Phaser.Structs.List#addCallback", "scope": "instance", "kind": "member", "___id": "T000002R038400", "___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.Structs.List#removeCallback\r\n * @type {function}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "List.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "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.Structs.List", "longname": "Phaser.Structs.List#removeCallback", "scope": "instance", "kind": "member", "___id": "T000002R038402", "___s": true }, { "comment": "/**\r\n * The property key to sort by.\r\n *\r\n * @name Phaser.Structs.List#_sortKey\r\n * @type {string}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "List.js", "lineno": 89, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The property key to sort by.", "name": "_sortKey", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.4.0", "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#_sortKey", "scope": "instance", "kind": "member", "___id": "T000002R038404", "___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.Structs.List#add\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [child,$return]\r\n *\r\n * @param {*|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": "List.js", "lineno": 99, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "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", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child,$return]", "value": "{T} - [child,$return]" } ], "params": [ { "type": { "names": [ "*", "Array.<*>" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "AllLiteral" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "AllLiteral" } ] } ] } }, "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.Structs.List", "longname": "Phaser.Structs.List#add", "scope": "instance", "___id": "T000002R038406", "___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.Structs.List#addAt\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [child,$return]\r\n *\r\n * @param {*} 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 {*} The List's underlying array.\r\n */", "meta": { "filename": "List.js", "lineno": 124, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "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", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child,$return]", "value": "{T} - [child,$return]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The List's underlying array." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#addAt", "scope": "instance", "___id": "T000002R038408", "___s": true }, { "comment": "/**\r\n * Retrieves the item at a given position inside the List.\r\n *\r\n * @method Phaser.Structs.List#getAt\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [$return]\r\n *\r\n * @param {number} index - The index of the item.\r\n *\r\n * @return {*} The retrieved item, or `undefined` if it's outside the List's bounds.\r\n */", "meta": { "filename": "List.js", "lineno": 150, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Retrieves the item at a given position inside the List.", "kind": "function", "name": "getAt", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$return]", "value": "{T} - [$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the item.", "name": "index" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The retrieved item, or `undefined` if it's outside the List's bounds." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#getAt", "scope": "instance", "___id": "T000002R038410", "___s": true }, { "comment": "/**\r\n * Locates an item within the List and returns its index.\r\n *\r\n * @method Phaser.Structs.List#getIndex\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [child]\r\n *\r\n * @param {*} 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": "List.js", "lineno": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Locates an item within the List and returns its index.", "kind": "function", "name": "getIndex", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child]", "value": "{T} - [child]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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.Structs.List", "longname": "Phaser.Structs.List#getIndex", "scope": "instance", "___id": "T000002R038412", "___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.Structs.List#sort\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T[]} - [children,$return]\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 boolean.\r\n *\r\n * @return {Phaser.Structs.List} This List object.\r\n */", "meta": { "filename": "List.js", "lineno": 185, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "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", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [children,$return]", "value": "{T[]} - [children,$return]" } ], "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 boolean.", "name": "handler" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.List" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.List" } }, "description": "This List object." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#sort", "scope": "instance", "___id": "T000002R038414", "___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.Structs.List#getByName\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T | null} - [$return]\r\n *\r\n * @param {string} name - The name to search for.\r\n *\r\n * @return {?*} The first child with a matching name, or null if none were found.\r\n */", "meta": { "filename": "List.js", "lineno": 219, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "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", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T | null} - [$return]", "value": "{T | null} - [$return]" } ], "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to search for.", "name": "name" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "nullable": true } }, "nullable": true, "description": "The first child with a matching name, or null if none were found." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#getByName", "scope": "instance", "___id": "T000002R038417", "___s": true }, { "comment": "/**\r\n * Returns a random child from the group.\r\n *\r\n * @method Phaser.Structs.List#getRandom\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T | null} - [$return]\r\n *\r\n * @param {number} [startIndex=0] - Offset from the front of the group (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 {?*} A random child of this Group.\r\n */", "meta": { "filename": "List.js", "lineno": 238, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Returns a random child from the group.", "kind": "function", "name": "getRandom", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T | null} - [$return]", "value": "{T | null} - [$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Offset from the front of the group (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": [ "*" ], "parsedType": { "type": "AllLiteral", "nullable": true } }, "nullable": true, "description": "A random child of this Group." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#getRandom", "scope": "instance", "___id": "T000002R038419", "___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.Structs.List#getFirst\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T | null} - [$return]\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 {*} 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 {?*} The first item which matches the given criterion, or `null` if no such item exists.\r\n */", "meta": { "filename": "List.js", "lineno": 256, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "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", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T | null} - [$return]", "value": "{T | null} - [$return]" } ], "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": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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": [ "*" ], "parsedType": { "type": "AllLiteral", "nullable": true } }, "nullable": true, "description": "The first item which matches the given criterion, or `null` if no such item exists." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#getFirst", "scope": "instance", "___id": "T000002R038421", "___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.Structs.List#getAll\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T[]} - [$return]\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": "List.js", "lineno": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "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", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [$return]", "value": "{T[]} - [$return]" } ], "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": "AllLiteral" } ] } }, "description": "All items of the List which match the given criterion, if any." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#getAll", "scope": "instance", "___id": "T000002R038423", "___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.Structs.List#count\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [value]\r\n *\r\n * @param {string} property - The property to test on each item.\r\n * @param {*} value - The value to test the property against.\r\n *\r\n * @return {number} The total number of matching elements.\r\n */", "meta": { "filename": "List.js", "lineno": 308, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "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", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [value]", "value": "{T} - [value]" } ], "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property to test on each item.", "name": "property" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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.Structs.List", "longname": "Phaser.Structs.List#count", "scope": "instance", "___id": "T000002R038425", "___s": true }, { "comment": "/**\r\n * Swaps the positions of two items in the list.\r\n *\r\n * @method Phaser.Structs.List#swap\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [child1,child2]\r\n *\r\n * @param {*} child1 - The first item to swap.\r\n * @param {*} child2 - The second item to swap.\r\n */", "meta": { "filename": "List.js", "lineno": 326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Swaps the positions of two items in the list.", "kind": "function", "name": "swap", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child1,child2]", "value": "{T} - [child1,child2]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The first item to swap.", "name": "child1" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The second item to swap.", "name": "child2" } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#swap", "scope": "instance", "___id": "T000002R038427", "___s": true }, { "comment": "/**\r\n * Moves an item in the List to a new position.\r\n *\r\n * @method Phaser.Structs.List#moveTo\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [child,$return]\r\n *\r\n * @param {*} child - The item to move.\r\n * @param {number} index - Moves an item in the List to a new position.\r\n *\r\n * @return {*} The item that was moved.\r\n */", "meta": { "filename": "List.js", "lineno": 342, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Moves an item in the List to a new position.", "kind": "function", "name": "moveTo", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child,$return]", "value": "{T} - [child,$return]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item to move.", "name": "child" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Moves an item in the List to a new position.", "name": "index" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item that was moved." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#moveTo", "scope": "instance", "___id": "T000002R038429", "___s": true }, { "comment": "/**\r\n * Moves the given array element above another one in the array.\r\n *\r\n * @method Phaser.Structs.List#moveAbove\r\n * @since 3.55.0\r\n *\r\n * @genericUse {T} - [child1,child2]\r\n *\r\n * @param {*} child1 - The element to move above base element.\r\n * @param {*} child2 - The base element.\r\n */", "meta": { "filename": "List.js", "lineno": 360, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Moves the given array element above another one in the array.", "kind": "function", "name": "moveAbove", "since": "3.55.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child1,child2]", "value": "{T} - [child1,child2]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The element to move above base element.", "name": "child1" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The base element.", "name": "child2" } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#moveAbove", "scope": "instance", "___id": "T000002R038431", "___s": true }, { "comment": "/**\r\n * Moves the given array element below another one in the array.\r\n *\r\n * @method Phaser.Structs.List#moveBelow\r\n * @since 3.55.0\r\n *\r\n * @genericUse {T} - [child1,child2]\r\n *\r\n * @param {*} child1 - The element to move below base element.\r\n * @param {*} child2 - The base element.\r\n */", "meta": { "filename": "List.js", "lineno": 376, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Moves the given array element below another one in the array.", "kind": "function", "name": "moveBelow", "since": "3.55.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child1,child2]", "value": "{T} - [child1,child2]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The element to move below base element.", "name": "child1" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The base element.", "name": "child2" } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#moveBelow", "scope": "instance", "___id": "T000002R038433", "___s": true }, { "comment": "/**\r\n * Removes one or many items from the List.\r\n *\r\n * @method Phaser.Structs.List#remove\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [child,$return]\r\n *\r\n * @param {*} 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 {*} The item, or array of items, which were successfully removed from the List.\r\n */", "meta": { "filename": "List.js", "lineno": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Removes one or many items from the List.", "kind": "function", "name": "remove", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child,$return]", "value": "{T} - [child,$return]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item, or array of items, which were successfully removed from the List." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#remove", "scope": "instance", "___id": "T000002R038435", "___s": true }, { "comment": "/**\r\n * Removes the item at the given position in the List.\r\n *\r\n * @method Phaser.Structs.List#removeAt\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [$return]\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 {*} The item that was removed.\r\n */", "meta": { "filename": "List.js", "lineno": 417, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Removes the item at the given position in the List.", "kind": "function", "name": "removeAt", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$return]", "value": "{T} - [$return]" } ], "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": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item that was removed." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#removeAt", "scope": "instance", "___id": "T000002R038437", "___s": true }, { "comment": "/**\r\n * Removes the items within the given range in the List.\r\n *\r\n * @method Phaser.Structs.List#removeBetween\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T[]} - [$return]\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": "List.js", "lineno": 442, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Removes the items within the given range in the List.", "kind": "function", "name": "removeBetween", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [$return]", "value": "{T[]} - [$return]" } ], "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": "AllLiteral" } ] } }, "description": "An array of the items which were removed." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#removeBetween", "scope": "instance", "___id": "T000002R038439", "___s": true }, { "comment": "/**\r\n * Removes all the items.\r\n *\r\n * @method Phaser.Structs.List#removeAll\r\n * @since 3.0.0\r\n *\r\n * @genericUse {Phaser.Structs.List.} - [$return]\r\n *\r\n * @param {boolean} [skipCallback=false] - Skip calling the List.removeCallback.\r\n *\r\n * @return {Phaser.Structs.List} This List object.\r\n */", "meta": { "filename": "List.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Removes all the items.", "kind": "function", "name": "removeAll", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.List.} - [$return]", "value": "{Phaser.Structs.List.} - [$return]" } ], "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip calling the List.removeCallback.", "name": "skipCallback" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.List" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.List" } }, "description": "This List object." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#removeAll", "scope": "instance", "___id": "T000002R038441", "___s": true }, { "comment": "/**\r\n * Brings the given child to the top of this List.\r\n *\r\n * @method Phaser.Structs.List#bringToTop\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [child,$return]\r\n *\r\n * @param {*} child - The item to bring to the top of the List.\r\n *\r\n * @return {*} The item which was moved.\r\n */", "meta": { "filename": "List.js", "lineno": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Brings the given child to the top of this List.", "kind": "function", "name": "bringToTop", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child,$return]", "value": "{T} - [child,$return]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item to bring to the top of the List.", "name": "child" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item which was moved." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#bringToTop", "scope": "instance", "___id": "T000002R038444", "___s": true }, { "comment": "/**\r\n * Sends the given child to the bottom of this List.\r\n *\r\n * @method Phaser.Structs.List#sendToBack\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [child,$return]\r\n *\r\n * @param {*} child - The item to send to the back of the list.\r\n *\r\n * @return {*} The item which was moved.\r\n */", "meta": { "filename": "List.js", "lineno": 509, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Sends the given child to the bottom of this List.", "kind": "function", "name": "sendToBack", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child,$return]", "value": "{T} - [child,$return]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item to send to the back of the list.", "name": "child" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item which was moved." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#sendToBack", "scope": "instance", "___id": "T000002R038446", "___s": true }, { "comment": "/**\r\n * Moves the given child up one place in this group unless it's already at the top.\r\n *\r\n * @method Phaser.Structs.List#moveUp\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [child,$return]\r\n *\r\n * @param {*} child - The item to move up.\r\n *\r\n * @return {*} The item which was moved.\r\n */", "meta": { "filename": "List.js", "lineno": 526, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Moves the given child up one place in this group unless it's already at the top.", "kind": "function", "name": "moveUp", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child,$return]", "value": "{T} - [child,$return]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item to move up.", "name": "child" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item which was moved." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#moveUp", "scope": "instance", "___id": "T000002R038448", "___s": true }, { "comment": "/**\r\n * Moves the given child down one place in this group unless it's already at the bottom.\r\n *\r\n * @method Phaser.Structs.List#moveDown\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [child,$return]\r\n *\r\n * @param {*} child - The item to move down.\r\n *\r\n * @return {*} The item which was moved.\r\n */", "meta": { "filename": "List.js", "lineno": 545, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Moves the given child down one place in this group unless it's already at the bottom.", "kind": "function", "name": "moveDown", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child,$return]", "value": "{T} - [child,$return]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item to move down.", "name": "child" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item which was moved." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#moveDown", "scope": "instance", "___id": "T000002R038450", "___s": true }, { "comment": "/**\r\n * Reverses the order of all children in this List.\r\n *\r\n * @method Phaser.Structs.List#reverse\r\n * @since 3.0.0\r\n *\r\n * @genericUse {Phaser.Structs.List.} - [$return]\r\n *\r\n * @return {Phaser.Structs.List} This List object.\r\n */", "meta": { "filename": "List.js", "lineno": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Reverses the order of all children in this List.", "kind": "function", "name": "reverse", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.List.} - [$return]", "value": "{Phaser.Structs.List.} - [$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.List" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.List" } }, "description": "This List object." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#reverse", "scope": "instance", "___id": "T000002R038452", "___s": true }, { "comment": "/**\r\n * Shuffles the items in the list.\r\n *\r\n * @method Phaser.Structs.List#shuffle\r\n * @since 3.0.0\r\n *\r\n * @genericUse {Phaser.Structs.List.} - [$return]\r\n *\r\n * @return {Phaser.Structs.List} This List object.\r\n */", "meta": { "filename": "List.js", "lineno": 581, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Shuffles the items in the list.", "kind": "function", "name": "shuffle", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.List.} - [$return]", "value": "{Phaser.Structs.List.} - [$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.List" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.List" } }, "description": "This List object." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#shuffle", "scope": "instance", "___id": "T000002R038454", "___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.Structs.List#replace\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [oldChild,newChild,$return]\r\n *\r\n * @param {*} oldChild - The child in this List that will be replaced.\r\n * @param {*} newChild - The child to be inserted into this List.\r\n *\r\n * @return {*} Returns the oldChild that was replaced within this group.\r\n */", "meta": { "filename": "List.js", "lineno": 598, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "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", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [oldChild,newChild,$return]", "value": "{T} - [oldChild,newChild,$return]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The child in this List that will be replaced.", "name": "oldChild" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The child to be inserted into this List.", "name": "newChild" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "Returns the oldChild that was replaced within this group." } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#replace", "scope": "instance", "___id": "T000002R038456", "___s": true }, { "comment": "/**\r\n * Checks if an item exists within the List.\r\n *\r\n * @method Phaser.Structs.List#exists\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [child]\r\n *\r\n * @param {*} 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": "List.js", "lineno": 616, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Checks if an item exists within the List.", "kind": "function", "name": "exists", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child]", "value": "{T} - [child]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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.Structs.List", "longname": "Phaser.Structs.List#exists", "scope": "instance", "___id": "T000002R038458", "___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.Structs.List#setAll\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [value]\r\n *\r\n * @param {string} property - The name of the property to set.\r\n * @param {*} 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": "List.js", "lineno": 633, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Sets the property `key` to the given value on all members of this List.", "kind": "function", "name": "setAll", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [value]", "value": "{T} - [value]" } ], "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property to set.", "name": "property" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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.Structs.List", "longname": "Phaser.Structs.List#setAll", "scope": "instance", "___id": "T000002R038460", "___s": true }, { "comment": "/**\r\n * Passes all children to the given callback.\r\n *\r\n * @method Phaser.Structs.List#each\r\n * @since 3.0.0\r\n *\r\n * @genericUse {EachListCallback.} - [callback]\r\n *\r\n * @param {EachListCallback} 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 child.\r\n */", "meta": { "filename": "List.js", "lineno": 653, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Passes all children to the given callback.", "kind": "function", "name": "each", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{EachListCallback.} - [callback]", "value": "{EachListCallback.} - [callback]" } ], "params": [ { "type": { "names": [ "EachListCallback" ], "parsedType": { "type": "NameExpression", "name": "EachListCallback" } }, "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 child.", "name": "args" } ], "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#each", "scope": "instance", "___id": "T000002R038462", "___s": true }, { "comment": "/**\r\n * Clears the List and recreates its internal array.\r\n *\r\n * @method Phaser.Structs.List#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "List.js", "lineno": 682, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Clears the List and recreates its internal array.", "kind": "function", "name": "shutdown", "since": "3.0.0", "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#shutdown", "scope": "instance", "___id": "T000002R038468", "___s": true }, { "comment": "/**\r\n * Destroys this List.\r\n *\r\n * @method Phaser.Structs.List#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "List.js", "lineno": 695, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Destroys this List.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#destroy", "scope": "instance", "___id": "T000002R038471", "___s": true }, { "comment": "/**\r\n * The number of items inside the List.\r\n *\r\n * @name Phaser.Structs.List#length\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "List.js", "lineno": 710, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "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.Structs.List", "longname": "Phaser.Structs.List#length", "scope": "instance", "kind": "member", "___id": "T000002R038476", "___s": true }, { "comment": "/**\r\n * The first item in the List or `null` for an empty List.\r\n *\r\n * @name Phaser.Structs.List#first\r\n * @genericUse {T} - [$type]\r\n * @type {*}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "List.js", "lineno": 727, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The first item in the List or `null` for an empty List.", "name": "first", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$type]", "value": "{T} - [$type]" } ], "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#first", "scope": "instance", "kind": "member", "___id": "T000002R038479", "___s": true }, { "comment": "/**\r\n * The last item in the List, or `null` for an empty List.\r\n *\r\n * @name Phaser.Structs.List#last\r\n * @genericUse {T} - [$type]\r\n * @type {*}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "List.js", "lineno": 754, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The last item in the List, or `null` for an empty List.", "name": "last", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$type]", "value": "{T} - [$type]" } ], "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#last", "scope": "instance", "kind": "member", "___id": "T000002R038483", "___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.Structs.List#next\r\n * @genericUse {T} - [$type]\r\n * @type {*}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "List.js", "lineno": 781, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "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", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$type]", "value": "{T} - [$type]" } ], "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#next", "scope": "instance", "kind": "member", "___id": "T000002R038487", "___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.Structs.List#previous\r\n * @genericUse {T} - [$type]\r\n * @type {*}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "List.js", "lineno": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "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", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$type]", "value": "{T} - [$type]" } ], "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Structs.List", "longname": "Phaser.Structs.List#previous", "scope": "instance", "kind": "member", "___id": "T000002R038490", "___s": true }, { "comment": "/**\r\n * @callback EachMapCallback\r\n *\r\n * @param {string} key - The key of the Map entry.\r\n * @param {E} entry - The value of the Map entry.\r\n *\r\n * @return {?boolean} The callback result.\r\n */", "meta": { "filename": "Map.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "kind": "typedef", "name": "EachMapCallback", "type": { "names": [ "function" ] }, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Map entry.", "name": "key" }, { "type": { "names": [ "E" ], "parsedType": { "type": "NameExpression", "name": "E" } }, "description": "The value of the Map entry.", "name": "entry" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "nullable": true, "description": "The callback result." } ], "longname": "EachMapCallback", "scope": "global", "___id": "T000002R038495", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The keys of a Map can be arbitrary values.\r\n *\r\n * ```javascript\r\n * var map = new Map([\r\n * [ 1, 'one' ],\r\n * [ 2, 'two' ],\r\n * [ 3, 'three' ]\r\n * ]);\r\n * ```\r\n *\r\n * @class Map\r\n * @memberof Phaser.Structs\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @generic K\r\n * @generic V\r\n * @genericUse {V[]} - [elements]\r\n *\r\n * @param {Array.<*>} elements - An optional array of key-value pairs to populate this Map with.\r\n */", "meta": { "filename": "Map.js", "lineno": 18, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "classdesc": "The keys of a Map can be arbitrary values.\r\r```javascript\rvar map = new Map([\r [ 1, 'one' ],\r [ 2, 'two' ],\r [ 3, 'three' ]\r]);\r```", "kind": "class", "name": "Map", "memberof": "Phaser.Structs", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "K", "value": "K" }, { "originalTitle": "generic", "title": "generic", "text": "V", "value": "V" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{V[]} - [elements]", "value": "{V[]} - [elements]" } ], "params": [ { "type": { "names": [ "Array.<*>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "AllLiteral" } ] } }, "description": "An optional array of key-value pairs to populate this Map with.", "name": "elements" } ], "scope": "static", "longname": "Phaser.Structs.Map", "___id": "T000002R038496", "___s": true }, { "comment": "/**\r\n * The entries in this Map.\r\n *\r\n * @genericUse {Object.} - [$type]\r\n *\r\n * @name Phaser.Structs.Map#entries\r\n * @type {Object.}\r\n * @default {}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Map.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The entries in this Map.", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{Object.} - [$type]", "value": "{Object.} - [$type]" } ], "name": "entries", "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.Structs.Map", "longname": "Phaser.Structs.Map#entries", "scope": "instance", "kind": "member", "___id": "T000002R038499", "___s": true }, { "comment": "/**\r\n * The number of key / value pairs in this Map.\r\n *\r\n * @name Phaser.Structs.Map#size\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Map.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The number of key / value pairs in this Map.", "name": "size", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Structs.Map", "longname": "Phaser.Structs.Map#size", "scope": "instance", "kind": "member", "___id": "T000002R038501", "___s": true }, { "comment": "/**\r\n * Adds an element with a specified `key` and `value` to this Map.\r\n * If the `key` already exists, the value will be replaced.\r\n *\r\n * @method Phaser.Structs.Map#set\r\n * @since 3.0.0\r\n *\r\n * @genericUse {K} - [key]\r\n * @genericUse {V} - [value]\r\n * @genericUse {Phaser.Structs.Map.} - [$return]\r\n *\r\n * @param {string} key - The key of the element to be added to this Map.\r\n * @param {*} value - The value of the element to be added to this Map.\r\n *\r\n * @return {Phaser.Structs.Map} This Map object.\r\n */", "meta": { "filename": "Map.js", "lineno": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Adds an element with a specified `key` and `value` to this Map.\rIf the `key` already exists, the value will be replaced.", "kind": "function", "name": "set", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{K} - [key]", "value": "{K} - [key]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{V} - [value]", "value": "{V} - [value]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.Map.} - [$return]", "value": "{Phaser.Structs.Map.} - [$return]" } ], "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the element to be added to this Map.", "name": "key" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value of the element to be added to this Map.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.Map" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Map" } }, "description": "This Map object." } ], "memberof": "Phaser.Structs.Map", "longname": "Phaser.Structs.Map#set", "scope": "instance", "___id": "T000002R038504", "___s": true }, { "comment": "/**\r\n * Returns the value associated to the `key`, or `undefined` if there is none.\r\n *\r\n * @method Phaser.Structs.Map#get\r\n * @since 3.0.0\r\n *\r\n * @genericUse {K} - [key]\r\n * @genericUse {V} - [$return]\r\n *\r\n * @param {string} key - The key of the element to return from the `Map` object.\r\n *\r\n * @return {*} The element associated with the specified key or `undefined` if the key can't be found in this Map object.\r\n */", "meta": { "filename": "Map.js", "lineno": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Returns the value associated to the `key`, or `undefined` if there is none.", "kind": "function", "name": "get", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{K} - [key]", "value": "{K} - [key]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{V} - [$return]", "value": "{V} - [$return]" } ], "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the element to return from the `Map` object.", "name": "key" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The element associated with the specified key or `undefined` if the key can't be found in this Map object." } ], "memberof": "Phaser.Structs.Map", "longname": "Phaser.Structs.Map#get", "scope": "instance", "___id": "T000002R038507", "___s": true }, { "comment": "/**\r\n * Returns an `Array` of all the values stored in this Map.\r\n *\r\n * @method Phaser.Structs.Map#getArray\r\n * @since 3.0.0\r\n *\r\n * @genericUse {V[]} - [$return]\r\n *\r\n * @return {Array.<*>} An array of the values stored in this Map.\r\n */", "meta": { "filename": "Map.js", "lineno": 127, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Returns an `Array` of all the values stored in this Map.", "kind": "function", "name": "getArray", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{V[]} - [$return]", "value": "{V[]} - [$return]" } ], "returns": [ { "type": { "names": [ "Array.<*>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "AllLiteral" } ] } }, "description": "An array of the values stored in this Map." } ], "memberof": "Phaser.Structs.Map", "longname": "Phaser.Structs.Map#getArray", "scope": "instance", "___id": "T000002R038509", "___s": true }, { "comment": "/**\r\n * Returns a boolean indicating whether an element with the specified key exists or not.\r\n *\r\n * @method Phaser.Structs.Map#has\r\n * @since 3.0.0\r\n *\r\n * @genericUse {K} - [key]\r\n *\r\n * @param {string} key - The key of the element to test for presence of in this Map.\r\n *\r\n * @return {boolean} Returns `true` if an element with the specified key exists in this Map, otherwise `false`.\r\n */", "meta": { "filename": "Map.js", "lineno": 150, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Returns a boolean indicating whether an element with the specified key exists or not.", "kind": "function", "name": "has", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{K} - [key]", "value": "{K} - [key]" } ], "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the element to test for presence of in this Map.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `true` if an element with the specified key exists in this Map, otherwise `false`." } ], "memberof": "Phaser.Structs.Map", "longname": "Phaser.Structs.Map#has", "scope": "instance", "___id": "T000002R038514", "___s": true }, { "comment": "/**\r\n * Delete the specified element from this Map.\r\n *\r\n * @method Phaser.Structs.Map#delete\r\n * @since 3.0.0\r\n *\r\n * @genericUse {K} - [key]\r\n * @genericUse {Phaser.Structs.Map.} - [$return]\r\n *\r\n * @param {string} key - The key of the element to delete from this Map.\r\n *\r\n * @return {Phaser.Structs.Map} This Map object.\r\n */", "meta": { "filename": "Map.js", "lineno": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Delete the specified element from this Map.", "kind": "function", "name": "delete", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{K} - [key]", "value": "{K} - [key]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.Map.} - [$return]", "value": "{Phaser.Structs.Map.} - [$return]" } ], "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the element to delete from this Map.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.Map" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Map" } }, "description": "This Map object." } ], "memberof": "Phaser.Structs.Map", "longname": "Phaser.Structs.Map#delete", "scope": "instance", "___id": "T000002R038516", "___s": true }, { "comment": "/**\r\n * Delete all entries from this Map.\r\n *\r\n * @method Phaser.Structs.Map#clear\r\n * @since 3.0.0\r\n *\r\n * @genericUse {Phaser.Structs.Map.} - [$return]\r\n *\r\n * @return {Phaser.Structs.Map} This Map object.\r\n */", "meta": { "filename": "Map.js", "lineno": 191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Delete all entries from this Map.", "kind": "function", "name": "clear", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.Map.} - [$return]", "value": "{Phaser.Structs.Map.} - [$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.Map" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Map" } }, "description": "This Map object." } ], "memberof": "Phaser.Structs.Map", "longname": "Phaser.Structs.Map#clear", "scope": "instance", "___id": "T000002R038518", "___s": true }, { "comment": "/**\r\n * Returns all entries keys in this Map.\r\n *\r\n * @method Phaser.Structs.Map#keys\r\n * @since 3.0.0\r\n *\r\n * @genericUse {K[]} - [$return]\r\n *\r\n * @return {string[]} Array containing entries' keys.\r\n */", "meta": { "filename": "Map.js", "lineno": 214, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Returns all entries keys in this Map.", "kind": "function", "name": "keys", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{K[]} - [$return]", "value": "{K[]} - [$return]" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "Array containing entries' keys." } ], "memberof": "Phaser.Structs.Map", "longname": "Phaser.Structs.Map#keys", "scope": "instance", "___id": "T000002R038521", "___s": true }, { "comment": "/**\r\n * Returns an `Array` of all entries.\r\n *\r\n * @method Phaser.Structs.Map#values\r\n * @since 3.0.0\r\n *\r\n * @genericUse {V[]} - [$return]\r\n *\r\n * @return {Array.<*>} An `Array` of entries.\r\n */", "meta": { "filename": "Map.js", "lineno": 229, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Returns an `Array` of all entries.", "kind": "function", "name": "values", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{V[]} - [$return]", "value": "{V[]} - [$return]" } ], "returns": [ { "type": { "names": [ "Array.<*>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "AllLiteral" } ] } }, "description": "An `Array` of entries." } ], "memberof": "Phaser.Structs.Map", "longname": "Phaser.Structs.Map#values", "scope": "instance", "___id": "T000002R038523", "___s": true }, { "comment": "/**\r\n * Dumps the contents of this Map to the console via `console.group`.\r\n *\r\n * @method Phaser.Structs.Map#dump\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Map.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Dumps the contents of this Map to the console via `console.group`.", "kind": "function", "name": "dump", "since": "3.0.0", "memberof": "Phaser.Structs.Map", "longname": "Phaser.Structs.Map#dump", "scope": "instance", "___id": "T000002R038528", "___s": true }, { "comment": "/**\r\n * Iterates through all entries in this Map, passing each one to the given callback.\r\n *\r\n * If the callback returns `false`, the iteration will break.\r\n *\r\n * @method Phaser.Structs.Map#each\r\n * @since 3.0.0\r\n *\r\n * @genericUse {EachMapCallback.} - [callback]\r\n * @genericUse {Phaser.Structs.Map.} - [$return]\r\n *\r\n * @param {EachMapCallback} callback - The callback which will receive the keys and entries held in this Map.\r\n *\r\n * @return {Phaser.Structs.Map} This Map object.\r\n */", "meta": { "filename": "Map.js", "lineno": 274, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Iterates through all entries in this Map, passing each one to the given callback.\r\rIf the callback returns `false`, the iteration will break.", "kind": "function", "name": "each", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{EachMapCallback.} - [callback]", "value": "{EachMapCallback.} - [callback]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.Map.} - [$return]", "value": "{Phaser.Structs.Map.} - [$return]" } ], "params": [ { "type": { "names": [ "EachMapCallback" ], "parsedType": { "type": "NameExpression", "name": "EachMapCallback" } }, "description": "The callback which will receive the keys and entries held in this Map.", "name": "callback" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.Map" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Map" } }, "description": "This Map object." } ], "memberof": "Phaser.Structs.Map", "longname": "Phaser.Structs.Map#each", "scope": "instance", "___id": "T000002R038532", "___s": true }, { "comment": "/**\r\n * Returns `true` if the value exists within this Map. Otherwise, returns `false`.\r\n *\r\n * @method Phaser.Structs.Map#contains\r\n * @since 3.0.0\r\n *\r\n * @genericUse {V} - [value]\r\n *\r\n * @param {*} value - The value to search for.\r\n *\r\n * @return {boolean} `true` if the value is found, otherwise `false`.\r\n */", "meta": { "filename": "Map.js", "lineno": 304, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Returns `true` if the value exists within this Map. Otherwise, returns `false`.", "kind": "function", "name": "contains", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{V} - [value]", "value": "{V} - [value]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value to search for.", "name": "value" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the value is found, otherwise `false`." } ], "memberof": "Phaser.Structs.Map", "longname": "Phaser.Structs.Map#contains", "scope": "instance", "___id": "T000002R038536", "___s": true }, { "comment": "/**\r\n * Merges all new keys from the given Map into this one.\r\n * If it encounters a key that already exists it will be skipped unless override is set to `true`.\r\n *\r\n * @method Phaser.Structs.Map#merge\r\n * @since 3.0.0\r\n *\r\n * @genericUse {Phaser.Structs.Map.} - [map,$return]\r\n *\r\n * @param {Phaser.Structs.Map} map - The Map to merge in to this Map.\r\n * @param {boolean} [override=false] - Set to `true` to replace values in this Map with those from the source map, or `false` to skip them.\r\n *\r\n * @return {Phaser.Structs.Map} This Map object.\r\n */", "meta": { "filename": "Map.js", "lineno": 331, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Merges all new keys from the given Map into this one.\rIf it encounters a key that already exists it will be skipped unless override is set to `true`.", "kind": "function", "name": "merge", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.Map.} - [map,$return]", "value": "{Phaser.Structs.Map.} - [map,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Structs.Map" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Map" } }, "description": "The Map to merge in to this Map.", "name": "map" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Set to `true` to replace values in this Map with those from the source map, or `false` to skip them.", "name": "override" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.Map" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Map" } }, "description": "This Map object." } ], "memberof": "Phaser.Structs.Map", "longname": "Phaser.Structs.Map#merge", "scope": "instance", "___id": "T000002R038540", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Process Queue maintains three internal lists.\r\n *\r\n * The `pending` list is a selection of items which are due to be made 'active' in the next update.\r\n * The `active` list is a selection of items which are considered active and should be updated.\r\n * The `destroy` list is a selection of items that were active and are awaiting being destroyed in the next update.\r\n *\r\n * When new items are added to a Process Queue they are put in the pending list, rather than being added\r\n * immediately the active list. Equally, items that are removed are put into the destroy list, rather than\r\n * being destroyed immediately. This allows the Process Queue to carefully process each item at a specific, fixed\r\n * time, rather than at the time of the request from the API.\r\n *\r\n * @class ProcessQueue\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Structs\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @generic T\r\n */", "meta": { "filename": "ProcessQueue.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "classdesc": "A Process Queue maintains three internal lists.\r\rThe `pending` list is a selection of items which are due to be made 'active' in the next update.\rThe `active` list is a selection of items which are considered active and should be updated.\rThe `destroy` list is a selection of items that were active and are awaiting being destroyed in the next update.\r\rWhen new items are added to a Process Queue they are put in the pending list, rather than being added\rimmediately the active list. Equally, items that are removed are put into the destroy list, rather than\rbeing destroyed immediately. This allows the Process Queue to carefully process each item at a specific, fixed\rtime, rather than at the time of the request from the API.", "kind": "class", "name": "ProcessQueue", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Structs", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" } ], "scope": "static", "longname": "Phaser.Structs.ProcessQueue", "___id": "T000002R038551", "___s": true }, { "comment": "/**\r\n * If `true` only unique objects will be allowed in the queue.\r\n *\r\n * @name Phaser.Structs.ProcessQueue#checkQueue\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "ProcessQueue.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "If `true` only unique objects will be allowed in the queue.", "name": "checkQueue", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Structs.ProcessQueue", "longname": "Phaser.Structs.ProcessQueue#checkQueue", "scope": "instance", "kind": "member", "___id": "T000002R038563", "___s": true }, { "comment": "/**\r\n * Checks the given item to see if it is already active within this Process Queue.\r\n *\r\n * @method Phaser.Structs.ProcessQueue#isActive\r\n * @since 3.60.0\r\n *\r\n * @genericUse {T} - [item]\r\n * @genericUse {Phaser.Structs.ProcessQueue.} - [$return]\r\n *\r\n * @param {*} item - The item to check.\r\n *\r\n * @return {boolean} `true` if the item is active, otherwise `false`.\r\n */", "meta": { "filename": "ProcessQueue.js", "lineno": 102, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Checks the given item to see if it is already active within this Process Queue.", "kind": "function", "name": "isActive", "since": "3.60.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [item]", "value": "{T} - [item]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.ProcessQueue.} - [$return]", "value": "{Phaser.Structs.ProcessQueue.} - [$return]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item to check.", "name": "item" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the item is active, otherwise `false`." } ], "memberof": "Phaser.Structs.ProcessQueue", "longname": "Phaser.Structs.ProcessQueue#isActive", "scope": "instance", "___id": "T000002R038565", "___s": true }, { "comment": "/**\r\n * Checks the given item to see if it is already pending addition to this Process Queue.\r\n *\r\n * @method Phaser.Structs.ProcessQueue#isPending\r\n * @since 3.60.0\r\n *\r\n * @genericUse {T} - [item]\r\n * @genericUse {Phaser.Structs.ProcessQueue.} - [$return]\r\n *\r\n * @param {*} item - The item to check.\r\n *\r\n * @return {boolean} `true` if the item is pending insertion, otherwise `false`.\r\n */", "meta": { "filename": "ProcessQueue.js", "lineno": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Checks the given item to see if it is already pending addition to this Process Queue.", "kind": "function", "name": "isPending", "since": "3.60.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [item]", "value": "{T} - [item]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.ProcessQueue.} - [$return]", "value": "{Phaser.Structs.ProcessQueue.} - [$return]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item to check.", "name": "item" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the item is pending insertion, otherwise `false`." } ], "memberof": "Phaser.Structs.ProcessQueue", "longname": "Phaser.Structs.ProcessQueue#isPending", "scope": "instance", "___id": "T000002R038567", "___s": true }, { "comment": "/**\r\n * Checks the given item to see if it is already pending destruction from this Process Queue.\r\n *\r\n * @method Phaser.Structs.ProcessQueue#isDestroying\r\n * @since 3.60.0\r\n *\r\n * @genericUse {T} - [item]\r\n * @genericUse {Phaser.Structs.ProcessQueue.} - [$return]\r\n *\r\n * @param {*} item - The item to check.\r\n *\r\n * @return {boolean} `true` if the item is pending destruction, otherwise `false`.\r\n */", "meta": { "filename": "ProcessQueue.js", "lineno": 138, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Checks the given item to see if it is already pending destruction from this Process Queue.", "kind": "function", "name": "isDestroying", "since": "3.60.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [item]", "value": "{T} - [item]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.ProcessQueue.} - [$return]", "value": "{Phaser.Structs.ProcessQueue.} - [$return]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item to check.", "name": "item" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the item is pending destruction, otherwise `false`." } ], "memberof": "Phaser.Structs.ProcessQueue", "longname": "Phaser.Structs.ProcessQueue#isDestroying", "scope": "instance", "___id": "T000002R038569", "___s": true }, { "comment": "/**\r\n * Adds a new item to the Process Queue.\r\n *\r\n * The item is added to the pending list and made active in the next update.\r\n *\r\n * @method Phaser.Structs.ProcessQueue#add\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [item]\r\n * @genericUse {Phaser.Structs.ProcessQueue.} - [$return]\r\n *\r\n * @param {*} item - The item to add to the queue.\r\n *\r\n * @return {*} The item that was added.\r\n */", "meta": { "filename": "ProcessQueue.js", "lineno": 156, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Adds a new item to the Process Queue.\r\rThe item is added to the pending list and made active in the next update.", "kind": "function", "name": "add", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [item]", "value": "{T} - [item]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.ProcessQueue.} - [$return]", "value": "{Phaser.Structs.ProcessQueue.} - [$return]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item to add to the queue.", "name": "item" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item that was added." } ], "memberof": "Phaser.Structs.ProcessQueue", "longname": "Phaser.Structs.ProcessQueue#add", "scope": "instance", "___id": "T000002R038571", "___s": true }, { "comment": "/**\r\n * Removes an item from the Process Queue.\r\n *\r\n * The item is added to the 'destroy' list and is fully removed in the next update.\r\n *\r\n * @method Phaser.Structs.ProcessQueue#remove\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [item]\r\n * @genericUse {Phaser.Structs.ProcessQueue.} - [$return]\r\n *\r\n * @param {*} item - The item to be removed from the queue.\r\n *\r\n * @return {*} The item that was removed.\r\n */", "meta": { "filename": "ProcessQueue.js", "lineno": 186, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Removes an item from the Process Queue.\r\rThe item is added to the 'destroy' list and is fully removed in the next update.", "kind": "function", "name": "remove", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [item]", "value": "{T} - [item]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.ProcessQueue.} - [$return]", "value": "{Phaser.Structs.ProcessQueue.} - [$return]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item to be removed from the queue.", "name": "item" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item that was removed." } ], "memberof": "Phaser.Structs.ProcessQueue", "longname": "Phaser.Structs.ProcessQueue#remove", "scope": "instance", "___id": "T000002R038573", "___s": true }, { "comment": "/**\r\n * Removes all active items from this Process Queue.\r\n *\r\n * All the items are marked as 'pending destroy' and fully removed in the next update.\r\n *\r\n * @method Phaser.Structs.ProcessQueue#removeAll\r\n * @since 3.20.0\r\n *\r\n * @return {this} This Process Queue object.\r\n */", "meta": { "filename": "ProcessQueue.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Removes all active items from this Process Queue.\r\rAll the items are marked as 'pending destroy' and fully removed in the next update.", "kind": "function", "name": "removeAll", "since": "3.20.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Process Queue object." } ], "memberof": "Phaser.Structs.ProcessQueue", "longname": "Phaser.Structs.ProcessQueue#removeAll", "scope": "instance", "___id": "T000002R038577", "___s": true }, { "comment": "/**\r\n * Update this queue. First it will process any items awaiting destruction, and remove them.\r\n *\r\n * Then it will check to see if there are any items pending insertion, and move them to an\r\n * active state. Finally, it will return a list of active items for further processing.\r\n *\r\n * @method Phaser.Structs.ProcessQueue#update\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T[]} - [$return]\r\n *\r\n * @return {Array.<*>} A list of active items.\r\n */", "meta": { "filename": "ProcessQueue.js", "lineno": 256, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Update this queue. First it will process any items awaiting destruction, and remove them.\r\rThen it will check to see if there are any items pending insertion, and move them to an\ractive state. Finally, it will return a list of active items for further processing.", "kind": "function", "name": "update", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [$return]", "value": "{T[]} - [$return]" } ], "returns": [ { "type": { "names": [ "Array.<*>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "AllLiteral" } ] } }, "description": "A list of active items." } ], "memberof": "Phaser.Structs.ProcessQueue", "longname": "Phaser.Structs.ProcessQueue#update", "scope": "instance", "___id": "T000002R038582", "___s": true }, { "comment": "/**\r\n * Returns the current list of active items.\r\n *\r\n * This method returns a reference to the active list array, not a copy of it.\r\n * Therefore, be careful to not modify this array outside of the ProcessQueue.\r\n *\r\n * @method Phaser.Structs.ProcessQueue#getActive\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T[]} - [$return]\r\n *\r\n * @return {Array.<*>} A list of active items.\r\n */", "meta": { "filename": "ProcessQueue.js", "lineno": 325, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Returns the current list of active items.\r\rThis method returns a reference to the active list array, not a copy of it.\rTherefore, be careful to not modify this array outside of the ProcessQueue.", "kind": "function", "name": "getActive", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [$return]", "value": "{T[]} - [$return]" } ], "returns": [ { "type": { "names": [ "Array.<*>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "AllLiteral" } ] } }, "description": "A list of active items." } ], "memberof": "Phaser.Structs.ProcessQueue", "longname": "Phaser.Structs.ProcessQueue#getActive", "scope": "instance", "___id": "T000002R038597", "___s": true }, { "comment": "/**\r\n * The number of entries in the active list.\r\n *\r\n * @name Phaser.Structs.ProcessQueue#length\r\n * @type {number}\r\n * @readonly\r\n * @since 3.20.0\r\n */", "meta": { "filename": "ProcessQueue.js", "lineno": 343, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The number of entries in the active list.", "name": "length", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.20.0", "memberof": "Phaser.Structs.ProcessQueue", "longname": "Phaser.Structs.ProcessQueue#length", "scope": "instance", "kind": "member", "___id": "T000002R038599", "___s": true }, { "comment": "/**\r\n * Immediately destroys this process queue, clearing all of its internal arrays and resetting the process totals.\r\n *\r\n * @method Phaser.Structs.ProcessQueue#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ProcessQueue.js", "lineno": 360, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Immediately destroys this process queue, clearing all of its internal arrays and resetting the process totals.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Structs.ProcessQueue", "longname": "Phaser.Structs.ProcessQueue#destroy", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#destroy", "___id": "T000002R038602", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * RBush is a high-performance JavaScript library for 2D spatial indexing of points and rectangles.\r\n * It's based on an optimized R-tree data structure with bulk insertion support.\r\n *\r\n * Spatial index is a special data structure for points and rectangles that allows you to perform queries like\r\n * \"all items within this bounding box\" very efficiently (e.g. hundreds of times faster than looping over all items).\r\n *\r\n * This version of RBush uses a fixed min/max accessor structure of `[ '.left', '.top', '.right', '.bottom' ]`.\r\n * This is to avoid the eval like function creation that the original library used, which caused CSP policy violations.\r\n *\r\n * rbush is forked from https://github.com/mourner/rbush by Vladimir Agafonkin\r\n *\r\n * @class RTree\r\n * @memberof Phaser.Structs\r\n * @constructor\r\n * @since 3.0.0\r\n */", "meta": { "filename": "RTree.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "classdesc": "RBush is a high-performance JavaScript library for 2D spatial indexing of points and rectangles.\rIt's based on an optimized R-tree data structure with bulk insertion support.\r\rSpatial index is a special data structure for points and rectangles that allows you to perform queries like\r\"all items within this bounding box\" very efficiently (e.g. hundreds of times faster than looping over all items).\r\rThis version of RBush uses a fixed min/max accessor structure of `[ '.left', '.top', '.right', '.bottom' ]`.\rThis is to avoid the eval like function creation that the original library used, which caused CSP policy violations.\r\rrbush is forked from https://github.com/mourner/rbush by Vladimir Agafonkin", "kind": "class", "name": "RTree", "memberof": "Phaser.Structs", "since": "3.0.0", "scope": "static", "longname": "Phaser.Structs.RTree", "___id": "T000002R038610", "___s": true }, { "comment": "/**\r\n * @callback EachSetCallback\r\n *\r\n * @param {E} entry - The Set entry.\r\n * @param {number} index - The index of the entry within the Set.\r\n *\r\n * @return {?boolean} The callback result.\r\n */", "meta": { "filename": "Set.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "kind": "typedef", "name": "EachSetCallback", "type": { "names": [ "function" ] }, "params": [ { "type": { "names": [ "E" ], "parsedType": { "type": "NameExpression", "name": "E" } }, "description": "The Set entry.", "name": "entry" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the entry within the Set.", "name": "index" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "nullable": true, "description": "The callback result." } ], "longname": "EachSetCallback", "scope": "global", "___id": "T000002R038841", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Set is a collection of unique elements.\r\n *\r\n * @class Set\r\n * @memberof Phaser.Structs\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @generic T\r\n * @genericUse {T[]} - [elements]\r\n *\r\n * @param {Array.<*>} [elements] - An optional array of elements to insert into this Set.\r\n */", "meta": { "filename": "Set.js", "lineno": 18, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "classdesc": "A Set is a collection of unique elements.", "kind": "class", "name": "Set", "memberof": "Phaser.Structs", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [elements]", "value": "{T[]} - [elements]" } ], "params": [ { "type": { "names": [ "Array.<*>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "AllLiteral" } ] } }, "optional": true, "description": "An optional array of elements to insert into this Set.", "name": "elements" } ], "scope": "static", "longname": "Phaser.Structs.Set", "___id": "T000002R038842", "___s": true }, { "comment": "/**\r\n * The entries of this Set. Stored internally as an array.\r\n *\r\n * @genericUse {T[]} - [$type]\r\n *\r\n * @name Phaser.Structs.Set#entries\r\n * @type {Array.<*>}\r\n * @default []\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Set.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The entries of this Set. Stored internally as an array.", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [$type]", "value": "{T[]} - [$type]" } ], "name": "entries", "type": { "names": [ "Array.<*>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "AllLiteral" } ] } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.Structs.Set", "longname": "Phaser.Structs.Set#entries", "scope": "instance", "kind": "member", "___id": "T000002R038845", "___s": true }, { "comment": "/**\r\n * Inserts the provided value into this Set. If the value is already contained in this Set this method will have no effect.\r\n *\r\n * @method Phaser.Structs.Set#set\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [value]\r\n * @genericUse {Phaser.Structs.Set.} - [$return]\r\n *\r\n * @param {*} value - The value to insert into this Set.\r\n *\r\n * @return {Phaser.Structs.Set} This Set object.\r\n */", "meta": { "filename": "Set.js", "lineno": 59, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Inserts the provided value into this Set. If the value is already contained in this Set this method will have no effect.", "kind": "function", "name": "set", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [value]", "value": "{T} - [value]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.Set.} - [$return]", "value": "{Phaser.Structs.Set.} - [$return]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value to insert into this Set.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.Set" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Set" } }, "description": "This Set object." } ], "memberof": "Phaser.Structs.Set", "longname": "Phaser.Structs.Set#set", "scope": "instance", "___id": "T000002R038848", "___s": true }, { "comment": "/**\r\n * Get an element of this Set which has a property of the specified name, if that property is equal to the specified value.\r\n * If no elements of this Set satisfy the condition then this method will return `null`.\r\n *\r\n * @method Phaser.Structs.Set#get\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [value,$return]\r\n *\r\n * @param {string} property - The property name to check on the elements of this Set.\r\n * @param {*} value - The value to check for.\r\n *\r\n * @return {*} The first element of this Set that meets the required condition, or `null` if this Set contains no elements that meet the condition.\r\n */", "meta": { "filename": "Set.js", "lineno": 82, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Get an element of this Set which has a property of the specified name, if that property is equal to the specified value.\rIf no elements of this Set satisfy the condition then this method will return `null`.", "kind": "function", "name": "get", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [value,$return]", "value": "{T} - [value,$return]" } ], "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property name to check on the elements of this Set.", "name": "property" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value to check for.", "name": "value" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The first element of this Set that meets the required condition, or `null` if this Set contains no elements that meet the condition." } ], "memberof": "Phaser.Structs.Set", "longname": "Phaser.Structs.Set#get", "scope": "instance", "___id": "T000002R038850", "___s": true }, { "comment": "/**\r\n * Returns an array containing all the values in this Set.\r\n *\r\n * @method Phaser.Structs.Set#getArray\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T[]} - [$return]\r\n *\r\n * @return {Array.<*>} An array containing all the values in this Set.\r\n */", "meta": { "filename": "Set.js", "lineno": 109, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Returns an array containing all the values in this Set.", "kind": "function", "name": "getArray", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [$return]", "value": "{T[]} - [$return]" } ], "returns": [ { "type": { "names": [ "Array.<*>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "AllLiteral" } ] } }, "description": "An array containing all the values in this Set." } ], "memberof": "Phaser.Structs.Set", "longname": "Phaser.Structs.Set#getArray", "scope": "instance", "___id": "T000002R038854", "___s": true }, { "comment": "/**\r\n * Removes the given value from this Set if this Set contains that value.\r\n *\r\n * @method Phaser.Structs.Set#delete\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [value]\r\n * @genericUse {Phaser.Structs.Set.} - [$return]\r\n *\r\n * @param {*} value - The value to remove from the Set.\r\n *\r\n * @return {Phaser.Structs.Set} This Set object.\r\n */", "meta": { "filename": "Set.js", "lineno": 124, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Removes the given value from this Set if this Set contains that value.", "kind": "function", "name": "delete", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [value]", "value": "{T} - [value]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.Set.} - [$return]", "value": "{Phaser.Structs.Set.} - [$return]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value to remove from the Set.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.Set" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Set" } }, "description": "This Set object." } ], "memberof": "Phaser.Structs.Set", "longname": "Phaser.Structs.Set#delete", "scope": "instance", "___id": "T000002R038856", "___s": true }, { "comment": "/**\r\n * Dumps the contents of this Set to the console via `console.group`.\r\n *\r\n * @method Phaser.Structs.Set#dump\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Set.js", "lineno": 149, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Dumps the contents of this Set to the console via `console.group`.", "kind": "function", "name": "dump", "since": "3.0.0", "memberof": "Phaser.Structs.Set", "longname": "Phaser.Structs.Set#dump", "scope": "instance", "___id": "T000002R038859", "___s": true }, { "comment": "/**\r\n * Passes each value in this Set to the given callback.\r\n * Use this function when you know this Set will be modified during the iteration, otherwise use `iterate`.\r\n *\r\n * @method Phaser.Structs.Set#each\r\n * @since 3.0.0\r\n *\r\n * @genericUse {EachSetCallback.} - [callback]\r\n * @genericUse {Phaser.Structs.Set.} - [$return]\r\n *\r\n * @param {EachSetCallback} callback - The callback to be invoked and passed each value this Set contains.\r\n * @param {*} [callbackScope] - The scope of the callback.\r\n *\r\n * @return {Phaser.Structs.Set} This Set object.\r\n */", "meta": { "filename": "Set.js", "lineno": 170, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Passes each value in this Set to the given callback.\rUse this function when you know this Set will be modified during the iteration, otherwise use `iterate`.", "kind": "function", "name": "each", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{EachSetCallback.} - [callback]", "value": "{EachSetCallback.} - [callback]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.Set.} - [$return]", "value": "{Phaser.Structs.Set.} - [$return]" } ], "params": [ { "type": { "names": [ "EachSetCallback" ], "parsedType": { "type": "NameExpression", "name": "EachSetCallback" } }, "description": "The callback to be invoked and passed each value this Set contains.", "name": "callback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The scope of the callback.", "name": "callbackScope" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.Set" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Set" } }, "description": "This Set object." } ], "memberof": "Phaser.Structs.Set", "longname": "Phaser.Structs.Set#each", "scope": "instance", "___id": "T000002R038863", "___s": true }, { "comment": "/**\r\n * Passes each value in this Set to the given callback.\r\n *\r\n * For when you absolutely know this Set won't be modified during the iteration.\r\n *\r\n * The callback must return a boolean. If it returns `false` then it will abort\r\n * the Set iteration immediately. If it returns `true`, it will carry on\r\n * iterating the next child in the Set.\r\n *\r\n * @method Phaser.Structs.Set#iterate\r\n * @since 3.0.0\r\n *\r\n * @genericUse {EachSetCallback.} - [callback]\r\n * @genericUse {Phaser.Structs.Set.} - [$return]\r\n *\r\n * @param {EachSetCallback} callback - The callback to be invoked and passed each value this Set contains.\r\n * @param {*} [callbackScope] - The scope of the callback.\r\n *\r\n * @return {Phaser.Structs.Set} This Set object.\r\n */", "meta": { "filename": "Set.js", "lineno": 215, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Passes each value in this Set to the given callback.\r\rFor when you absolutely know this Set won't be modified during the iteration.\r\rThe callback must return a boolean. If it returns `false` then it will abort\rthe Set iteration immediately. If it returns `true`, it will carry on\riterating the next child in the Set.", "kind": "function", "name": "iterate", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{EachSetCallback.} - [callback]", "value": "{EachSetCallback.} - [callback]" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.Set.} - [$return]", "value": "{Phaser.Structs.Set.} - [$return]" } ], "params": [ { "type": { "names": [ "EachSetCallback" ], "parsedType": { "type": "NameExpression", "name": "EachSetCallback" } }, "description": "The callback to be invoked and passed each value this Set contains.", "name": "callback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The scope of the callback.", "name": "callbackScope" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.Set" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Set" } }, "description": "This Set object." } ], "memberof": "Phaser.Structs.Set", "longname": "Phaser.Structs.Set#iterate", "scope": "instance", "___id": "T000002R038870", "___s": true }, { "comment": "/**\r\n * Goes through each entry in this Set and invokes the given function on them, passing in the arguments.\r\n *\r\n * @method Phaser.Structs.Set#iterateLocal\r\n * @since 3.0.0\r\n *\r\n * @genericUse {Phaser.Structs.Set.} - [$return]\r\n *\r\n * @param {string} callbackKey - The key of the function to be invoked on each Set entry.\r\n * @param {...*} [args] - Additional arguments that will be passed to the callback, after the child.\r\n *\r\n * @return {Phaser.Structs.Set} This Set object.\r\n */", "meta": { "filename": "Set.js", "lineno": 264, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Goes through each entry in this Set and invokes the given function on them, passing in the arguments.", "kind": "function", "name": "iterateLocal", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.Set.} - [$return]", "value": "{Phaser.Structs.Set.} - [$return]" } ], "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the function to be invoked on each Set entry.", "name": "callbackKey" }, { "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": [ "Phaser.Structs.Set" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Set" } }, "description": "This Set object." } ], "memberof": "Phaser.Structs.Set", "longname": "Phaser.Structs.Set#iterateLocal", "scope": "instance", "___id": "T000002R038876", "___s": true }, { "comment": "/**\r\n * Clears this Set so that it no longer contains any values.\r\n *\r\n * @method Phaser.Structs.Set#clear\r\n * @since 3.0.0\r\n *\r\n * @genericUse {Phaser.Structs.Set.} - [$return]\r\n *\r\n * @return {Phaser.Structs.Set} This Set object.\r\n */", "meta": { "filename": "Set.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Clears this Set so that it no longer contains any values.", "kind": "function", "name": "clear", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.Set.} - [$return]", "value": "{Phaser.Structs.Set.} - [$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.Set" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Set" } }, "description": "This Set object." } ], "memberof": "Phaser.Structs.Set", "longname": "Phaser.Structs.Set#clear", "scope": "instance", "___id": "T000002R038884", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Set contains the given value, otherwise returns `false`.\r\n *\r\n * @method Phaser.Structs.Set#contains\r\n * @since 3.0.0\r\n *\r\n * @genericUse {T} - [value]\r\n *\r\n * @param {*} value - The value to check for in this Set.\r\n *\r\n * @return {boolean} `true` if the given value was found in this Set, otherwise `false`.\r\n */", "meta": { "filename": "Set.js", "lineno": 316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Returns `true` if this Set contains the given value, otherwise returns `false`.", "kind": "function", "name": "contains", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [value]", "value": "{T} - [value]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value to check for in this Set.", "name": "value" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given value was found in this Set, otherwise `false`." } ], "memberof": "Phaser.Structs.Set", "longname": "Phaser.Structs.Set#contains", "scope": "instance", "___id": "T000002R038887", "___s": true }, { "comment": "/**\r\n * Returns a new Set containing all values that are either in this Set or in the Set provided as an argument.\r\n *\r\n * @method Phaser.Structs.Set#union\r\n * @since 3.0.0\r\n *\r\n * @genericUse {Phaser.Structs.Set.} - [set,$return]\r\n *\r\n * @param {Phaser.Structs.Set} set - The Set to perform the union with.\r\n *\r\n * @return {Phaser.Structs.Set} A new Set containing all the values in this Set and the Set provided as an argument.\r\n */", "meta": { "filename": "Set.js", "lineno": 333, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Returns a new Set containing all values that are either in this Set or in the Set provided as an argument.", "kind": "function", "name": "union", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.Set.} - [set,$return]", "value": "{Phaser.Structs.Set.} - [set,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Structs.Set" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Set" } }, "description": "The Set to perform the union with.", "name": "set" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.Set" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Set" } }, "description": "A new Set containing all the values in this Set and the Set provided as an argument." } ], "memberof": "Phaser.Structs.Set", "longname": "Phaser.Structs.Set#union", "scope": "instance", "___id": "T000002R038889", "___s": true }, { "comment": "/**\r\n * Returns a new Set that contains only the values which are in this Set and that are also in the given Set.\r\n *\r\n * @method Phaser.Structs.Set#intersect\r\n * @since 3.0.0\r\n *\r\n * @genericUse {Phaser.Structs.Set.} - [set,$return]\r\n *\r\n * @param {Phaser.Structs.Set} set - The Set to intersect this set with.\r\n *\r\n * @return {Phaser.Structs.Set} The result of the intersection, as a new Set.\r\n */", "meta": { "filename": "Set.js", "lineno": 362, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Returns a new Set that contains only the values which are in this Set and that are also in the given Set.", "kind": "function", "name": "intersect", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.Set.} - [set,$return]", "value": "{Phaser.Structs.Set.} - [set,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Structs.Set" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Set" } }, "description": "The Set to intersect this set with.", "name": "set" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.Set" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Set" } }, "description": "The result of the intersection, as a new Set." } ], "memberof": "Phaser.Structs.Set", "longname": "Phaser.Structs.Set#intersect", "scope": "instance", "___id": "T000002R038892", "___s": true }, { "comment": "/**\r\n * Returns a new Set containing all the values in this Set which are *not* also in the given Set.\r\n *\r\n * @method Phaser.Structs.Set#difference\r\n * @since 3.0.0\r\n *\r\n * @genericUse {Phaser.Structs.Set.} - [set,$return]\r\n *\r\n * @param {Phaser.Structs.Set} set - The Set to perform the difference with.\r\n *\r\n * @return {Phaser.Structs.Set} A new Set containing all the values in this Set that are not also in the Set provided as an argument to this method.\r\n */", "meta": { "filename": "Set.js", "lineno": 389, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Returns a new Set containing all the values in this Set which are *not* also in the given Set.", "kind": "function", "name": "difference", "since": "3.0.0", "tags": [ { "originalTitle": "genericUse", "title": "genericuse", "text": "{Phaser.Structs.Set.} - [set,$return]", "value": "{Phaser.Structs.Set.} - [set,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Structs.Set" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Set" } }, "description": "The Set to perform the difference with.", "name": "set" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.Set" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Set" } }, "description": "A new Set containing all the values in this Set that are not also in the Set provided as an argument to this method." } ], "memberof": "Phaser.Structs.Set", "longname": "Phaser.Structs.Set#difference", "scope": "instance", "___id": "T000002R038895", "___s": true }, { "comment": "/**\r\n * The size of this Set. This is the number of entries within it.\r\n * Changing the size will truncate the Set if the given value is smaller than the current size.\r\n * Increasing the size larger than the current size has no effect.\r\n *\r\n * @name Phaser.Structs.Set#size\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Set.js", "lineno": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The size of this Set. This is the number of entries within it.\rChanging the size will truncate the Set if the given value is smaller than the current size.\rIncreasing the size larger than the current size has no effect.", "name": "size", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Structs.Set", "longname": "Phaser.Structs.Set#size", "scope": "instance", "kind": "member", "___id": "T000002R038898", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Size component allows you to set `width` and `height` properties and define the relationship between them.\r\n *\r\n * The component can automatically maintain the aspect ratios between the two values, and clamp them\r\n * to a defined min-max range. You can also control the dominant axis. When dimensions are given to the Size component\r\n * that would cause it to exceed its min-max range, the dimensions are adjusted based on the dominant axis.\r\n *\r\n * @class Size\r\n * @memberof Phaser.Structs\r\n * @constructor\r\n * @since 3.16.0\r\n *\r\n * @param {number} [width=0] - The width of the Size component.\r\n * @param {number} [height=width] - The height of the Size component. If not given, it will use the `width`.\r\n * @param {number} [aspectMode=0] - The aspect mode of the Size component. Defaults to 0, no mode.\r\n * @param {any} [parent=null] - The parent of this Size component. Can be any object with public `width` and `height` properties. Dimensions are clamped to keep them within the parent bounds where possible.\r\n */", "meta": { "filename": "Size.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "classdesc": "The Size component allows you to set `width` and `height` properties and define the relationship between them.\r\rThe component can automatically maintain the aspect ratios between the two values, and clamp them\rto a defined min-max range. You can also control the dominant axis. When dimensions are given to the Size component\rthat would cause it to exceed its min-max range, the dimensions are adjusted based on the dominant axis.", "kind": "class", "name": "Size", "memberof": "Phaser.Structs", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The width of the Size component.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "width", "description": "The height of the Size component. If not given, it will use the `width`.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The aspect mode of the Size component. Defaults to 0, no mode.", "name": "aspectMode" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "defaultvalue": null, "description": "The parent of this Size component. Can be any object with public `width` and `height` properties. Dimensions are clamped to keep them within the parent bounds where possible.", "name": "parent" } ], "scope": "static", "longname": "Phaser.Structs.Size", "___id": "T000002R038908", "___s": true }, { "comment": "/**\r\n * The aspect mode this Size component will use when calculating its dimensions.\r\n * This property is read-only. To change it use the `setAspectMode` method.\r\n *\r\n * @name Phaser.Structs.Size#aspectMode\r\n * @type {number}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Size.js", "lineno": 71, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The aspect mode this Size component will use when calculating its dimensions.\rThis property is read-only. To change it use the `setAspectMode` method.", "name": "aspectMode", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#aspectMode", "scope": "instance", "kind": "member", "___id": "T000002R038921", "___s": true }, { "comment": "/**\r\n * The proportional relationship between the width and height.\r\n *\r\n * This property is read-only and is updated automatically when either the `width` or `height` properties are changed,\r\n * depending on the aspect mode.\r\n *\r\n * @name Phaser.Structs.Size#aspectRatio\r\n * @type {number}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Size.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The proportional relationship between the width and height.\r\rThis property is read-only and is updated automatically when either the `width` or `height` properties are changed,\rdepending on the aspect mode.", "name": "aspectRatio", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#aspectRatio", "scope": "instance", "kind": "member", "___id": "T000002R038923", "___s": true }, { "comment": "/**\r\n * The minimum allowed width.\r\n * Cannot be less than zero.\r\n * This value is read-only. To change it see the `setMin` method.\r\n *\r\n * @name Phaser.Structs.Size#minWidth\r\n * @type {number}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Size.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The minimum allowed width.\rCannot be less than zero.\rThis value is read-only. To change it see the `setMin` method.", "name": "minWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#minWidth", "scope": "instance", "kind": "member", "___id": "T000002R038925", "___s": true }, { "comment": "/**\r\n * The minimum allowed height.\r\n * Cannot be less than zero.\r\n * This value is read-only. To change it see the `setMin` method.\r\n *\r\n * @name Phaser.Structs.Size#minHeight\r\n * @type {number}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Size.js", "lineno": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The minimum allowed height.\rCannot be less than zero.\rThis value is read-only. To change it see the `setMin` method.", "name": "minHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#minHeight", "scope": "instance", "kind": "member", "___id": "T000002R038927", "___s": true }, { "comment": "/**\r\n * The maximum allowed width.\r\n * This value is read-only. To change it see the `setMax` method.\r\n *\r\n * @name Phaser.Structs.Size#maxWidth\r\n * @type {number}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Size.js", "lineno": 119, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The maximum allowed width.\rThis value is read-only. To change it see the `setMax` method.", "name": "maxWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#maxWidth", "scope": "instance", "kind": "member", "___id": "T000002R038929", "___s": true }, { "comment": "/**\r\n * The maximum allowed height.\r\n * This value is read-only. To change it see the `setMax` method.\r\n *\r\n * @name Phaser.Structs.Size#maxHeight\r\n * @type {number}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Size.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The maximum allowed height.\rThis value is read-only. To change it see the `setMax` method.", "name": "maxHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#maxHeight", "scope": "instance", "kind": "member", "___id": "T000002R038931", "___s": true }, { "comment": "/**\r\n * A Vector2 containing the horizontal and vertical snap values, which the width and height are snapped to during resizing.\r\n *\r\n * By default this is disabled.\r\n *\r\n * This property is read-only. To change it see the `setSnap` method.\r\n *\r\n * @name Phaser.Structs.Size#snapTo\r\n * @type {Phaser.Math.Vector2}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Size.js", "lineno": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "A Vector2 containing the horizontal and vertical snap values, which the width and height are snapped to during resizing.\r\rBy default this is disabled.\r\rThis property is read-only. To change it see the `setSnap` method.", "name": "snapTo", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#snapTo", "scope": "instance", "kind": "member", "___id": "T000002R038933", "___s": true }, { "comment": "/**\r\n * Sets the aspect mode of this Size component.\r\n *\r\n * The aspect mode controls what happens when you modify the `width` or `height` properties, or call `setSize`.\r\n *\r\n * It can be a number from 0 to 4, or a Size constant:\r\n *\r\n * 0. NONE = Do not make the size fit the aspect ratio. Change the ratio when the size changes.\r\n * 1. WIDTH_CONTROLS_HEIGHT = The height is automatically adjusted based on the width.\r\n * 2. HEIGHT_CONTROLS_WIDTH = The width is automatically adjusted based on the height.\r\n * 3. FIT = The width and height are automatically adjusted to fit inside the given target area, while keeping the aspect ratio. Depending on the aspect ratio there may be some space inside the area which is not covered.\r\n * 4. ENVELOP = The width and height are automatically adjusted to make the size cover the entire target area while keeping the aspect ratio. This may extend further out than the target size.\r\n *\r\n * Calling this method automatically recalculates the `width` and the `height`, if required.\r\n *\r\n * @method Phaser.Structs.Size#setAspectMode\r\n * @since 3.16.0\r\n *\r\n * @param {number} [value=0] - The aspect mode value.\r\n *\r\n * @return {this} This Size component instance.\r\n */", "meta": { "filename": "Size.js", "lineno": 156, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Sets the aspect mode of this Size component.\r\rThe aspect mode controls what happens when you modify the `width` or `height` properties, or call `setSize`.\r\rIt can be a number from 0 to 4, or a Size constant:\r\r0. NONE = Do not make the size fit the aspect ratio. Change the ratio when the size changes.\r1. WIDTH_CONTROLS_HEIGHT = The height is automatically adjusted based on the width.\r2. HEIGHT_CONTROLS_WIDTH = The width is automatically adjusted based on the height.\r3. FIT = The width and height are automatically adjusted to fit inside the given target area, while keeping the aspect ratio. Depending on the aspect ratio there may be some space inside the area which is not covered.\r4. ENVELOP = The width and height are automatically adjusted to make the size cover the entire target area while keeping the aspect ratio. This may extend further out than the target size.\r\rCalling this method automatically recalculates the `width` and the `height`, if required.", "kind": "function", "name": "setAspectMode", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The aspect mode value.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Size component instance." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#setAspectMode", "scope": "instance", "___id": "T000002R038935", "___s": true }, { "comment": "/**\r\n * By setting a Snap To value when this Size component is modified its dimensions will automatically\r\n * by snapped to the nearest grid slice, using floor. For example, if you have snap value of 16,\r\n * and the width changes to 68, then it will snap down to 64 (the closest multiple of 16 when floored)\r\n *\r\n * Note that snapping takes place before adjustments by the parent, or the min / max settings. If these\r\n * values are not multiples of the given snap values, then this can result in un-snapped dimensions.\r\n *\r\n * Call this method with no arguments to reset the snap values.\r\n *\r\n * Calling this method automatically recalculates the `width` and the `height`, if required.\r\n *\r\n * @method Phaser.Structs.Size#setSnap\r\n * @since 3.16.0\r\n *\r\n * @param {number} [snapWidth=0] - The amount to snap the width to. If you don't want to snap the width, pass a value of zero.\r\n * @param {number} [snapHeight=snapWidth] - The amount to snap the height to. If not provided it will use the `snapWidth` value. If you don't want to snap the height, pass a value of zero.\r\n *\r\n * @return {this} This Size component instance.\r\n */", "meta": { "filename": "Size.js", "lineno": 187, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "By setting a Snap To value when this Size component is modified its dimensions will automatically\rby snapped to the nearest grid slice, using floor. For example, if you have snap value of 16,\rand the width changes to 68, then it will snap down to 64 (the closest multiple of 16 when floored)\r\rNote that snapping takes place before adjustments by the parent, or the min / max settings. If these\rvalues are not multiples of the given snap values, then this can result in un-snapped dimensions.\r\rCall this method with no arguments to reset the snap values.\r\rCalling this method automatically recalculates the `width` and the `height`, if required.", "kind": "function", "name": "setSnap", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to snap the width to. If you don't want to snap the width, pass a value of zero.", "name": "snapWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "snapWidth", "description": "The amount to snap the height to. If not provided it will use the `snapWidth` value. If you don't want to snap the height, pass a value of zero.", "name": "snapHeight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Size component instance." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#setSnap", "scope": "instance", "___id": "T000002R038939", "___s": true }, { "comment": "/**\r\n * Sets, or clears, the parent of this Size component.\r\n *\r\n * To clear the parent call this method with no arguments.\r\n *\r\n * The parent influences the maximum extents to which this Size component can expand,\r\n * based on the aspect mode:\r\n *\r\n * NONE - The parent clamps both the width and height.\r\n * WIDTH_CONTROLS_HEIGHT - The parent clamps just the width.\r\n * HEIGHT_CONTROLS_WIDTH - The parent clamps just the height.\r\n * FIT - The parent clamps whichever axis is required to ensure the size fits within it.\r\n * ENVELOP - The parent is used to ensure the size fully envelops the parent.\r\n *\r\n * Calling this method automatically calls `setSize`.\r\n *\r\n * @method Phaser.Structs.Size#setParent\r\n * @since 3.16.0\r\n *\r\n * @param {any} [parent] - Sets the parent of this Size component. Don't provide a value to clear an existing parent.\r\n *\r\n * @return {this} This Size component instance.\r\n */", "meta": { "filename": "Size.js", "lineno": 217, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Sets, or clears, the parent of this Size component.\r\rTo clear the parent call this method with no arguments.\r\rThe parent influences the maximum extents to which this Size component can expand,\rbased on the aspect mode:\r\rNONE - The parent clamps both the width and height.\rWIDTH_CONTROLS_HEIGHT - The parent clamps just the width.\rHEIGHT_CONTROLS_WIDTH - The parent clamps just the height.\rFIT - The parent clamps whichever axis is required to ensure the size fits within it.\rENVELOP - The parent is used to ensure the size fully envelops the parent.\r\rCalling this method automatically calls `setSize`.", "kind": "function", "name": "setParent", "since": "3.16.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Sets the parent of this Size component. Don't provide a value to clear an existing parent.", "name": "parent" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Size component instance." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#setParent", "scope": "instance", "___id": "T000002R038943", "___s": true }, { "comment": "/**\r\n * Set the minimum width and height values this Size component will allow.\r\n *\r\n * The minimum values can never be below zero, or greater than the maximum values.\r\n *\r\n * Setting this will automatically adjust both the `width` and `height` properties to ensure they are within range.\r\n *\r\n * Note that based on the aspect mode, and if this Size component has a parent set or not, the minimums set here\r\n * _can_ be exceed in some situations.\r\n *\r\n * @method Phaser.Structs.Size#setMin\r\n * @since 3.16.0\r\n *\r\n * @param {number} [width=0] - The minimum allowed width of the Size component.\r\n * @param {number} [height=width] - The minimum allowed height of the Size component. If not given, it will use the `width`.\r\n *\r\n * @return {this} This Size component instance.\r\n */", "meta": { "filename": "Size.js", "lineno": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Set the minimum width and height values this Size component will allow.\r\rThe minimum values can never be below zero, or greater than the maximum values.\r\rSetting this will automatically adjust both the `width` and `height` properties to ensure they are within range.\r\rNote that based on the aspect mode, and if this Size component has a parent set or not, the minimums set here\r_can_ be exceed in some situations.", "kind": "function", "name": "setMin", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The minimum allowed width of the Size component.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "width", "description": "The minimum allowed height of the Size component. If not given, it will use the `width`.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Size component instance." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#setMin", "scope": "instance", "___id": "T000002R038946", "___s": true }, { "comment": "/**\r\n * Set the maximum width and height values this Size component will allow.\r\n *\r\n * Setting this will automatically adjust both the `width` and `height` properties to ensure they are within range.\r\n *\r\n * Note that based on the aspect mode, and if this Size component has a parent set or not, the maximums set here\r\n * _can_ be exceed in some situations.\r\n *\r\n * @method Phaser.Structs.Size#setMax\r\n * @since 3.16.0\r\n *\r\n * @param {number} [width=Number.MAX_VALUE] - The maximum allowed width of the Size component.\r\n * @param {number} [height=width] - The maximum allowed height of the Size component. If not given, it will use the `width`.\r\n *\r\n * @return {this} This Size component instance.\r\n */", "meta": { "filename": "Size.js", "lineno": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Set the maximum width and height values this Size component will allow.\r\rSetting this will automatically adjust both the `width` and `height` properties to ensure they are within range.\r\rNote that based on the aspect mode, and if this Size component has a parent set or not, the maximums set here\r_can_ be exceed in some situations.", "kind": "function", "name": "setMax", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "Number.MAX_VALUE", "description": "The maximum allowed width of the Size component.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "width", "description": "The maximum allowed height of the Size component. If not given, it will use the `width`.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Size component instance." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#setMax", "scope": "instance", "___id": "T000002R038952", "___s": true }, { "comment": "/**\r\n * Sets the width and height of this Size component based on the aspect mode.\r\n *\r\n * If the aspect mode is 'none' then calling this method will change the aspect ratio, otherwise the current\r\n * aspect ratio is honored across all other modes.\r\n *\r\n * If snapTo values have been set then the given width and height are snapped first, prior to any further\r\n * adjustment via min/max values, or a parent.\r\n *\r\n * If minimum and/or maximum dimensions have been specified, the values given to this method will be clamped into\r\n * that range prior to adjustment, but may still exceed them depending on the aspect mode.\r\n *\r\n * If this Size component has a parent set, and the aspect mode is `fit` or `envelop`, then the given sizes will\r\n * be clamped to the range specified by the parent.\r\n *\r\n * @method Phaser.Structs.Size#setSize\r\n * @since 3.16.0\r\n *\r\n * @param {number} [width=0] - The new width of the Size component.\r\n * @param {number} [height=width] - The new height of the Size component. If not given, it will use the `width`.\r\n *\r\n * @return {this} This Size component instance.\r\n */", "meta": { "filename": "Size.js", "lineno": 303, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Sets the width and height of this Size component based on the aspect mode.\r\rIf the aspect mode is 'none' then calling this method will change the aspect ratio, otherwise the current\raspect ratio is honored across all other modes.\r\rIf snapTo values have been set then the given width and height are snapped first, prior to any further\radjustment via min/max values, or a parent.\r\rIf minimum and/or maximum dimensions have been specified, the values given to this method will be clamped into\rthat range prior to adjustment, but may still exceed them depending on the aspect mode.\r\rIf this Size component has a parent set, and the aspect mode is `fit` or `envelop`, then the given sizes will\rbe clamped to the range specified by the parent.", "kind": "function", "name": "setSize", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The new width of the Size component.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "width", "description": "The new height of the Size component. If not given, it will use the `width`.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Size component instance." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#setSize", "scope": "instance", "___id": "T000002R038958", "___s": true }, { "comment": "/**\r\n * Sets a new aspect ratio, overriding what was there previously.\r\n *\r\n * It then calls `setSize` immediately using the current dimensions.\r\n *\r\n * @method Phaser.Structs.Size#setAspectRatio\r\n * @since 3.16.0\r\n *\r\n * @param {number} ratio - The new aspect ratio.\r\n *\r\n * @return {this} This Size component instance.\r\n */", "meta": { "filename": "Size.js", "lineno": 361, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Sets a new aspect ratio, overriding what was there previously.\r\rIt then calls `setSize` immediately using the current dimensions.", "kind": "function", "name": "setAspectRatio", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new aspect ratio.", "name": "ratio" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Size component instance." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#setAspectRatio", "scope": "instance", "___id": "T000002R038969", "___s": true }, { "comment": "/**\r\n * Sets a new width and height for this Size component and updates the aspect ratio based on them.\r\n *\r\n * It _doesn't_ change the `aspectMode` and still factors in size limits such as the min max and parent bounds.\r\n *\r\n * @method Phaser.Structs.Size#resize\r\n * @since 3.16.0\r\n *\r\n * @param {number} width - The new width of the Size component.\r\n * @param {number} [height=width] - The new height of the Size component. If not given, it will use the `width`.\r\n *\r\n * @return {this} This Size component instance.\r\n */", "meta": { "filename": "Size.js", "lineno": 380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Sets a new width and height for this Size component and updates the aspect ratio based on them.\r\rIt _doesn't_ change the `aspectMode` and still factors in size limits such as the min max and parent bounds.", "kind": "function", "name": "resize", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the Size component.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "width", "description": "The new height of the Size component. If not given, it will use the `width`.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Size component instance." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#resize", "scope": "instance", "___id": "T000002R038972", "___s": true }, { "comment": "/**\r\n * Takes a new width and passes it through the min/max clamp and then checks it doesn't exceed the parent width.\r\n *\r\n * @method Phaser.Structs.Size#getNewWidth\r\n * @since 3.16.0\r\n *\r\n * @param {number} value - The value to clamp and check.\r\n * @param {boolean} [checkParent=true] - Check the given value against the parent, if set.\r\n *\r\n * @return {number} The modified width value.\r\n */", "meta": { "filename": "Size.js", "lineno": 402, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Takes a new width and passes it through the min/max clamp and then checks it doesn't exceed the parent width.", "kind": "function", "name": "getNewWidth", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to clamp and check.", "name": "value" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Check the given value against the parent, if set.", "name": "checkParent" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The modified width value." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#getNewWidth", "scope": "instance", "___id": "T000002R038977", "___s": true }, { "comment": "/**\r\n * Takes a new height and passes it through the min/max clamp and then checks it doesn't exceed the parent height.\r\n *\r\n * @method Phaser.Structs.Size#getNewHeight\r\n * @since 3.16.0\r\n *\r\n * @param {number} value - The value to clamp and check.\r\n * @param {boolean} [checkParent=true] - Check the given value against the parent, if set.\r\n *\r\n * @return {number} The modified height value.\r\n */", "meta": { "filename": "Size.js", "lineno": 427, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Takes a new height and passes it through the min/max clamp and then checks it doesn't exceed the parent height.", "kind": "function", "name": "getNewHeight", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to clamp and check.", "name": "value" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Check the given value against the parent, if set.", "name": "checkParent" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The modified height value." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#getNewHeight", "scope": "instance", "___id": "T000002R038982", "___s": true }, { "comment": "/**\r\n * The current `width` and `height` are adjusted to fit inside the given dimensions, while keeping the aspect ratio.\r\n *\r\n * If `fit` is true there may be some space inside the target area which is not covered if its aspect ratio differs.\r\n * If `fit` is false the size may extend further out than the target area if the aspect ratios differ.\r\n *\r\n * If this Size component has a parent set, then the width and height passed to this method will be clamped so\r\n * it cannot exceed that of the parent.\r\n *\r\n * @method Phaser.Structs.Size#constrain\r\n * @since 3.16.0\r\n *\r\n * @param {number} [width=0] - The new width of the Size component.\r\n * @param {number} [height] - The new height of the Size component. If not given, it will use the width value.\r\n * @param {boolean} [fit=true] - Perform a `fit` (true) constraint, or an `envelop` (false) constraint.\r\n *\r\n * @return {this} This Size component instance.\r\n */", "meta": { "filename": "Size.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The current `width` and `height` are adjusted to fit inside the given dimensions, while keeping the aspect ratio.\r\rIf `fit` is true there may be some space inside the target area which is not covered if its aspect ratio differs.\rIf `fit` is false the size may extend further out than the target area if the aspect ratios differ.\r\rIf this Size component has a parent set, then the width and height passed to this method will be clamped so\rit cannot exceed that of the parent.", "kind": "function", "name": "constrain", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The new width of the Size component.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The new height of the Size component. If not given, it will use the width value.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Perform a `fit` (true) constraint, or an `envelop` (false) constraint.", "name": "fit" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Size component instance." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#constrain", "scope": "instance", "___id": "T000002R038987", "___s": true }, { "comment": "/**\r\n * The current `width` and `height` are adjusted to fit inside the given dimensions, while keeping the aspect ratio.\r\n *\r\n * There may be some space inside the target area which is not covered if its aspect ratio differs.\r\n *\r\n * If this Size component has a parent set, then the width and height passed to this method will be clamped so\r\n * it cannot exceed that of the parent.\r\n *\r\n * @method Phaser.Structs.Size#fitTo\r\n * @since 3.16.0\r\n *\r\n * @param {number} [width=0] - The new width of the Size component.\r\n * @param {number} [height] - The new height of the Size component. If not given, it will use the width value.\r\n *\r\n * @return {this} This Size component instance.\r\n */", "meta": { "filename": "Size.js", "lineno": 521, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The current `width` and `height` are adjusted to fit inside the given dimensions, while keeping the aspect ratio.\r\rThere may be some space inside the target area which is not covered if its aspect ratio differs.\r\rIf this Size component has a parent set, then the width and height passed to this method will be clamped so\rit cannot exceed that of the parent.", "kind": "function", "name": "fitTo", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The new width of the Size component.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The new height of the Size component. If not given, it will use the width value.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Size component instance." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#fitTo", "scope": "instance", "___id": "T000002R039006", "___s": true }, { "comment": "/**\r\n * The current `width` and `height` are adjusted so that they fully envelope the given dimensions, while keeping the aspect ratio.\r\n *\r\n * The size may extend further out than the target area if the aspect ratios differ.\r\n *\r\n * If this Size component has a parent set, then the values are clamped so that it never exceeds the parent\r\n * on the longest axis.\r\n *\r\n * @method Phaser.Structs.Size#envelop\r\n * @since 3.16.0\r\n *\r\n * @param {number} [width=0] - The new width of the Size component.\r\n * @param {number} [height] - The new height of the Size component. If not given, it will use the width value.\r\n *\r\n * @return {this} This Size component instance.\r\n */", "meta": { "filename": "Size.js", "lineno": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The current `width` and `height` are adjusted so that they fully envelope the given dimensions, while keeping the aspect ratio.\r\rThe size may extend further out than the target area if the aspect ratios differ.\r\rIf this Size component has a parent set, then the values are clamped so that it never exceeds the parent\ron the longest axis.", "kind": "function", "name": "envelop", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The new width of the Size component.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The new height of the Size component. If not given, it will use the width value.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Size component instance." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#envelop", "scope": "instance", "___id": "T000002R039008", "___s": true }, { "comment": "/**\r\n * Sets the width of this Size component.\r\n *\r\n * Depending on the aspect mode, changing the width may also update the height and aspect ratio.\r\n *\r\n * @method Phaser.Structs.Size#setWidth\r\n * @since 3.16.0\r\n *\r\n * @param {number} width - The new width of the Size component.\r\n *\r\n * @return {this} This Size component instance.\r\n */", "meta": { "filename": "Size.js", "lineno": 563, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Sets the width of this Size component.\r\rDepending on the aspect mode, changing the width may also update the height and aspect ratio.", "kind": "function", "name": "setWidth", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the Size component.", "name": "width" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Size component instance." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#setWidth", "scope": "instance", "___id": "T000002R039010", "___s": true }, { "comment": "/**\r\n * Sets the height of this Size component.\r\n *\r\n * Depending on the aspect mode, changing the height may also update the width and aspect ratio.\r\n *\r\n * @method Phaser.Structs.Size#setHeight\r\n * @since 3.16.0\r\n *\r\n * @param {number} height - The new height of the Size component.\r\n *\r\n * @return {this} This Size component instance.\r\n */", "meta": { "filename": "Size.js", "lineno": 580, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Sets the height of this Size component.\r\rDepending on the aspect mode, changing the height may also update the width and aspect ratio.", "kind": "function", "name": "setHeight", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of the Size component.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Size component instance." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#setHeight", "scope": "instance", "___id": "T000002R039012", "___s": true }, { "comment": "/**\r\n * Returns a string representation of this Size component.\r\n *\r\n * @method Phaser.Structs.Size#toString\r\n * @since 3.16.0\r\n *\r\n * @return {string} A string representation of this Size component.\r\n */", "meta": { "filename": "Size.js", "lineno": 597, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Returns a string representation of this Size component.", "kind": "function", "name": "toString", "since": "3.16.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A string representation of this Size component." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#toString", "scope": "instance", "___id": "T000002R039014", "___s": true }, { "comment": "/**\r\n * Sets the values of this Size component to the `element.style.width` and `height`\r\n * properties of the given DOM Element. The properties are set as `px` values.\r\n *\r\n * @method Phaser.Structs.Size#setCSS\r\n * @since 3.17.0\r\n *\r\n * @param {HTMLElement} element - The DOM Element to set the CSS style on.\r\n */", "meta": { "filename": "Size.js", "lineno": 610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Sets the values of this Size component to the `element.style.width` and `height`\rproperties of the given DOM Element. The properties are set as `px` values.", "kind": "function", "name": "setCSS", "since": "3.17.0", "params": [ { "type": { "names": [ "HTMLElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLElement" } }, "description": "The DOM Element to set the CSS style on.", "name": "element" } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#setCSS", "scope": "instance", "___id": "T000002R039016", "___s": true }, { "comment": "/**\r\n * Copies the aspect mode, aspect ratio, width and height from this Size component\r\n * to the given Size component. Note that the parent, if set, is not copied across.\r\n *\r\n * @method Phaser.Structs.Size#copy\r\n * @since 3.16.0\r\n *\r\n * @param {Phaser.Structs.Size} destination - The Size component to copy the values to.\r\n *\r\n * @return {Phaser.Structs.Size} The updated destination Size component.\r\n */", "meta": { "filename": "Size.js", "lineno": 628, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Copies the aspect mode, aspect ratio, width and height from this Size component\rto the given Size component. Note that the parent, if set, is not copied across.", "kind": "function", "name": "copy", "since": "3.16.0", "params": [ { "type": { "names": [ "Phaser.Structs.Size" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Size" } }, "description": "The Size component to copy the values to.", "name": "destination" } ], "returns": [ { "type": { "names": [ "Phaser.Structs.Size" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Size" } }, "description": "The updated destination Size component." } ], "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#copy", "scope": "instance", "___id": "T000002R039020", "___s": true }, { "comment": "/**\r\n * Destroys this Size component.\r\n *\r\n * This clears the local properties and any parent object, if set.\r\n *\r\n * A destroyed Size component cannot be re-used.\r\n *\r\n * @method Phaser.Structs.Size#destroy\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Size.js", "lineno": 648, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Destroys this Size component.\r\rThis clears the local properties and any parent object, if set.\r\rA destroyed Size component cannot be re-used.", "kind": "function", "name": "destroy", "since": "3.16.0", "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#destroy", "scope": "instance", "___id": "T000002R039023", "___s": true }, { "comment": "/**\r\n * The width of this Size component.\r\n *\r\n * This value is clamped to the range specified by `minWidth` and `maxWidth`, if enabled.\r\n *\r\n * A width can never be less than zero.\r\n *\r\n * Changing this value will automatically update the `height` if the aspect ratio lock is enabled.\r\n * You can also use the `setWidth` and `getWidth` methods.\r\n *\r\n * @name Phaser.Structs.Size#width\r\n * @type {number}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Size.js", "lineno": 664, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The width of this Size component.\r\rThis value is clamped to the range specified by `minWidth` and `maxWidth`, if enabled.\r\rA width can never be less than zero.\r\rChanging this value will automatically update the `height` if the aspect ratio lock is enabled.\rYou can also use the `setWidth` and `getWidth` methods.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.16.0", "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#width", "scope": "instance", "kind": "member", "___id": "T000002R039027", "___s": true }, { "comment": "/**\r\n * The height of this Size component.\r\n *\r\n * This value is clamped to the range specified by `minHeight` and `maxHeight`, if enabled.\r\n *\r\n * A height can never be less than zero.\r\n *\r\n * Changing this value will automatically update the `width` if the aspect ratio lock is enabled.\r\n * You can also use the `setHeight` and `getHeight` methods.\r\n *\r\n * @name Phaser.Structs.Size#height\r\n * @type {number}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Size.js", "lineno": 692, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The height of this Size component.\r\rThis value is clamped to the range specified by `minHeight` and `maxHeight`, if enabled.\r\rA height can never be less than zero.\r\rChanging this value will automatically update the `width` if the aspect ratio lock is enabled.\rYou can also use the `setHeight` and `getHeight` methods.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.16.0", "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size#height", "scope": "instance", "kind": "member", "___id": "T000002R039031", "___s": true }, { "comment": "/**\r\n * Do not make the size fit the aspect ratio. Change the ratio when the size changes.\r\n *\r\n * @name Phaser.Structs.Size.NONE\r\n * @constant\r\n * @type {number}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Size.js", "lineno": 722, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "Do not make the size fit the aspect ratio. Change the ratio when the size changes.", "name": "NONE", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.16.0", "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size.NONE", "scope": "static", "___id": "T000002R039035", "___s": true }, { "comment": "/**\r\n * The height is automatically adjusted based on the width.\r\n *\r\n * @name Phaser.Structs.Size.WIDTH_CONTROLS_HEIGHT\r\n * @constant\r\n * @type {number}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Size.js", "lineno": 732, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The height is automatically adjusted based on the width.", "name": "WIDTH_CONTROLS_HEIGHT", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.16.0", "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size.WIDTH_CONTROLS_HEIGHT", "scope": "static", "___id": "T000002R039037", "___s": true }, { "comment": "/**\r\n * The width is automatically adjusted based on the height.\r\n *\r\n * @name Phaser.Structs.Size.HEIGHT_CONTROLS_WIDTH\r\n * @constant\r\n * @type {number}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Size.js", "lineno": 742, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The width is automatically adjusted based on the height.", "name": "HEIGHT_CONTROLS_WIDTH", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.16.0", "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size.HEIGHT_CONTROLS_WIDTH", "scope": "static", "___id": "T000002R039039", "___s": true }, { "comment": "/**\r\n * The width and height are automatically adjusted to fit inside the given target area, while keeping the aspect ratio. Depending on the aspect ratio there may be some space inside the area which is not covered.\r\n *\r\n * @name Phaser.Structs.Size.FIT\r\n * @constant\r\n * @type {number}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Size.js", "lineno": 752, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The width and height are automatically adjusted to fit inside the given target area, while keeping the aspect ratio. Depending on the aspect ratio there may be some space inside the area which is not covered.", "name": "FIT", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.16.0", "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size.FIT", "scope": "static", "___id": "T000002R039041", "___s": true }, { "comment": "/**\r\n * The width and height are automatically adjusted to make the size cover the entire target area while keeping the aspect ratio. This may extend further out than the target size.\r\n *\r\n * @name Phaser.Structs.Size.ENVELOP\r\n * @constant\r\n * @type {number}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Size.js", "lineno": 762, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\structs", "code": {} }, "description": "The width and height are automatically adjusted to make the size cover the entire target area while keeping the aspect ratio. This may extend further out than the target size.", "name": "ENVELOP", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.16.0", "memberof": "Phaser.Structs.Size", "longname": "Phaser.Structs.Size.ENVELOP", "scope": "static", "___id": "T000002R039043", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Canvas Texture is a special kind of Texture that is backed by an HTML Canvas Element as its source.\r\n *\r\n * You can use the properties of this texture to draw to the canvas element directly, using all of the standard\r\n * canvas operations available in the browser. Any Game Object can be given this texture and will render with it.\r\n *\r\n * Note: When running under WebGL the Canvas Texture needs to re-generate its base WebGLTexture and reupload it to\r\n * the GPU every time you modify it, otherwise the changes you make to this texture will not be visible. To do this\r\n * you should call `CanvasTexture.refresh()` once you are finished with your changes to the canvas. Try and keep\r\n * this to a minimum, especially on large canvas sizes, or you may inadvertently thrash the GPU by constantly uploading\r\n * texture data to it. This restriction does not apply if using the Canvas Renderer.\r\n *\r\n * It starts with only one frame that covers the whole of the canvas. You can add further frames, that specify\r\n * sections of the canvas using the `add` method.\r\n *\r\n * Should you need to resize the canvas use the `setSize` method so that it accurately updates all of the underlying\r\n * texture data as well. Forgetting to do this (i.e. by changing the canvas size directly from your code) could cause\r\n * graphical errors.\r\n *\r\n * @class CanvasTexture\r\n * @extends Phaser.Textures.Texture\r\n * @memberof Phaser.Textures\r\n * @constructor\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Textures.TextureManager} manager - A reference to the Texture Manager this Texture belongs to.\r\n * @param {string} key - The unique string-based key of this Texture.\r\n * @param {HTMLCanvasElement} source - The canvas element that is used as the base of this texture.\r\n * @param {number} width - The width of the canvas.\r\n * @param {number} height - The height of the canvas.\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "classdesc": "A Canvas Texture is a special kind of Texture that is backed by an HTML Canvas Element as its source.\r\rYou can use the properties of this texture to draw to the canvas element directly, using all of the standard\rcanvas operations available in the browser. Any Game Object can be given this texture and will render with it.\r\rNote: When running under WebGL the Canvas Texture needs to re-generate its base WebGLTexture and reupload it to\rthe GPU every time you modify it, otherwise the changes you make to this texture will not be visible. To do this\ryou should call `CanvasTexture.refresh()` once you are finished with your changes to the canvas. Try and keep\rthis to a minimum, especially on large canvas sizes, or you may inadvertently thrash the GPU by constantly uploading\rtexture data to it. This restriction does not apply if using the Canvas Renderer.\r\rIt starts with only one frame that covers the whole of the canvas. You can add further frames, that specify\rsections of the canvas using the `add` method.\r\rShould you need to resize the canvas use the `setSize` method so that it accurately updates all of the underlying\rtexture data as well. Forgetting to do this (i.e. by changing the canvas size directly from your code) could cause\rgraphical errors.", "kind": "class", "name": "CanvasTexture", "augments": [ "Phaser.Textures.Texture" ], "memberof": "Phaser.Textures", "since": "3.7.0", "params": [ { "type": { "names": [ "Phaser.Textures.TextureManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } }, "description": "A reference to the Texture Manager this Texture belongs to.", "name": "manager" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of this Texture.", "name": "key" }, { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The canvas element that is used as the base of this texture.", "name": "source" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the canvas.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the canvas.", "name": "height" } ], "scope": "static", "longname": "Phaser.Textures.CanvasTexture", "___id": "T000002R039052", "___s": true }, { "comment": "/**\r\n * The source Canvas Element.\r\n *\r\n * @name Phaser.Textures.CanvasTexture#canvas\r\n * @readonly\r\n * @type {HTMLCanvasElement}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The source Canvas Element.", "name": "canvas", "readonly": true, "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.7.0", "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#canvas", "scope": "instance", "kind": "member", "___id": "T000002R039058", "___s": true }, { "comment": "/**\r\n * The 2D Canvas Rendering Context.\r\n *\r\n * @name Phaser.Textures.CanvasTexture#context\r\n * @readonly\r\n * @type {CanvasRenderingContext2D}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 78, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The 2D Canvas Rendering Context.", "name": "context", "readonly": true, "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "since": "3.7.0", "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#context", "scope": "instance", "kind": "member", "___id": "T000002R039060", "___s": true }, { "comment": "/**\r\n * The width of the Canvas.\r\n * This property is read-only, if you wish to change it use the `setSize` method.\r\n *\r\n * @name Phaser.Textures.CanvasTexture#width\r\n * @readonly\r\n * @type {number}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The width of the Canvas.\rThis property is read-only, if you wish to change it use the `setSize` method.", "name": "width", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.7.0", "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#width", "scope": "instance", "kind": "member", "___id": "T000002R039063", "___s": true }, { "comment": "/**\r\n * The height of the Canvas.\r\n * This property is read-only, if you wish to change it use the `setSize` method.\r\n *\r\n * @name Phaser.Textures.CanvasTexture#height\r\n * @readonly\r\n * @type {number}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The height of the Canvas.\rThis property is read-only, if you wish to change it use the `setSize` method.", "name": "height", "readonly": true, "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.7.0", "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#height", "scope": "instance", "kind": "member", "___id": "T000002R039065", "___s": true }, { "comment": "/**\r\n * The context image data.\r\n * Use the `update` method to populate this when the canvas changes.\r\n *\r\n * @name Phaser.Textures.CanvasTexture#imageData\r\n * @type {ImageData}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The context image data.\rUse the `update` method to populate this when the canvas changes.", "name": "imageData", "type": { "names": [ "ImageData" ], "parsedType": { "type": "NameExpression", "name": "ImageData" } }, "since": "3.13.0", "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#imageData", "scope": "instance", "kind": "member", "___id": "T000002R039067", "___s": true }, { "comment": "/**\r\n * A Uint8ClampedArray view into the `buffer`.\r\n * Use the `update` method to populate this when the canvas changes.\r\n * Note that this is unavailable in some browsers, such as Epic Browser, due to their security restrictions.\r\n *\r\n * @name Phaser.Textures.CanvasTexture#data\r\n * @type {Uint8ClampedArray}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "A Uint8ClampedArray view into the `buffer`.\rUse the `update` method to populate this when the canvas changes.\rNote that this is unavailable in some browsers, such as Epic Browser, due to their security restrictions.", "name": "data", "type": { "names": [ "Uint8ClampedArray" ], "parsedType": { "type": "NameExpression", "name": "Uint8ClampedArray" } }, "since": "3.13.0", "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#data", "scope": "instance", "kind": "member", "___id": "T000002R039069", "___s": true }, { "comment": "/**\r\n * An Uint32Array view into the `buffer`.\r\n *\r\n * @name Phaser.Textures.CanvasTexture#pixels\r\n * @type {Uint32Array}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "An Uint32Array view into the `buffer`.", "name": "pixels", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.13.0", "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#pixels", "scope": "instance", "kind": "member", "___id": "T000002R039072", "___s": true }, { "comment": "/**\r\n * An ArrayBuffer the same size as the context ImageData.\r\n *\r\n * @name Phaser.Textures.CanvasTexture#buffer\r\n * @type {ArrayBuffer}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "An ArrayBuffer the same size as the context ImageData.", "name": "buffer", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "since": "3.13.0", "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#buffer", "scope": "instance", "kind": "member", "___id": "T000002R039074", "___s": true }, { "comment": "/**\r\n * This re-creates the `imageData` from the current context.\r\n * It then re-builds the ArrayBuffer, the `data` Uint8ClampedArray reference and the `pixels` Int32Array.\r\n *\r\n * Warning: This is a very expensive operation, so use it sparingly.\r\n *\r\n * @method Phaser.Textures.CanvasTexture#update\r\n * @since 3.13.0\r\n *\r\n * @return {Phaser.Textures.CanvasTexture} This CanvasTexture.\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 173, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "This re-creates the `imageData` from the current context.\rIt then re-builds the ArrayBuffer, the `data` Uint8ClampedArray reference and the `pixels` Int32Array.\r\rWarning: This is a very expensive operation, so use it sparingly.", "kind": "function", "name": "update", "since": "3.13.0", "returns": [ { "type": { "names": [ "Phaser.Textures.CanvasTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.CanvasTexture" } }, "description": "This CanvasTexture." } ], "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#update", "scope": "instance", "___id": "T000002R039081", "___s": true }, { "comment": "/**\r\n * Draws the given Image or Canvas element to this CanvasTexture, then updates the internal\r\n * ImageData buffer and arrays.\r\n *\r\n * @method Phaser.Textures.CanvasTexture#draw\r\n * @since 3.13.0\r\n *\r\n * @param {number} x - The x coordinate to draw the source at.\r\n * @param {number} y - The y coordinate to draw the source at.\r\n * @param {(HTMLImageElement|HTMLCanvasElement)} source - The element to draw to this canvas.\r\n * @param {boolean} [update=true] - Update the internal ImageData buffer and arrays.\r\n *\r\n * @return {Phaser.Textures.CanvasTexture} This CanvasTexture.\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 213, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Draws the given Image or Canvas element to this CanvasTexture, then updates the internal\rImageData buffer and arrays.", "kind": "function", "name": "draw", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to draw the source at.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to draw the source at.", "name": "y" }, { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" } ] } }, "description": "The element to draw to this canvas.", "name": "source" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Update the internal ImageData buffer and arrays.", "name": "update" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.CanvasTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.CanvasTexture" } }, "description": "This CanvasTexture." } ], "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#draw", "scope": "instance", "___id": "T000002R039090", "___s": true }, { "comment": "/**\r\n * Draws the given texture frame to this CanvasTexture, then updates the internal\r\n * ImageData buffer and arrays.\r\n *\r\n * @method Phaser.Textures.CanvasTexture#drawFrame\r\n * @since 3.16.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {(string|number)} [frame] - The string-based name, or integer based index, of the Frame to get from the Texture.\r\n * @param {number} [x=0] - The x coordinate to draw the source at.\r\n * @param {number} [y=0] - The y coordinate to draw the source at.\r\n * @param {boolean} [update=true] - Update the internal ImageData buffer and arrays.\r\n *\r\n * @return {Phaser.Textures.CanvasTexture} This CanvasTexture.\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 241, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Draws the given texture frame to this CanvasTexture, then updates the internal\rImageData buffer and arrays.", "kind": "function", "name": "drawFrame", "since": "3.16.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The string-based name, or integer based index, of the Frame to get from the Texture.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate to draw the source at.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate to draw the source at.", "name": "y" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Update the internal ImageData buffer and arrays.", "name": "update" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.CanvasTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.CanvasTexture" } }, "description": "This CanvasTexture." } ], "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#drawFrame", "scope": "instance", "___id": "T000002R039093", "___s": true }, { "comment": "/**\r\n * Sets a pixel in the CanvasTexture to the given color and alpha values.\r\n *\r\n * This is an expensive operation to run in large quantities, so use sparingly.\r\n *\r\n * @method Phaser.Textures.CanvasTexture#setPixel\r\n * @since 3.16.0\r\n *\r\n * @param {number} x - The x coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.\r\n * @param {number} y - The y coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.\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 *\r\n * @return {this} This CanvasTexture.\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 291, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Sets a pixel in the CanvasTexture to the given color and alpha values.\r\rThis is an expensive operation to run in large quantities, so use sparingly.", "kind": "function", "name": "setPixel", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.", "name": "y" }, { "type": { "names": [ "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" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This CanvasTexture." } ], "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#setPixel", "scope": "instance", "___id": "T000002R039103", "___s": true }, { "comment": "/**\r\n * Puts the ImageData into the context of this CanvasTexture at the given coordinates.\r\n *\r\n * @method Phaser.Textures.CanvasTexture#putData\r\n * @since 3.16.0\r\n *\r\n * @param {ImageData} imageData - The ImageData to put at the given location.\r\n * @param {number} x - The x coordinate to put the imageData. Must lay within the dimensions of this CanvasTexture and be an integer.\r\n * @param {number} y - The y coordinate to put the imageData. Must lay within the dimensions of this CanvasTexture and be an integer.\r\n * @param {number} [dirtyX=0] - Horizontal position (x coordinate) of the top-left corner from which the image data will be extracted.\r\n * @param {number} [dirtyY=0] - Vertical position (x coordinate) of the top-left corner from which the image data will be extracted.\r\n * @param {number} [dirtyWidth] - Width of the rectangle to be painted. Defaults to the width of the image data.\r\n * @param {number} [dirtyHeight] - Height of the rectangle to be painted. Defaults to the height of the image data.\r\n *\r\n * @return {this} This CanvasTexture.\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Puts the ImageData into the context of this CanvasTexture at the given coordinates.", "kind": "function", "name": "putData", "since": "3.16.0", "params": [ { "type": { "names": [ "ImageData" ], "parsedType": { "type": "NameExpression", "name": "ImageData" } }, "description": "The ImageData to put at the given location.", "name": "imageData" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to put the imageData. Must lay within the dimensions of this CanvasTexture and be an integer.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to put the imageData. Must lay within the dimensions of this CanvasTexture and be an integer.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Horizontal position (x coordinate) of the top-left corner from which the image data will be extracted.", "name": "dirtyX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Vertical position (x coordinate) of the top-left corner from which the image data will be extracted.", "name": "dirtyY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Width of the rectangle to be painted. Defaults to the width of the image data.", "name": "dirtyWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Height of the rectangle to be painted. Defaults to the height of the image data.", "name": "dirtyHeight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This CanvasTexture." } ], "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#putData", "scope": "instance", "___id": "T000002R039114", "___s": true }, { "comment": "/**\r\n * Gets an ImageData region from this CanvasTexture from the position and size specified.\r\n * You can write this back using `CanvasTexture.putData`, or manipulate it.\r\n *\r\n * @method Phaser.Textures.CanvasTexture#getData\r\n * @since 3.16.0\r\n *\r\n * @param {number} x - The x coordinate of the top-left of the area to get the ImageData from. Must lay within the dimensions of this CanvasTexture and be an integer.\r\n * @param {number} y - The y coordinate of the top-left of the area to get the ImageData from. Must lay within the dimensions of this CanvasTexture and be an integer.\r\n * @param {number} width - The width of the rectangle from which the ImageData will be extracted. Positive values are to the right, and negative to the left.\r\n * @param {number} height - The height of the rectangle from which the ImageData will be extracted. Positive values are down, and negative are up.\r\n *\r\n * @return {ImageData} The ImageData extracted from this CanvasTexture.\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 360, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Gets an ImageData region from this CanvasTexture from the position and size specified.\rYou can write this back using `CanvasTexture.putData`, or manipulate it.", "kind": "function", "name": "getData", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the top-left of the area to get the ImageData from. Must lay within the dimensions of this CanvasTexture and be an integer.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the top-left of the area to get the ImageData from. Must lay within the dimensions of this CanvasTexture and be an integer.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the rectangle from which the ImageData will be extracted. Positive values are to the right, and negative to the left.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the rectangle from which the ImageData will be extracted. Positive values are down, and negative are up.", "name": "height" } ], "returns": [ { "type": { "names": [ "ImageData" ], "parsedType": { "type": "NameExpression", "name": "ImageData" } }, "description": "The ImageData extracted from this CanvasTexture." } ], "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#getData", "scope": "instance", "___id": "T000002R039120", "___s": true }, { "comment": "/**\r\n * Get the color of a specific pixel from this texture and store it in a Color object.\r\n *\r\n * If you have drawn anything to this CanvasTexture since it was created you must call `CanvasTexture.update` to refresh the array buffer,\r\n * otherwise this may return out of date color values, or worse - throw a run-time error as it tries to access an array element that doesn't exist.\r\n *\r\n * @method Phaser.Textures.CanvasTexture#getPixel\r\n * @since 3.13.0\r\n *\r\n * @param {number} x - The x coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.\r\n * @param {number} y - The y coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.\r\n * @param {Phaser.Display.Color} [out] - A Color object to store the pixel values in. If not provided a new Color object will be created.\r\n *\r\n * @return {Phaser.Display.Color} An object with the red, green, blue and alpha values set in the r, g, b and a properties.\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 386, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Get the color of a specific pixel from this texture and store it in a Color object.\r\rIf you have drawn anything to this CanvasTexture since it was created you must call `CanvasTexture.update` to refresh the array buffer,\rotherwise this may return out of date color values, or worse - throw a run-time error as it tries to access an array element that doesn't exist.", "kind": "function", "name": "getPixel", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.", "name": "y" }, { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "optional": true, "description": "A Color object to store the pixel values in. If not provided a new Color object will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "An object with the red, green, blue and alpha values set in the r, g, b and a properties." } ], "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#getPixel", "scope": "instance", "___id": "T000002R039127", "___s": true }, { "comment": "/**\r\n * Returns an array containing all of the pixels in the given region.\r\n *\r\n * If the requested region extends outside the bounds of this CanvasTexture,\r\n * the region is truncated to fit.\r\n *\r\n * If you have drawn anything to this CanvasTexture since it was created you must call `CanvasTexture.update` to refresh the array buffer,\r\n * otherwise this may return out of date color values, or worse - throw a run-time error as it tries to access an array element that doesn't exist.\r\n *\r\n * @method Phaser.Textures.CanvasTexture#getPixels\r\n * @since 3.16.0\r\n *\r\n * @param {number} [x=0] - The x coordinate of the top-left of the region. Must lay within the dimensions of this CanvasTexture and be an integer.\r\n * @param {number} [y=0] - The y coordinate of the top-left of the region. Must lay within the dimensions of this CanvasTexture and be an integer.\r\n * @param {number} [width] - The width of the region to get. Must be an integer. Defaults to the canvas width if not given.\r\n * @param {number} [height] - The height of the region to get. Must be an integer. If not given will be set to the `width`.\r\n *\r\n * @return {Phaser.Types.Textures.PixelConfig[][]} A 2d array of Pixel objects.\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 425, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Returns an array containing all of the pixels in the given region.\r\rIf the requested region extends outside the bounds of this CanvasTexture,\rthe region is truncated to fit.\r\rIf you have drawn anything to this CanvasTexture since it was created you must call `CanvasTexture.update` to refresh the array buffer,\rotherwise this may return out of date color values, or worse - throw a run-time error as it tries to access an array element that doesn't exist.", "kind": "function", "name": "getPixels", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of the top-left of the region. Must lay within the dimensions of this CanvasTexture and be an integer.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the top-left of the region. Must lay within the dimensions of this CanvasTexture and be an integer.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the region to get. Must be an integer. Defaults to the canvas width if not given.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the region to get. Must be an integer. If not given will be set to the `width`.", "name": "height" } ], "returns": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Textures.PixelConfig", "type": "NameExpression" } ] } ] } }, "description": "A 2d array of Pixel objects." } ], "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#getPixels", "scope": "instance", "___id": "T000002R039136", "___s": true }, { "comment": "/**\r\n * Returns the Image Data index for the given pixel in this CanvasTexture.\r\n *\r\n * The index can be used to read directly from the `this.data` array.\r\n *\r\n * The index points to the red value in the array. The subsequent 3 indexes\r\n * point to green, blue and alpha respectively.\r\n *\r\n * @method Phaser.Textures.CanvasTexture#getIndex\r\n * @since 3.16.0\r\n *\r\n * @param {number} x - The x coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.\r\n * @param {number} y - The y coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.\r\n *\r\n * @return {number}\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 480, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Returns the Image Data index for the given pixel in this CanvasTexture.\r\rThe index can be used to read directly from the `this.data` array.\r\rThe index points to the red value in the array. The subsequent 3 indexes\rpoint to green, blue and alpha respectively.", "kind": "function", "name": "getIndex", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.", "name": "y" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } } } ], "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#getIndex", "scope": "instance", "___id": "T000002R039158", "___s": true }, { "comment": "/**\r\n * This should be called manually if you are running under WebGL.\r\n * It will refresh the WebGLTexture from the Canvas source. Only call this if you know that the\r\n * canvas has changed, as there is a significant GPU texture allocation cost involved in doing so.\r\n *\r\n * @method Phaser.Textures.CanvasTexture#refresh\r\n * @since 3.7.0\r\n *\r\n * @return {Phaser.Textures.CanvasTexture} This CanvasTexture.\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 511, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "This should be called manually if you are running under WebGL.\rIt will refresh the WebGLTexture from the Canvas source. Only call this if you know that the\rcanvas has changed, as there is a significant GPU texture allocation cost involved in doing so.", "kind": "function", "name": "refresh", "since": "3.7.0", "returns": [ { "type": { "names": [ "Phaser.Textures.CanvasTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.CanvasTexture" } }, "description": "This CanvasTexture." } ], "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#refresh", "scope": "instance", "___id": "T000002R039162", "___s": true }, { "comment": "/**\r\n * Gets the Canvas Element.\r\n *\r\n * @method Phaser.Textures.CanvasTexture#getCanvas\r\n * @since 3.7.0\r\n *\r\n * @return {HTMLCanvasElement} The Canvas DOM element this texture is using.\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 528, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Gets the Canvas Element.", "kind": "function", "name": "getCanvas", "since": "3.7.0", "returns": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The Canvas DOM element this texture is using." } ], "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#getCanvas", "scope": "instance", "___id": "T000002R039164", "___s": true }, { "comment": "/**\r\n * Gets the 2D Canvas Rendering Context.\r\n *\r\n * @method Phaser.Textures.CanvasTexture#getContext\r\n * @since 3.7.0\r\n *\r\n * @return {CanvasRenderingContext2D} The Canvas Rendering Context this texture is using.\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 541, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Gets the 2D Canvas Rendering Context.", "kind": "function", "name": "getContext", "since": "3.7.0", "returns": [ { "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "description": "The Canvas Rendering Context this texture is using." } ], "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#getContext", "scope": "instance", "___id": "T000002R039166", "___s": true }, { "comment": "/**\r\n * Clears the given region of this Canvas Texture, resetting it back to transparent.\r\n * If no region is given, the whole Canvas Texture is cleared.\r\n *\r\n * @method Phaser.Textures.CanvasTexture#clear\r\n * @since 3.7.0\r\n *\r\n * @param {number} [x=0] - The x coordinate of the top-left of the region to clear.\r\n * @param {number} [y=0] - The y coordinate of the top-left of the region to clear.\r\n * @param {number} [width] - The width of the region.\r\n * @param {number} [height] - The height of the region.\r\n * @param {boolean} [update=true] - Update the internal ImageData buffer and arrays.\r\n *\r\n * @return {Phaser.Textures.CanvasTexture} The Canvas Texture.\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 554, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Clears the given region of this Canvas Texture, resetting it back to transparent.\rIf no region is given, the whole Canvas Texture is cleared.", "kind": "function", "name": "clear", "since": "3.7.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of the top-left of the region to clear.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the top-left of the region to clear.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the region.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the region.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Update the internal ImageData buffer and arrays.", "name": "update" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.CanvasTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.CanvasTexture" } }, "description": "The Canvas Texture." } ], "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#clear", "scope": "instance", "___id": "T000002R039168", "___s": true }, { "comment": "/**\r\n * Changes the size of this Canvas Texture.\r\n *\r\n * @method Phaser.Textures.CanvasTexture#setSize\r\n * @since 3.7.0\r\n *\r\n * @param {number} width - The new width of the Canvas.\r\n * @param {number} [height] - The new height of the Canvas. If not given it will use the width as the height.\r\n *\r\n * @return {Phaser.Textures.CanvasTexture} The Canvas Texture.\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Changes the size of this Canvas Texture.", "kind": "function", "name": "setSize", "since": "3.7.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the Canvas.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The new height of the Canvas. If not given it will use the width as the height.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.CanvasTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.CanvasTexture" } }, "description": "The Canvas Texture." } ], "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#setSize", "scope": "instance", "___id": "T000002R039175", "___s": true }, { "comment": "/**\r\n * Destroys this Texture and releases references to its sources and frames.\r\n *\r\n * @method Phaser.Textures.CanvasTexture#destroy\r\n * @since 3.16.0\r\n */", "meta": { "filename": "CanvasTexture.js", "lineno": 626, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Destroys this Texture and releases references to its sources and frames.", "kind": "function", "name": "destroy", "since": "3.16.0", "memberof": "Phaser.Textures.CanvasTexture", "longname": "Phaser.Textures.CanvasTexture#destroy", "scope": "instance", "overrides": "Phaser.Textures.Texture#destroy", "___id": "T000002R039185", "___s": true }, { "comment": "/**\r\n * Filter Types.\r\n *\r\n * @namespace Phaser.Textures.FilterMode\r\n * @memberof Phaser.Textures\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Filter Types.", "kind": "namespace", "name": "FilterMode", "memberof": "Phaser.Textures", "since": "3.0.0", "longname": "Phaser.Textures.FilterMode", "scope": "static", "___id": "T000002R039195", "___s": true }, { "comment": "/**\r\n * Linear filter type.\r\n *\r\n * @name Phaser.Textures.FilterMode.LINEAR\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 16, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Linear filter type.", "name": "LINEAR", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Textures.FilterMode", "longname": "Phaser.Textures.FilterMode.LINEAR", "scope": "static", "___id": "T000002R039197", "___s": true }, { "comment": "/**\r\n * Nearest neighbor filter type.\r\n *\r\n * @name Phaser.Textures.FilterMode.NEAREST\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 26, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Nearest neighbor filter type.", "name": "NEAREST", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Textures.FilterMode", "longname": "Phaser.Textures.FilterMode.NEAREST", "scope": "static", "___id": "T000002R039199", "___s": true }, { "comment": "/**\r\n * @classdesc\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 * ```js\r\n * const t = this.textures.addDynamicTexture('player', 64, 128);\r\n * // draw objects to t\r\n * this.add.sprite(x, y, 'player');\r\n * ```\r\n *\r\n * Because this is a standard Texture within Phaser, you can add frames to it, meaning you can use it\r\n * to generate sprite sheets, texture atlases or tile sets.\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 * Based on the assumption that you will be using this Dynamic Texture as a source for Sprites, it will\r\n * automatically invert any drawing done to it on the y axis. If you do not require this, please call the\r\n * `setIsSpriteTexture()` method and pass it `false` as its parameter. Do this before you start drawing\r\n * to this texture, otherwise you will get vertically inverted frames under WebGL. This isn't required\r\n * for Canvas.\r\n *\r\n * @class DynamicTexture\r\n * @extends Phaser.Textures.Texture\r\n * @memberof Phaser.Textures\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Textures.TextureManager} manager - A reference to the Texture Manager this Texture belongs to.\r\n * @param {string} key - The unique string-based key of this Texture.\r\n * @param {number} [width=256] - The width of this Dymamic Texture in pixels. Defaults to 256 x 256.\r\n * @param {number} [height=256] - The height of this Dymamic Texture in pixels. Defaults to 256 x 256.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "classdesc": "A 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\r```js\rconst t = this.textures.addDynamicTexture('player', 64, 128);\r// draw objects to t\rthis.add.sprite(x, y, 'player');\r```\r\rBecause this is a standard Texture within Phaser, you can add frames to it, meaning you can use it\rto generate sprite sheets, texture atlases or tile sets.\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\rBased on the assumption that you will be using this Dynamic Texture as a source for Sprites, it will\rautomatically invert any drawing done to it on the y axis. If you do not require this, please call the\r`setIsSpriteTexture()` method and pass it `false` as its parameter. Do this before you start drawing\rto this texture, otherwise you will get vertically inverted frames under WebGL. This isn't required\rfor Canvas.", "kind": "class", "name": "DynamicTexture", "augments": [ "Phaser.Textures.Texture" ], "memberof": "Phaser.Textures", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Textures.TextureManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } }, "description": "A reference to the Texture Manager this Texture belongs to.", "name": "manager" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of this Texture.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 256, "description": "The width of this Dymamic Texture in pixels. Defaults to 256 x 256.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 256, "description": "The height of this Dymamic Texture in pixels. Defaults to 256 x 256.", "name": "height" } ], "scope": "static", "longname": "Phaser.Textures.DynamicTexture", "___id": "T000002R039213", "___s": true }, { "comment": "/**\r\n * The internal data type of this object.\r\n *\r\n * @name Phaser.Textures.DynamicTexture#type\r\n * @type {string}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The internal data type of this object.", "name": "type", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#type", "scope": "instance", "kind": "member", "___id": "T000002R039219", "___s": true }, { "comment": "/**\r\n * A reference to either the Canvas or WebGL Renderer that the Game instance is using.\r\n *\r\n * @name Phaser.Textures.DynamicTexture#renderer\r\n * @type {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)}\r\n * @since 3.2.0\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "A reference to either the Canvas or WebGL Renderer that the Game instance is using.", "name": "renderer", "type": { "names": [ "Phaser.Renderer.Canvas.CanvasRenderer", "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.Canvas.CanvasRenderer" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } ] } }, "since": "3.2.0", "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#renderer", "scope": "instance", "kind": "member", "___id": "T000002R039224", "___s": true }, { "comment": "/**\r\n * The width of this Dynamic Texture.\r\n *\r\n * Treat this property as read-only. Use the `setSize` method to change the size.\r\n *\r\n * @name Phaser.Textures.DynamicTexture#width\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The width of this Dynamic Texture.\r\rTreat this property as read-only. Use the `setSize` method to change the size.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#width", "scope": "instance", "kind": "member", "___id": "T000002R039226", "___s": true }, { "comment": "/**\r\n * The height of this Dynamic Texture.\r\n *\r\n * Treat this property as read-only. Use the `setSize` method to change the size.\r\n *\r\n * @name Phaser.Textures.DynamicTexture#height\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The height of this Dynamic Texture.\r\rTreat this property as read-only. Use the `setSize` method to change the size.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#height", "scope": "instance", "kind": "member", "___id": "T000002R039228", "___s": true }, { "comment": "/**\r\n * This flag is set to 'true' during `beginDraw` and reset to 'false` in `endDraw`,\r\n * allowing you to determine if this Dynamic Texture is batch drawing, or not.\r\n *\r\n * @name Phaser.Textures.DynamicTexture#isDrawing\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 124, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "This flag is set to 'true' during `beginDraw` and reset to 'false` in `endDraw`,\rallowing you to determine if this Dynamic Texture is batch drawing, or not.", "name": "isDrawing", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#isDrawing", "scope": "instance", "kind": "member", "___id": "T000002R039230", "___s": true }, { "comment": "/**\r\n * A reference to the Rendering Context belonging to the Canvas Element this Dynamic Texture is drawing to.\r\n *\r\n * @name Phaser.Textures.DynamicTexture#canvas\r\n * @type {HTMLCanvasElement}\r\n * @since 3.2.0\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 135, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "A reference to the Rendering Context belonging to the Canvas Element this Dynamic Texture is drawing to.", "name": "canvas", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.2.0", "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#canvas", "scope": "instance", "kind": "member", "___id": "T000002R039232", "___s": true }, { "comment": "/**\r\n * The 2D Canvas Rendering Context.\r\n *\r\n * @name Phaser.Textures.DynamicTexture#context\r\n * @readonly\r\n * @type {CanvasRenderingContext2D}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 144, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The 2D Canvas Rendering Context.", "name": "context", "readonly": true, "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "since": "3.7.0", "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#context", "scope": "instance", "kind": "member", "___id": "T000002R039234", "___s": true }, { "comment": "/**\r\n * Is this Dynamic Texture dirty or not? If not it won't spend time clearing or filling itself.\r\n *\r\n * @name Phaser.Textures.DynamicTexture#dirty\r\n * @type {boolean}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Is this Dynamic Texture dirty or not? If not it won't spend time clearing or filling itself.", "name": "dirty", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.12.0", "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#dirty", "scope": "instance", "kind": "member", "___id": "T000002R039237", "___s": true }, { "comment": "/**\r\n * Is this Dynamic Texture being used as the base texture for a Sprite Game Object?\r\n *\r\n * This is enabled by default, as we expect that will be the core use for Dynamic Textures.\r\n *\r\n * However, to disable it, call `RenderTexture.setIsSpriteTexture(false)`.\r\n *\r\n * You should do this _before_ drawing to this texture, so that it correctly\r\n * inverses the frames for WebGL rendering. Not doing so will result in vertically flipped frames.\r\n *\r\n * This property is used in the `endDraw` method.\r\n *\r\n * @name Phaser.Textures.DynamicTexture#isSpriteTexture\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Is this Dynamic Texture being used as the base texture for a Sprite Game Object?\r\rThis is enabled by default, as we expect that will be the core use for Dynamic Textures.\r\rHowever, to disable it, call `RenderTexture.setIsSpriteTexture(false)`.\r\rYou should do this _before_ drawing to this texture, so that it correctly\rinverses the frames for WebGL rendering. Not doing so will result in vertically flipped frames.\r\rThis property is used in the `endDraw` method.", "name": "isSpriteTexture", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#isSpriteTexture", "scope": "instance", "kind": "member", "___id": "T000002R039239", "___s": true }, { "comment": "/**\r\n * An internal Camera that can be used to move around this Dynamic 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** (not textures) that you then draw to this texture.\r\n *\r\n * You can scroll, zoom and rotate this Camera.\r\n *\r\n * @name Phaser.Textures.DynamicTexture#camera\r\n * @type {Phaser.Cameras.Scene2D.BaseCamera}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 191, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "An internal Camera that can be used to move around this Dynamic Texture.\r\rControl it just like you would any Scene Camera. The difference is that it only impacts\rthe placement of **Game Objects** (not textures) that you then draw to this texture.\r\rYou can scroll, zoom and rotate this Camera.", "name": "camera", "type": { "names": [ "Phaser.Cameras.Scene2D.BaseCamera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.BaseCamera" } }, "since": "3.12.0", "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#camera", "scope": "instance", "kind": "member", "___id": "T000002R039243", "___s": true }, { "comment": "/**\r\n * The Render Target that belongs to this Dynamic Texture.\r\n *\r\n * A Render Target encapsulates a framebuffer and texture for the WebGL Renderer.\r\n *\r\n * This property remains `null` under Canvas.\r\n *\r\n * @name Phaser.Textures.DynamicTexture#renderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 205, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The Render Target that belongs to this Dynamic Texture.\r\rA Render Target encapsulates a framebuffer and texture for the WebGL Renderer.\r\rThis property remains `null` under Canvas.", "name": "renderTarget", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.60.0", "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#renderTarget", "scope": "instance", "kind": "member", "___id": "T000002R039245", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Single Pipeline.\r\n *\r\n * This property remains `null` under Canvas.\r\n *\r\n * @name Phaser.Textures.DynamicTexture#pipeline\r\n * @type {Phaser.Renderer.WebGL.Pipelines.SinglePipeline}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 218, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "A reference to the WebGL Single Pipeline.\r\rThis property remains `null` under Canvas.", "name": "pipeline", "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.SinglePipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline" } }, "since": "3.60.0", "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#pipeline", "scope": "instance", "kind": "member", "___id": "T000002R039247", "___s": true }, { "comment": "/**\r\n * Resizes this Dynamic 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 this Dynamic Texture.\r\n * In Canvas it will resize the underlying canvas DOM element.\r\n *\r\n * Both approaches will erase everything currently drawn to this texture.\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.Textures.DynamicTexture#setSize\r\n * @since 3.10.0\r\n *\r\n * @param {number} width - The new width of this Dynamic Texture.\r\n * @param {number} [height=width] - The new height of this Dynamic Texture. If not specified, will be set the same as the `width`.\r\n *\r\n * @return {this} This Dynamic Texture.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 240, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Resizes this Dynamic Texture to the new dimensions given.\r\rIn WebGL it will destroy and then re-create the frame buffer being used by this Dynamic Texture.\rIn Canvas it will resize the underlying canvas DOM element.\r\rBoth approaches will erase everything currently drawn to this texture.\r\rIf the dimensions given are the same as those already being used, calling this method will do nothing.", "kind": "function", "name": "setSize", "since": "3.10.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this Dynamic Texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "width", "description": "The new height of this Dynamic Texture. If not specified, will be set the same as the `width`.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Dynamic Texture." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#setSize", "scope": "instance", "___id": "T000002R039254", "___s": true }, { "comment": "/**\r\n * Links the WebGL Textures used by this Dynamic Texture to its Render Target.\r\n *\r\n * This method is called internally by the Dynamic Texture when it is first created,\r\n * or if you change its size.\r\n *\r\n * @method Phaser.Textures.DynamicTexture#setFromRenderTarget\r\n * @since 3.61.0\r\n *\r\n * @return {this} This Dynamic Texture instance.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Links the WebGL Textures used by this Dynamic Texture to its Render Target.\r\rThis method is called internally by the Dynamic Texture when it is first created,\ror if you change its size.", "kind": "function", "name": "setFromRenderTarget", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Dynamic Texture instance." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#setFromRenderTarget", "scope": "instance", "___id": "T000002R039269", "___s": true }, { "comment": "/**\r\n * If you are planning on using this Render Texture as a base texture for Sprite\r\n * Game Objects, then you should call this method with a value of `true` before\r\n * drawing anything to it, otherwise you will get inverted frames in WebGL.\r\n *\r\n * @method Phaser.Textures.DynamicTexture#setIsSpriteTexture\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} value - Is this Render Target being used as a Sprite Texture, or not?\r\n *\r\n * @return {this} This Dynamic Texture instance.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 345, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "If you are planning on using this Render Texture as a base texture for Sprite\rGame Objects, then you should call this method with a value of `true` before\rdrawing anything to it, otherwise you will get inverted frames in WebGL.", "kind": "function", "name": "setIsSpriteTexture", "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this Render Target being used as a Sprite Texture, or not?", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Dynamic Texture instance." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#setIsSpriteTexture", "scope": "instance", "___id": "T000002R039279", "___s": true }, { "comment": "/**\r\n * Fills this Dynamic 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.Textures.DynamicTexture#fill\r\n * @since 3.2.0\r\n *\r\n * @param {number} rgb - The color to fill this Dynamic 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 Dynamic Texture instance.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 364, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Fills this Dynamic 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 Dynamic 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 Dynamic Texture instance." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#fill", "scope": "instance", "___id": "T000002R039282", "___s": true }, { "comment": "/**\r\n * Fully clears this Dynamic Texture, erasing everything from it and resetting it back to\r\n * a blank, transparent, texture.\r\n *\r\n * @method Phaser.Textures.DynamicTexture#clear\r\n * @since 3.2.0\r\n *\r\n * @return {this} This Dynamic Texture instance.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 439, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Fully clears this Dynamic Texture, erasing everything from it and resetting it back to\ra blank, transparent, texture.", "kind": "function", "name": "clear", "since": "3.2.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Dynamic Texture instance." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#clear", "scope": "instance", "___id": "T000002R039303", "___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 * @method Phaser.Textures.DynamicTexture#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 Dynamic Texture instance.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 473, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "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.", "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 Dynamic Texture instance." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#stamp", "scope": "instance", "___id": "T000002R039308", "___s": true }, { "comment": "/**\r\n * Draws the given object, or an array of objects, to this Dynamic 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 * 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: You cannot erase a Dynamic Texture from itself.\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.\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 *\r\n * Calling this method causes the WebGL batch to flush, so it can write the texture\r\n * data to the framebuffer being used internally. The batch is flushed at the end,\r\n * after the entries have been iterated. So if you've a bunch of objects to draw,\r\n * try and pass them in an array in one single call, rather than making lots of\r\n * separate calls.\r\n *\r\n * If you are not planning on using this Dynamic Texture as a base texture for Sprite\r\n * Game Objects, then you should set `DynamicTexture.isSpriteTexture = false` before\r\n * calling this method, otherwise you will get vertically inverted frames in WebGL.\r\n *\r\n * @method Phaser.Textures.DynamicTexture#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 Dynamic Texture instance.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 553, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Draws the given object, or an array of objects, to this Dynamic Texture using a blend mode of ERASE.\rThis has the effect of erasing any filled pixels present in the objects from this texture.\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: You cannot erase a Dynamic Texture from itself.\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.\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.\r\rCalling this method causes the WebGL batch to flush, so it can write the texture\rdata to the framebuffer being used internally. The batch is flushed at the end,\rafter the entries have been iterated. So if you've a bunch of objects to draw,\rtry and pass them in an array in one single call, rather than making lots of\rseparate calls.\r\rIf you are not planning on using this Dynamic Texture as a base texture for Sprite\rGame Objects, then you should set `DynamicTexture.isSpriteTexture = false` before\rcalling this method, otherwise you will get vertically inverted frames in WebGL.", "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 Dynamic Texture instance." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#erase", "scope": "instance", "___id": "T000002R039327", "___s": true }, { "comment": "/**\r\n * Draws the given object, or an array of objects, to this Dynamic Texture.\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 Dynamic Texture to itself.\r\n *\r\n * Note 2: For Game Objects that have Post FX Pipelines, the pipeline _cannot_ be\r\n * used when drawn to this texture.\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 *\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 * Calling this method causes the WebGL batch to flush, so it can write the texture\r\n * data to the framebuffer being used internally. The batch is flushed at the end,\r\n * after the entries have been iterated. So if you've a bunch of objects to draw,\r\n * try and pass them in an array in one single call, rather than making lots of\r\n * separate calls.\r\n *\r\n * If you are not planning on using this Dynamic Texture as a base texture for Sprite\r\n * Game Objects, then you should set `DynamicTexture.isSpriteTexture = false` before\r\n * calling this method, otherwise you will get vertically inverted frames in WebGL.\r\n *\r\n * @method Phaser.Textures.DynamicTexture#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 Dynamic Texture instance.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Draws the given object, or an array of objects, to this Dynamic Texture.\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 Dynamic Texture to itself.\r\rNote 2: For Game Objects that have Post FX Pipelines, the pipeline _cannot_ be\rused when drawn to this texture.\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.\r\rThe `alpha` and `tint` values are only used by Texture Frames.\rGame Objects use their own alpha and tint values when being drawn.\r\rCalling this method causes the WebGL batch to flush, so it can write the texture\rdata to the framebuffer being used internally. The batch is flushed at the end,\rafter the entries have been iterated. So if you've a bunch of objects to draw,\rtry and pass them in an array in one single call, rather than making lots of\rseparate calls.\r\rIf you are not planning on using this Dynamic Texture as a base texture for Sprite\rGame Objects, then you should set `DynamicTexture.isSpriteTexture = false` before\rcalling this method, otherwise you will get vertically inverted frames in WebGL.", "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 Dynamic Texture instance." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#draw", "scope": "instance", "___id": "T000002R039331", "___s": true }, { "comment": "/**\r\n * Draws the Texture Frame to the Render Texture at the given position.\r\n *\r\n * Textures are referenced by their string-based keys, as stored in the Texture Manager.\r\n *\r\n * ```javascript\r\n * var rt = this.add.renderTexture(0, 0, 800, 600);\r\n * rt.drawFrame(key, frame);\r\n * ```\r\n *\r\n * You can optionally provide a position, alpha and tint value to apply to the frame\r\n * before it is drawn.\r\n *\r\n * Calling this method will cause a batch flush, so if you've got a stack of things to draw\r\n * in a tight loop, try using the `draw` method instead.\r\n *\r\n * If you need to draw a Sprite to this Render Texture, use the `draw` method instead.\r\n *\r\n * If you are not planning on using this Dynamic Texture as a base texture for Sprite\r\n * Game Objects, then you should set `DynamicTexture.isSpriteTexture = false` before\r\n * calling this method, otherwise you will get vertically inverted frames in WebGL.\r\n *\r\n * @method Phaser.Textures.DynamicTexture#drawFrame\r\n * @since 3.12.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 {number} [alpha=1] - The alpha value. Only used when drawing Texture Frames to this texture.\r\n * @param {number} [tint=0xffffff] - The tint color value. Only used when drawing Texture Frames to this texture. WebGL only.\r\n *\r\n * @return {this} This Dynamic Texture instance.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 683, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Draws the Texture Frame to the Render Texture at the given position.\r\rTextures are referenced by their string-based keys, as stored in the Texture Manager.\r\r```javascript\rvar rt = this.add.renderTexture(0, 0, 800, 600);\rrt.drawFrame(key, frame);\r```\r\rYou can optionally provide a position, alpha and tint value to apply to the frame\rbefore it is drawn.\r\rCalling this method will cause a batch flush, so if you've got a stack of things to draw\rin a tight loop, try using the `draw` method instead.\r\rIf you need to draw a Sprite to this Render Texture, use the `draw` method instead.\r\rIf you are not planning on using this Dynamic Texture as a base texture for Sprite\rGame Objects, then you should set `DynamicTexture.isSpriteTexture = false` before\rcalling this method, otherwise you will get vertically inverted frames in WebGL.", "kind": "function", "name": "drawFrame", "since": "3.12.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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The alpha value. Only used when drawing Texture Frames to this texture.", "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. WebGL only.", "name": "tint" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Dynamic Texture instance." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#drawFrame", "scope": "instance", "___id": "T000002R039333", "___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 *\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 * Calling this method will cause a batch flush by default. Use the `skipBatch` argument\r\n * to disable this if this call is part of a larger batch draw.\r\n *\r\n * If you are not planning on using this Dynamic Texture as a base texture for Sprite\r\n * Game Objects, then you should set `DynamicTexture.isSpriteTexture = false` before\r\n * calling this method, otherwise you will get vertically inverted frames in WebGL.\r\n *\r\n * @method Phaser.Textures.DynamicTexture#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 {number} [alpha=1] - The alpha to use. Defaults to 1, no alpha.\r\n * @param {number} [tint=0xffffff] - WebGL only. The tint color to use. Leave as undefined, or 0xffffff to have no tint.\r\n * @param {boolean} [skipBatch=false] - Skip beginning and ending a batch with this call. Use if this is part of a bigger batched draw.\r\n *\r\n * @return {this} This Dynamic Texture instance.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 726, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "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.\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\rCalling this method will cause a batch flush by default. Use the `skipBatch` argument\rto disable this if this call is part of a larger batch draw.\r\rIf you are not planning on using this Dynamic Texture as a base texture for Sprite\rGame Objects, then you should set `DynamicTexture.isSpriteTexture = false` before\rcalling this method, otherwise you will get vertically inverted frames in WebGL.", "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The alpha to use. Defaults to 1, no alpha.", "name": "alpha" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "WebGL only. The tint color to use. Leave as undefined, or 0xffffff to have no tint.", "name": "tint" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip beginning and ending a batch with this call. Use if this is part of a bigger batched draw.", "name": "skipBatch" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Dynamic Texture instance." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#repeat", "scope": "instance", "___id": "T000002R039335", "___s": true }, { "comment": "/**\r\n * Use this method if you need to batch draw a large number of Game Objects to\r\n * this Dynamic Texture in a single pass, or on a frequent basis. This is especially\r\n * useful under WebGL, however, if your game is using Canvas only, it will not make\r\n * any speed difference in that situation.\r\n *\r\n * This method starts the beginning of a batched draw, unless one is already open.\r\n *\r\n * Batched drawing is faster than calling `draw` in loop, but you must be careful\r\n * to manage the flow of code and remember to call `endDraw()` when you're finished.\r\n *\r\n * If you don't need to draw large numbers of objects it's much safer and easier\r\n * to use the `draw` method instead.\r\n *\r\n * The flow should be:\r\n *\r\n * ```javascript\r\n * // Call once:\r\n * DynamicTexture.beginDraw();\r\n *\r\n * // repeat n times:\r\n * DynamicTexture.batchDraw();\r\n * // or\r\n * DynamicTexture.batchDrawFrame();\r\n *\r\n * // Call once:\r\n * DynamicTexture.endDraw();\r\n * ```\r\n *\r\n * Do not call any methods other than `batchDraw`, `batchDrawFrame`, or `endDraw` once you\r\n * have started a batch. Also, be very careful not to destroy this Dynamic Texture while the\r\n * batch is still open. Doing so will cause a run-time error in the WebGL Renderer.\r\n *\r\n * You can use the `DynamicTexture.isDrawing` boolean property to tell if a batch is\r\n * currently open, or not.\r\n *\r\n * @method Phaser.Textures.DynamicTexture#beginDraw\r\n * @since 3.50.0\r\n *\r\n * @return {this} This Dynamic Texture instance.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 915, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Use this method if you need to batch draw a large number of Game Objects to\rthis Dynamic Texture in a single pass, or on a frequent basis. This is especially\ruseful under WebGL, however, if your game is using Canvas only, it will not make\rany speed difference in that situation.\r\rThis method starts the beginning of a batched draw, unless one is already open.\r\rBatched drawing is faster than calling `draw` in loop, but you must be careful\rto manage the flow of code and remember to call `endDraw()` when you're finished.\r\rIf you don't need to draw large numbers of objects it's much safer and easier\rto use the `draw` method instead.\r\rThe flow should be:\r\r```javascript\r// Call once:\rDynamicTexture.beginDraw();\r\r// repeat n times:\rDynamicTexture.batchDraw();\r// or\rDynamicTexture.batchDrawFrame();\r\r// Call once:\rDynamicTexture.endDraw();\r```\r\rDo not call any methods other than `batchDraw`, `batchDrawFrame`, or `endDraw` once you\rhave started a batch. Also, be very careful not to destroy this Dynamic Texture while the\rbatch is still open. Doing so will cause a run-time error in the WebGL Renderer.\r\rYou can use the `DynamicTexture.isDrawing` boolean property to tell if a batch is\rcurrently open, or not.", "kind": "function", "name": "beginDraw", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Dynamic Texture instance." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#beginDraw", "scope": "instance", "___id": "T000002R039382", "___s": true }, { "comment": "/**\r\n * Use this method if you have already called `beginDraw` and need to batch\r\n * draw a large number of objects to this Dynamic Texture.\r\n *\r\n * This method batches the drawing of the given objects to this texture,\r\n * without causing a WebGL bind or batch flush for each one.\r\n *\r\n * It is faster than calling `draw`, but you must be careful to manage the\r\n * flow of code and remember to call `endDraw()`. If you don't need to draw large\r\n * numbers of objects it's much safer and easier to use the `draw` method instead.\r\n *\r\n * The flow should be:\r\n *\r\n * ```javascript\r\n * // Call once:\r\n * DynamicTexture.beginDraw();\r\n *\r\n * // repeat n times:\r\n * DynamicTexture.batchDraw();\r\n * // or\r\n * DynamicTexture.batchDrawFrame();\r\n *\r\n * // Call once:\r\n * DynamicTexture.endDraw();\r\n * ```\r\n *\r\n * Do not call any methods other than `batchDraw`, `batchDrawFrame`, or `endDraw` once you\r\n * have started a batch. Also, be very careful not to destroy this Dynamic Texture while the\r\n * batch is still open. Doing so will cause a run-time error in the WebGL Renderer.\r\n *\r\n * You can use the `DynamicTexture.isDrawing` boolean property to tell if a batch is\r\n * currently open, or not.\r\n *\r\n * This method 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's Display List. Pass in `Scene.children` to draw the whole list.\r\n * * Another Dynamic Texture or Render Texture.\r\n * * A Texture Frame instance.\r\n * * A string. This is used to look-up a texture from the Texture Manager.\r\n *\r\n * Note: You cannot draw a Dynamic Texture to itself.\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 *\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.Textures.DynamicTexture#batchDraw\r\n * @since 3.50.0\r\n *\r\n * @param {any} entries - Any renderable Game Object, or Group, Container, Display List, other Dynamic or 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 Dynamic Texture instance.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 981, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Use this method if you have already called `beginDraw` and need to batch\rdraw a large number of objects to this Dynamic Texture.\r\rThis method batches the drawing of the given objects to this texture,\rwithout causing a WebGL bind or batch flush for each one.\r\rIt is faster than calling `draw`, but you must be careful to manage the\rflow of code and remember to call `endDraw()`. If you don't need to draw large\rnumbers of objects it's much safer and easier to use the `draw` method instead.\r\rThe flow should be:\r\r```javascript\r// Call once:\rDynamicTexture.beginDraw();\r\r// repeat n times:\rDynamicTexture.batchDraw();\r// or\rDynamicTexture.batchDrawFrame();\r\r// Call once:\rDynamicTexture.endDraw();\r```\r\rDo not call any methods other than `batchDraw`, `batchDrawFrame`, or `endDraw` once you\rhave started a batch. Also, be very careful not to destroy this Dynamic Texture while the\rbatch is still open. Doing so will cause a run-time error in the WebGL Renderer.\r\rYou can use the `DynamicTexture.isDrawing` boolean property to tell if a batch is\rcurrently open, or not.\r\rThis method 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's Display List. Pass in `Scene.children` to draw the whole list.\r* Another Dynamic Texture or Render Texture.\r* A Texture Frame instance.\r* A string. This is used to look-up a texture from the Texture Manager.\r\rNote: You cannot draw a Dynamic Texture to itself.\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.\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": "batchDraw", "since": "3.50.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "Any renderable Game Object, or Group, Container, Display List, other Dynamic or 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 Dynamic Texture instance." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#batchDraw", "scope": "instance", "___id": "T000002R039388", "___s": true }, { "comment": "/**\r\n * Use this method if you have already called `beginDraw` and need to batch\r\n * draw a large number of texture frames to this Dynamic Texture.\r\n *\r\n * This method batches the drawing of the given frames to this Dynamic Texture,\r\n * without causing a WebGL bind or batch flush for each one.\r\n *\r\n * It is faster than calling `drawFrame`, but you must be careful to manage the\r\n * flow of code and remember to call `endDraw()`. If you don't need to draw large\r\n * numbers of frames it's much safer and easier to use the `drawFrame` method instead.\r\n *\r\n * The flow should be:\r\n *\r\n * ```javascript\r\n * // Call once:\r\n * DynamicTexture.beginDraw();\r\n *\r\n * // repeat n times:\r\n * DynamicTexture.batchDraw();\r\n * // or\r\n * DynamicTexture.batchDrawFrame();\r\n *\r\n * // Call once:\r\n * DynamicTexture.endDraw();\r\n * ```\r\n *\r\n * Do not call any methods other than `batchDraw`, `batchDrawFrame`, or `endDraw` once you\r\n * have started a batch. Also, be very careful not to destroy this Dynamic Texture while the\r\n * batch is still open. Doing so will cause a run-time error in the WebGL Renderer.\r\n *\r\n * You can use the `DynamicTexture.isDrawing` boolean property to tell if a batch is\r\n * currently open, or not.\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, alpha and tint value to apply to the frame\r\n * before it is drawn.\r\n *\r\n * @method Phaser.Textures.DynamicTexture#batchDrawFrame\r\n * @since 3.50.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 * @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 {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 Dynamic Texture instance.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 1069, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Use this method if you have already called `beginDraw` and need to batch\rdraw a large number of texture frames to this Dynamic Texture.\r\rThis method batches the drawing of the given frames to this Dynamic Texture,\rwithout causing a WebGL bind or batch flush for each one.\r\rIt is faster than calling `drawFrame`, but you must be careful to manage the\rflow of code and remember to call `endDraw()`. If you don't need to draw large\rnumbers of frames it's much safer and easier to use the `drawFrame` method instead.\r\rThe flow should be:\r\r```javascript\r// Call once:\rDynamicTexture.beginDraw();\r\r// repeat n times:\rDynamicTexture.batchDraw();\r// or\rDynamicTexture.batchDrawFrame();\r\r// Call once:\rDynamicTexture.endDraw();\r```\r\rDo not call any methods other than `batchDraw`, `batchDrawFrame`, or `endDraw` once you\rhave started a batch. Also, be very careful not to destroy this Dynamic Texture while the\rbatch is still open. Doing so will cause a run-time error in the WebGL Renderer.\r\rYou can use the `DynamicTexture.isDrawing` boolean property to tell if a batch is\rcurrently open, or not.\r\rTextures are referenced by their string-based keys, as stored in the Texture Manager.\r\rYou can optionally provide a position, alpha and tint value to apply to the frame\rbefore it is drawn.", "kind": "function", "name": "batchDrawFrame", "since": "3.50.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" }, { "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": [ "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 Dynamic Texture instance." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#batchDrawFrame", "scope": "instance", "___id": "T000002R039391", "___s": true }, { "comment": "/**\r\n * Use this method to finish batch drawing to this Dynamic Texture.\r\n *\r\n * Doing so will stop the WebGL Renderer from capturing draws and then blit the\r\n * framebuffer to the Render Target owned by this texture.\r\n *\r\n * Calling this method without first calling `beginDraw` will have no effect.\r\n *\r\n * Batch drawing is faster than calling `draw`, but you must be careful to manage the\r\n * flow of code and remember to call `endDraw()` when you're finished.\r\n *\r\n * If you don't need to draw large numbers of objects it's much safer and easier\r\n * to use the `draw` method instead.\r\n *\r\n * The flow should be:\r\n *\r\n * ```javascript\r\n * // Call once:\r\n * DynamicTexture.beginDraw();\r\n *\r\n * // repeat n times:\r\n * DynamicTexture.batchDraw();\r\n * // or\r\n * DynamicTexture.batchDrawFrame();\r\n *\r\n * // Call once:\r\n * DynamicTexture.endDraw();\r\n * ```\r\n *\r\n * Do not call any methods other than `batchDraw`, `batchDrawFrame`, or `endDraw` once you\r\n * have started a batch. Also, be very careful not to destroy this Dynamic Texture while the\r\n * batch is still open. Doing so will cause a run-time error in the WebGL Renderer.\r\n *\r\n * You can use the `DynamicTexture.isDrawing` boolean property to tell if a batch is\r\n * currently open, or not.\r\n *\r\n * @method Phaser.Textures.DynamicTexture#endDraw\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [erase=false] - Draws all objects in this batch using a blend mode of ERASE. This has the effect of erasing any filled pixels in the objects being drawn.\r\n *\r\n * @return {this} This Dynamic Texture instance.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 1143, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Use this method to finish batch drawing to this Dynamic Texture.\r\rDoing so will stop the WebGL Renderer from capturing draws and then blit the\rframebuffer to the Render Target owned by this texture.\r\rCalling this method without first calling `beginDraw` will have no effect.\r\rBatch drawing is faster than calling `draw`, but you must be careful to manage the\rflow of code and remember to call `endDraw()` when you're finished.\r\rIf you don't need to draw large numbers of objects it's much safer and easier\rto use the `draw` method instead.\r\rThe flow should be:\r\r```javascript\r// Call once:\rDynamicTexture.beginDraw();\r\r// repeat n times:\rDynamicTexture.batchDraw();\r// or\rDynamicTexture.batchDrawFrame();\r\r// Call once:\rDynamicTexture.endDraw();\r```\r\rDo not call any methods other than `batchDraw`, `batchDrawFrame`, or `endDraw` once you\rhave started a batch. Also, be very careful not to destroy this Dynamic Texture while the\rbatch is still open. Doing so will cause a run-time error in the WebGL Renderer.\r\rYou can use the `DynamicTexture.isDrawing` boolean property to tell if a batch is\rcurrently open, or not.", "kind": "function", "name": "endDraw", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Draws all objects in this batch using a blend mode of ERASE. This has the effect of erasing any filled pixels in the objects being drawn.", "name": "erase" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Dynamic Texture instance." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#endDraw", "scope": "instance", "___id": "T000002R039398", "___s": true }, { "comment": "/**\r\n * Takes a snapshot of the given area of this Dynamic 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 Dynamic 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 Dynamic Texture has, so please be careful how you employ this in your game.\r\n *\r\n * @method Phaser.Textures.DynamicTexture#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 Dynamic Texture instance.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 1455, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Takes a snapshot of the given area of this Dynamic Texture.\r\rThe snapshot is taken immediately, but the results are returned via the given callback.\r\rTo capture the whole Dynamic 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 Dynamic 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 Dynamic Texture instance." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#snapshotArea", "scope": "instance", "___id": "T000002R039447", "___s": true }, { "comment": "/**\r\n * Takes a snapshot of the whole of this Dynamic 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 Dynamic 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 Dynamic Texture has, so please be careful how you employ this in your game.\r\n *\r\n * @method Phaser.Textures.DynamicTexture#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 Dynamic Texture instance.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 1497, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Takes a snapshot of the whole of this Dynamic Texture.\r\rThe snapshot is taken immediately, but the results are returned via the given callback.\r\rTo capture a portion of this Dynamic 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 Dynamic 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 Dynamic Texture instance." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#snapshot", "scope": "instance", "___id": "T000002R039449", "___s": true }, { "comment": "/**\r\n * Takes a snapshot of the given pixel from this Dynamic 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 Dynamic Texture see the `snapshot` method.\r\n * To capture a portion of this Dynamic 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.Textures.DynamicTexture#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 Dynamic Texture instance.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 1526, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Takes a snapshot of the given pixel from this Dynamic Texture.\r\rThe snapshot is taken immediately, but the results are returned via the given callback.\r\rTo capture the whole Dynamic Texture see the `snapshot` method.\rTo capture a portion of this Dynamic 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 Dynamic Texture instance." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#snapshotPixel", "scope": "instance", "___id": "T000002R039451", "___s": true }, { "comment": "/**\r\n * Returns the underlying WebGLTexture, if not running in Canvas mode.\r\n *\r\n * @method Phaser.Textures.DynamicTexture#getWebGLTexture\r\n * @since 3.60.0\r\n *\r\n * @return {?WebGLTexture} The underlying WebGLTexture, if not running in Canvas mode.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 1552, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Returns the underlying WebGLTexture, if not running in Canvas mode.", "kind": "function", "name": "getWebGLTexture", "since": "3.60.0", "returns": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "description": "The underlying WebGLTexture, if not running in Canvas mode." } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#getWebGLTexture", "scope": "instance", "___id": "T000002R039453", "___s": true }, { "comment": "/**\r\n * Renders this Dynamic Texture onto the Stamp Game Object as a BitmapMask.\r\n *\r\n * @method Phaser.Textures.DynamicTexture#renderWebGL\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - A reference to the current active WebGL renderer.\r\n * @param {Phaser.GameObjects.Image} src - The Game Object being rendered in this call.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that is rendering the Game Object.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - This transform matrix is defined if the game object is nested\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 1568, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Renders this Dynamic Texture onto the Stamp Game Object as a BitmapMask.", "kind": "function", "name": "renderWebGL", "since": "3.60.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.Image" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Image" } }, "description": "The Game Object being rendered in this call.", "name": "src" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera that is rendering the Game Object.", "name": "camera" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "This transform matrix is defined if the game object is nested", "name": "parentMatrix" } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#renderWebGL", "scope": "instance", "___id": "T000002R039455", "___s": true }, { "comment": "/**\r\n * This is a NOOP method. Bitmap Masks are not supported by the Canvas Renderer.\r\n *\r\n * @method Phaser.Textures.DynamicTexture#renderCanvas\r\n * @since 3.60.0\r\n *\r\n * @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - The Canvas Renderer which would be rendered to.\r\n * @param {Phaser.GameObjects.GameObject} mask - The masked Game Object which would be rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to render to.\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "This is a NOOP method. Bitmap Masks are not supported by the Canvas Renderer.", "kind": "function", "name": "renderCanvas", "since": "3.60.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 Canvas Renderer which would be rendered to.", "name": "renderer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The masked Game Object which would be rendered.", "name": "mask" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to render to.", "name": "camera" } ], "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#renderCanvas", "scope": "instance", "___id": "T000002R039458", "___s": true }, { "comment": "/**\r\n * Destroys this Texture and releases references to its sources and frames.\r\n *\r\n * @method Phaser.Textures.DynamicTexture#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "DynamicTexture.js", "lineno": 1604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Destroys this Texture and releases references to its sources and frames.", "kind": "function", "name": "destroy", "since": "3.60.0", "memberof": "Phaser.Textures.DynamicTexture", "longname": "Phaser.Textures.DynamicTexture#destroy", "scope": "instance", "overrides": "Phaser.Textures.Texture#destroy", "___id": "T000002R039460", "___s": true }, { "comment": "/**\r\n * The Texture Add Event.\r\n *\r\n * This event is dispatched by the Texture Manager when a texture is added to it.\r\n *\r\n * Listen to this event from within a Scene using: `this.textures.on('addtexture', listener)`.\r\n *\r\n * @event Phaser.Textures.Events#ADD\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key of the Texture that was added to the Texture Manager.\r\n * @param {Phaser.Textures.Texture} texture - A reference to the Texture that was added to the Texture Manager.\r\n */", "meta": { "filename": "ADD_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\events", "code": {} }, "description": "The Texture Add Event.\r\rThis event is dispatched by the Texture Manager when a texture is added to it.\r\rListen to this event from within a Scene using: `this.textures.on('addtexture', listener)`.", "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 key of the Texture that was added to the Texture Manager.", "name": "key" }, { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture" } }, "description": "A reference to the Texture that was added to the Texture Manager.", "name": "texture" } ], "memberof": "Phaser.Textures.Events", "longname": "Phaser.Textures.Events#event:ADD", "scope": "instance", "___id": "T000002R039467", "___s": true }, { "comment": "/**\r\n * The Texture Add Key Event.\r\n *\r\n * This event is dispatched by the Texture Manager when a texture with the given key is added to it.\r\n *\r\n * Listen to this event from within a Scene using: `this.textures.on('addtexture-key', listener)`.\r\n *\r\n * @event Phaser.Textures.Events#ADD_KEY\r\n * @type {string}\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Textures.Texture} texture - A reference to the Texture that was added to the Texture Manager.\r\n */", "meta": { "filename": "ADD_KEY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\events", "code": {} }, "description": "The Texture Add Key Event.\r\rThis event is dispatched by the Texture Manager when a texture with the given key is added to it.\r\rListen to this event from within a Scene using: `this.textures.on('addtexture-key', listener)`.", "kind": "event", "name": "ADD_KEY", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture" } }, "description": "A reference to the Texture that was added to the Texture Manager.", "name": "texture" } ], "memberof": "Phaser.Textures.Events", "longname": "Phaser.Textures.Events#event:ADD_KEY", "scope": "instance", "___id": "T000002R039469", "___s": true }, { "comment": "/**\r\n * The Texture Load Error Event.\r\n *\r\n * This event is dispatched by the Texture Manager when a texture it requested to load failed.\r\n * This only happens when base64 encoded textures fail. All other texture types are loaded via the Loader Plugin.\r\n *\r\n * Listen to this event from within a Scene using: `this.textures.on('onerror', listener)`.\r\n *\r\n * @event Phaser.Textures.Events#ERROR\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key of the Texture that failed to load into the Texture Manager.\r\n */", "meta": { "filename": "ERROR_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\events", "code": {} }, "description": "The Texture Load Error Event.\r\rThis event is dispatched by the Texture Manager when a texture it requested to load failed.\rThis only happens when base64 encoded textures fail. All other texture types are loaded via the Loader Plugin.\r\rListen to this event from within a Scene using: `this.textures.on('onerror', listener)`.", "kind": "event", "name": "ERROR", "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 Texture that failed to load into the Texture Manager.", "name": "key" } ], "memberof": "Phaser.Textures.Events", "longname": "Phaser.Textures.Events#event:ERROR", "scope": "instance", "___id": "T000002R039471", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Textures.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Textures", "longname": "Phaser.Textures.Events", "scope": "static", "___id": "T000002R039473", "___s": true }, { "comment": "/**\r\n * The Texture Load Event.\r\n *\r\n * This event is dispatched by the Texture Manager when a texture has finished loading on it.\r\n * This only happens for base64 encoded textures. All other texture types are loaded via the Loader Plugin.\r\n *\r\n * Listen to this event from within a Scene using: `this.textures.on('onload', listener)`.\r\n *\r\n * This event is dispatched after the [ADD]{@linkcode Phaser.Textures.Events#event:ADD} event.\r\n *\r\n * @event Phaser.Textures.Events#LOAD\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key of the Texture that was loaded by the Texture Manager.\r\n * @param {Phaser.Textures.Texture} texture - A reference to the Texture that was loaded by the Texture Manager.\r\n */", "meta": { "filename": "LOAD_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\events", "code": {} }, "description": "The Texture Load Event.\r\rThis event is dispatched by the Texture Manager when a texture has finished loading on it.\rThis only happens for base64 encoded textures. All other texture types are loaded via the Loader Plugin.\r\rListen to this event from within a Scene using: `this.textures.on('onload', listener)`.\r\rThis event is dispatched after the [ADD]{@linkcode Phaser.Textures.Events#event:ADD} event.", "kind": "event", "name": "LOAD", "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 Texture that was loaded by the Texture Manager.", "name": "key" }, { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture" } }, "description": "A reference to the Texture that was loaded by the Texture Manager.", "name": "texture" } ], "memberof": "Phaser.Textures.Events", "longname": "Phaser.Textures.Events#event:LOAD", "scope": "instance", "___id": "T000002R039482", "___s": true }, { "comment": "/**\r\n * This internal event signifies that the Texture Manager is now ready and the Game can continue booting.\r\n *\r\n * When a Phaser Game instance is booting for the first time, the Texture Manager has to wait on a couple of non-blocking\r\n * async events before it's fully ready to carry on. When those complete the Texture Manager emits this event via the Game\r\n * instance, which tells the Game to carry on booting.\r\n *\r\n * @event Phaser.Textures.Events#READY\r\n * @type {string}\r\n * @since 3.16.1\r\n */", "meta": { "filename": "READY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\events", "code": {} }, "description": "This internal event signifies that the Texture Manager is now ready and the Game can continue booting.\r\rWhen a Phaser Game instance is booting for the first time, the Texture Manager has to wait on a couple of non-blocking\rasync events before it's fully ready to carry on. When those complete the Texture Manager emits this event via the Game\rinstance, which tells the Game to carry on booting.", "kind": "event", "name": "READY", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.1", "memberof": "Phaser.Textures.Events", "longname": "Phaser.Textures.Events#event:READY", "scope": "instance", "___id": "T000002R039484", "___s": true }, { "comment": "/**\r\n * The Texture Remove Event.\r\n *\r\n * This event is dispatched by the Texture Manager when a texture is removed from it.\r\n *\r\n * Listen to this event from within a Scene using: `this.textures.on('removetexture', listener)`.\r\n *\r\n * If you have any Game Objects still using the removed texture, they will start throwing\r\n * errors the next time they try to render. Be sure to clear all use of the texture in this event handler.\r\n *\r\n * @event Phaser.Textures.Events#REMOVE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key of the Texture that was removed from the Texture Manager.\r\n */", "meta": { "filename": "REMOVE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\events", "code": {} }, "description": "The Texture Remove Event.\r\rThis event is dispatched by the Texture Manager when a texture is removed from it.\r\rListen to this event from within a Scene using: `this.textures.on('removetexture', listener)`.\r\rIf you have any Game Objects still using the removed texture, they will start throwing\rerrors the next time they try to render. Be sure to clear all use of the texture in this event handler.", "kind": "event", "name": "REMOVE", "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 Texture that was removed from the Texture Manager.", "name": "key" } ], "memberof": "Phaser.Textures.Events", "longname": "Phaser.Textures.Events#event:REMOVE", "scope": "instance", "___id": "T000002R039486", "___s": true }, { "comment": "/**\r\n * The Texture Remove Key Event.\r\n *\r\n * This event is dispatched by the Texture Manager when a texture with the given key is removed from it.\r\n *\r\n * Listen to this event from within a Scene using: `this.textures.on('removetexture-key', listener)`.\r\n *\r\n * If you have any Game Objects still using the removed texture, they will start throwing\r\n * errors the next time they try to render. Be sure to clear all use of the texture in this event handler.\r\n *\r\n * @event Phaser.Textures.Events#REMOVE_KEY\r\n * @type {string}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "REMOVE_KEY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\events", "code": {} }, "description": "The Texture Remove Key Event.\r\rThis event is dispatched by the Texture Manager when a texture with the given key is removed from it.\r\rListen to this event from within a Scene using: `this.textures.on('removetexture-key', listener)`.\r\rIf you have any Game Objects still using the removed texture, they will start throwing\rerrors the next time they try to render. Be sure to clear all use of the texture in this event handler.", "kind": "event", "name": "REMOVE_KEY", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "memberof": "Phaser.Textures.Events", "longname": "Phaser.Textures.Events#event:REMOVE_KEY", "scope": "instance", "___id": "T000002R039488", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Frame is a section of a Texture.\r\n *\r\n * @class Frame\r\n * @memberof Phaser.Textures\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Textures.Texture} texture - The Texture this Frame is a part of.\r\n * @param {(number|string)} name - The name of this Frame. The name is unique within the Texture.\r\n * @param {number} sourceIndex - The index of the TextureSource that this Frame is a part of.\r\n * @param {number} x - The x coordinate of the top-left of this Frame.\r\n * @param {number} y - The y coordinate of the top-left of this Frame.\r\n * @param {number} width - The width of this Frame.\r\n * @param {number} height - The height of this Frame.\r\n */", "meta": { "filename": "Frame.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "classdesc": "A Frame is a section of a Texture.", "kind": "class", "name": "Frame", "memberof": "Phaser.Textures", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture" } }, "description": "The Texture this Frame is a part of.", "name": "texture" }, { "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The name of this Frame. The name is unique within the Texture.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the TextureSource that this Frame is a part of.", "name": "sourceIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the top-left of this Frame.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the top-left of this Frame.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this Frame.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this Frame.", "name": "height" } ], "scope": "static", "longname": "Phaser.Textures.Frame", "___id": "T000002R039493", "___s": true }, { "comment": "/**\r\n * The Texture this Frame is a part of.\r\n *\r\n * @name Phaser.Textures.Frame#texture\r\n * @type {Phaser.Textures.Texture}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 34, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The Texture this Frame is a part of.", "name": "texture", "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#texture", "scope": "instance", "kind": "member", "___id": "T000002R039496", "___s": true }, { "comment": "/**\r\n * The name of this Frame.\r\n * The name is unique within the Texture.\r\n *\r\n * @name Phaser.Textures.Frame#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 43, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The name of this Frame.\rThe name is unique within the Texture.", "name": "name", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#name", "scope": "instance", "kind": "member", "___id": "T000002R039498", "___s": true }, { "comment": "/**\r\n * The TextureSource this Frame is part of.\r\n *\r\n * @name Phaser.Textures.Frame#source\r\n * @type {Phaser.Textures.TextureSource}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The TextureSource this Frame is part of.", "name": "source", "type": { "names": [ "Phaser.Textures.TextureSource" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureSource" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#source", "scope": "instance", "kind": "member", "___id": "T000002R039500", "___s": true }, { "comment": "/**\r\n * The index of the TextureSource in the Texture sources array.\r\n *\r\n * @name Phaser.Textures.Frame#sourceIndex\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The index of the TextureSource in the Texture sources array.", "name": "sourceIndex", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#sourceIndex", "scope": "instance", "kind": "member", "___id": "T000002R039502", "___s": true }, { "comment": "/**\r\n * A reference to the Texture Source WebGL Texture that this Frame is using.\r\n *\r\n * @name Phaser.Textures.Frame#glTexture\r\n * @type {?WebGLTexture}\r\n * @default null\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 71, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "A reference to the Texture Source WebGL Texture that this Frame is using.", "name": "glTexture", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.11.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#glTexture", "scope": "instance", "kind": "member", "___id": "T000002R039504", "___s": true }, { "comment": "/**\r\n * X position within the source image to cut from.\r\n *\r\n * @name Phaser.Textures.Frame#cutX\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 81, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "X position within the source image to cut from.", "name": "cutX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#cutX", "scope": "instance", "kind": "member", "___id": "T000002R039506", "___s": true }, { "comment": "/**\r\n * Y position within the source image to cut from.\r\n *\r\n * @name Phaser.Textures.Frame#cutY\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 90, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Y position within the source image to cut from.", "name": "cutY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#cutY", "scope": "instance", "kind": "member", "___id": "T000002R039508", "___s": true }, { "comment": "/**\r\n * The width of the area in the source image to cut.\r\n *\r\n * @name Phaser.Textures.Frame#cutWidth\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The width of the area in the source image to cut.", "name": "cutWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#cutWidth", "scope": "instance", "kind": "member", "___id": "T000002R039510", "___s": true }, { "comment": "/**\r\n * The height of the area in the source image to cut.\r\n *\r\n * @name Phaser.Textures.Frame#cutHeight\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The height of the area in the source image to cut.", "name": "cutHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#cutHeight", "scope": "instance", "kind": "member", "___id": "T000002R039512", "___s": true }, { "comment": "/**\r\n * The X rendering offset of this Frame, taking trim into account.\r\n *\r\n * @name Phaser.Textures.Frame#x\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 117, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The X rendering offset of this Frame, taking trim into account.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#x", "scope": "instance", "kind": "member", "___id": "T000002R039514", "___s": true }, { "comment": "/**\r\n * The Y rendering offset of this Frame, taking trim into account.\r\n *\r\n * @name Phaser.Textures.Frame#y\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 127, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The Y rendering offset of this Frame, taking trim into account.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#y", "scope": "instance", "kind": "member", "___id": "T000002R039516", "___s": true }, { "comment": "/**\r\n * The rendering width of this Frame, taking trim into account.\r\n *\r\n * @name Phaser.Textures.Frame#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 137, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The rendering width of this Frame, taking trim into account.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#width", "scope": "instance", "kind": "member", "___id": "T000002R039518", "___s": true }, { "comment": "/**\r\n * The rendering height of this Frame, taking trim into account.\r\n *\r\n * @name Phaser.Textures.Frame#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 146, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The rendering height of this Frame, taking trim into account.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#height", "scope": "instance", "kind": "member", "___id": "T000002R039520", "___s": true }, { "comment": "/**\r\n * Half the width, floored.\r\n * Precalculated for the renderer.\r\n *\r\n * @name Phaser.Textures.Frame#halfWidth\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 155, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Half the width, floored.\rPrecalculated for the renderer.", "name": "halfWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#halfWidth", "scope": "instance", "kind": "member", "___id": "T000002R039522", "___s": true }, { "comment": "/**\r\n * Half the height, floored.\r\n * Precalculated for the renderer.\r\n *\r\n * @name Phaser.Textures.Frame#halfHeight\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Half the height, floored.\rPrecalculated for the renderer.", "name": "halfHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#halfHeight", "scope": "instance", "kind": "member", "___id": "T000002R039524", "___s": true }, { "comment": "/**\r\n * The x center of this frame, floored.\r\n *\r\n * @name Phaser.Textures.Frame#centerX\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The x center of this frame, floored.", "name": "centerX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#centerX", "scope": "instance", "kind": "member", "___id": "T000002R039526", "___s": true }, { "comment": "/**\r\n * The y center of this frame, floored.\r\n *\r\n * @name Phaser.Textures.Frame#centerY\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 184, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The y center of this frame, floored.", "name": "centerY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#centerY", "scope": "instance", "kind": "member", "___id": "T000002R039528", "___s": true }, { "comment": "/**\r\n * The horizontal pivot point of this Frame.\r\n *\r\n * @name Phaser.Textures.Frame#pivotX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 193, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The horizontal pivot point of this Frame.", "name": "pivotX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#pivotX", "scope": "instance", "kind": "member", "___id": "T000002R039530", "___s": true }, { "comment": "/**\r\n * The vertical pivot point of this Frame.\r\n *\r\n * @name Phaser.Textures.Frame#pivotY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 203, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The vertical pivot point of this Frame.", "name": "pivotY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#pivotY", "scope": "instance", "kind": "member", "___id": "T000002R039532", "___s": true }, { "comment": "/**\r\n * Does this Frame have a custom pivot point?\r\n *\r\n * @name Phaser.Textures.Frame#customPivot\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 213, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Does this Frame have a custom pivot point?", "name": "customPivot", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#customPivot", "scope": "instance", "kind": "member", "___id": "T000002R039534", "___s": true }, { "comment": "/**\r\n * **CURRENTLY UNSUPPORTED**\r\n *\r\n * Is this frame is rotated or not in the Texture?\r\n * Rotation allows you to use rotated frames in texture atlas packing.\r\n * It has nothing to do with Sprite rotation.\r\n *\r\n * @name Phaser.Textures.Frame#rotated\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 223, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "**CURRENTLY UNSUPPORTED**\r\rIs this frame is rotated or not in the Texture?\rRotation allows you to use rotated frames in texture atlas packing.\rIt has nothing to do with Sprite rotation.", "name": "rotated", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#rotated", "scope": "instance", "kind": "member", "___id": "T000002R039536", "___s": true }, { "comment": "/**\r\n * Over-rides the Renderer setting.\r\n * -1 = use Renderer Setting\r\n * 0 = No rounding\r\n * 1 = Round\r\n *\r\n * @name Phaser.Textures.Frame#autoRound\r\n * @type {number}\r\n * @default -1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 237, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Over-rides the Renderer setting.\r-1 = use Renderer Setting\r0 = No rounding\r1 = Round", "name": "autoRound", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#autoRound", "scope": "instance", "kind": "member", "___id": "T000002R039538", "___s": true }, { "comment": "/**\r\n * Any Frame specific custom data can be stored here.\r\n *\r\n * @name Phaser.Textures.Frame#customData\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 250, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Any Frame specific custom data can be stored here.", "name": "customData", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#customData", "scope": "instance", "kind": "member", "___id": "T000002R039540", "___s": true }, { "comment": "/**\r\n * WebGL UV u0 value.\r\n *\r\n * @name Phaser.Textures.Frame#u0\r\n * @type {number}\r\n * @default 0\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 259, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "WebGL UV u0 value.", "name": "u0", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.11.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#u0", "scope": "instance", "kind": "member", "___id": "T000002R039542", "___s": true }, { "comment": "/**\r\n * WebGL UV v0 value.\r\n *\r\n * @name Phaser.Textures.Frame#v0\r\n * @type {number}\r\n * @default 0\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "WebGL UV v0 value.", "name": "v0", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.11.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#v0", "scope": "instance", "kind": "member", "___id": "T000002R039544", "___s": true }, { "comment": "/**\r\n * WebGL UV u1 value.\r\n *\r\n * @name Phaser.Textures.Frame#u1\r\n * @type {number}\r\n * @default 0\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "WebGL UV u1 value.", "name": "u1", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.11.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#u1", "scope": "instance", "kind": "member", "___id": "T000002R039546", "___s": true }, { "comment": "/**\r\n * WebGL UV v1 value.\r\n *\r\n * @name Phaser.Textures.Frame#v1\r\n * @type {number}\r\n * @default 0\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "WebGL UV v1 value.", "name": "v1", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.11.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#v1", "scope": "instance", "kind": "member", "___id": "T000002R039548", "___s": true }, { "comment": "/**\r\n * Sets the width, height, x and y of this Frame.\r\n *\r\n * This is called automatically by the constructor\r\n * and should rarely be changed on-the-fly.\r\n *\r\n * @method Phaser.Textures.Frame#setSize\r\n * @since 3.7.0\r\n *\r\n * @param {number} width - The width of the frame before being trimmed.\r\n * @param {number} height - The height of the frame before being trimmed.\r\n * @param {number} [x=0] - The x coordinate of the top-left of this Frame.\r\n * @param {number} [y=0] - The y coordinate of the top-left of this Frame.\r\n *\r\n * @return {this} This Frame object.\r\n */", "meta": { "filename": "Frame.js", "lineno": 341, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Sets the width, height, x and y of this Frame.\r\rThis is called automatically by the constructor\rand should rarely be changed on-the-fly.", "kind": "function", "name": "setSize", "since": "3.7.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the frame before being trimmed.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the frame before being trimmed.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of the top-left of this Frame.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the top-left of this Frame.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Frame object." } ], "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#setSize", "scope": "instance", "___id": "T000002R039576", "___s": true }, { "comment": "/**\r\n * If the frame was trimmed when added to the Texture Atlas, this records the trim and source data.\r\n *\r\n * @method Phaser.Textures.Frame#setTrim\r\n * @since 3.0.0\r\n *\r\n * @param {number} actualWidth - The width of the frame before being trimmed.\r\n * @param {number} actualHeight - The height of the frame before being trimmed.\r\n * @param {number} destX - The destination X position of the trimmed frame for display.\r\n * @param {number} destY - The destination Y position of the trimmed frame for display.\r\n * @param {number} destWidth - The destination width of the trimmed frame for display.\r\n * @param {number} destHeight - The destination height of the trimmed frame for display.\r\n *\r\n * @return {this} This Frame object.\r\n */", "meta": { "filename": "Frame.js", "lineno": 404, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "If the frame was trimmed when added to the Texture Atlas, this records the trim and source data.", "kind": "function", "name": "setTrim", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the frame before being trimmed.", "name": "actualWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the frame before being trimmed.", "name": "actualHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The destination X position of the trimmed frame for display.", "name": "destX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The destination Y position of the trimmed frame for display.", "name": "destY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The destination width of the trimmed frame for display.", "name": "destWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The destination height of the trimmed frame for display.", "name": "destHeight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Frame object." } ], "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#setTrim", "scope": "instance", "___id": "T000002R039608", "___s": true }, { "comment": "/**\r\n * Takes a crop data object and, based on the rectangular region given, calculates the\r\n * required UV coordinates in order to crop this Frame for WebGL and Canvas rendering.\r\n *\r\n * This is called directly by the Game Object Texture Components `setCrop` method.\r\n * Please use that method to crop a Game Object.\r\n *\r\n * @method Phaser.Textures.Frame#setCropUVs\r\n * @since 3.11.0\r\n *\r\n * @param {object} crop - The crop data object. This is the `GameObject._crop` property.\r\n * @param {number} x - The x coordinate to start the crop from. Cannot be negative or exceed the Frame width.\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. Cannot exceed the Frame width.\r\n * @param {number} height - The height of the crop rectangle. Cannot exceed the Frame height.\r\n * @param {boolean} flipX - Does the parent Game Object have flipX set?\r\n * @param {boolean} flipY - Does the parent Game Object have flipY set?\r\n *\r\n * @return {object} The updated crop data object.\r\n */", "meta": { "filename": "Frame.js", "lineno": 454, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Takes a crop data object and, based on the rectangular region given, calculates the\rrequired UV coordinates in order to crop this Frame for WebGL and Canvas rendering.\r\rThis is called directly by the Game Object Texture Components `setCrop` method.\rPlease use that method to crop a Game Object.", "kind": "function", "name": "setCropUVs", "since": "3.11.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The crop data object. This is the `GameObject._crop` property.", "name": "crop" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to start the crop from. Cannot be negative or exceed the Frame width.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" } }, "description": "The width of the crop rectangle. Cannot exceed the Frame width.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the crop rectangle. Cannot exceed the Frame height.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Does the parent Game Object have flipX set?", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Does the parent Game Object have flipY set?", "name": "flipY" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The updated crop data object." } ], "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#setCropUVs", "scope": "instance", "___id": "T000002R039629", "___s": true }, { "comment": "/**\r\n * Takes a crop data object and recalculates the UVs based on the dimensions inside the crop object.\r\n * Called automatically by `setFrame`.\r\n *\r\n * @method Phaser.Textures.Frame#updateCropUVs\r\n * @since 3.11.0\r\n *\r\n * @param {object} crop - The crop data object. This is the `GameObject._crop` property.\r\n * @param {boolean} flipX - Does the parent Game Object have flipX set?\r\n * @param {boolean} flipY - Does the parent Game Object have flipY set?\r\n *\r\n * @return {object} The updated crop data object.\r\n */", "meta": { "filename": "Frame.js", "lineno": 595, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Takes a crop data object and recalculates the UVs based on the dimensions inside the crop object.\rCalled automatically by `setFrame`.", "kind": "function", "name": "updateCropUVs", "since": "3.11.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The crop data object. This is the `GameObject._crop` property.", "name": "crop" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Does the parent Game Object have flipX set?", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Does the parent Game Object have flipY set?", "name": "flipY" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The updated crop data object." } ], "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#updateCropUVs", "scope": "instance", "___id": "T000002R039688", "___s": true }, { "comment": "/**\r\n * Directly sets the canvas and WebGL UV data for this frame.\r\n *\r\n * Use this if you need to override the values that are generated automatically\r\n * when the Frame is created.\r\n *\r\n * @method Phaser.Textures.Frame#setUVs\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - Width of this frame for the Canvas data.\r\n * @param {number} height - Height of this frame for the Canvas data.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n *\r\n * @return {this} This Frame object.\r\n */", "meta": { "filename": "Frame.js", "lineno": 613, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Directly sets the canvas and WebGL UV data for this frame.\r\rUse this if you need to override the values that are generated automatically\rwhen the Frame is created.", "kind": "function", "name": "setUVs", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of this frame for the Canvas data.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of this frame for the Canvas data.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Frame object." } ], "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#setUVs", "scope": "instance", "___id": "T000002R039690", "___s": true }, { "comment": "/**\r\n * Updates the internal WebGL UV cache and the drawImage cache.\r\n *\r\n * @method Phaser.Textures.Frame#updateUVs\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Frame object.\r\n */", "meta": { "filename": "Frame.js", "lineno": 651, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Updates the internal WebGL UV cache and the drawImage cache.", "kind": "function", "name": "updateUVs", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Frame object." } ], "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#updateUVs", "scope": "instance", "___id": "T000002R039699", "___s": true }, { "comment": "/**\r\n * Updates the internal WebGL UV cache.\r\n *\r\n * @method Phaser.Textures.Frame#updateUVsInverted\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Frame object.\r\n */", "meta": { "filename": "Frame.js", "lineno": 687, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Updates the internal WebGL UV cache.", "kind": "function", "name": "updateUVsInverted", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Frame object." } ], "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#updateUVsInverted", "scope": "instance", "___id": "T000002R039714", "___s": true }, { "comment": "/**\r\n * Clones this Frame into a new Frame object.\r\n *\r\n * @method Phaser.Textures.Frame#clone\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Textures.Frame} A clone of this Frame.\r\n */", "meta": { "filename": "Frame.js", "lineno": 709, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Clones this Frame into a new Frame object.", "kind": "function", "name": "clone", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "description": "A clone of this Frame." } ], "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#clone", "scope": "instance", "___id": "T000002R039722", "___s": true }, { "comment": "/**\r\n * Destroys this Frame by nulling its reference to the parent Texture and and data objects.\r\n *\r\n * @method Phaser.Textures.Frame#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Destroys this Frame by nulling its reference to the parent Texture and and data objects.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#destroy", "scope": "instance", "___id": "T000002R039739", "___s": true }, { "comment": "/**\r\n * The width of the Frame in its un-trimmed, un-padded state, as prepared in the art package,\r\n * before being packed.\r\n *\r\n * @name Phaser.Textures.Frame#realWidth\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 762, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The width of the Frame in its un-trimmed, un-padded state, as prepared in the art package,\rbefore being packed.", "name": "realWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#realWidth", "scope": "instance", "kind": "member", "___id": "T000002R039746", "___s": true }, { "comment": "/**\r\n * The height of the Frame in its un-trimmed, un-padded state, as prepared in the art package,\r\n * before being packed.\r\n *\r\n * @name Phaser.Textures.Frame#realHeight\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 780, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The height of the Frame in its un-trimmed, un-padded state, as prepared in the art package,\rbefore being packed.", "name": "realHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#realHeight", "scope": "instance", "kind": "member", "___id": "T000002R039749", "___s": true }, { "comment": "/**\r\n * The radius of the Frame (derived from sqrt(w * w + h * h) / 2)\r\n *\r\n * @name Phaser.Textures.Frame#radius\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 798, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The radius of the Frame (derived from sqrt(w * w + h * h) / 2)", "name": "radius", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#radius", "scope": "instance", "kind": "member", "___id": "T000002R039752", "___s": true }, { "comment": "/**\r\n * Is the Frame trimmed or not?\r\n *\r\n * @name Phaser.Textures.Frame#trimmed\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 815, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Is the Frame trimmed or not?", "name": "trimmed", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#trimmed", "scope": "instance", "kind": "member", "___id": "T000002R039755", "___s": true }, { "comment": "/**\r\n * The Canvas drawImage data object.\r\n *\r\n * @name Phaser.Textures.Frame#canvasData\r\n * @type {object}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Frame.js", "lineno": 832, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The Canvas drawImage data object.", "name": "canvasData", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Textures.Frame", "longname": "Phaser.Textures.Frame#canvasData", "scope": "instance", "kind": "member", "___id": "T000002R039758", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Textures\r\n */", "meta": { "filename": "index.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "kind": "namespace", "name": "Textures", "memberof": "Phaser", "longname": "Phaser.Textures", "scope": "static", "___id": "T000002R039764", "___s": true }, { "comment": "/**\r\n * Linear filter type.\r\n *\r\n * @name Phaser.Textures.LINEAR\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "index.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Linear filter type.", "name": "LINEAR", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Textures", "longname": "Phaser.Textures.LINEAR", "scope": "static", "___id": "T000002R039765", "___s": true }, { "comment": "/**\r\n * Nearest Neighbor filter type.\r\n *\r\n * @name Phaser.Textures.NEAREST\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "index.js", "lineno": 23, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Nearest Neighbor filter type.", "name": "NEAREST", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Textures", "longname": "Phaser.Textures.NEAREST", "scope": "static", "___id": "T000002R039766", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Textures.Parsers\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\parsers", "code": {} }, "kind": "namespace", "name": "Parsers", "memberof": "Phaser.Textures", "longname": "Phaser.Textures.Parsers", "scope": "static", "___id": "T000002R039805", "___s": true }, { "comment": "/**\r\n * Parses a KTX format Compressed Texture file and generates texture data suitable for WebGL from it.\r\n *\r\n * @function Phaser.Textures.Parsers.KTXParser\r\n * @memberof Phaser.Textures.Parsers\r\n * @since 3.60.0\r\n *\r\n * @param {ArrayBuffer} data - The data object created by the Compressed Texture File Loader.\r\n *\r\n * @return {Phaser.Types.Textures.CompressedTextureData} The Compressed Texture data.\r\n */", "meta": { "filename": "KTXParser.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\parsers", "code": {} }, "description": "Parses a KTX format Compressed Texture file and generates texture data suitable for WebGL from it.", "kind": "function", "name": "KTXParser", "memberof": "Phaser.Textures.Parsers", "since": "3.60.0", "params": [ { "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "description": "The data object created by the Compressed Texture File Loader.", "name": "data" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Textures.CompressedTextureData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Textures.CompressedTextureData" } }, "description": "The Compressed Texture data." } ], "longname": "Phaser.Textures.Parsers.KTXParser", "scope": "static", "___id": "T000002R039855", "___s": true }, { "comment": "/**\r\n * Parses a PVR format Compressed Texture file and generates texture data suitable for WebGL from it.\r\n *\r\n * @function Phaser.Textures.Parsers.PVRParser\r\n * @memberof Phaser.Textures.Parsers\r\n * @since 3.60.0\r\n *\r\n * @param {ArrayBuffer} data - The data object created by the Compressed Texture File Loader.\r\n *\r\n * @return {Phaser.Types.Textures.CompressedTextureData} The Compressed Texture data.\r\n */", "meta": { "filename": "PVRParser.js", "lineno": 224, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\parsers", "code": {} }, "description": "Parses a PVR format Compressed Texture file and generates texture data suitable for WebGL from it.", "kind": "function", "name": "PVRParser", "memberof": "Phaser.Textures.Parsers", "since": "3.60.0", "params": [ { "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "description": "The data object created by the Compressed Texture File Loader.", "name": "data" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Textures.CompressedTextureData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Textures.CompressedTextureData" } }, "description": "The Compressed Texture data." } ], "longname": "Phaser.Textures.Parsers.PVRParser", "scope": "static", "___id": "T000002R039999", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Texture consists of a source, usually an Image from the Cache, and a collection of Frames.\r\n * The Frames represent the different areas of the Texture. For example a texture atlas\r\n * may have many Frames, one for each element within the atlas. Where-as a single image would have\r\n * just one frame, that encompasses the whole image.\r\n *\r\n * Every Texture, no matter where it comes from, always has at least 1 frame called the `__BASE` frame.\r\n * This frame represents the entirety of the source image.\r\n *\r\n * Textures are managed by the global TextureManager. This is a singleton class that is\r\n * responsible for creating and delivering Textures and their corresponding Frames to Game Objects.\r\n *\r\n * Sprites and other Game Objects get the texture data they need from the TextureManager.\r\n *\r\n * @class Texture\r\n * @memberof Phaser.Textures\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Textures.TextureManager} manager - A reference to the Texture Manager this Texture belongs to.\r\n * @param {string} key - The unique string-based key of this Texture.\r\n * @param {(HTMLImageElement|HTMLCanvasElement|HTMLImageElement[]|HTMLCanvasElement[])} source - An array of sources that are used to create the texture. Usually Images, but can also be a Canvas.\r\n * @param {number} [width] - The width of the Texture. This is optional and automatically derived from the source images.\r\n * @param {number} [height] - The height of the Texture. This is optional and automatically derived from the source images.\r\n */", "meta": { "filename": "Texture.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "classdesc": "A Texture consists of a source, usually an Image from the Cache, and a collection of Frames.\rThe Frames represent the different areas of the Texture. For example a texture atlas\rmay have many Frames, one for each element within the atlas. Where-as a single image would have\rjust one frame, that encompasses the whole image.\r\rEvery Texture, no matter where it comes from, always has at least 1 frame called the `__BASE` frame.\rThis frame represents the entirety of the source image.\r\rTextures are managed by the global TextureManager. This is a singleton class that is\rresponsible for creating and delivering Textures and their corresponding Frames to Game Objects.\r\rSprites and other Game Objects get the texture data they need from the TextureManager.", "kind": "class", "name": "Texture", "memberof": "Phaser.Textures", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Textures.TextureManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } }, "description": "A reference to the Texture Manager this Texture belongs to.", "name": "manager" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of this Texture.", "name": "key" }, { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLImageElement", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLCanvasElement", "type": "NameExpression" } ] } ] } }, "description": "An array of sources that are used to create the texture. Usually Images, but can also be a Canvas.", "name": "source" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the Texture. This is optional and automatically derived from the source images.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the Texture. This is optional and automatically derived from the source images.", "name": "height" } ], "scope": "static", "longname": "Phaser.Textures.Texture", "___id": "T000002R040159", "___s": true }, { "comment": "/**\r\n * A reference to the Texture Manager this Texture belongs to.\r\n *\r\n * @name Phaser.Textures.Texture#manager\r\n * @type {Phaser.Textures.TextureManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "A reference to the Texture Manager this Texture belongs to.", "name": "manager", "type": { "names": [ "Phaser.Textures.TextureManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#manager", "scope": "instance", "kind": "member", "___id": "T000002R040163", "___s": true }, { "comment": "/**\r\n * The unique string-based key of this Texture.\r\n *\r\n * @name Phaser.Textures.Texture#key\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The unique string-based key of this Texture.", "name": "key", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#key", "scope": "instance", "kind": "member", "___id": "T000002R040165", "___s": true }, { "comment": "/**\r\n * An array of TextureSource instances.\r\n * These are unique to this Texture and contain the actual Image (or Canvas) data.\r\n *\r\n * @name Phaser.Textures.Texture#source\r\n * @type {Phaser.Textures.TextureSource[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "An array of TextureSource instances.\rThese are unique to this Texture and contain the actual Image (or Canvas) data.", "name": "source", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Textures.TextureSource", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#source", "scope": "instance", "kind": "member", "___id": "T000002R040167", "___s": true }, { "comment": "/**\r\n * An array of TextureSource data instances.\r\n * Used to store additional data images, such as normal maps or specular maps.\r\n *\r\n * @name Phaser.Textures.Texture#dataSource\r\n * @type {array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 78, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "An array of TextureSource data instances.\rUsed to store additional data images, such as normal maps or specular maps.", "name": "dataSource", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#dataSource", "scope": "instance", "kind": "member", "___id": "T000002R040169", "___s": true }, { "comment": "/**\r\n * A key-value object pair associating the unique Frame keys with the Frames objects.\r\n *\r\n * @name Phaser.Textures.Texture#frames\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "A key-value object pair associating the unique Frame keys with the Frames objects.", "name": "frames", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#frames", "scope": "instance", "kind": "member", "___id": "T000002R040171", "___s": true }, { "comment": "/**\r\n * Any additional data that was set in the source JSON (if any),\r\n * or any extra data you'd like to store relating to this texture\r\n *\r\n * @name Phaser.Textures.Texture#customData\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Any additional data that was set in the source JSON (if any),\ror any extra data you'd like to store relating to this texture", "name": "customData", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#customData", "scope": "instance", "kind": "member", "___id": "T000002R040173", "___s": true }, { "comment": "/**\r\n * The name of the first frame of the Texture.\r\n *\r\n * @name Phaser.Textures.Texture#firstFrame\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The name of the first frame of the Texture.", "name": "firstFrame", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#firstFrame", "scope": "instance", "kind": "member", "___id": "T000002R040175", "___s": true }, { "comment": "/**\r\n * The total number of Frames in this Texture, including the `__BASE` frame.\r\n *\r\n * A Texture will always contain at least 1 frame because every Texture contains a `__BASE` frame by default,\r\n * in addition to any extra frames that have been added to it, such as when parsing a Sprite Sheet or Texture Atlas.\r\n *\r\n * @name Phaser.Textures.Texture#frameTotal\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The total number of Frames in this Texture, including the `__BASE` frame.\r\rA Texture will always contain at least 1 frame because every Texture contains a `__BASE` frame by default,\rin addition to any extra frames that have been added to it, such as when parsing a Sprite Sheet or Texture Atlas.", "name": "frameTotal", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#frameTotal", "scope": "instance", "kind": "member", "___id": "T000002R040177", "___s": true }, { "comment": "/**\r\n * Adds a new Frame to this Texture.\r\n *\r\n * A Frame is a rectangular region of a TextureSource with a unique index or string-based key.\r\n *\r\n * The name given must be unique within this Texture. If it already exists, this method will return `null`.\r\n *\r\n * @method Phaser.Textures.Texture#add\r\n * @since 3.0.0\r\n *\r\n * @param {(number|string)} name - The name of this Frame. The name is unique within the Texture.\r\n * @param {number} sourceIndex - The index of the TextureSource that this Frame is a part of.\r\n * @param {number} x - The x coordinate of the top-left of this Frame.\r\n * @param {number} y - The y coordinate of the top-left of this Frame.\r\n * @param {number} width - The width of this Frame.\r\n * @param {number} height - The height of this Frame.\r\n *\r\n * @return {?Phaser.Textures.Frame} The Frame that was added to this Texture, or `null` if the given name already exists.\r\n */", "meta": { "filename": "Texture.js", "lineno": 136, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Adds a new Frame to this Texture.\r\rA Frame is a rectangular region of a TextureSource with a unique index or string-based key.\r\rThe name given must be unique within this Texture. If it already exists, this method will return `null`.", "kind": "function", "name": "add", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The name of this Frame. The name is unique within the Texture.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the TextureSource that this Frame is a part of.", "name": "sourceIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the top-left of this Frame.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the top-left of this Frame.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this Frame.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this Frame.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame", "nullable": true } }, "nullable": true, "description": "The Frame that was added to this Texture, or `null` if the given name already exists." } ], "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#add", "scope": "instance", "___id": "T000002R040180", "___s": true }, { "comment": "/**\r\n * Removes the given Frame from this Texture. The Frame is destroyed immediately.\r\n *\r\n * Any Game Objects using this Frame should stop using it _before_ you remove it,\r\n * as it does not happen automatically.\r\n *\r\n * @method Phaser.Textures.Texture#remove\r\n * @since 3.19.0\r\n *\r\n * @param {string} name - The key of the Frame to remove.\r\n *\r\n * @return {boolean} True if a Frame with the matching key was removed from this Texture.\r\n */", "meta": { "filename": "Texture.js", "lineno": 180, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Removes the given Frame from this Texture. The Frame is destroyed immediately.\r\rAny Game Objects using this Frame should stop using it _before_ you remove it,\ras it does not happen automatically.", "kind": "function", "name": "remove", "since": "3.19.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Frame to remove.", "name": "name" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if a Frame with the matching key was removed from this Texture." } ], "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#remove", "scope": "instance", "___id": "T000002R040185", "___s": true }, { "comment": "/**\r\n * Checks to see if a Frame matching the given key exists within this Texture.\r\n *\r\n * @method Phaser.Textures.Texture#has\r\n * @since 3.0.0\r\n *\r\n * @param {string} name - The key of the Frame to check for.\r\n *\r\n * @return {boolean} True if a Frame with the matching key exists in this Texture.\r\n */", "meta": { "filename": "Texture.js", "lineno": 209, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Checks to see if a Frame matching the given key exists within this Texture.", "kind": "function", "name": "has", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Frame to check for.", "name": "name" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if a Frame with the matching key exists in this Texture." } ], "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#has", "scope": "instance", "___id": "T000002R040188", "___s": true }, { "comment": "/**\r\n * Gets a Frame from this Texture based on either the key or the index of the Frame.\r\n *\r\n * In a Texture Atlas Frames are typically referenced by a key.\r\n * In a Sprite Sheet Frames are referenced by an index.\r\n * Passing no value for the name returns the base texture.\r\n *\r\n * @method Phaser.Textures.Texture#get\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number)} [name] - The string-based name, or integer based index, of the Frame to get from this Texture.\r\n *\r\n * @return {Phaser.Textures.Frame} The Texture Frame.\r\n */", "meta": { "filename": "Texture.js", "lineno": 224, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Gets a Frame from this Texture based on either the key or the index of the Frame.\r\rIn a Texture Atlas Frames are typically referenced by a key.\rIn a Sprite Sheet Frames are referenced by an index.\rPassing no value for the name returns the base texture.", "kind": "function", "name": "get", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The string-based name, or integer based index, of the Frame to get from this Texture.", "name": "name" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "description": "The Texture Frame." } ], "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#get", "scope": "instance", "___id": "T000002R040190", "___s": true }, { "comment": "/**\r\n * Takes the given TextureSource and returns the index of it within this Texture.\r\n * If it's not in this Texture, it returns -1.\r\n * Unless this Texture has multiple TextureSources, such as with a multi-atlas, this\r\n * method will always return zero or -1.\r\n *\r\n * @method Phaser.Textures.Texture#getTextureSourceIndex\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Textures.TextureSource} source - The TextureSource to check.\r\n *\r\n * @return {number} The index of the TextureSource within this Texture, or -1 if not in this Texture.\r\n */", "meta": { "filename": "Texture.js", "lineno": 258, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Takes the given TextureSource and returns the index of it within this Texture.\rIf it's not in this Texture, it returns -1.\rUnless this Texture has multiple TextureSources, such as with a multi-atlas, this\rmethod will always return zero or -1.", "kind": "function", "name": "getTextureSourceIndex", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Textures.TextureSource" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureSource" } }, "description": "The TextureSource to check.", "name": "source" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the TextureSource within this Texture, or -1 if not in this Texture." } ], "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#getTextureSourceIndex", "scope": "instance", "___id": "T000002R040195", "___s": true }, { "comment": "/**\r\n * Returns an array of all the Frames in the given TextureSource.\r\n *\r\n * @method Phaser.Textures.Texture#getFramesFromTextureSource\r\n * @since 3.0.0\r\n *\r\n * @param {number} sourceIndex - The index of the TextureSource to get the Frames from.\r\n * @param {boolean} [includeBase=false] - Include the `__BASE` Frame in the output array?\r\n *\r\n * @return {Phaser.Textures.Frame[]} An array of Texture Frames.\r\n */", "meta": { "filename": "Texture.js", "lineno": 284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Returns an array of all the Frames in the given TextureSource.", "kind": "function", "name": "getFramesFromTextureSource", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the TextureSource to get the Frames from.", "name": "sourceIndex" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Include the `__BASE` Frame in the output array?", "name": "includeBase" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Textures.Frame", "type": "NameExpression" } ] } }, "description": "An array of Texture Frames." } ], "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#getFramesFromTextureSource", "scope": "instance", "___id": "T000002R040198", "___s": true }, { "comment": "/**\r\n * Returns an array with all of the names of the Frames in this Texture.\r\n *\r\n * Useful if you want to randomly assign a Frame to a Game Object, as you can\r\n * pick a random element from the returned array.\r\n *\r\n * @method Phaser.Textures.Texture#getFrameNames\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [includeBase=false] - Include the `__BASE` Frame in the output array?\r\n *\r\n * @return {string[]} An array of all Frame names in this Texture.\r\n */", "meta": { "filename": "Texture.js", "lineno": 319, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Returns an array with all of the names of the Frames in this Texture.\r\rUseful if you want to randomly assign a Frame to a Game Object, as you can\rpick a random element from the returned array.", "kind": "function", "name": "getFrameNames", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Include the `__BASE` Frame in the output array?", "name": "includeBase" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "An array of all Frame names in this Texture." } ], "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#getFrameNames", "scope": "instance", "___id": "T000002R040204", "___s": true }, { "comment": "/**\r\n * Given a Frame name, return the source image it uses to render with.\r\n *\r\n * This will return the actual DOM Image or Canvas element.\r\n *\r\n * @method Phaser.Textures.Texture#getSourceImage\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number)} [name] - The string-based name, or integer based index, of the Frame to get from this Texture.\r\n *\r\n * @return {(HTMLImageElement|HTMLCanvasElement|Phaser.GameObjects.RenderTexture)} The DOM Image, Canvas Element or Render Texture.\r\n */", "meta": { "filename": "Texture.js", "lineno": 351, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Given a Frame name, return the source image it uses to render with.\r\rThis will return the actual DOM Image or Canvas element.", "kind": "function", "name": "getSourceImage", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The string-based name, or integer based index, of the Frame to get from this Texture.", "name": "name" } ], "returns": [ { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement", "Phaser.GameObjects.RenderTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" }, { "type": "NameExpression", "name": "Phaser.GameObjects.RenderTexture" } ] } }, "description": "The DOM Image, Canvas Element or Render Texture." } ], "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#getSourceImage", "scope": "instance", "___id": "T000002R040209", "___s": true }, { "comment": "/**\r\n * Given a Frame name, return the data source image it uses to render with.\r\n * You can use this to get the normal map for an image for example.\r\n *\r\n * This will return the actual DOM Image.\r\n *\r\n * @method Phaser.Textures.Texture#getDataSourceImage\r\n * @since 3.7.0\r\n *\r\n * @param {(string|number)} [name] - The string-based name, or integer based index, of the Frame to get from this Texture.\r\n *\r\n * @return {(HTMLImageElement|HTMLCanvasElement)} The DOM Image or Canvas Element.\r\n */", "meta": { "filename": "Texture.js", "lineno": 384, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Given a Frame name, return the data source image it uses to render with.\rYou can use this to get the normal map for an image for example.\r\rThis will return the actual DOM Image.", "kind": "function", "name": "getDataSourceImage", "since": "3.7.0", "params": [ { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The string-based name, or integer based index, of the Frame to get from this Texture.", "name": "name" } ], "returns": [ { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" } ] } }, "description": "The DOM Image or Canvas Element." } ], "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#getDataSourceImage", "scope": "instance", "___id": "T000002R040213", "___s": true }, { "comment": "/**\r\n * Adds a data source image to this Texture.\r\n *\r\n * An example of a data source image would be a normal map, where all of the Frames for this Texture\r\n * equally apply to the normal map.\r\n *\r\n * @method Phaser.Textures.Texture#setDataSource\r\n * @since 3.0.0\r\n *\r\n * @param {(HTMLImageElement|HTMLCanvasElement|HTMLImageElement[]|HTMLCanvasElement[])} data - The source image.\r\n */", "meta": { "filename": "Texture.js", "lineno": 421, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Adds a data source image to this Texture.\r\rAn example of a data source image would be a normal map, where all of the Frames for this Texture\requally apply to the normal map.", "kind": "function", "name": "setDataSource", "since": "3.0.0", "params": [ { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLImageElement", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLCanvasElement", "type": "NameExpression" } ] } ] } }, "description": "The source image.", "name": "data" } ], "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#setDataSource", "scope": "instance", "___id": "T000002R040220", "___s": true }, { "comment": "/**\r\n * Sets the Filter Mode for this Texture.\r\n *\r\n * The mode can be either Linear, the default, or Nearest.\r\n *\r\n * For pixel-art you should use Nearest.\r\n *\r\n * The mode applies to the entire Texture, not just a specific Frame of it.\r\n *\r\n * @method Phaser.Textures.Texture#setFilter\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Textures.FilterMode} filterMode - The Filter Mode.\r\n */", "meta": { "filename": "Texture.js", "lineno": 447, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Sets the Filter Mode for this Texture.\r\rThe mode can be either Linear, the default, or Nearest.\r\rFor pixel-art you should use Nearest.\r\rThe mode applies to the entire Texture, not just a specific Frame of it.", "kind": "function", "name": "setFilter", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Textures.FilterMode" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.FilterMode" } }, "description": "The Filter Mode.", "name": "filterMode" } ], "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#setFilter", "scope": "instance", "___id": "T000002R040225", "___s": true }, { "comment": "/**\r\n * Destroys this Texture and releases references to its sources and frames.\r\n *\r\n * @method Phaser.Textures.Texture#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 476, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Destroys this Texture and releases references to its sources and frames.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Textures.Texture", "longname": "Phaser.Textures.Texture#destroy", "scope": "instance", "___id": "T000002R040230", "___s": true }, { "comment": "/**\r\n * @callback EachTextureCallback\r\n *\r\n * @param {Phaser.Textures.Texture} texture - Each texture in Texture Manager.\r\n * @param {...*} [args] - Additional arguments that will be passed to the callback, after the child.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 25, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "kind": "typedef", "name": "EachTextureCallback", "type": { "names": [ "function" ] }, "params": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture" } }, "description": "Each texture in Texture Manager.", "name": "texture" }, { "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": "EachTextureCallback", "scope": "global", "___id": "T000002R040261", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * When Phaser boots it will create an instance of this Texture Manager class.\r\n *\r\n * It is a global manager that handles all textures in your game. You can access it from within\r\n * a Scene via the `this.textures` property.\r\n *\r\n * Its role is as a manager for all textures that your game uses. It can create, update and remove\r\n * textures globally, as well as parse texture data from external files, such as sprite sheets\r\n * and texture atlases.\r\n *\r\n * Sprites and other texture-based Game Objects get their texture data directly from this class.\r\n *\r\n * @class TextureManager\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Textures\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - The Phaser.Game instance this Texture Manager belongs to.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 32, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "classdesc": "When Phaser boots it will create an instance of this Texture Manager class.\r\rIt is a global manager that handles all textures in your game. You can access it from within\ra Scene via the `this.textures` property.\r\rIts role is as a manager for all textures that your game uses. It can create, update and remove\rtextures globally, as well as parse texture data from external files, such as sprite sheets\rand texture atlases.\r\rSprites and other texture-based Game Objects get their texture data directly from this class.", "kind": "class", "name": "TextureManager", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Textures", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "The Phaser.Game instance this Texture Manager belongs to.", "name": "game" } ], "scope": "static", "longname": "Phaser.Textures.TextureManager", "___id": "T000002R040262", "___s": true }, { "comment": "/**\r\n * The Game that the Texture Manager belongs to.\r\n *\r\n * A game will only ever have one instance of a Texture Manager.\r\n *\r\n * @name Phaser.Textures.TextureManager#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The Game that the Texture Manager belongs to.\r\rA game will only ever have one instance of a Texture Manager.", "name": "game", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#game", "scope": "instance", "kind": "member", "___id": "T000002R040266", "___s": true }, { "comment": "/**\r\n * The internal name of this manager.\r\n *\r\n * @name Phaser.Textures.TextureManager#name\r\n * @type {string}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The internal name of this manager.", "name": "name", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#name", "scope": "instance", "kind": "member", "___id": "T000002R040268", "___s": true }, { "comment": "/**\r\n * This object contains all Textures that belong to this Texture Manager.\r\n *\r\n * Textures are identified by string-based keys, which are used as the property\r\n * within this object. Therefore, you can access any texture directly from this\r\n * object without any iteration.\r\n *\r\n * You should not typically modify this object directly, but instead use the\r\n * methods provided by the Texture Manager to add and remove entries from it.\r\n *\r\n * @name Phaser.Textures.TextureManager#list\r\n * @type {object}\r\n * @default {}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "This object contains all Textures that belong to this Texture Manager.\r\rTextures are identified by string-based keys, which are used as the property\rwithin this object. Therefore, you can access any texture directly from this\robject without any iteration.\r\rYou should not typically modify this object directly, but instead use the\rmethods provided by the Texture Manager to add and remove entries from it.", "name": "list", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "defaultvalue": "{}", "since": "3.0.0", "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#list", "scope": "instance", "kind": "member", "___id": "T000002R040270", "___s": true }, { "comment": "/**\r\n * An Image Game Object that belongs to this Texture Manager.\r\n *\r\n * Used as a drawing stamp within Dynamic Textures.\r\n *\r\n * This is not part of the display list and doesn't render.\r\n *\r\n * @name Phaser.Textures.TextureManager#stamp\r\n * @type {Phaser.GameObjects.Image}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 134, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "An Image Game Object that belongs to this Texture Manager.\r\rUsed as a drawing stamp within Dynamic Textures.\r\rThis is not part of the display list and doesn't render.", "name": "stamp", "type": { "names": [ "Phaser.GameObjects.Image" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Image" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#stamp", "scope": "instance", "kind": "member", "___id": "T000002R040279", "___s": true }, { "comment": "/**\r\n * The crop Rectangle as used by the Stamp when it needs to crop itself.\r\n *\r\n * @name Phaser.Textures.TextureManager#stampCrop\r\n * @type {Phaser.Geom.Rectangle}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The crop Rectangle as used by the Stamp when it needs to crop itself.", "name": "stampCrop", "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "since": "3.60.0", "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#stampCrop", "scope": "instance", "kind": "member", "___id": "T000002R040281", "___s": true }, { "comment": "/**\r\n * If this flag is `true` then the Texture Manager will never emit any\r\n * warnings to the console log that report missing textures.\r\n *\r\n * @name Phaser.Textures.TextureManager#silentWarnings\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 157, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "If this flag is `true` then the Texture Manager will never emit any\rwarnings to the console log that report missing textures.", "name": "silentWarnings", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#silentWarnings", "scope": "instance", "kind": "member", "___id": "T000002R040283", "___s": true }, { "comment": "/**\r\n * Checks the given texture key and throws a console.warn if the key is already in use, then returns false.\r\n *\r\n * If you wish to avoid the console.warn then use `TextureManager.exists` instead.\r\n *\r\n * @method Phaser.Textures.TextureManager#checkKey\r\n * @since 3.7.0\r\n *\r\n * @param {string} key - The texture key to check.\r\n *\r\n * @return {boolean} `true` if it's safe to use the texture key, otherwise `false`.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Checks the given texture key and throws a console.warn if the key is already in use, then returns false.\r\rIf you wish to avoid the console.warn then use `TextureManager.exists` instead.", "kind": "function", "name": "checkKey", "since": "3.7.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The texture key to check.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if it's safe to use the texture key, otherwise `false`." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#checkKey", "scope": "instance", "___id": "T000002R040292", "___s": true }, { "comment": "/**\r\n * Removes a Texture from the Texture Manager and destroys it. This will immediately\r\n * clear all references to it from the Texture Manager, and if it has one, destroy its\r\n * WebGLTexture. This will emit a `removetexture` event.\r\n *\r\n * Note: If you have any Game Objects still using this texture they will start throwing\r\n * errors the next time they try to render. Make sure that removing the texture is the final\r\n * step when clearing down to avoid this.\r\n *\r\n * @method Phaser.Textures.TextureManager#remove\r\n * @fires Phaser.Textures.Events#REMOVE\r\n * @since 3.7.0\r\n *\r\n * @param {(string|Phaser.Textures.Texture)} key - The key of the Texture to remove, or a reference to it.\r\n *\r\n * @return {Phaser.Textures.TextureManager} The Texture Manager.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 244, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Removes a Texture from the Texture Manager and destroys it. This will immediately\rclear all references to it from the Texture Manager, and if it has one, destroy its\rWebGLTexture. This will emit a `removetexture` event.\r\rNote: If you have any Game Objects still using this texture they will start throwing\rerrors the next time they try to render. Make sure that removing the texture is the final\rstep when clearing down to avoid this.", "kind": "function", "name": "remove", "fires": [ "Phaser.Textures.Events#event:REMOVE" ], "since": "3.7.0", "params": [ { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key of the Texture to remove, or a reference to it.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.TextureManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } }, "description": "The Texture Manager." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#remove", "scope": "instance", "___id": "T000002R040294", "___s": true }, { "comment": "/**\r\n * Removes a key from the Texture Manager but does not destroy the Texture that was using the key.\r\n *\r\n * @method Phaser.Textures.TextureManager#removeKey\r\n * @since 3.17.0\r\n *\r\n * @param {string} key - The key to remove from the texture list.\r\n *\r\n * @return {Phaser.Textures.TextureManager} The Texture Manager.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 294, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Removes a key from the Texture Manager but does not destroy the Texture that was using the key.", "kind": "function", "name": "removeKey", "since": "3.17.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to remove from the texture list.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.TextureManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } }, "description": "The Texture Manager." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#removeKey", "scope": "instance", "___id": "T000002R040298", "___s": true }, { "comment": "/**\r\n * Adds a new Texture to the Texture Manager created from the given Base64 encoded data.\r\n *\r\n * It works by creating an `Image` DOM object, then setting the `src` attribute to\r\n * the given base64 encoded data. As a result, the process is asynchronous by its nature,\r\n * so be sure to listen for the events this method dispatches before using the texture.\r\n *\r\n * @method Phaser.Textures.TextureManager#addBase64\r\n * @fires Phaser.Textures.Events#ADD\r\n * @fires Phaser.Textures.Events#ERROR\r\n * @fires Phaser.Textures.Events#LOAD\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {*} data - The Base64 encoded data.\r\n *\r\n * @return {this} This Texture Manager instance.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 314, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Adds a new Texture to the Texture Manager created from the given Base64 encoded data.\r\rIt works by creating an `Image` DOM object, then setting the `src` attribute to\rthe given base64 encoded data. As a result, the process is asynchronous by its nature,\rso be sure to listen for the events this method dispatches before using the texture.", "kind": "function", "name": "addBase64", "fires": [ "Phaser.Textures.Events#event:ADD", "Phaser.Textures.Events#event:ERROR", "Phaser.Textures.Events#event:LOAD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The Base64 encoded data.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Texture Manager instance." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#addBase64", "scope": "instance", "___id": "T000002R040300", "___s": true }, { "comment": "/**\r\n * Gets an existing texture frame and converts it into a base64 encoded image and returns the base64 data.\r\n *\r\n * You can also provide the image type and encoder options.\r\n *\r\n * This will only work with bitmap based texture frames, such as those created from Texture Atlases.\r\n * It will not work with GL Texture objects, such as Shaders, or Render Textures. For those please\r\n * see the WebGL Snapshot function instead.\r\n *\r\n * @method Phaser.Textures.TextureManager#getBase64\r\n * @since 3.12.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {(string|number)} [frame] - The string-based name, or integer based index, of the Frame to get from the Texture.\r\n * @param {string} [type='image/png'] - A DOMString indicating the image format. The default format type is image/png.\r\n * @param {number} [encoderOptions=0.92] - A Number between 0 and 1 indicating the image quality to use for image formats that use lossy compression such as image/jpeg and image/webp. If this argument is anything else, the default value for image quality is used. The default value is 0.92. Other arguments are ignored.\r\n *\r\n * @return {string} The base64 encoded data, or an empty string if the texture frame could not be found.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 362, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Gets an existing texture frame and converts it into a base64 encoded image and returns the base64 data.\r\rYou can also provide the image type and encoder options.\r\rThis will only work with bitmap based texture frames, such as those created from Texture Atlases.\rIt will not work with GL Texture objects, such as Shaders, or Render Textures. For those please\rsee the WebGL Snapshot function instead.", "kind": "function", "name": "getBase64", "since": "3.12.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The string-based name, or integer based index, of the Frame to get from the Texture.", "name": "frame" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'image/png'", "description": "A DOMString indicating the image format. The default format type is image/png.", "name": "type" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.92, "description": "A Number between 0 and 1 indicating the image quality to use for image formats that use lossy compression such as image/jpeg and image/webp. If this argument is anything else, the default value for image quality is used. The default value is 0.92. Other arguments are ignored.", "name": "encoderOptions" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The base64 encoded data, or an empty string if the texture frame could not be found." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#getBase64", "scope": "instance", "___id": "T000002R040308", "___s": true }, { "comment": "/**\r\n * Adds a new Texture to the Texture Manager created from the given Image element.\r\n *\r\n * @method Phaser.Textures.TextureManager#addImage\r\n * @fires Phaser.Textures.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {HTMLImageElement} source - The source Image element.\r\n * @param {HTMLImageElement|HTMLCanvasElement} [dataSource] - An optional data Image element.\r\n *\r\n * @return {?Phaser.Textures.Texture} The Texture that was created, or `null` if the key is already in use.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 427, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Adds a new Texture to the Texture Manager created from the given Image element.", "kind": "function", "name": "addImage", "fires": [ "Phaser.Textures.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "HTMLImageElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLImageElement" } }, "description": "The source Image element.", "name": "source" }, { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" } ] } }, "optional": true, "description": "An optional data Image element.", "name": "dataSource" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture", "nullable": true } }, "nullable": true, "description": "The Texture that was created, or `null` if the key is already in use." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#addImage", "scope": "instance", "___id": "T000002R040319", "___s": true }, { "comment": "/**\r\n * Takes a WebGL Texture and creates a Phaser Texture from it, which is added to the Texture Manager using the given key.\r\n *\r\n * This allows you to then use the Texture as a normal texture for texture based Game Objects like Sprites.\r\n *\r\n * If the `width` and `height` arguments are omitted, but the WebGL Texture was created by Phaser's WebGL Renderer\r\n * and has `glTexture.width` and `glTexture.height` properties, these values will be used instead.\r\n *\r\n * This is a WebGL only feature.\r\n *\r\n * @method Phaser.Textures.TextureManager#addGLTexture\r\n * @fires Phaser.Textures.Events#ADD\r\n * @since 3.19.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {WebGLTexture} glTexture - The source Render Texture.\r\n * @param {number} [width] - The new width of the Texture. Read from `glTexture.width` if omitted.\r\n * @param {number} [height] - The new height of the Texture. Read from `glTexture.height` if omitted.\r\n *\r\n * @return {?Phaser.Textures.Texture} The Texture that was created, or `null` if the key is already in use.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 462, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Takes a WebGL Texture and creates a Phaser Texture from it, which is added to the Texture Manager using the given key.\r\rThis allows you to then use the Texture as a normal texture for texture based Game Objects like Sprites.\r\rIf the `width` and `height` arguments are omitted, but the WebGL Texture was created by Phaser's WebGL Renderer\rand has `glTexture.width` and `glTexture.height` properties, these values will be used instead.\r\rThis is a WebGL only feature.", "kind": "function", "name": "addGLTexture", "fires": [ "Phaser.Textures.Events#event:ADD" ], "since": "3.19.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The source Render Texture.", "name": "glTexture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The new width of the Texture. Read from `glTexture.width` if omitted.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The new height of the Texture. Read from `glTexture.height` if omitted.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture", "nullable": true } }, "nullable": true, "description": "The Texture that was created, or `null` if the key is already in use." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#addGLTexture", "scope": "instance", "___id": "T000002R040323", "___s": true }, { "comment": "/**\r\n * Adds a Compressed Texture to this Texture Manager.\r\n *\r\n * The texture should typically have been loaded via the `CompressedTextureFile` loader,\r\n * in order to prepare the correct data object this method requires.\r\n *\r\n * You can optionally also pass atlas data to this method, in which case a texture atlas\r\n * will be generated from the given compressed texture, combined with the atlas data.\r\n *\r\n * @method Phaser.Textures.TextureManager#addCompressedTexture\r\n * @fires Phaser.Textures.Events#ADD\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {Phaser.Types.Textures.CompressedTextureData} textureData - The Compressed Texture data object.\r\n * @param {object} [atlasData] - Optional Texture Atlas data.\r\n *\r\n * @return {?Phaser.Textures.Texture} The Texture that was created, or `null` if the key is already in use.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 503, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Adds a Compressed Texture to this Texture Manager.\r\rThe texture should typically have been loaded via the `CompressedTextureFile` loader,\rin order to prepare the correct data object this method requires.\r\rYou can optionally also pass atlas data to this method, in which case a texture atlas\rwill be generated from the given compressed texture, combined with the atlas data.", "kind": "function", "name": "addCompressedTexture", "fires": [ "Phaser.Textures.Events#event:ADD" ], "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Textures.CompressedTextureData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Textures.CompressedTextureData" } }, "description": "The Compressed Texture data object.", "name": "textureData" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional Texture Atlas data.", "name": "atlasData" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture", "nullable": true } }, "nullable": true, "description": "The Texture that was created, or `null` if the key is already in use." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#addCompressedTexture", "scope": "instance", "___id": "T000002R040329", "___s": true }, { "comment": "/**\r\n * Adds a Render Texture to the Texture Manager using the given key.\r\n * This allows you to then use the Render Texture as a normal texture for texture based Game Objects like Sprites.\r\n *\r\n * @method Phaser.Textures.TextureManager#addRenderTexture\r\n * @fires Phaser.Textures.Events#ADD\r\n * @since 3.12.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {Phaser.GameObjects.RenderTexture} renderTexture - The source Render Texture.\r\n *\r\n * @return {?Phaser.Textures.Texture} The Texture that was created, or `null` if the key is already in use.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 554, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Adds a Render Texture to the Texture Manager using the given key.\rThis allows you to then use the Render Texture as a normal texture for texture based Game Objects like Sprites.", "kind": "function", "name": "addRenderTexture", "fires": [ "Phaser.Textures.Events#event:ADD" ], "since": "3.12.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "Phaser.GameObjects.RenderTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.RenderTexture" } }, "description": "The source Render Texture.", "name": "renderTexture" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture", "nullable": true } }, "nullable": true, "description": "The Texture that was created, or `null` if the key is already in use." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#addRenderTexture", "scope": "instance", "___id": "T000002R040334", "___s": true }, { "comment": "/**\r\n * Creates a new Texture using the given config values.\r\n *\r\n * Generated textures consist of a Canvas element to which the texture data is drawn.\r\n *\r\n * Generates a texture based on the given Create configuration object.\r\n *\r\n * The texture is drawn using a fixed-size indexed palette of 16 colors, where the hex value in the\r\n * data cells map to a single color. For example, if the texture config looked like this:\r\n *\r\n * ```javascript\r\n * var star = [\r\n * '.....828.....',\r\n * '....72227....',\r\n * '....82228....',\r\n * '...7222227...',\r\n * '2222222222222',\r\n * '8222222222228',\r\n * '.72222222227.',\r\n * '..787777787..',\r\n * '..877777778..',\r\n * '.78778887787.',\r\n * '.27887.78872.',\r\n * '.787.....787.'\r\n * ];\r\n *\r\n * this.textures.generate('star', { data: star, pixelWidth: 4 });\r\n * ```\r\n *\r\n * Then it would generate a texture that is 52 x 48 pixels in size, because each cell of the data array\r\n * represents 1 pixel multiplied by the `pixelWidth` value. The cell values, such as `8`, maps to color\r\n * number 8 in the palette. If a cell contains a period character `.` then it is transparent.\r\n *\r\n * The default palette is Arne16, but you can specify your own using the `palette` property.\r\n *\r\n * @method Phaser.Textures.TextureManager#generate\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {Phaser.Types.Create.GenerateTextureConfig} config - The configuration object needed to generate the texture.\r\n *\r\n * @return {?Phaser.Textures.Texture} The Texture that was created, or `null` if the key is already in use.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 584, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Creates a new Texture using the given config values.\r\rGenerated textures consist of a Canvas element to which the texture data is drawn.\r\rGenerates a texture based on the given Create configuration object.\r\rThe texture is drawn using a fixed-size indexed palette of 16 colors, where the hex value in the\rdata cells map to a single color. For example, if the texture config looked like this:\r\r```javascript\rvar star = [\r '.....828.....',\r '....72227....',\r '....82228....',\r '...7222227...',\r '2222222222222',\r '8222222222228',\r '.72222222227.',\r '..787777787..',\r '..877777778..',\r '.78778887787.',\r '.27887.78872.',\r '.787.....787.'\r];\r\rthis.textures.generate('star', { data: star, pixelWidth: 4 });\r```\r\rThen it would generate a texture that is 52 x 48 pixels in size, because each cell of the data array\rrepresents 1 pixel multiplied by the `pixelWidth` value. The cell values, such as `8`, maps to color\rnumber 8 in the palette. If a cell contains a period character `.` then it is transparent.\r\rThe default palette is Arne16, but you can specify your own using the `palette` property.", "kind": "function", "name": "generate", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Create.GenerateTextureConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Create.GenerateTextureConfig" } }, "description": "The configuration object needed to generate the texture.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture", "nullable": true } }, "nullable": true, "description": "The Texture that was created, or `null` if the key is already in use." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#generate", "scope": "instance", "___id": "T000002R040338", "___s": true }, { "comment": "/**\r\n * Creates a new Texture using a blank Canvas element of the size given.\r\n *\r\n * Canvas elements are automatically pooled and calling this method will\r\n * extract a free canvas from the CanvasPool, or create one if none are available.\r\n *\r\n * @method Phaser.Textures.TextureManager#createCanvas\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {number} [width=256] - The width of the Canvas element.\r\n * @param {number} [height=256] - The height of the Canvas element.\r\n *\r\n * @return {?Phaser.Textures.CanvasTexture} The Canvas Texture that was created, or `null` if the key is already in use.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 645, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Creates a new Texture using a blank Canvas element of the size given.\r\rCanvas elements are automatically pooled and calling this method will\rextract a free canvas from the CanvasPool, or create one if none are available.", "kind": "function", "name": "createCanvas", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 256, "description": "The width of the Canvas element.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 256, "description": "The height of the Canvas element.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.CanvasTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.CanvasTexture", "nullable": true } }, "nullable": true, "description": "The Canvas Texture that was created, or `null` if the key is already in use." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#createCanvas", "scope": "instance", "___id": "T000002R040342", "___s": true }, { "comment": "/**\r\n * Creates a new Canvas Texture object from an existing Canvas element\r\n * and adds it to this Texture Manager, unless `skipCache` is true.\r\n *\r\n * @method Phaser.Textures.TextureManager#addCanvas\r\n * @fires Phaser.Textures.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {HTMLCanvasElement} source - The Canvas element to form the base of the new Texture.\r\n * @param {boolean} [skipCache=false] - Skip adding this Texture into the Cache?\r\n *\r\n * @return {?Phaser.Textures.CanvasTexture} The Canvas Texture that was created, or `null` if the key is already in use.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 675, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Creates a new Canvas Texture object from an existing Canvas element\rand adds it to this Texture Manager, unless `skipCache` is true.", "kind": "function", "name": "addCanvas", "fires": [ "Phaser.Textures.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The Canvas element to form the base of the new Texture.", "name": "source" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip adding this Texture into the Cache?", "name": "skipCache" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.CanvasTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.CanvasTexture", "nullable": true } }, "nullable": true, "description": "The Canvas Texture that was created, or `null` if the key is already in use." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#addCanvas", "scope": "instance", "___id": "T000002R040347", "___s": true }, { "comment": "/**\r\n * Creates a Dynamic Texture instance and adds itself to this Texture Manager.\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 * See the methods available on the `DynamicTexture` class for more details.\r\n *\r\n * Optionally, you can also pass a Dynamic Texture instance to this method to have\r\n * it added to the Texture Manager.\r\n *\r\n * @method Phaser.Textures.TextureManager#addDynamicTexture\r\n * @fires Phaser.Textures.Events#ADD\r\n * @since 3.60.0\r\n *\r\n * @param {(string|Phaser.Textures.DynamicTexture)} key - The string-based key of this Texture. Must be unique within the Texture Manager. Or, a DynamicTexture instance.\r\n * @param {number} [width=256] - The width of this Dynamic Texture in pixels. Defaults to 256 x 256. Ignored if an instance is passed as the key.\r\n * @param {number} [height=256] - The height of this Dynamic Texture in pixels. Defaults to 256 x 256. Ignored if an instance is passed as the key.\r\n *\r\n * @return {?Phaser.Textures.DynamicTexture} The Dynamic Texture that was created, or `null` if the key is already in use.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 712, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Creates a Dynamic Texture instance and adds itself to this Texture Manager.\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\rSee the methods available on the `DynamicTexture` class for more details.\r\rOptionally, you can also pass a Dynamic Texture instance to this method to have\rit added to the Texture Manager.", "kind": "function", "name": "addDynamicTexture", "fires": [ "Phaser.Textures.Events#event:ADD" ], "since": "3.60.0", "params": [ { "type": { "names": [ "string", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "description": "The string-based key of this Texture. Must be unique within the Texture Manager. Or, a DynamicTexture instance.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 256, "description": "The width of this Dynamic Texture in pixels. Defaults to 256 x 256. Ignored if an instance is passed as the key.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 256, "description": "The height of this Dynamic Texture in pixels. Defaults to 256 x 256. Ignored if an instance is passed as the key.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture", "nullable": true } }, "nullable": true, "description": "The Dynamic Texture that was created, or `null` if the key is already in use." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#addDynamicTexture", "scope": "instance", "___id": "T000002R040354", "___s": true }, { "comment": "/**\r\n * Adds a Texture Atlas to this Texture Manager.\r\n *\r\n * In Phaser terminology, a Texture Atlas is a combination of an atlas image and a JSON data file,\r\n * such as those exported by applications like Texture Packer.\r\n *\r\n * It can accept either JSON Array or JSON Hash formats, as exported by Texture Packer and similar software.\r\n *\r\n * As of Phaser 3.60 you can use this method to add a atlas data to an existing Phaser Texture.\r\n *\r\n * @method Phaser.Textures.TextureManager#addAtlas\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {(HTMLImageElement|HTMLImageElement[]|Phaser.Textures.Texture)} source - The source Image element/s, or a Phaser Texture.\r\n * @param {(object|object[])} data - The Texture Atlas data/s.\r\n * @param {HTMLImageElement|HTMLCanvasElement|HTMLImageElement[]|HTMLCanvasElement[]} [dataSource] - An optional data Image element.\r\n *\r\n * @return {?Phaser.Textures.Texture} The Texture that was created, or `null` if the key is already in use.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 769, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Adds a Texture Atlas to this Texture Manager.\r\rIn Phaser terminology, a Texture Atlas is a combination of an atlas image and a JSON data file,\rsuch as those exported by applications like Texture Packer.\r\rIt can accept either JSON Array or JSON Hash formats, as exported by Texture Packer and similar software.\r\rAs of Phaser 3.60 you can use this method to add a atlas data to an existing Phaser Texture.", "kind": "function", "name": "addAtlas", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "HTMLImageElement", "Array.", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLImageElement", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The source Image element/s, or a Phaser Texture.", "name": "source" }, { "type": { "names": [ "object", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } ] } }, "description": "The Texture Atlas data/s.", "name": "data" }, { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLImageElement", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLCanvasElement", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An optional data Image element.", "name": "dataSource" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture", "nullable": true } }, "nullable": true, "description": "The Texture that was created, or `null` if the key is already in use." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#addAtlas", "scope": "instance", "___id": "T000002R040362", "___s": true }, { "comment": "/**\r\n * Adds a Texture Atlas to this Texture Manager.\r\n *\r\n * In Phaser terminology, a Texture Atlas is a combination of an atlas image and a JSON data file,\r\n * such as those exported by applications like Texture Packer.\r\n *\r\n * The frame data of the atlas must be stored in an Array within the JSON.\r\n *\r\n * This is known as a JSON Array in software such as Texture Packer.\r\n *\r\n * As of Phaser 3.60 you can use this method to add a atlas data to an existing Phaser Texture.\r\n *\r\n * @method Phaser.Textures.TextureManager#addAtlasJSONArray\r\n * @fires Phaser.Textures.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {(HTMLImageElement|HTMLImageElement[]|Phaser.Textures.Texture)} source - The source Image element/s, or a Phaser Texture.\r\n * @param {(object|object[])} data - The Texture Atlas data/s.\r\n * @param {HTMLImageElement|HTMLCanvasElement|HTMLImageElement[]|HTMLCanvasElement[]} [dataSource] - An optional data Image element.\r\n *\r\n * @return {?Phaser.Textures.Texture} The Texture that was created, or `null` if the key is already in use.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 802, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Adds a Texture Atlas to this Texture Manager.\r\rIn Phaser terminology, a Texture Atlas is a combination of an atlas image and a JSON data file,\rsuch as those exported by applications like Texture Packer.\r\rThe frame data of the atlas must be stored in an Array within the JSON.\r\rThis is known as a JSON Array in software such as Texture Packer.\r\rAs of Phaser 3.60 you can use this method to add a atlas data to an existing Phaser Texture.", "kind": "function", "name": "addAtlasJSONArray", "fires": [ "Phaser.Textures.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "HTMLImageElement", "Array.", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLImageElement", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The source Image element/s, or a Phaser Texture.", "name": "source" }, { "type": { "names": [ "object", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } ] } }, "description": "The Texture Atlas data/s.", "name": "data" }, { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLImageElement", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLCanvasElement", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An optional data Image element.", "name": "dataSource" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture", "nullable": true } }, "nullable": true, "description": "The Texture that was created, or `null` if the key is already in use." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#addAtlasJSONArray", "scope": "instance", "___id": "T000002R040364", "___s": true }, { "comment": "/**\r\n * Adds a Texture Atlas to this Texture Manager.\r\n *\r\n * In Phaser terminology, a Texture Atlas is a combination of an atlas image and a JSON data file,\r\n * such as those exported by applications like Texture Packer.\r\n *\r\n * The frame data of the atlas must be stored in an Object within the JSON.\r\n *\r\n * This is known as a JSON Hash in software such as Texture Packer.\r\n *\r\n * As of Phaser 3.60 you can use this method to add a atlas data to an existing Phaser Texture.\r\n *\r\n * @method Phaser.Textures.TextureManager#addAtlasJSONHash\r\n * @fires Phaser.Textures.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {(HTMLImageElement|HTMLImageElement[]|Phaser.Textures.Texture)} source - The source Image element/s, or a Phaser Texture.\r\n * @param {(object|object[])} data - The Texture Atlas data/s.\r\n * @param {HTMLImageElement|HTMLCanvasElement|HTMLImageElement[]|HTMLCanvasElement[]} [dataSource] - An optional data Image element.\r\n *\r\n * @return {?Phaser.Textures.Texture} The Texture that was created, or `null` if the key is already in use.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 871, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Adds a Texture Atlas to this Texture Manager.\r\rIn Phaser terminology, a Texture Atlas is a combination of an atlas image and a JSON data file,\rsuch as those exported by applications like Texture Packer.\r\rThe frame data of the atlas must be stored in an Object within the JSON.\r\rThis is known as a JSON Hash in software such as Texture Packer.\r\rAs of Phaser 3.60 you can use this method to add a atlas data to an existing Phaser Texture.", "kind": "function", "name": "addAtlasJSONHash", "fires": [ "Phaser.Textures.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "HTMLImageElement", "Array.", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLImageElement", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The source Image element/s, or a Phaser Texture.", "name": "source" }, { "type": { "names": [ "object", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } ] } }, "description": "The Texture Atlas data/s.", "name": "data" }, { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLImageElement", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLCanvasElement", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An optional data Image element.", "name": "dataSource" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture", "nullable": true } }, "nullable": true, "description": "The Texture that was created, or `null` if the key is already in use." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#addAtlasJSONHash", "scope": "instance", "___id": "T000002R040373", "___s": true }, { "comment": "/**\r\n * Adds a Texture Atlas to this Texture Manager.\r\n *\r\n * In Phaser terminology, a Texture Atlas is a combination of an atlas image and a data file,\r\n * such as those exported by applications like Texture Packer.\r\n *\r\n * The frame data of the atlas must be stored in an XML file.\r\n *\r\n * As of Phaser 3.60 you can use this method to add a atlas data to an existing Phaser Texture.\r\n *\r\n * @method Phaser.Textures.TextureManager#addAtlasXML\r\n * @fires Phaser.Textures.Events#ADD\r\n * @since 3.7.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {(HTMLImageElement|Phaser.Textures.Texture)} source - The source Image element, or a Phaser Texture.\r\n * @param {object} data - The Texture Atlas XML data.\r\n * @param {HTMLImageElement|HTMLCanvasElement|HTMLImageElement[]|HTMLCanvasElement[]} [dataSource] - An optional data Image element.\r\n *\r\n * @return {?Phaser.Textures.Texture} The Texture that was created, or `null` if the key is already in use.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 934, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Adds a Texture Atlas to this Texture Manager.\r\rIn Phaser terminology, a Texture Atlas is a combination of an atlas image and a data file,\rsuch as those exported by applications like Texture Packer.\r\rThe frame data of the atlas must be stored in an XML file.\r\rAs of Phaser 3.60 you can use this method to add a atlas data to an existing Phaser Texture.", "kind": "function", "name": "addAtlasXML", "fires": [ "Phaser.Textures.Events#event:ADD" ], "since": "3.7.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "HTMLImageElement", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The source Image element, or a Phaser Texture.", "name": "source" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The Texture Atlas XML data.", "name": "data" }, { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLImageElement", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLCanvasElement", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An optional data Image element.", "name": "dataSource" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture", "nullable": true } }, "nullable": true, "description": "The Texture that was created, or `null` if the key is already in use." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#addAtlasXML", "scope": "instance", "___id": "T000002R040380", "___s": true }, { "comment": "/**\r\n * Adds a Unity Texture Atlas to this Texture Manager.\r\n *\r\n * In Phaser terminology, a Texture Atlas is a combination of an atlas image and a data file,\r\n * such as those exported by applications like Texture Packer or Unity.\r\n *\r\n * The frame data of the atlas must be stored in a Unity YAML file.\r\n *\r\n * As of Phaser 3.60 you can use this method to add a atlas data to an existing Phaser Texture.\r\n *\r\n * @method Phaser.Textures.TextureManager#addUnityAtlas\r\n * @fires Phaser.Textures.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {HTMLImageElement} source - The source Image element.\r\n * @param {object} data - The Texture Atlas data.\r\n * @param {HTMLImageElement|HTMLCanvasElement|HTMLImageElement[]|HTMLCanvasElement[]} [dataSource] - An optional data Image element.\r\n *\r\n * @return {?Phaser.Textures.Texture} The Texture that was created, or `null` if the key is already in use.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 985, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Adds a Unity Texture Atlas to this Texture Manager.\r\rIn Phaser terminology, a Texture Atlas is a combination of an atlas image and a data file,\rsuch as those exported by applications like Texture Packer or Unity.\r\rThe frame data of the atlas must be stored in a Unity YAML file.\r\rAs of Phaser 3.60 you can use this method to add a atlas data to an existing Phaser Texture.", "kind": "function", "name": "addUnityAtlas", "fires": [ "Phaser.Textures.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "HTMLImageElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLImageElement" } }, "description": "The source Image element.", "name": "source" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The Texture Atlas data.", "name": "data" }, { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLImageElement", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLCanvasElement", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An optional data Image element.", "name": "dataSource" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture", "nullable": true } }, "nullable": true, "description": "The Texture that was created, or `null` if the key is already in use." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#addUnityAtlas", "scope": "instance", "___id": "T000002R040386", "___s": true }, { "comment": "/**\r\n * Adds a Sprite Sheet to this Texture Manager.\r\n *\r\n * In Phaser terminology a Sprite Sheet is a texture containing different frames, but each frame is the exact\r\n * same size and cannot be trimmed or rotated. This is different to a Texture Atlas, created by tools such as\r\n * Texture Packer, and more akin with the fixed-frame exports you get from apps like Aseprite or old arcade\r\n * games.\r\n *\r\n * As of Phaser 3.60 you can use this method to add a sprite sheet to an existing Phaser Texture.\r\n *\r\n * @method Phaser.Textures.TextureManager#addSpriteSheet\r\n * @fires Phaser.Textures.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture. Give an empty string if you provide a Phaser Texture as the 2nd argument.\r\n * @param {(HTMLImageElement|Phaser.Textures.Texture)} source - The source Image element, or a Phaser Texture.\r\n * @param {Phaser.Types.Textures.SpriteSheetConfig} config - The configuration object for this Sprite Sheet.\r\n * @param {HTMLImageElement|HTMLCanvasElement} [dataSource] - An optional data Image element.\r\n *\r\n * @return {?Phaser.Textures.Texture} The Texture that was created or updated, or `null` if the key is already in use.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 1036, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Adds a Sprite Sheet to this Texture Manager.\r\rIn Phaser terminology a Sprite Sheet is a texture containing different frames, but each frame is the exact\rsame size and cannot be trimmed or rotated. This is different to a Texture Atlas, created by tools such as\rTexture Packer, and more akin with the fixed-frame exports you get from apps like Aseprite or old arcade\rgames.\r\rAs of Phaser 3.60 you can use this method to add a sprite sheet to an existing Phaser Texture.", "kind": "function", "name": "addSpriteSheet", "fires": [ "Phaser.Textures.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture. Give an empty string if you provide a Phaser Texture as the 2nd argument.", "name": "key" }, { "type": { "names": [ "HTMLImageElement", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The source Image element, or a Phaser Texture.", "name": "source" }, { "type": { "names": [ "Phaser.Types.Textures.SpriteSheetConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Textures.SpriteSheetConfig" } }, "description": "The configuration object for this Sprite Sheet.", "name": "config" }, { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" } ] } }, "optional": true, "description": "An optional data Image element.", "name": "dataSource" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture", "nullable": true } }, "nullable": true, "description": "The Texture that was created or updated, or `null` if the key is already in use." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#addSpriteSheet", "scope": "instance", "___id": "T000002R040392", "___s": true }, { "comment": "/**\r\n * Adds a Sprite Sheet to this Texture Manager, where the Sprite Sheet exists as a Frame within a Texture Atlas.\r\n *\r\n * In Phaser terminology a Sprite Sheet is a texture containing different frames, but each frame is the exact\r\n * same size and cannot be trimmed or rotated.\r\n *\r\n * @method Phaser.Textures.TextureManager#addSpriteSheetFromAtlas\r\n * @fires Phaser.Textures.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {Phaser.Types.Textures.SpriteSheetFromAtlasConfig} config - The configuration object for this Sprite Sheet.\r\n *\r\n * @return {?Phaser.Textures.Texture} The Texture that was created, or `null` if the key is already in use.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 1090, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Adds a Sprite Sheet to this Texture Manager, where the Sprite Sheet exists as a Frame within a Texture Atlas.\r\rIn Phaser terminology a Sprite Sheet is a texture containing different frames, but each frame is the exact\rsame size and cannot be trimmed or rotated.", "kind": "function", "name": "addSpriteSheetFromAtlas", "fires": [ "Phaser.Textures.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Textures.SpriteSheetFromAtlasConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Textures.SpriteSheetFromAtlasConfig" } }, "description": "The configuration object for this Sprite Sheet.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture", "nullable": true } }, "nullable": true, "description": "The Texture that was created, or `null` if the key is already in use." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#addSpriteSheetFromAtlas", "scope": "instance", "___id": "T000002R040400", "___s": true }, { "comment": "/**\r\n * Creates a new Texture using the given source and dimensions.\r\n *\r\n * @method Phaser.Textures.TextureManager#create\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {HTMLImageElement} source - The source Image element.\r\n * @param {number} width - The width of the Texture.\r\n * @param {number} height - The height of the Texture.\r\n *\r\n * @return {?Phaser.Textures.Texture} The Texture that was created, or `null` if the key is already in use.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 1144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Creates a new Texture using the given source and dimensions.", "kind": "function", "name": "create", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "HTMLImageElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLImageElement" } }, "description": "The source Image element.", "name": "source" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the Texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the Texture.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture", "nullable": true } }, "nullable": true, "description": "The Texture that was created, or `null` if the key is already in use." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#create", "scope": "instance", "___id": "T000002R040407", "___s": true }, { "comment": "/**\r\n * Checks the given key to see if a Texture using it exists within this Texture Manager.\r\n *\r\n * @method Phaser.Textures.TextureManager#exists\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n *\r\n * @return {boolean} Returns `true` if a Texture matching the given key exists in this Texture Manager.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 1171, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Checks the given key to see if a Texture using it exists within this Texture Manager.", "kind": "function", "name": "exists", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `true` if a Texture matching the given key exists in this Texture Manager." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#exists", "scope": "instance", "___id": "T000002R040412", "___s": true }, { "comment": "/**\r\n * Returns a Texture from the Texture Manager that matches the given key.\r\n *\r\n * If the key is `undefined` it will return the `__DEFAULT` Texture.\r\n *\r\n * If the key is an instance of a Texture, it will return the instance.\r\n *\r\n * If the key is an instance of a Frame, it will return the frames parent Texture instance.\r\n *\r\n * Finally, if the key is given, but not found, and not a Texture or Frame instance, it will return the `__MISSING` Texture.\r\n *\r\n * @method Phaser.Textures.TextureManager#get\r\n * @since 3.0.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 {Phaser.Textures.Texture} The Texture matching the given key.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 1186, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Returns a Texture from the Texture Manager that matches the given key.\r\rIf the key is `undefined` it will return the `__DEFAULT` Texture.\r\rIf the key is an instance of a Texture, it will return the instance.\r\rIf the key is an instance of a Frame, it will return the frames parent Texture instance.\r\rFinally, if the key is given, but not found, and not a Texture or Frame instance, it will return the `__MISSING` Texture.", "kind": "function", "name": "get", "since": "3.0.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": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture" } }, "description": "The Texture matching the given key." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#get", "scope": "instance", "___id": "T000002R040414", "___s": true }, { "comment": "/**\r\n * Takes a Texture key and Frame name and returns a clone of that Frame if found.\r\n *\r\n * @method Phaser.Textures.TextureManager#cloneFrame\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {(string|number)} frame - The string or index of the Frame to be cloned.\r\n *\r\n * @return {Phaser.Textures.Frame} A Clone of the given Frame.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 1226, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Takes a Texture key and Frame name and returns a clone of that Frame if found.", "kind": "function", "name": "cloneFrame", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "The string or index of the Frame to be cloned.", "name": "frame" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "description": "A Clone of the given Frame." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#cloneFrame", "scope": "instance", "___id": "T000002R040417", "___s": true }, { "comment": "/**\r\n * Takes a Texture key and Frame name and returns a reference to that Frame, if found.\r\n *\r\n * @method Phaser.Textures.TextureManager#getFrame\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {(string|number)} [frame] - The string-based name, or integer based index, of the Frame to get from the Texture.\r\n *\r\n * @return {Phaser.Textures.Frame} A Texture Frame object.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 1245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Takes a Texture key and Frame name and returns a reference to that Frame, if found.", "kind": "function", "name": "getFrame", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The string-based name, or integer based index, of the Frame to get from the Texture.", "name": "frame" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "description": "A Texture Frame object." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#getFrame", "scope": "instance", "___id": "T000002R040419", "___s": true }, { "comment": "/**\r\n * Parses the 'key' parameter and returns a Texture Frame instance.\r\n *\r\n * It can accept the following formats:\r\n *\r\n * 1) A string\r\n * 2) An array where the elements are: [ key, [frame] ]\r\n * 3) An object with the properties: { key, [frame] }\r\n * 4) A Texture instance - which returns the default frame from the Texture\r\n * 5) A Frame instance - returns itself\r\n *\r\n * @method Phaser.Textures.TextureManager#parseFrame\r\n * @since 3.60.0\r\n *\r\n * @param {(string|array|object|Phaser.Textures.Texture|Phaser.Textures.Frame)} key - The key to be parsed.\r\n *\r\n * @return {Phaser.Textures.Frame} A Texture Frame object, if found, or undefined if not.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 1264, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Parses the 'key' parameter and returns a Texture Frame instance.\r\rIt can accept the following formats:\r\r1) A string\r2) An array where the elements are: [ key, [frame] ]\r3) An object with the properties: { key, [frame] }\r4) A Texture instance - which returns the default frame from the Texture\r5) A Frame instance - returns itself", "kind": "function", "name": "parseFrame", "since": "3.60.0", "params": [ { "type": { "names": [ "string", "array", "object", "Phaser.Textures.Texture", "Phaser.Textures.Frame" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "array" }, { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" }, { "type": "NameExpression", "name": "Phaser.Textures.Frame" } ] } }, "description": "The key to be parsed.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "description": "A Texture Frame object, if found, or undefined if not." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#parseFrame", "scope": "instance", "___id": "T000002R040421", "___s": true }, { "comment": "/**\r\n * Returns an array with all of the keys of all Textures in this Texture Manager.\r\n * The output array will exclude the `__DEFAULT`, `__MISSING`, and `__WHITE` keys.\r\n *\r\n * @method Phaser.Textures.TextureManager#getTextureKeys\r\n * @since 3.0.0\r\n *\r\n * @return {string[]} An array containing all of the Texture keys stored in this Texture Manager.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 1310, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Returns an array with all of the keys of all Textures in this Texture Manager.\rThe output array will exclude the `__DEFAULT`, `__MISSING`, and `__WHITE` keys.", "kind": "function", "name": "getTextureKeys", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "An array containing all of the Texture keys stored in this Texture Manager." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#getTextureKeys", "scope": "instance", "___id": "T000002R040423", "___s": true }, { "comment": "/**\r\n * Given a Texture and an `x` and `y` coordinate this method will return a new\r\n * Color object that has been populated with the color and alpha values of the pixel\r\n * at that location in the Texture.\r\n *\r\n * @method Phaser.Textures.TextureManager#getPixel\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate of the pixel within the Texture.\r\n * @param {number} y - The y coordinate of the pixel within the Texture.\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {(string|number)} [frame] - The string or index of the Frame.\r\n *\r\n * @return {?Phaser.Display.Color} A Color object populated with the color values of the requested pixel,\r\n * or `null` if the coordinates were out of bounds.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 1334, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Given a Texture and an `x` and `y` coordinate this method will return a new\rColor object that has been populated with the color and alpha values of the pixel\rat that location in the Texture.", "kind": "function", "name": "getPixel", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the pixel within the Texture.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the pixel within the Texture.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The string or index of the Frame.", "name": "frame" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color", "nullable": true } }, "nullable": true, "description": "A Color object populated with the color values of the requested pixel,\ror `null` if the coordinates were out of bounds." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#getPixel", "scope": "instance", "___id": "T000002R040427", "___s": true }, { "comment": "/**\r\n * Given a Texture and an `x` and `y` coordinate this method will return a value between 0 and 255\r\n * corresponding to the alpha value of the pixel at that location in the Texture. If the coordinate\r\n * is out of bounds it will return null.\r\n *\r\n * @method Phaser.Textures.TextureManager#getPixelAlpha\r\n * @since 3.10.0\r\n *\r\n * @param {number} x - The x coordinate of the pixel within the Texture.\r\n * @param {number} y - The y coordinate of the pixel within the Texture.\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {(string|number)} [frame] - The string or index of the Frame.\r\n *\r\n * @return {number} A value between 0 and 255, or `null` if the coordinates were out of bounds.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 1381, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Given a Texture and an `x` and `y` coordinate this method will return a value between 0 and 255\rcorresponding to the alpha value of the pixel at that location in the Texture. If the coordinate\ris out of bounds it will return null.", "kind": "function", "name": "getPixelAlpha", "since": "3.10.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the pixel within the Texture.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the pixel within the Texture.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The string or index of the Frame.", "name": "frame" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A value between 0 and 255, or `null` if the coordinates were out of bounds." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#getPixelAlpha", "scope": "instance", "___id": "T000002R040437", "___s": true }, { "comment": "/**\r\n * Sets the given Game Objects `texture` and `frame` properties so that it uses\r\n * the Texture and Frame specified in the `key` and `frame` arguments to this method.\r\n *\r\n * @method Phaser.Textures.TextureManager#setTexture\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object the texture would be set on.\r\n * @param {string} key - The unique string-based key of the Texture.\r\n * @param {(string|number)} [frame] - The string or index of the Frame.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object the texture was set on.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 1427, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Sets the given Game Objects `texture` and `frame` properties so that it uses\rthe Texture and Frame specified in the `key` and `frame` arguments to this method.", "kind": "function", "name": "setTexture", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object the texture would be set on.", "name": "gameObject" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique string-based key of the Texture.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The string or index of the Frame.", "name": "frame" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object the texture was set on." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#setTexture", "scope": "instance", "___id": "T000002R040447", "___s": true }, { "comment": "/**\r\n * Changes the key being used by a Texture to the new key provided.\r\n *\r\n * The old key is removed, allowing it to be re-used.\r\n *\r\n * Game Objects are linked to Textures by a reference to the Texture object, so\r\n * all existing references will be retained.\r\n *\r\n * @method Phaser.Textures.TextureManager#renameTexture\r\n * @since 3.12.0\r\n *\r\n * @param {string} currentKey - The current string-based key of the Texture you wish to rename.\r\n * @param {string} newKey - The new unique string-based key to use for the Texture.\r\n *\r\n * @return {boolean} `true` if the Texture key was successfully renamed, otherwise `false`.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 1451, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Changes the key being used by a Texture to the new key provided.\r\rThe old key is removed, allowing it to be re-used.\r\rGame Objects are linked to Textures by a reference to the Texture object, so\rall existing references will be retained.", "kind": "function", "name": "renameTexture", "since": "3.12.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The current string-based key of the Texture you wish to rename.", "name": "currentKey" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The new unique string-based key to use for the Texture.", "name": "newKey" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Texture key was successfully renamed, otherwise `false`." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#renameTexture", "scope": "instance", "___id": "T000002R040451", "___s": true }, { "comment": "/**\r\n * Passes all Textures to the given callback.\r\n *\r\n * @method Phaser.Textures.TextureManager#each\r\n * @since 3.0.0\r\n *\r\n * @param {EachTextureCallback} callback - The callback function to be sent the Textures.\r\n * @param {object} scope - The value to use as `this` when executing the callback.\r\n * @param {...*} [args] - Additional arguments that will be passed to the callback, after the child.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 1485, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Passes all Textures to the given callback.", "kind": "function", "name": "each", "since": "3.0.0", "params": [ { "type": { "names": [ "EachTextureCallback" ], "parsedType": { "type": "NameExpression", "name": "EachTextureCallback" } }, "description": "The callback function to be sent the Textures.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The value to use as `this` when executing the callback.", "name": "scope" }, { "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" } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#each", "scope": "instance", "___id": "T000002R040456", "___s": true }, { "comment": "/**\r\n * Resets the internal Stamp object, ready for drawing and returns it.\r\n *\r\n * @method Phaser.Textures.TextureManager#resetStamp\r\n * @since 3.60.0\r\n *\r\n * @param {number} [alpha=1] - The alpha to use.\r\n * @param {number} [tint=0xffffff] - WebGL only. The tint color to use.\r\n *\r\n * @return {Phaser.GameObjects.Image} A reference to the Stamp Game Object.\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 1512, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Resets the internal Stamp object, ready for drawing and returns it.", "kind": "function", "name": "resetStamp", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The alpha to use.", "name": "alpha" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "WebGL only. The tint color to use.", "name": "tint" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Image" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Image" } }, "description": "A reference to the Stamp Game Object." } ], "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#resetStamp", "scope": "instance", "___id": "T000002R040462", "___s": true }, { "comment": "/**\r\n * Destroys the Texture Manager and all Textures stored within it.\r\n *\r\n * @method Phaser.Textures.TextureManager#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureManager.js", "lineno": 1541, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Destroys the Texture Manager and all Textures stored within it.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Textures.TextureManager", "longname": "Phaser.Textures.TextureManager#destroy", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#destroy", "___id": "T000002R040467", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Texture Source is the encapsulation of the actual source data for a Texture.\r\n *\r\n * This is typically an Image Element, loaded from the file system or network, a Canvas Element or a Video Element.\r\n *\r\n * A Texture can contain multiple Texture Sources, which only happens when a multi-atlas is loaded.\r\n *\r\n * @class TextureSource\r\n * @memberof Phaser.Textures\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Textures.Texture} texture - The Texture this TextureSource belongs to.\r\n * @param {(HTMLImageElement|HTMLCanvasElement|HTMLVideoElement|Phaser.GameObjects.RenderTexture|WebGLTexture|Phaser.Types.Textures.CompressedTextureData|Phaser.Textures.DynamicTexture)} source - The source image data.\r\n * @param {number} [width] - Optional width of the source image. If not given it's derived from the source itself.\r\n * @param {number} [height] - Optional height of the source image. If not given it's derived from the source itself.\r\n * @param {boolean} [flipY=false] - Sets the `UNPACK_FLIP_Y_WEBGL` flag the WebGL Texture uses during upload.\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "classdesc": "A Texture Source is the encapsulation of the actual source data for a Texture.\r\rThis is typically an Image Element, loaded from the file system or network, a Canvas Element or a Video Element.\r\rA Texture can contain multiple Texture Sources, which only happens when a multi-atlas is loaded.", "kind": "class", "name": "TextureSource", "memberof": "Phaser.Textures", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture" } }, "description": "The Texture this TextureSource belongs to.", "name": "texture" }, { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement", "HTMLVideoElement", "Phaser.GameObjects.RenderTexture", "WebGLTexture", "Phaser.Types.Textures.CompressedTextureData", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" }, { "type": "NameExpression", "name": "HTMLVideoElement" }, { "type": "NameExpression", "name": "Phaser.GameObjects.RenderTexture" }, { "type": "NameExpression", "name": "WebGLTexture" }, { "type": "NameExpression", "name": "Phaser.Types.Textures.CompressedTextureData" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "description": "The source image data.", "name": "source" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional width of the source image. If not given it's derived from the source itself.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional height of the source image. If not given it's derived from the source itself.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Sets the `UNPACK_FLIP_Y_WEBGL` flag the WebGL Texture uses during upload.", "name": "flipY" } ], "scope": "static", "longname": "Phaser.Textures.TextureSource", "___id": "T000002R040478", "___s": true }, { "comment": "/**\r\n * A reference to the Canvas or WebGL Renderer.\r\n *\r\n * @name Phaser.Textures.TextureSource#renderer\r\n * @type {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 41, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "A reference to the Canvas or WebGL Renderer.", "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.7.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#renderer", "scope": "instance", "kind": "member", "___id": "T000002R040483", "___s": true }, { "comment": "/**\r\n * The Texture this TextureSource instance belongs to.\r\n *\r\n * @name Phaser.Textures.TextureSource#texture\r\n * @type {Phaser.Textures.Texture}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The Texture this TextureSource instance belongs to.", "name": "texture", "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture" } }, "since": "3.0.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#texture", "scope": "instance", "kind": "member", "___id": "T000002R040485", "___s": true }, { "comment": "/**\r\n * The source of the image data.\r\n *\r\n * This is either an Image Element, a Canvas Element, a Video Element, a RenderTexture or a WebGLTexture.\r\n *\r\n * In Phaser 3.60 and above it can also be a Compressed Texture data object.\r\n *\r\n * @name Phaser.Textures.TextureSource#source\r\n * @type {(HTMLImageElement|HTMLCanvasElement|HTMLVideoElement|Phaser.GameObjects.RenderTexture|WebGLTexture|Phaser.Types.Textures.CompressedTextureData|Phaser.Textures.DynamicTexture)}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The source of the image data.\r\rThis is either an Image Element, a Canvas Element, a Video Element, a RenderTexture or a WebGLTexture.\r\rIn Phaser 3.60 and above it can also be a Compressed Texture data object.", "name": "source", "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement", "HTMLVideoElement", "Phaser.GameObjects.RenderTexture", "WebGLTexture", "Phaser.Types.Textures.CompressedTextureData", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" }, { "type": "NameExpression", "name": "HTMLVideoElement" }, { "type": "NameExpression", "name": "Phaser.GameObjects.RenderTexture" }, { "type": "NameExpression", "name": "WebGLTexture" }, { "type": "NameExpression", "name": "Phaser.Types.Textures.CompressedTextureData" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "since": "3.12.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#source", "scope": "instance", "kind": "member", "___id": "T000002R040487", "___s": true }, { "comment": "/**\r\n * The image data.\r\n *\r\n * This is either an Image element, Canvas element or a Video Element.\r\n *\r\n * @name Phaser.Textures.TextureSource#image\r\n * @type {(HTMLImageElement|HTMLCanvasElement|HTMLVideoElement)}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The image data.\r\rThis is either an Image element, Canvas element or a Video Element.", "name": "image", "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement", "HTMLVideoElement" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" }, { "type": "NameExpression", "name": "HTMLVideoElement" } ] } }, "since": "3.0.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#image", "scope": "instance", "kind": "member", "___id": "T000002R040489", "___s": true }, { "comment": "/**\r\n * Holds the compressed textured algorithm, or `null` if it's not a compressed texture.\r\n *\r\n * Prior to Phaser 3.60 this value always held `null`.\r\n *\r\n * @name Phaser.Textures.TextureSource#compressionAlgorithm\r\n * @type {number}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Holds the compressed textured algorithm, or `null` if it's not a compressed texture.\r\rPrior to Phaser 3.60 this value always held `null`.", "name": "compressionAlgorithm", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#compressionAlgorithm", "scope": "instance", "kind": "member", "___id": "T000002R040491", "___s": true }, { "comment": "/**\r\n * The resolution of the source image.\r\n *\r\n * @name Phaser.Textures.TextureSource#resolution\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The resolution of the source image.", "name": "resolution", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#resolution", "scope": "instance", "kind": "member", "___id": "T000002R040493", "___s": true }, { "comment": "/**\r\n * The width of the source image. If not specified in the constructor it will check\r\n * the `naturalWidth` and then `width` properties of the source image.\r\n *\r\n * @name Phaser.Textures.TextureSource#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The width of the source image. If not specified in the constructor it will check\rthe `naturalWidth` and then `width` properties of the source image.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#width", "scope": "instance", "kind": "member", "___id": "T000002R040495", "___s": true }, { "comment": "/**\r\n * The height of the source image. If not specified in the constructor it will check\r\n * the `naturalHeight` and then `height` properties of the source image.\r\n *\r\n * @name Phaser.Textures.TextureSource#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 115, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The height of the source image. If not specified in the constructor it will check\rthe `naturalHeight` and then `height` properties of the source image.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#height", "scope": "instance", "kind": "member", "___id": "T000002R040497", "___s": true }, { "comment": "/**\r\n * The Scale Mode the image will use when rendering.\r\n * Either Linear or Nearest.\r\n *\r\n * @name Phaser.Textures.TextureSource#scaleMode\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The Scale Mode the image will use when rendering.\rEither Linear or Nearest.", "name": "scaleMode", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#scaleMode", "scope": "instance", "kind": "member", "___id": "T000002R040499", "___s": true }, { "comment": "/**\r\n * Is the source image a Canvas Element?\r\n *\r\n * @name Phaser.Textures.TextureSource#isCanvas\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 135, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Is the source image a Canvas Element?", "name": "isCanvas", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#isCanvas", "scope": "instance", "kind": "member", "___id": "T000002R040501", "___s": true }, { "comment": "/**\r\n * Is the source image a Video Element?\r\n *\r\n * @name Phaser.Textures.TextureSource#isVideo\r\n * @type {boolean}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 144, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Is the source image a Video Element?", "name": "isVideo", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.20.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#isVideo", "scope": "instance", "kind": "member", "___id": "T000002R040503", "___s": true }, { "comment": "/**\r\n * Is the source image a Render Texture?\r\n *\r\n * @name Phaser.Textures.TextureSource#isRenderTexture\r\n * @type {boolean}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 153, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Is the source image a Render Texture?", "name": "isRenderTexture", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.12.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#isRenderTexture", "scope": "instance", "kind": "member", "___id": "T000002R040505", "___s": true }, { "comment": "/**\r\n * Is the source image a WebGLTexture?\r\n *\r\n * @name Phaser.Textures.TextureSource#isGLTexture\r\n * @type {boolean}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 162, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Is the source image a WebGLTexture?", "name": "isGLTexture", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.19.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#isGLTexture", "scope": "instance", "kind": "member", "___id": "T000002R040507", "___s": true }, { "comment": "/**\r\n * Are the source image dimensions a power of two?\r\n *\r\n * @name Phaser.Textures.TextureSource#isPowerOf2\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 171, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Are the source image dimensions a power of two?", "name": "isPowerOf2", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#isPowerOf2", "scope": "instance", "kind": "member", "___id": "T000002R040509", "___s": true }, { "comment": "/**\r\n * The WebGL Texture of the source image. If this TextureSource is driven from a WebGLTexture\r\n * already, then this is a reference to that WebGLTexture.\r\n *\r\n * @name Phaser.Textures.TextureSource#glTexture\r\n * @type {?WebGLTexture}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 180, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "The WebGL Texture of the source image. If this TextureSource is driven from a WebGLTexture\ralready, then this is a reference to that WebGLTexture.", "name": "glTexture", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#glTexture", "scope": "instance", "kind": "member", "___id": "T000002R040511", "___s": true }, { "comment": "/**\r\n * Sets the `UNPACK_FLIP_Y_WEBGL` flag the WebGL Texture uses during upload.\r\n *\r\n * @name Phaser.Textures.TextureSource#flipY\r\n * @type {boolean}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 191, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Sets the `UNPACK_FLIP_Y_WEBGL` flag the WebGL Texture uses during upload.", "name": "flipY", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.20.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#flipY", "scope": "instance", "kind": "member", "___id": "T000002R040513", "___s": true }, { "comment": "/**\r\n * Creates a WebGL Texture, if required, and sets the Texture filter mode.\r\n *\r\n * @method Phaser.Textures.TextureSource#init\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": "TextureSource.js", "lineno": 203, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Creates a WebGL Texture, if required, and sets the Texture filter mode.", "kind": "function", "name": "init", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "A reference to the Phaser Game instance.", "name": "game" } ], "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#init", "scope": "instance", "___id": "T000002R040515", "___s": true }, { "comment": "/**\r\n * Sets the Filter Mode for this Texture.\r\n *\r\n * The mode can be either Linear, the default, or Nearest.\r\n *\r\n * For pixel-art you should use Nearest.\r\n *\r\n * @method Phaser.Textures.TextureSource#setFilter\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Textures.FilterMode} filterMode - The Filter Mode.\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 270, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Sets the Filter Mode for this Texture.\r\rThe mode can be either Linear, the default, or Nearest.\r\rFor pixel-art you should use Nearest.", "kind": "function", "name": "setFilter", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Textures.FilterMode" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.FilterMode" } }, "description": "The Filter Mode.", "name": "filterMode" } ], "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#setFilter", "scope": "instance", "___id": "T000002R040533", "___s": true }, { "comment": "/**\r\n * Sets the `UNPACK_FLIP_Y_WEBGL` flag for the WebGL Texture during texture upload.\r\n *\r\n * @method Phaser.Textures.TextureSource#setFlipY\r\n * @since 3.20.0\r\n *\r\n * @param {boolean} [value=true] - Should the WebGL Texture be flipped on the Y axis on texture upload or not?\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 292, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Sets the `UNPACK_FLIP_Y_WEBGL` flag for the WebGL Texture during texture upload.", "kind": "function", "name": "setFlipY", "since": "3.20.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the WebGL Texture be flipped on the Y axis on texture upload or not?", "name": "value" } ], "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#setFlipY", "scope": "instance", "___id": "T000002R040536", "___s": true }, { "comment": "/**\r\n * If this TextureSource is backed by a Canvas and is running under WebGL,\r\n * it updates the WebGLTexture using the canvas data.\r\n *\r\n * @method Phaser.Textures.TextureSource#update\r\n * @since 3.7.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 309, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "If this TextureSource is backed by a Canvas and is running under WebGL,\rit updates the WebGLTexture using the canvas data.", "kind": "function", "name": "update", "since": "3.7.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#update", "scope": "instance", "___id": "T000002R040540", "___s": true }, { "comment": "/**\r\n * Destroys this Texture Source and nulls the references.\r\n *\r\n * @method Phaser.Textures.TextureSource#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureSource.js", "lineno": 333, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "description": "Destroys this Texture Source and nulls the references.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Textures.TextureSource", "longname": "Phaser.Textures.TextureSource#destroy", "scope": "instance", "___id": "T000002R040548", "___s": true }, { "comment": "/**\r\n * An object containing the dimensions and mipmap data for a Compressed Texture.\r\n *\r\n * @typedef {object} Phaser.Types.Textures.CompressedTextureData\r\n * @since 3.60.0\r\n *\r\n * @property {boolean} compressed - Is this a compressed texture?\r\n * @property {boolean} generateMipmap - Should this texture have mipmaps generated?\r\n * @property {number} width - The width of the maximum size of the texture.\r\n * @property {number} height - The height of the maximum size of the texture.\r\n * @property {GLenum} internalFormat - The WebGL internal texture format.\r\n * @property {Phaser.Types.Textures.MipmapType[]} mipmaps - An array of MipmapType objects.\r\n */", "meta": { "filename": "CompressedTextureData.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\typedefs", "code": {} }, "description": "An object containing the dimensions and mipmap data for a Compressed Texture.", "kind": "typedef", "name": "CompressedTextureData", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this a compressed texture?", "name": "compressed" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should this texture have mipmaps generated?", "name": "generateMipmap" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the maximum size of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the maximum size of the texture.", "name": "height" }, { "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "description": "The WebGL internal texture format.", "name": "internalFormat" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Textures.MipmapType", "type": "NameExpression" } ] } }, "description": "An array of MipmapType objects.", "name": "mipmaps" } ], "memberof": "Phaser.Types.Textures", "longname": "Phaser.Types.Textures.CompressedTextureData", "scope": "static", "___id": "T000002R040556", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Textures\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\typedefs", "code": {} }, "kind": "namespace", "name": "Textures", "memberof": "Phaser.Types", "longname": "Phaser.Types.Textures", "scope": "static", "___id": "T000002R040557", "___s": true }, { "comment": "/**\r\n * A Mipmap Data entry for a Compressed Texture.\r\n *\r\n * @typedef {object} Phaser.Types.Textures.MipmapType\r\n * @since 3.60.0\r\n *\r\n * @property {number} width - The width of this level of the mipmap.\r\n * @property {number} height - The height of this level of the mipmap.\r\n * @property {Uint8Array} data - The decoded pixel data.\r\n */", "meta": { "filename": "MipmapType.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\typedefs", "code": {} }, "description": "A Mipmap Data entry for a Compressed Texture.", "kind": "typedef", "name": "MipmapType", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this level of the mipmap.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this level of the mipmap.", "name": "height" }, { "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "description": "The decoded pixel data.", "name": "data" } ], "memberof": "Phaser.Types.Textures", "longname": "Phaser.Types.Textures.MipmapType", "scope": "static", "___id": "T000002R040558", "___s": true }, { "comment": "/**\r\n * An object containing the position and color data for a single pixel in a CanvasTexture.\r\n *\r\n * @typedef {object} Phaser.Types.Textures.PixelConfig\r\n * @since 3.16.0\r\n *\r\n * @property {number} x - The x-coordinate of the pixel.\r\n * @property {number} y - The y-coordinate of the pixel.\r\n * @property {number} color - The color of the pixel, not including the alpha channel.\r\n * @property {number} alpha - The alpha of the pixel, between 0 and 1.\r\n */", "meta": { "filename": "PixelConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\typedefs", "code": {} }, "description": "An object containing the position and color data for a single pixel in a CanvasTexture.", "kind": "typedef", "name": "PixelConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.16.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x-coordinate of the pixel.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y-coordinate of the pixel.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The color of the pixel, not including the alpha channel.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha of the pixel, between 0 and 1.", "name": "alpha" } ], "memberof": "Phaser.Types.Textures", "longname": "Phaser.Types.Textures.PixelConfig", "scope": "static", "___id": "T000002R040559", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Textures.SpriteSheetConfig\r\n * @since 3.0.0\r\n * \r\n * @property {number} frameWidth - The fixed width of each frame.\r\n * @property {number} [frameHeight] - The fixed height of each frame. If not set it will use the frameWidth as the height.\r\n * @property {number} [startFrame=0] - Skip a number of frames. Useful when there are multiple sprite sheets in one Texture.\r\n * @property {number} [endFrame=-1] - The total number of frames to extract from the Sprite Sheet. The default value of -1 means \"extract all frames\".\r\n * @property {number} [margin=0] - If the frames have been drawn with a margin, specify the amount here.\r\n * @property {number} [spacing=0] - If the frames have been drawn with spacing between them, specify the amount here.\r\n */", "meta": { "filename": "SpriteSheetConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\typedefs", "code": {} }, "kind": "typedef", "name": "SpriteSheetConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The fixed width of each frame.", "name": "frameWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The fixed height of each frame. If not set it will use the frameWidth as the height.", "name": "frameHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Skip a number of frames. Useful when there are multiple sprite sheets in one Texture.", "name": "startFrame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": -1, "description": "The total number of frames to extract from the Sprite Sheet. The default value of -1 means \"extract all frames\".", "name": "endFrame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "If the frames have been drawn with a margin, specify the amount here.", "name": "margin" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "If the frames have been drawn with spacing between them, specify the amount here.", "name": "spacing" } ], "memberof": "Phaser.Types.Textures", "longname": "Phaser.Types.Textures.SpriteSheetConfig", "scope": "static", "___id": "T000002R040560", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Textures.SpriteSheetFromAtlasConfig\r\n * @since 3.0.0\r\n * \r\n * @property {string} atlas - The key of the Texture Atlas in which this Sprite Sheet can be found.\r\n * @property {string} frame - The key of the Texture Atlas Frame in which this Sprite Sheet can be found.\r\n * @property {number} frameWidth - The fixed width of each frame.\r\n * @property {number} [frameHeight] - The fixed height of each frame. If not set it will use the frameWidth as the height.\r\n * @property {number} [startFrame=0] - Skip a number of frames. Useful when there are multiple sprite sheets in one Texture.\r\n * @property {number} [endFrame=-1] - The total number of frames to extract from the Sprite Sheet. The default value of -1 means \"extract all frames\".\r\n * @property {number} [margin=0] - If the frames have been drawn with a margin, specify the amount here.\r\n * @property {number} [spacing=0] - If the frames have been drawn with spacing between them, specify the amount here.\r\n */", "meta": { "filename": "SpriteSheetFromAtlasConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\typedefs", "code": {} }, "kind": "typedef", "name": "SpriteSheetFromAtlasConfig", "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 Atlas in which this Sprite Sheet can be found.", "name": "atlas" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Texture Atlas Frame in which this Sprite Sheet can be found.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The fixed width of each frame.", "name": "frameWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The fixed height of each frame. If not set it will use the frameWidth as the height.", "name": "frameHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Skip a number of frames. Useful when there are multiple sprite sheets in one Texture.", "name": "startFrame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": -1, "description": "The total number of frames to extract from the Sprite Sheet. The default value of -1 means \"extract all frames\".", "name": "endFrame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "If the frames have been drawn with a margin, specify the amount here.", "name": "margin" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "If the frames have been drawn with spacing between them, specify the amount here.", "name": "spacing" } ], "memberof": "Phaser.Types.Textures", "longname": "Phaser.Types.Textures.SpriteSheetFromAtlasConfig", "scope": "static", "___id": "T000002R040561", "___s": true }, { "comment": "/**\r\n * An object containing the position and color data for a single pixel in a CanvasTexture.\r\n *\r\n * @typedef {object} Phaser.Types.Textures.StampConfig\r\n * @since 3.60.0\r\n *\r\n * @property {number} [alpha=1] - The alpha value used by the stamp.\r\n * @property {number} [tint=0xffffff] - The tint color value used by the stamp. WebGL only.\r\n * @property {number} [angle=0] - The angle of the stamp in degrees. Rotation takes place around its origin.\r\n * @property {number} [rotation=0] - The rotation of the stamp in radians. Rotation takes place around its origin.\r\n * @property {number} [scale=1] - Sets both the horizontal and vertical scale of the stamp with a single value.\r\n * @property {number} [scaleX=1] - Set the horizontal scale of the stamp. Overrides the scale property, if provided.\r\n * @property {number} [scaleY=1] - Set the vertical scale of the stamp. Overrides the scale property, if provided.\r\n * @property {number} [originX=0.5] - The horizontal origin of the stamp. 0 is the left, 0.5 is the center and 1 is the right.\r\n * @property {number} [originY=0.5] - The vertical origin of the stamp. 0 is the top, 0.5 is the center and 1 is the bottom.\r\n * @property {(string|Phaser.BlendModes|number)} [blendMode=0] - The blend mode used when drawing the stamp. Defaults to 0 (normal).\r\n * @property {boolean} [erase=false] - Erase this stamp from the texture?\r\n * @property {boolean} [skipBatch=false] - Skip beginning and ending a batch with this call. Use if this is part of a bigger batched draw.\r\n */", "meta": { "filename": "StampConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\textures\\typedefs", "code": {} }, "description": "An object containing the position and color data for a single pixel in a CanvasTexture.", "kind": "typedef", "name": "StampConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The alpha value used by the stamp.", "name": "alpha" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The tint color value used by the stamp. WebGL only.", "name": "tint" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The angle of the stamp in degrees. Rotation takes place around its origin.", "name": "angle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of the stamp in radians. Rotation takes place around its origin.", "name": "rotation" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Sets both the horizontal and vertical scale of the stamp with a single value.", "name": "scale" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Set the horizontal scale of the stamp. Overrides the scale property, if provided.", "name": "scaleX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Set the vertical scale of the stamp. Overrides the scale property, if provided.", "name": "scaleY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The horizontal origin of the stamp. 0 is the left, 0.5 is the center and 1 is the right.", "name": "originX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The vertical origin of the stamp. 0 is the top, 0.5 is the center and 1 is the bottom.", "name": "originY" }, { "type": { "names": [ "string", "Phaser.BlendModes", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.BlendModes" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "defaultvalue": 0, "description": "The blend mode used when drawing the stamp. Defaults to 0 (normal).", "name": "blendMode" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase this stamp from the texture?", "name": "erase" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip beginning and ending a batch with this call. Use if this is part of a bigger batched draw.", "name": "skipBatch" } ], "memberof": "Phaser.Types.Textures", "longname": "Phaser.Types.Textures.StampConfig", "scope": "static", "___id": "T000002R040562", "___s": true }, { "comment": "/**\r\n * Calculates interesting faces at the given tile coordinates of the specified layer. Interesting\r\n * faces are used internally for optimizing collisions against tiles. This method is mostly used\r\n * internally to optimize recalculating faces when only one tile has been changed.\r\n *\r\n * @function Phaser.Tilemaps.Components.CalculateFacesAt\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The x coordinate.\r\n * @param {number} tileY - The y coordinate.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "CalculateFacesAt.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Calculates interesting faces at the given tile coordinates of the specified layer. Interesting\rfaces are used internally for optimizing collisions against tiles. This method is mostly used\rinternally to optimize recalculating faces when only one tile has been changed.", "kind": "function", "name": "CalculateFacesAt", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate.", "name": "tileY" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.CalculateFacesAt", "scope": "static", "___id": "T000002R040564", "___s": true }, { "comment": "/**\r\n * Calculates interesting faces within the rectangular area specified (in tile coordinates) of the\r\n * layer. Interesting faces are used internally for optimizing collisions against tiles. This method\r\n * is mostly used internally.\r\n *\r\n * @function Phaser.Tilemaps.Components.CalculateFacesWithin\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} tileY - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} width - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} height - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "CalculateFacesWithin.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Calculates interesting faces within the rectangular area specified (in tile coordinates) of the\rlayer. Interesting faces are used internally for optimizing collisions against tiles. This method\ris mostly used internally.", "kind": "function", "name": "CalculateFacesWithin", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.CalculateFacesWithin", "scope": "static", "___id": "T000002R040587", "___s": true }, { "comment": "/**\r\n * Checks if the given tile coordinate is within the isometric layer bounds, or not.\r\n *\r\n * @function Phaser.Tilemaps.Components.CheckIsoBounds\r\n * @since 3.50.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to check against.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to run the cull check against.\r\n *\r\n * @return {boolean} Returns `true` if the coordinates are within the iso bounds.\r\n */", "meta": { "filename": "CheckIsoBounds.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Checks if the given tile coordinate is within the isometric layer bounds, or not.", "kind": "function", "name": "CheckIsoBounds", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to check against.", "name": "layer" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to run the cull check against.", "name": "camera" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `true` if the coordinates are within the iso bounds." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.CheckIsoBounds", "scope": "static", "___id": "T000002R040607", "___s": true }, { "comment": "/**\r\n * Copies the tiles in the source rectangular area to a new destination (all specified in tile\r\n * coordinates) within the layer. This copies all tile properties and recalculates collision\r\n * information in the destination region.\r\n *\r\n * @function Phaser.Tilemaps.Components.Copy\r\n * @since 3.0.0\r\n *\r\n * @param {number} srcTileX - The x coordinate of the area to copy from, in tiles, not pixels.\r\n * @param {number} srcTileY - The y coordinate of the area to copy from, in tiles, not pixels.\r\n * @param {number} width - The width of the area to copy, in tiles, not pixels.\r\n * @param {number} height - The height of the area to copy, in tiles, not pixels.\r\n * @param {number} destTileX - The x coordinate of the area to copy to, in tiles, not pixels.\r\n * @param {number} destTileY - The y coordinate of the area to copy to, in tiles, not pixels.\r\n * @param {boolean} recalculateFaces - `true` if the faces data should be recalculated.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "Copy.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Copies the tiles in the source rectangular area to a new destination (all specified in tile\rcoordinates) within the layer. This copies all tile properties and recalculates collision\rinformation in the destination region.", "kind": "function", "name": "Copy", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the area to copy from, in tiles, not pixels.", "name": "srcTileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the area to copy from, in tiles, not pixels.", "name": "srcTileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the area to copy, in tiles, not pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the area to copy, in tiles, not pixels.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the area to copy to, in tiles, not pixels.", "name": "destTileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the area to copy to, in tiles, not pixels.", "name": "destTileY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.Copy", "scope": "static", "___id": "T000002R040618", "___s": true }, { "comment": "/**\r\n * Creates a Sprite for every object matching the given tile indexes in the layer. You can\r\n * optionally specify if each tile will be replaced with a new tile after the Sprite has been\r\n * created. This is useful if you want to lay down special tiles in a level that are converted to\r\n * Sprites, but want to replace the tile itself with a floor tile or similar once converted.\r\n *\r\n * @function Phaser.Tilemaps.Components.CreateFromTiles\r\n * @since 3.0.0\r\n *\r\n * @param {(number|number[])} indexes - The tile index, or array of indexes, to create Sprites from.\r\n * @param {?(number|number[])} replacements - The tile index, or array of indexes, to change a converted tile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a one-to-one mapping with the indexes array.\r\n * @param {Phaser.Types.GameObjects.Sprite.SpriteConfig} spriteConfig - The config object to pass into the Sprite creator (i.e. scene.make.sprite).\r\n * @param {Phaser.Scene} scene - The Scene to create the Sprites within.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when determining the world XY\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.GameObjects.Sprite[]} An array of the Sprites that were created.\r\n */", "meta": { "filename": "CreateFromTiles.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Creates a Sprite for every object matching the given tile indexes in the layer. You can\roptionally specify if each tile will be replaced with a new tile after the Sprite has been\rcreated. This is useful if you want to lay down special tiles in a level that are converted to\rSprites, but want to replace the tile itself with a floor tile or similar once converted.", "kind": "function", "name": "CreateFromTiles", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "description": "The tile index, or array of indexes, to create Sprites from.", "name": "indexes" }, { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ], "nullable": true } }, "nullable": true, "description": "The tile index, or array of indexes, to change a converted tile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a one-to-one mapping with the indexes array.", "name": "replacements" }, { "type": { "names": [ "Phaser.Types.GameObjects.Sprite.SpriteConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Sprite.SpriteConfig" } }, "description": "The config object to pass into the Sprite creator (i.e. scene.make.sprite).", "name": "spriteConfig" }, { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to create the Sprites within.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when determining the world XY", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Sprite", "type": "NameExpression" } ] } }, "description": "An array of the Sprites that were created." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.CreateFromTiles", "scope": "static", "___id": "T000002R040638", "___s": true }, { "comment": "/**\r\n * Returns the bounds in the given orthogonal layer that are within the cameras viewport.\r\n * This is used internally by the cull tiles function.\r\n *\r\n * @function Phaser.Tilemaps.Components.CullBounds\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to run the cull check against.\r\n *\r\n * @return {Phaser.Geom.Rectangle} A rectangle containing the culled bounds. If you wish to retain this object, clone it, as it's recycled internally.\r\n */", "meta": { "filename": "CullBounds.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Returns the bounds in the given orthogonal layer that are within the cameras viewport.\rThis is used internally by the cull tiles function.", "kind": "function", "name": "CullBounds", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to run the cull check against.", "name": "camera" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "A rectangle containing the culled bounds. If you wish to retain this object, clone it, as it's recycled internally." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.CullBounds", "scope": "static", "___id": "T000002R040660", "___s": true }, { "comment": "/**\r\n * Returns the tiles in the given layer that are within the cameras viewport. This is used internally.\r\n *\r\n * @function Phaser.Tilemaps.Components.CullTiles\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to run the cull check against.\r\n * @param {array} [outputArray] - An optional array to store the Tile objects within.\r\n * @param {number} [renderOrder=0] - The rendering order constant.\r\n *\r\n * @return {Phaser.Tilemaps.Tile[]} An array of Tile objects.\r\n */", "meta": { "filename": "CullTiles.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Returns the tiles in the given layer that are within the cameras viewport. This is used internally.", "kind": "function", "name": "CullTiles", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to run the cull check against.", "name": "camera" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "An optional array to store the Tile objects within.", "name": "outputArray" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rendering order constant.", "name": "renderOrder" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of Tile objects." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.CullTiles", "scope": "static", "___id": "T000002R040673", "___s": true }, { "comment": "/**\r\n * Sets the tiles in the given rectangular area (in tile coordinates) of the layer with the\r\n * specified index. Tiles will be set to collide if the given index is a colliding index.\r\n * Collision information in the region will be recalculated.\r\n *\r\n * @function Phaser.Tilemaps.Components.Fill\r\n * @since 3.0.0\r\n *\r\n * @param {number} index - The tile index to fill the area with.\r\n * @param {number} tileX - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} tileY - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} width - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} height - How many tiles tall from the `tileY` index the area will be.\r\n * @param {boolean} recalculateFaces - `true` if the faces data should be recalculated.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The tile layer to use. If not given the current layer is used.\r\n */", "meta": { "filename": "Fill.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Sets the tiles in the given rectangular area (in tile coordinates) of the layer with the\rspecified index. Tiles will be set to collide if the given index is a colliding index.\rCollision information in the region will be recalculated.", "kind": "function", "name": "Fill", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tile index to fill the area with.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.Fill", "scope": "static", "___id": "T000002R040688", "___s": true }, { "comment": "/**\r\n * For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\r\n * filter callback function. Any tiles that pass the filter test (i.e. where the callback returns\r\n * true) will returned as a new array. Similar to Array.prototype.Filter in vanilla JS.\r\n *\r\n * @function Phaser.Tilemaps.Components.FilterTiles\r\n * @since 3.0.0\r\n *\r\n * @param {function} callback - The callback. Each tile in the given area will be passed to this\r\n * callback as the first and only parameter. The callback should return true for tiles that pass the\r\n * filter.\r\n * @param {object} context - The context under which the callback should be run.\r\n * @param {number} tileX - The left most tile index (in tile coordinates) to use as the origin of the area to filter.\r\n * @param {number} tileY - The top most tile index (in tile coordinates) to use as the origin of the area to filter.\r\n * @param {number} width - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} height - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} filteringOptions - Optional filters to apply when getting the tiles.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Tilemaps.Tile[]} The filtered array of Tiles.\r\n */", "meta": { "filename": "FilterTiles.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\rfilter callback function. Any tiles that pass the filter test (i.e. where the callback returns\rtrue) will returned as a new array. Similar to Array.prototype.Filter in vanilla JS.", "kind": "function", "name": "FilterTiles", "since": "3.0.0", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback. Each tile in the given area will be passed to this\rcallback as the first and only parameter. The callback should return true for tiles that pass the\rfilter.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The context under which the callback should be run.", "name": "context" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left most tile index (in tile coordinates) to use as the origin of the area to filter.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top most tile index (in tile coordinates) to use as the origin of the area to filter.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "The filtered array of Tiles." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.FilterTiles", "scope": "static", "___id": "T000002R040696", "___s": true }, { "comment": "/**\r\n * Searches the entire map layer for the first tile matching the given index, then returns that Tile\r\n * object. If no match is found, it returns null. The search starts from the top-left tile and\r\n * continues horizontally until it hits the end of the row, then it drops down to the next column.\r\n * If the reverse boolean is true, it scans starting from the bottom-right corner traveling up to\r\n * the top-left.\r\n *\r\n * @function Phaser.Tilemaps.Components.FindByIndex\r\n * @since 3.0.0\r\n *\r\n * @param {number} index - The tile index value to search for.\r\n * @param {number} skip - The number of times to skip a matching tile before returning.\r\n * @param {boolean} reverse - If true it will scan the layer in reverse, starting at the bottom-right. Otherwise it scans from the top-left.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {?Phaser.Tilemaps.Tile} The first (or n skipped) tile with the matching index.\r\n */", "meta": { "filename": "FindByIndex.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Searches the entire map layer for the first tile matching the given index, then returns that Tile\robject. If no match is found, it returns null. The search starts from the top-left tile and\rcontinues horizontally until it hits the end of the row, then it drops down to the next column.\rIf the reverse boolean is true, it scans starting from the bottom-right corner traveling up to\rthe top-left.", "kind": "function", "name": "FindByIndex", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tile index value to search for.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of times to skip a matching tile before returning.", "name": "skip" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If true it will scan the layer in reverse, starting at the bottom-right. Otherwise it scans from the top-left.", "name": "reverse" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile", "nullable": true } }, "nullable": true, "description": "The first (or n skipped) tile with the matching index." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.FindByIndex", "scope": "static", "___id": "T000002R040700", "___s": true }, { "comment": "/**\r\n * @callback FindTileCallback\r\n *\r\n * @param {Phaser.Tilemaps.Tile} value - The Tile.\r\n * @param {number} index - The index of the tile.\r\n * @param {Phaser.Tilemaps.Tile[]} array - An array of Tile objects.\r\n *\r\n * @return {boolean} Return `true` if the callback should run, otherwise `false`.\r\n */", "meta": { "filename": "FindTile.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "kind": "typedef", "name": "FindTileCallback", "type": { "names": [ "function" ] }, "params": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The Tile.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the tile.", "name": "index" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of Tile objects.", "name": "array" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Return `true` if the callback should run, otherwise `false`." } ], "longname": "FindTileCallback", "scope": "global", "___id": "T000002R040718", "___s": true }, { "comment": "/**\r\n * Find the first tile in the given rectangular area (in tile coordinates) of the layer that\r\n * satisfies the provided testing function. I.e. finds the first tile for which `callback` returns\r\n * true. Similar to Array.prototype.find in vanilla JS.\r\n *\r\n * @function Phaser.Tilemaps.Components.FindTile\r\n * @since 3.0.0\r\n *\r\n * @param {FindTileCallback} callback - The callback. Each tile in the given area will be passed to this callback as the first and only parameter.\r\n * @param {object} context - The context under which the callback should be run.\r\n * @param {number} tileX - The left most tile index (in tile coordinates) to use as the origin of the area to filter.\r\n * @param {number} tileY - The top most tile index (in tile coordinates) to use as the origin of the area to filter.\r\n * @param {number} width - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} height - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} filteringOptions - Optional filters to apply when getting the tiles.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {?Phaser.Tilemaps.Tile} A Tile that matches the search, or null if no Tile found\r\n */", "meta": { "filename": "FindTile.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Find the first tile in the given rectangular area (in tile coordinates) of the layer that\rsatisfies the provided testing function. I.e. finds the first tile for which `callback` returns\rtrue. Similar to Array.prototype.find in vanilla JS.", "kind": "function", "name": "FindTile", "since": "3.0.0", "params": [ { "type": { "names": [ "FindTileCallback" ], "parsedType": { "type": "NameExpression", "name": "FindTileCallback" } }, "description": "The callback. Each tile in the given area will be passed to this callback as the first and only parameter.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The context under which the callback should be run.", "name": "context" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left most tile index (in tile coordinates) to use as the origin of the area to filter.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top most tile index (in tile coordinates) to use as the origin of the area to filter.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile", "nullable": true } }, "nullable": true, "description": "A Tile that matches the search, or null if no Tile found" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.FindTile", "scope": "static", "___id": "T000002R040719", "___s": true }, { "comment": "/**\r\n * @callback EachTileCallback\r\n *\r\n * @param {Phaser.Tilemaps.Tile} value - The Tile.\r\n * @param {number} index - The index of the tile.\r\n * @param {Phaser.Tilemaps.Tile[]} array - An array of Tile objects.\r\n */", "meta": { "filename": "ForEachTile.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "kind": "typedef", "name": "EachTileCallback", "type": { "names": [ "function" ] }, "params": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The Tile.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the tile.", "name": "index" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of Tile objects.", "name": "array" } ], "longname": "EachTileCallback", "scope": "global", "___id": "T000002R040724", "___s": true }, { "comment": "/**\r\n * For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\r\n * callback. Similar to Array.prototype.forEach in vanilla JS.\r\n *\r\n * @function Phaser.Tilemaps.Components.ForEachTile\r\n * @since 3.0.0\r\n *\r\n * @param {EachTileCallback} callback - The callback. Each tile in the given area will be passed to this callback as the first and only parameter.\r\n * @param {object} context - The context under which the callback should be run.\r\n * @param {number} tileX - The left most tile index (in tile coordinates) to use as the origin of the area to filter.\r\n * @param {number} tileY - The top most tile index (in tile coordinates) to use as the origin of the area to filter.\r\n * @param {number} width - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} height - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} filteringOptions - Optional filters to apply when getting the tiles.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "ForEachTile.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\rcallback. Similar to Array.prototype.forEach in vanilla JS.", "kind": "function", "name": "ForEachTile", "since": "3.0.0", "params": [ { "type": { "names": [ "EachTileCallback" ], "parsedType": { "type": "NameExpression", "name": "EachTileCallback" } }, "description": "The callback. Each tile in the given area will be passed to this callback as the first and only parameter.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The context under which the callback should be run.", "name": "context" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left most tile index (in tile coordinates) to use as the origin of the area to filter.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top most tile index (in tile coordinates) to use as the origin of the area to filter.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.ForEachTile", "scope": "static", "___id": "T000002R040725", "___s": true }, { "comment": "/**\r\n * Gets the correct function to use to cull tiles, based on the map orientation.\r\n *\r\n * @function Phaser.Tilemaps.Components.GetCullTilesFunction\r\n * @since 3.50.0\r\n *\r\n * @param {number} orientation - The Tilemap orientation constant.\r\n *\r\n * @return {function} The function to use to cull tiles for the given map type.\r\n */", "meta": { "filename": "GetCullTilesFunction.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Gets the correct function to use to cull tiles, based on the map orientation.", "kind": "function", "name": "GetCullTilesFunction", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Tilemap orientation constant.", "name": "orientation" } ], "returns": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The function to use to cull tiles for the given map type." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.GetCullTilesFunction", "scope": "static", "___id": "T000002R040735", "___s": true }, { "comment": "/**\r\n * Gets a tile at the given tile coordinates from the given layer.\r\n *\r\n * @function Phaser.Tilemaps.Components.GetTileAt\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - X position to get the tile from (given in tile units, not pixels).\r\n * @param {number} tileY - Y position to get the tile from (given in tile units, not pixels).\r\n * @param {boolean} nonNull - If true getTile won't return null for empty tiles, but a Tile object with an index of -1.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Tilemaps.Tile} The tile at the given coordinates or null if no tile was found or the coordinates were invalid.\r\n */", "meta": { "filename": "GetTileAt.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Gets a tile at the given tile coordinates from the given layer.", "kind": "function", "name": "GetTileAt", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X position to get the tile from (given in tile units, not pixels).", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y position to get the tile from (given in tile units, not pixels).", "name": "tileY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If true getTile won't return null for empty tiles, but a Tile object with an index of -1.", "name": "nonNull" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The tile at the given coordinates or null if no tile was found or the coordinates were invalid." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.GetTileAt", "scope": "static", "___id": "T000002R040739", "___s": true }, { "comment": "/**\r\n * Gets a tile at the given world coordinates from the given layer.\r\n *\r\n * @function Phaser.Tilemaps.Components.GetTileAtWorldXY\r\n * @since 3.0.0\r\n *\r\n * @param {number} worldX - X position to get the tile from (given in pixels)\r\n * @param {number} worldY - Y position to get the tile from (given in pixels)\r\n * @param {boolean} nonNull - If true, function won't return null for empty tiles, but a Tile object with an index of -1.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Tilemaps.Tile} The tile at the given coordinates or null if no tile was found or the coordinates were invalid.\r\n */", "meta": { "filename": "GetTileAtWorldXY.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Gets a tile at the given world coordinates from the given layer.", "kind": "function", "name": "GetTileAtWorldXY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X position to get the tile from (given in pixels)", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y position to get the tile from (given in pixels)", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If true, function won't return null for empty tiles, but a Tile object with an index of -1.", "name": "nonNull" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The tile at the given coordinates or null if no tile was found or the coordinates were invalid." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.GetTileAtWorldXY", "scope": "static", "___id": "T000002R040747", "___s": true }, { "comment": "/**\r\n * Gets the corners of the Tile as an array of Vector2s.\r\n *\r\n * @function Phaser.Tilemaps.Components.GetTileCorners\r\n * @since 3.60.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of Vector2s corresponding to the world XY location of each tile corner.\r\n */", "meta": { "filename": "GetTileCorners.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Gets the corners of the Tile as an array of Vector2s.", "kind": "function", "name": "GetTileCorners", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Vector2s corresponding to the world XY location of each tile corner." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.GetTileCorners", "scope": "static", "___id": "T000002R040751", "___s": true }, { "comment": "/**\r\n * Gets the correct function to use to get the tile corners, based on the map orientation.\r\n *\r\n * @function Phaser.Tilemaps.Components.GetTileCornersFunction\r\n * @since 3.60.0\r\n *\r\n * @param {number} orientation - The Tilemap orientation constant.\r\n *\r\n * @return {function} The function to use to translate tiles for the given map type.\r\n */", "meta": { "filename": "GetTileCornersFunction.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Gets the correct function to use to get the tile corners, based on the map orientation.", "kind": "function", "name": "GetTileCornersFunction", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Tilemap orientation constant.", "name": "orientation" } ], "returns": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The function to use to translate tiles for the given map type." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.GetTileCornersFunction", "scope": "static", "___id": "T000002R040770", "___s": true }, { "comment": "/**\r\n * Gets the tiles in the given rectangular area (in tile coordinates) of the layer.\r\n *\r\n * This returns an array with references to the Tile instances in, so be aware of\r\n * modifying them directly.\r\n *\r\n * @function Phaser.Tilemaps.Components.GetTilesWithin\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} tileY - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} width - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} height - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} filteringOptions - Optional filters to apply when getting the tiles.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Tilemaps.Tile[]} Array of Tile objects.\r\n */", "meta": { "filename": "GetTilesWithin.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Gets the tiles in the given rectangular area (in tile coordinates) of the layer.\r\rThis returns an array with references to the Tile instances in, so be aware of\rmodifying them directly.", "kind": "function", "name": "GetTilesWithin", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "Array of Tile objects." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.GetTilesWithin", "scope": "static", "___id": "T000002R040774", "___s": true }, { "comment": "/**\r\n * Gets the tiles that overlap with the given shape in the given layer. The shape must be a Circle,\r\n * Line, Rectangle or Triangle. The shape should be in world coordinates.\r\n *\r\n * @function Phaser.Tilemaps.Components.GetTilesWithinShape\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Geom.Circle|Phaser.Geom.Line|Phaser.Geom.Rectangle|Phaser.Geom.Triangle)} shape - A shape in world (pixel) coordinates\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} filteringOptions - Optional filters to apply when getting the tiles.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Tilemaps.Tile[]} Array of Tile objects.\r\n */", "meta": { "filename": "GetTilesWithinShape.js", "lineno": 22, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Gets the tiles that overlap with the given shape in the given layer. The shape must be a Circle,\rLine, Rectangle or Triangle. The shape should be in world coordinates.", "kind": "function", "name": "GetTilesWithinShape", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Circle", "Phaser.Geom.Line", "Phaser.Geom.Rectangle", "Phaser.Geom.Triangle" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Circle" }, { "type": "NameExpression", "name": "Phaser.Geom.Line" }, { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } ] } }, "description": "A shape in world (pixel) coordinates", "name": "shape" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "Array of Tile objects." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.GetTilesWithinShape", "scope": "static", "___id": "T000002R040804", "___s": true }, { "comment": "/**\r\n * Gets the tiles in the given rectangular area (in world coordinates) of the layer.\r\n *\r\n * @function Phaser.Tilemaps.Components.GetTilesWithinWorldXY\r\n * @since 3.0.0\r\n *\r\n * @param {number} worldX - The world x coordinate for the top-left of the area.\r\n * @param {number} worldY - The world y coordinate for the top-left of the area.\r\n * @param {number} width - The width of the area.\r\n * @param {number} height - The height of the area.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} filteringOptions - Optional filters to apply when getting the tiles.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when factoring in which tiles to return.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Tilemaps.Tile[]} Array of Tile objects.\r\n */", "meta": { "filename": "GetTilesWithinWorldXY.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Gets the tiles in the given rectangular area (in world coordinates) of the layer.", "kind": "function", "name": "GetTilesWithinWorldXY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The world x coordinate for the top-left of the area.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The world y coordinate for the top-left of the area.", "name": "worldY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the area.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the area.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when factoring in which tiles to return.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "Array of Tile objects." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.GetTilesWithinWorldXY", "scope": "static", "___id": "T000002R040833", "___s": true }, { "comment": "/**\r\n * Gets the correct function to use to translate tiles, based on the map orientation.\r\n *\r\n * @function Phaser.Tilemaps.Components.GetTileToWorldXFunction\r\n * @since 3.50.0\r\n *\r\n * @param {number} orientation - The Tilemap orientation constant.\r\n *\r\n * @return {function} The function to use to translate tiles for the given map type.\r\n */", "meta": { "filename": "GetTileToWorldXFunction.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Gets the correct function to use to translate tiles, based on the map orientation.", "kind": "function", "name": "GetTileToWorldXFunction", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Tilemap orientation constant.", "name": "orientation" } ], "returns": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The function to use to translate tiles for the given map type." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.GetTileToWorldXFunction", "scope": "static", "___id": "T000002R040844", "___s": true }, { "comment": "/**\r\n * Gets the correct function to use to translate tiles, based on the map orientation.\r\n *\r\n * @function Phaser.Tilemaps.Components.GetTileToWorldXYFunction\r\n * @since 3.50.0\r\n *\r\n * @param {number} orientation - The Tilemap orientation constant.\r\n *\r\n * @return {function} The function to use to translate tiles for the given map type.\r\n */", "meta": { "filename": "GetTileToWorldXYFunction.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Gets the correct function to use to translate tiles, based on the map orientation.", "kind": "function", "name": "GetTileToWorldXYFunction", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Tilemap orientation constant.", "name": "orientation" } ], "returns": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The function to use to translate tiles for the given map type." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.GetTileToWorldXYFunction", "scope": "static", "___id": "T000002R040853", "___s": true }, { "comment": "/**\r\n * Gets the correct function to use to translate tiles, based on the map orientation.\r\n *\r\n * @function Phaser.Tilemaps.Components.GetTileToWorldYFunction\r\n * @since 3.50.0\r\n *\r\n * @param {number} orientation - The Tilemap orientation constant.\r\n *\r\n * @return {function} The function to use to translate tiles for the given map type.\r\n */", "meta": { "filename": "GetTileToWorldYFunction.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Gets the correct function to use to translate tiles, based on the map orientation.", "kind": "function", "name": "GetTileToWorldYFunction", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Tilemap orientation constant.", "name": "orientation" } ], "returns": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The function to use to translate tiles for the given map type." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.GetTileToWorldYFunction", "scope": "static", "___id": "T000002R040860", "___s": true }, { "comment": "/**\r\n * Gets the correct function to use to translate tiles, based on the map orientation.\r\n *\r\n * Only orthogonal maps support this feature.\r\n *\r\n * @function Phaser.Tilemaps.Components.GetWorldToTileXFunction\r\n * @since 3.50.0\r\n *\r\n * @param {number} orientation - The Tilemap orientation constant.\r\n *\r\n * @return {function} The function to use to translate tiles for the given map type.\r\n */", "meta": { "filename": "GetWorldToTileXFunction.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Gets the correct function to use to translate tiles, based on the map orientation.\r\rOnly orthogonal maps support this feature.", "kind": "function", "name": "GetWorldToTileXFunction", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Tilemap orientation constant.", "name": "orientation" } ], "returns": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The function to use to translate tiles for the given map type." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.GetWorldToTileXFunction", "scope": "static", "___id": "T000002R040866", "___s": true }, { "comment": "/**\r\n * Gets the correct function to use to translate tiles, based on the map orientation.\r\n *\r\n * @function Phaser.Tilemaps.Components.GetWorldToTileXYFunction\r\n * @since 3.50.0\r\n *\r\n * @param {number} orientation - The Tilemap orientation constant.\r\n *\r\n * @return {function} The function to use to translate tiles for the given map type.\r\n */", "meta": { "filename": "GetWorldToTileXYFunction.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Gets the correct function to use to translate tiles, based on the map orientation.", "kind": "function", "name": "GetWorldToTileXYFunction", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Tilemap orientation constant.", "name": "orientation" } ], "returns": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The function to use to translate tiles for the given map type." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.GetWorldToTileXYFunction", "scope": "static", "___id": "T000002R040875", "___s": true }, { "comment": "/**\r\n * Gets the correct function to use to translate tiles, based on the map orientation.\r\n *\r\n * @function Phaser.Tilemaps.Components.GetWorldToTileYFunction\r\n * @since 3.50.0\r\n *\r\n * @param {number} orientation - The Tilemap orientation constant.\r\n *\r\n * @return {function} The function to use to translate tiles for the given map type.\r\n */", "meta": { "filename": "GetWorldToTileYFunction.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Gets the correct function to use to translate tiles, based on the map orientation.", "kind": "function", "name": "GetWorldToTileYFunction", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Tilemap orientation constant.", "name": "orientation" } ], "returns": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The function to use to translate tiles for the given map type." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.GetWorldToTileYFunction", "scope": "static", "___id": "T000002R040882", "___s": true }, { "comment": "/**\r\n * Checks if there is a tile at the given location (in tile coordinates) in the given layer. Returns\r\n * false if there is no tile or if the tile at that location has an index of -1.\r\n *\r\n * @function Phaser.Tilemaps.Components.HasTileAt\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - X position to get the tile from (given in tile units, not pixels).\r\n * @param {number} tileY - Y position to get the tile from (given in tile units, not pixels).\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {?boolean} Returns a boolean, or null if the layer given was invalid.\r\n */", "meta": { "filename": "HasTileAt.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Checks if there is a tile at the given location (in tile coordinates) in the given layer. Returns\rfalse if there is no tile or if the tile at that location has an index of -1.", "kind": "function", "name": "HasTileAt", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X position to get the tile from (given in tile units, not pixels).", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y position to get the tile from (given in tile units, not pixels).", "name": "tileY" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "nullable": true, "description": "Returns a boolean, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.HasTileAt", "scope": "static", "___id": "T000002R040886", "___s": true }, { "comment": "/**\r\n * Checks if there is a tile at the given location (in world coordinates) in the given layer. Returns\r\n * false if there is no tile or if the tile at that location has an index of -1.\r\n *\r\n * @function Phaser.Tilemaps.Components.HasTileAtWorldXY\r\n * @since 3.0.0\r\n *\r\n * @param {number} worldX - The X coordinate of the world position.\r\n * @param {number} worldY - The Y coordinate of the world position.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when factoring in which tiles to return.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {?boolean} Returns a boolean, or null if the layer given was invalid.\r\n */", "meta": { "filename": "HasTileAtWorldXY.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Checks if there is a tile at the given location (in world coordinates) in the given layer. Returns\rfalse if there is no tile or if the tile at that location has an index of -1.", "kind": "function", "name": "HasTileAtWorldXY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the world position.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the world position.", "name": "worldY" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when factoring in which tiles to return.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "nullable": true, "description": "Returns a boolean, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.HasTileAtWorldXY", "scope": "static", "___id": "T000002R040893", "___s": true }, { "comment": "/**\r\n * Returns the bounds in the given layer that are within the camera's viewport.\r\n * This is used internally by the cull tiles function.\r\n *\r\n * @function Phaser.Tilemaps.Components.HexagonalCullBounds\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to run the cull check against.\r\n *\r\n * @return {object} An object containing the `left`, `right`, `top` and `bottom` bounds.\r\n */", "meta": { "filename": "HexagonalCullBounds.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Returns the bounds in the given layer that are within the camera's viewport.\rThis is used internally by the cull tiles function.", "kind": "function", "name": "HexagonalCullBounds", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to run the cull check against.", "name": "camera" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "An object containing the `left`, `right`, `top` and `bottom` bounds." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.HexagonalCullBounds", "scope": "static", "___id": "T000002R040900", "___s": true }, { "comment": "/**\r\n * Returns the tiles in the given layer that are within the cameras viewport. This is used internally.\r\n *\r\n * @function Phaser.Tilemaps.Components.HexagonalCullTiles\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to run the cull check against.\r\n * @param {array} [outputArray] - An optional array to store the Tile objects within.\r\n * @param {number} [renderOrder=0] - The rendering order constant.\r\n *\r\n * @return {Phaser.Tilemaps.Tile[]} An array of Tile objects.\r\n */", "meta": { "filename": "HexagonalCullTiles.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Returns the tiles in the given layer that are within the cameras viewport. This is used internally.", "kind": "function", "name": "HexagonalCullTiles", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to run the cull check against.", "name": "camera" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "An optional array to store the Tile objects within.", "name": "outputArray" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rendering order constant.", "name": "renderOrder" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of Tile objects." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.HexagonalCullTiles", "scope": "static", "___id": "T000002R040928", "___s": true }, { "comment": "/**\r\n * Gets the corners of the Hexagonal Tile as an array of Vector2s.\r\n *\r\n * @function Phaser.Tilemaps.Components.HexagonalGetTileCorners\r\n * @since 3.60.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of Vector2s corresponding to the world XY location of each tile corner.\r\n */", "meta": { "filename": "HexagonalGetTileCorners.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Gets the corners of the Hexagonal Tile as an array of Vector2s.", "kind": "function", "name": "HexagonalGetTileCorners", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Vector2s corresponding to the world XY location of each tile corner." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.HexagonalGetTileCorners", "scope": "static", "___id": "T000002R040943", "___s": true }, { "comment": "/**\r\n * Converts from hexagonal tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\r\n * layer's position, scale and scroll. This will return a new Vector2 object or update the given\r\n * `point` object.\r\n *\r\n * @function Phaser.Tilemaps.Components.HexagonalTileToWorldXY\r\n * @since 3.50.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {Phaser.Math.Vector2} point - A Vector2 to store the coordinates in. If not given a new Vector2 is created.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Math.Vector2} The XY location in world coordinates.\r\n */", "meta": { "filename": "HexagonalTileToWorldXY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Converts from hexagonal tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\rlayer's position, scale and scroll. This will return a new Vector2 object or update the given\r`point` object.", "kind": "function", "name": "HexagonalTileToWorldXY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 to store the coordinates in. If not given a new Vector2 is created.", "name": "point" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The XY location in world coordinates." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.HexagonalTileToWorldXY", "scope": "static", "___id": "T000002R040963", "___s": true }, { "comment": "/**\r\n * Converts from world XY coordinates (pixels) to hexagonal tile XY coordinates (tile units), factoring in the\r\n * layer's position, scale and scroll. This will return a new Vector2 object or update the given\r\n * `point` object.\r\n *\r\n * @function Phaser.Tilemaps.Components.HexagonalWorldToTileXY\r\n * @since 3.50.0\r\n *\r\n * @param {number} worldX - The x coordinate to be converted, in pixels, not tiles.\r\n * @param {number} worldY - The y coordinate to be converted, in pixels, not tiles.\r\n * @param {boolean} snapToFloor - Whether or not to round the tile coordinates down to the nearest integer.\r\n * @param {Phaser.Math.Vector2} point - A Vector2 to store the coordinates in. If not given a new Vector2 is created.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Math.Vector2} The XY location in tile units.\r\n */", "meta": { "filename": "HexagonalWorldToTileXY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Converts from world XY coordinates (pixels) to hexagonal tile XY coordinates (tile units), factoring in the\rlayer's position, scale and scroll. This will return a new Vector2 object or update the given\r`point` object.", "kind": "function", "name": "HexagonalWorldToTileXY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to be converted, in pixels, not tiles.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to be converted, in pixels, not tiles.", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether or not to round the tile coordinates down to the nearest integer.", "name": "snapToFloor" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 to store the coordinates in. If not given a new Vector2 is created.", "name": "point" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The XY location in tile units." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.HexagonalWorldToTileXY", "scope": "static", "___id": "T000002R040990", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Tilemaps.Components\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "kind": "namespace", "name": "Components", "memberof": "Phaser.Tilemaps", "longname": "Phaser.Tilemaps.Components", "scope": "static", "___id": "T000002R041034", "___s": true }, { "comment": "/**\r\n * Checks if the given tile coordinates are within the bounds of the layer.\r\n *\r\n * @function Phaser.Tilemaps.Components.IsInLayerBounds\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {boolean} `true` if the tile coordinates are within the bounds of the layer, otherwise `false`.\r\n */", "meta": { "filename": "IsInLayerBounds.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Checks if the given tile coordinates are within the bounds of the layer.", "kind": "function", "name": "IsInLayerBounds", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the tile coordinates are within the bounds of the layer, otherwise `false`." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.IsInLayerBounds", "scope": "static", "___id": "T000002R041106", "___s": true }, { "comment": "/**\r\n * Returns the tiles in the given layer that are within the cameras viewport. This is used internally.\r\n *\r\n * @function Phaser.Tilemaps.Components.IsometricCullTiles\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to run the cull check against.\r\n * @param {array} [outputArray] - An optional array to store the Tile objects within.\r\n * @param {number} [renderOrder=0] - The rendering order constant.\r\n *\r\n * @return {Phaser.Tilemaps.Tile[]} An array of Tile objects.\r\n */", "meta": { "filename": "IsometricCullTiles.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Returns the tiles in the given layer that are within the cameras viewport. This is used internally.", "kind": "function", "name": "IsometricCullTiles", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to run the cull check against.", "name": "camera" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "An optional array to store the Tile objects within.", "name": "outputArray" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rendering order constant.", "name": "renderOrder" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of Tile objects." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.IsometricCullTiles", "scope": "static", "___id": "T000002R041110", "___s": true }, { "comment": "/**\r\n * Converts from isometric tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\r\n * layer's position, scale and scroll. This will return a new Vector2 object or update the given\r\n * `point` object.\r\n *\r\n * @function Phaser.Tilemaps.Components.IsometricTileToWorldXY\r\n * @since 3.50.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {Phaser.Math.Vector2} point - A Vector2 to store the coordinates in. If not given a new Vector2 is created.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Math.Vector2} The XY location in world coordinates.\r\n */", "meta": { "filename": "IsometricTileToWorldXY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Converts from isometric tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\rlayer's position, scale and scroll. This will return a new Vector2 object or update the given\r`point` object.", "kind": "function", "name": "IsometricTileToWorldXY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 to store the coordinates in. If not given a new Vector2 is created.", "name": "point" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The XY location in world coordinates." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.IsometricTileToWorldXY", "scope": "static", "___id": "T000002R041143", "___s": true }, { "comment": "/**\r\n * Converts from world XY coordinates (pixels) to isometric tile XY coordinates (tile units), factoring in the\r\n * layers position, scale and scroll. This will return a new Vector2 object or update the given\r\n * `point` object.\r\n *\r\n * @function Phaser.Tilemaps.Components.IsometricWorldToTileXY\r\n * @since 3.50.0\r\n *\r\n * @param {number} worldX - The x coordinate to be converted, in pixels, not tiles.\r\n * @param {number} worldY - The y coordinate to be converted, in pixels, not tiles.\r\n * @param {boolean} snapToFloor - Whether or not to round the tile coordinate down to the nearest integer.\r\n * @param {Phaser.Math.Vector2} point - A Vector2 to store the coordinates in. If not given a new Vector2 is created.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n * @param {boolean} [originTop=true] - Which is the active face of the isometric tile? The top (default, true), or the base? (false)\r\n *\r\n * @return {Phaser.Math.Vector2} The XY location in tile units.\r\n */", "meta": { "filename": "IsometricWorldToTileXY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Converts from world XY coordinates (pixels) to isometric tile XY coordinates (tile units), factoring in the\rlayers position, scale and scroll. This will return a new Vector2 object or update the given\r`point` object.", "kind": "function", "name": "IsometricWorldToTileXY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to be converted, in pixels, not tiles.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to be converted, in pixels, not tiles.", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether or not to round the tile coordinate down to the nearest integer.", "name": "snapToFloor" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 to store the coordinates in. If not given a new Vector2 is created.", "name": "point" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Which is the active face of the isometric tile? The top (default, true), or the base? (false)", "name": "originTop" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The XY location in tile units." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.IsometricWorldToTileXY", "scope": "static", "___id": "T000002R041160", "___s": true }, { "comment": "/**\r\n * Puts a tile at the given tile coordinates in the specified layer. You can pass in either an index\r\n * or a Tile object. If you pass in a Tile, all attributes will be copied over to the specified\r\n * location. If you pass in an index, only the index at the specified location will be changed.\r\n * Collision information will be recalculated at the specified location.\r\n *\r\n * @function Phaser.Tilemaps.Components.PutTileAt\r\n * @since 3.0.0\r\n *\r\n * @param {(number|Phaser.Tilemaps.Tile)} tile - The index of this tile to set or a Tile object.\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {boolean} recalculateFaces - `true` if the faces data should be recalculated.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Tilemaps.Tile} The Tile object that was created or added to this map.\r\n */", "meta": { "filename": "PutTileAt.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Puts a tile at the given tile coordinates in the specified layer. You can pass in either an index\ror a Tile object. If you pass in a Tile, all attributes will be copied over to the specified\rlocation. If you pass in an index, only the index at the specified location will be changed.\rCollision information will be recalculated at the specified location.", "kind": "function", "name": "PutTileAt", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } ] } }, "description": "The index of this tile to set or a Tile object.", "name": "tile" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The Tile object that was created or added to this map." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.PutTileAt", "scope": "static", "___id": "T000002R041184", "___s": true }, { "comment": "/**\r\n * Puts a tile at the given world coordinates (pixels) in the specified layer. You can pass in either\r\n * an index or a Tile object. If you pass in a Tile, all attributes will be copied over to the\r\n * specified location. If you pass in an index, only the index at the specified location will be\r\n * changed. Collision information will be recalculated at the specified location.\r\n *\r\n * @function Phaser.Tilemaps.Components.PutTileAtWorldXY\r\n * @since 3.0.0\r\n *\r\n * @param {(number|Phaser.Tilemaps.Tile)} tile - The index of this tile to set or a Tile object.\r\n * @param {number} worldX - The x coordinate, in pixels.\r\n * @param {number} worldY - The y coordinate, in pixels.\r\n * @param {boolean} recalculateFaces - `true` if the faces data should be recalculated.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Tilemaps.Tile} The Tile object that was created or added to this map.\r\n */", "meta": { "filename": "PutTileAtWorldXY.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Puts a tile at the given world coordinates (pixels) in the specified layer. You can pass in either\ran index or a Tile object. If you pass in a Tile, all attributes will be copied over to the\rspecified location. If you pass in an index, only the index at the specified location will be\rchanged. Collision information will be recalculated at the specified location.", "kind": "function", "name": "PutTileAtWorldXY", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } ] } }, "description": "The index of this tile to set or a Tile object.", "name": "tile" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in pixels.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in pixels.", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The Tile object that was created or added to this map." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.PutTileAtWorldXY", "scope": "static", "___id": "T000002R041209", "___s": true }, { "comment": "/**\r\n * Puts an array of tiles or a 2D array of tiles at the given tile coordinates in the specified\r\n * layer. The array can be composed of either tile indexes or Tile objects. If you pass in a Tile,\r\n * all attributes will be copied over to the specified location. If you pass in an index, only the\r\n * index at the specified location will be changed. Collision information will be recalculated\r\n * within the region tiles were changed.\r\n *\r\n * @function Phaser.Tilemaps.Components.PutTilesAt\r\n * @since 3.0.0\r\n *\r\n * @param {(number[]|number[][]|Phaser.Tilemaps.Tile[]|Phaser.Tilemaps.Tile[][])} tile - A row (array) or grid (2D array) of Tiles or tile indexes to place.\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {boolean} recalculateFaces - `true` if the faces data should be recalculated.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "PutTilesAt.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Puts an array of tiles or a 2D array of tiles at the given tile coordinates in the specified\rlayer. The array can be composed of either tile indexes or Tile objects. If you pass in a Tile,\rall attributes will be copied over to the specified location. If you pass in an index, only the\rindex at the specified location will be changed. Collision information will be recalculated\rwithin the region tiles were changed.", "kind": "function", "name": "PutTilesAt", "since": "3.0.0", "params": [ { "type": { "names": [ "Array.", "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": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } ] } ] } }, "description": "A row (array) or grid (2D array) of Tiles or tile indexes to place.", "name": "tile" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.PutTilesAt", "scope": "static", "___id": "T000002R041214", "___s": true }, { "comment": "/**\r\n * Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\r\n * specified layer. Each tile will receive a new index. If an array of indexes is passed in, then\r\n * those will be used for randomly assigning new tile indexes. If an array is not provided, the\r\n * indexes found within the region (excluding -1) will be used for randomly assigning new tile\r\n * indexes. This method only modifies tile indexes and does not change collision information.\r\n *\r\n * @function Phaser.Tilemaps.Components.Randomize\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} tileY - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} width - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} height - How many tiles tall from the `tileY` index the area will be.\r\n * @param {number[]} indexes - An array of indexes to randomly draw from during randomization.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "Randomize.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\rspecified layer. Each tile will receive a new index. If an array of indexes is passed in, then\rthose will be used for randomly assigning new tile indexes. If an array is not provided, the\rindexes found within the region (excluding -1) will be used for randomly assigning new tile\rindexes. This method only modifies tile indexes and does not change collision information.", "kind": "function", "name": "Randomize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "An array of indexes to randomly draw from during randomization.", "name": "indexes" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.Randomize", "scope": "static", "___id": "T000002R041226", "___s": true }, { "comment": "/**\r\n * Removes the tile at the given tile coordinates in the specified layer and updates the layer's\r\n * collision information.\r\n *\r\n * @function Phaser.Tilemaps.Components.RemoveTileAt\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The x coordinate.\r\n * @param {number} tileY - The y coordinate.\r\n * @param {boolean} replaceWithNull - If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.\r\n * @param {boolean} recalculateFaces - `true` if the faces data should be recalculated.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Tilemaps.Tile} The Tile object that was removed.\r\n */", "meta": { "filename": "RemoveTileAt.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Removes the tile at the given tile coordinates in the specified layer and updates the layer's\rcollision information.", "kind": "function", "name": "RemoveTileAt", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate.", "name": "tileY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.", "name": "replaceWithNull" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The Tile object that was removed." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.RemoveTileAt", "scope": "static", "___id": "T000002R041238", "___s": true }, { "comment": "/**\r\n * Removes the tile at the given world coordinates in the specified layer and updates the layer's\r\n * collision information.\r\n *\r\n * @function Phaser.Tilemaps.Components.RemoveTileAtWorldXY\r\n * @since 3.0.0\r\n *\r\n * @param {number} worldX - The x coordinate, in pixels.\r\n * @param {number} worldY - The y coordinate, in pixels.\r\n * @param {boolean} replaceWithNull - If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.\r\n * @param {boolean} recalculateFaces - `true` if the faces data should be recalculated.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Tilemaps.Tile} The Tile object that was removed.\r\n */", "meta": { "filename": "RemoveTileAtWorldXY.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Removes the tile at the given world coordinates in the specified layer and updates the layer's\rcollision information.", "kind": "function", "name": "RemoveTileAtWorldXY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in pixels.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in pixels.", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.", "name": "replaceWithNull" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The Tile object that was removed." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.RemoveTileAtWorldXY", "scope": "static", "___id": "T000002R041248", "___s": true }, { "comment": "/**\r\n * Draws a debug representation of the layer to the given Graphics. This is helpful when you want to\r\n * get a quick idea of which of your tiles are colliding and which have interesting faces. The tiles\r\n * are drawn starting at (0, 0) in the Graphics, allowing you to place the debug representation\r\n * wherever you want on the screen.\r\n *\r\n * @function Phaser.Tilemaps.Components.RenderDebug\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Graphics} graphics - The target Graphics object to draw upon.\r\n * @param {Phaser.Types.Tilemaps.DebugStyleOptions} styleConfig - An object specifying the colors to use for the debug drawing.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "RenderDebug.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Draws a debug representation of the layer to the given Graphics. This is helpful when you want to\rget a quick idea of which of your tiles are colliding and which have interesting faces. The tiles\rare drawn starting at (0, 0) in the Graphics, allowing you to place the debug representation\rwherever you want on the screen.", "kind": "function", "name": "RenderDebug", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The target Graphics object to draw upon.", "name": "graphics" }, { "type": { "names": [ "Phaser.Types.Tilemaps.DebugStyleOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.DebugStyleOptions" } }, "description": "An object specifying the colors to use for the debug drawing.", "name": "styleConfig" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.RenderDebug", "scope": "static", "___id": "T000002R041256", "___s": true }, { "comment": "/**\r\n * Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\r\n * `findIndex` and updates their index to match `newIndex`. This only modifies the index and does\r\n * not change collision information.\r\n *\r\n * @function Phaser.Tilemaps.Components.ReplaceByIndex\r\n * @since 3.0.0\r\n *\r\n * @param {number} findIndex - The index of the tile to search for.\r\n * @param {number} newIndex - The index of the tile to replace it with.\r\n * @param {number} tileX - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} tileY - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} width - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} height - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "ReplaceByIndex.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\r`findIndex` and updates their index to match `newIndex`. This only modifies the index and does\rnot change collision information.", "kind": "function", "name": "ReplaceByIndex", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the tile to search for.", "name": "findIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the tile to replace it with.", "name": "newIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.ReplaceByIndex", "scope": "static", "___id": "T000002R041276", "___s": true }, { "comment": "/**\r\n * Returns the tiles in the given layer that are within the cameras viewport. This is used internally.\r\n *\r\n * @function Phaser.Tilemaps.Components.RunCull\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n * @param {object} bounds - An object containing the `left`, `right`, `top` and `bottom` bounds.\r\n * @param {number} renderOrder - The rendering order constant.\r\n * @param {array} outputArray - The array to store the Tile objects within.\r\n *\r\n * @return {Phaser.Tilemaps.Tile[]} An array of Tile objects.\r\n */", "meta": { "filename": "RunCull.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Returns the tiles in the given layer that are within the cameras viewport. This is used internally.", "kind": "function", "name": "RunCull", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "An object containing the `left`, `right`, `top` and `bottom` bounds.", "name": "bounds" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rendering order constant.", "name": "renderOrder" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to store the Tile objects within.", "name": "outputArray" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of Tile objects." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.RunCull", "scope": "static", "___id": "T000002R041282", "___s": true }, { "comment": "/**\r\n * Sets collision on the given tile or tiles within a layer by index. You can pass in either a\r\n * single numeric index or an array of indexes: [2, 3, 15, 20]. The `collides` parameter controls if\r\n * collision will be enabled (true) or disabled (false).\r\n *\r\n * @function Phaser.Tilemaps.Components.SetCollision\r\n * @since 3.0.0\r\n *\r\n * @param {(number|array)} indexes - Either a single tile index, or an array of tile indexes.\r\n * @param {boolean} collides - If true it will enable collision. If false it will clear collision.\r\n * @param {boolean} recalculateFaces - Whether or not to recalculate the tile faces after the update.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n * @param {boolean} [updateLayer=true] - If true, updates the current tiles on the layer. Set to false if no tiles have been placed for significant performance boost.\r\n */", "meta": { "filename": "SetCollision.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Sets collision on the given tile or tiles within a layer by index. You can pass in either a\rsingle numeric index or an array of indexes: [2, 3, 15, 20]. The `collides` parameter controls if\rcollision will be enabled (true) or disabled (false).", "kind": "function", "name": "SetCollision", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "array" } ] } }, "description": "Either a single tile index, or an array of tile indexes.", "name": "indexes" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If true it will enable collision. If false it will clear collision.", "name": "collides" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether or not to recalculate the tile faces after the update.", "name": "recalculateFaces" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If true, updates the current tiles on the layer. Set to false if no tiles have been placed for significant performance boost.", "name": "updateLayer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.SetCollision", "scope": "static", "___id": "T000002R041313", "___s": true }, { "comment": "/**\r\n * Sets collision on a range of tiles in a layer whose index is between the specified `start` and\r\n * `stop` (inclusive). Calling this with a start value of 10 and a stop value of 14 would set\r\n * collision for tiles 10, 11, 12, 13 and 14. The `collides` parameter controls if collision will be\r\n * enabled (true) or disabled (false).\r\n *\r\n * @function Phaser.Tilemaps.Components.SetCollisionBetween\r\n * @since 3.0.0\r\n *\r\n * @param {number} start - The first index of the tile to be set for collision.\r\n * @param {number} stop - The last index of the tile to be set for collision.\r\n * @param {boolean} collides - If true it will enable collision. If false it will clear collision.\r\n * @param {boolean} recalculateFaces - Whether or not to recalculate the tile faces after the update.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n * @param {boolean} [updateLayer=true] - If true, updates the current tiles on the layer. Set to false if no tiles have been placed for significant performance boost.\r\n */", "meta": { "filename": "SetCollisionBetween.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Sets collision on a range of tiles in a layer whose index is between the specified `start` and\r`stop` (inclusive). Calling this with a start value of 10 and a stop value of 14 would set\rcollision for tiles 10, 11, 12, 13 and 14. The `collides` parameter controls if collision will be\renabled (true) or disabled (false).", "kind": "function", "name": "SetCollisionBetween", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The first index of the tile to be set for collision.", "name": "start" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The last index of the tile to be set for collision.", "name": "stop" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If true it will enable collision. If false it will clear collision.", "name": "collides" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether or not to recalculate the tile faces after the update.", "name": "recalculateFaces" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If true, updates the current tiles on the layer. Set to false if no tiles have been placed for significant performance boost.", "name": "updateLayer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.SetCollisionBetween", "scope": "static", "___id": "T000002R041327", "___s": true }, { "comment": "/**\r\n * Sets collision on all tiles in the given layer, except for tiles that have an index specified in\r\n * the given array. The `collides` parameter controls if collision will be enabled (true) or\r\n * disabled (false). Tile indexes not currently in the layer are not affected.\r\n *\r\n * @function Phaser.Tilemaps.Components.SetCollisionByExclusion\r\n * @since 3.0.0\r\n *\r\n * @param {number[]} indexes - An array of the tile indexes to not be counted for collision.\r\n * @param {boolean} collides - If true it will enable collision. If false it will clear collision.\r\n * @param {boolean} recalculateFaces - Whether or not to recalculate the tile faces after the update.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "SetCollisionByExclusion.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Sets collision on all tiles in the given layer, except for tiles that have an index specified in\rthe given array. The `collides` parameter controls if collision will be enabled (true) or\rdisabled (false). Tile indexes not currently in the layer are not affected.", "kind": "function", "name": "SetCollisionByExclusion", "since": "3.0.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "An array of the tile indexes to not be counted for collision.", "name": "indexes" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If true it will enable collision. If false it will clear collision.", "name": "collides" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether or not to recalculate the tile faces after the update.", "name": "recalculateFaces" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.SetCollisionByExclusion", "scope": "static", "___id": "T000002R041340", "___s": true }, { "comment": "/**\r\n * Sets collision on the tiles within a layer by checking tile properties. If a tile has a property\r\n * that matches the given properties object, its collision flag will be set. The `collides`\r\n * parameter controls if collision will be enabled (true) or disabled (false). Passing in\r\n * `{ collides: true }` would update the collision flag on any tiles with a \"collides\" property that\r\n * has a value of true. Any tile that doesn't have \"collides\" set to true will be ignored. You can\r\n * also use an array of values, e.g. `{ types: [\"stone\", \"lava\", \"sand\" ] }`. If a tile has a\r\n * \"types\" property that matches any of those values, its collision flag will be updated.\r\n *\r\n * @function Phaser.Tilemaps.Components.SetCollisionByProperty\r\n * @since 3.0.0\r\n *\r\n * @param {object} properties - An object with tile properties and corresponding values that should be checked.\r\n * @param {boolean} collides - If true it will enable collision. If false it will clear collision.\r\n * @param {boolean} recalculateFaces - Whether or not to recalculate the tile faces after the update.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "SetCollisionByProperty.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Sets collision on the tiles within a layer by checking tile properties. If a tile has a property\rthat matches the given properties object, its collision flag will be set. The `collides`\rparameter controls if collision will be enabled (true) or disabled (false). Passing in\r`{ collides: true }` would update the collision flag on any tiles with a \"collides\" property that\rhas a value of true. Any tile that doesn't have \"collides\" set to true will be ignored. You can\ralso use an array of values, e.g. `{ types: [\"stone\", \"lava\", \"sand\" ] }`. If a tile has a\r\"types\" property that matches any of those values, its collision flag will be updated.", "kind": "function", "name": "SetCollisionByProperty", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "An object with tile properties and corresponding values that should be checked.", "name": "properties" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If true it will enable collision. If false it will clear collision.", "name": "collides" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether or not to recalculate the tile faces after the update.", "name": "recalculateFaces" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.SetCollisionByProperty", "scope": "static", "___id": "T000002R041352", "___s": true }, { "comment": "/**\r\n * Sets collision on the tiles within a layer by checking each tile's collision group data\r\n * (typically defined in Tiled within the tileset collision editor). If any objects are found within\r\n * a tile's collision group, the tile's colliding information will be set. The `collides` parameter\r\n * controls if collision will be enabled (true) or disabled (false).\r\n *\r\n * @function Phaser.Tilemaps.Components.SetCollisionFromCollisionGroup\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} collides - If true it will enable collision. If false it will clear collision.\r\n * @param {boolean} recalculateFaces - Whether or not to recalculate the tile faces after the update.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "SetCollisionFromCollisionGroup.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Sets collision on the tiles within a layer by checking each tile's collision group data\r(typically defined in Tiled within the tileset collision editor). If any objects are found within\ra tile's collision group, the tile's colliding information will be set. The `collides` parameter\rcontrols if collision will be enabled (true) or disabled (false).", "kind": "function", "name": "SetCollisionFromCollisionGroup", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If true it will enable collision. If false it will clear collision.", "name": "collides" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether or not to recalculate the tile faces after the update.", "name": "recalculateFaces" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.SetCollisionFromCollisionGroup", "scope": "static", "___id": "T000002R041366", "___s": true }, { "comment": "/**\r\n * Internally used method to keep track of the tile indexes that collide within a layer. This\r\n * updates LayerData.collideIndexes to either contain or not contain the given `tileIndex`.\r\n *\r\n * @function Phaser.Tilemaps.Components.SetLayerCollisionIndex\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileIndex - The tile index to set the collision boolean for.\r\n * @param {boolean} collides - Should the tile index collide or not?\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "SetLayerCollisionIndex.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Internally used method to keep track of the tile indexes that collide within a layer. This\rupdates LayerData.collideIndexes to either contain or not contain the given `tileIndex`.", "kind": "function", "name": "SetLayerCollisionIndex", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tile index to set the collision boolean for.", "name": "tileIndex" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should the tile index collide or not?", "name": "collides" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.SetLayerCollisionIndex", "scope": "static", "___id": "T000002R041375", "___s": true }, { "comment": "/**\r\n * Internally used method to set the colliding state of a tile. This does not recalculate\r\n * interesting faces.\r\n *\r\n * @function Phaser.Tilemaps.Components.SetTileCollision\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Tilemaps.Tile} tile - The Tile to set the collision on.\r\n * @param {boolean} [collides=true] - Should the tile index collide or not?\r\n */", "meta": { "filename": "SetTileCollision.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Internally used method to set the colliding state of a tile. This does not recalculate\rinteresting faces.", "kind": "function", "name": "SetTileCollision", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The Tile to set the collision on.", "name": "tile" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the tile index collide or not?", "name": "collides" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.SetTileCollision", "scope": "static", "___id": "T000002R041379", "___s": true }, { "comment": "/**\r\n * Sets a global collision callback for the given tile index within the layer. This will affect all\r\n * tiles on this layer that have the same index. If a callback is already set for the tile index it\r\n * will be replaced. Set the callback to null to remove it. If you want to set a callback for a tile\r\n * at a specific location on the map then see setTileLocationCallback.\r\n *\r\n * @function Phaser.Tilemaps.Components.SetTileIndexCallback\r\n * @since 3.0.0\r\n *\r\n * @param {(number|array)} indexes - Either a single tile index, or an array of tile indexes to have a collision callback set for.\r\n * @param {function} callback - The callback that will be invoked when the tile is collided with.\r\n * @param {object} callbackContext - The context under which the callback is called.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "SetTileIndexCallback.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Sets a global collision callback for the given tile index within the layer. This will affect all\rtiles on this layer that have the same index. If a callback is already set for the tile index it\rwill be replaced. Set the callback to null to remove it. If you want to set a callback for a tile\rat a specific location on the map then see setTileLocationCallback.", "kind": "function", "name": "SetTileIndexCallback", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "array" } ] } }, "description": "Either a single tile index, or an array of tile indexes to have a collision callback set for.", "name": "indexes" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback that will be invoked when the tile is collided with.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The context under which the callback is called.", "name": "callbackContext" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.SetTileIndexCallback", "scope": "static", "___id": "T000002R041382", "___s": true }, { "comment": "/**\r\n * Sets a collision callback for the given rectangular area (in tile coordinates) within the layer.\r\n * If a callback is already set for the tile index it will be replaced. Set the callback to null to\r\n * remove it.\r\n *\r\n * @function Phaser.Tilemaps.Components.SetTileLocationCallback\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} tileY - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} width - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} height - How many tiles tall from the `tileY` index the area will be.\r\n * @param {function} callback - The callback that will be invoked when the tile is collided with.\r\n * @param {object} callbackContext - The context under which the callback is called.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "SetTileLocationCallback.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Sets a collision callback for the given rectangular area (in tile coordinates) within the layer.\rIf a callback is already set for the tile index it will be replaced. Set the callback to null to\rremove it.", "kind": "function", "name": "SetTileLocationCallback", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback that will be invoked when the tile is collided with.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The context under which the callback is called.", "name": "callbackContext" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.SetTileLocationCallback", "scope": "static", "___id": "T000002R041394", "___s": true }, { "comment": "/**\r\n * Shuffles the tiles in a rectangular region (specified in tile coordinates) within the given\r\n * layer. It will only randomize the tiles in that area, so if they're all the same nothing will\r\n * appear to have changed! This method only modifies tile indexes and does not change collision\r\n * information.\r\n *\r\n * @function Phaser.Tilemaps.Components.Shuffle\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} tileY - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} width - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} height - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "Shuffle.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Shuffles the tiles in a rectangular region (specified in tile coordinates) within the given\rlayer. It will only randomize the tiles in that area, so if they're all the same nothing will\rappear to have changed! This method only modifies tile indexes and does not change collision\rinformation.", "kind": "function", "name": "Shuffle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.Shuffle", "scope": "static", "___id": "T000002R041401", "___s": true }, { "comment": "/**\r\n * Returns the bounds in the given layer that are within the camera's viewport.\r\n * This is used internally by the cull tiles function.\r\n *\r\n * @function Phaser.Tilemaps.Components.StaggeredCullBounds\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to run the cull check against.\r\n *\r\n * @return {object} An object containing the `left`, `right`, `top` and `bottom` bounds.\r\n */", "meta": { "filename": "StaggeredCullBounds.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Returns the bounds in the given layer that are within the camera's viewport.\rThis is used internally by the cull tiles function.", "kind": "function", "name": "StaggeredCullBounds", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to run the cull check against.", "name": "camera" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "An object containing the `left`, `right`, `top` and `bottom` bounds." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.StaggeredCullBounds", "scope": "static", "___id": "T000002R041410", "___s": true }, { "comment": "/**\r\n * Returns the tiles in the given layer that are within the cameras viewport. This is used internally.\r\n *\r\n * @function Phaser.Tilemaps.Components.StaggeredCullTiles\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to run the cull check against.\r\n * @param {array} [outputArray] - An optional array to store the Tile objects within.\r\n * @param {number} [renderOrder=0] - The rendering order constant.\r\n *\r\n * @return {Phaser.Tilemaps.Tile[]} An array of Tile objects.\r\n */", "meta": { "filename": "StaggeredCullTiles.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Returns the tiles in the given layer that are within the cameras viewport. This is used internally.", "kind": "function", "name": "StaggeredCullTiles", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to run the cull check against.", "name": "camera" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "An optional array to store the Tile objects within.", "name": "outputArray" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rendering order constant.", "name": "renderOrder" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of Tile objects." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.StaggeredCullTiles", "scope": "static", "___id": "T000002R041427", "___s": true }, { "comment": "/**\r\n * Converts from staggered tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\r\n * layer's position, scale and scroll. This will return a new Vector2 object or update the given\r\n * `point` object.\r\n *\r\n * @function Phaser.Tilemaps.Components.StaggeredTileToWorldXY\r\n * @since 3.50.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {Phaser.Math.Vector2} point - A Vector2 to store the coordinates in. If not given a new Vector2 is created.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Math.Vector2} The XY location in world coordinates.\r\n */", "meta": { "filename": "StaggeredTileToWorldXY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Converts from staggered tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\rlayer's position, scale and scroll. This will return a new Vector2 object or update the given\r`point` object.", "kind": "function", "name": "StaggeredTileToWorldXY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 to store the coordinates in. If not given a new Vector2 is created.", "name": "point" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The XY location in world coordinates." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.StaggeredTileToWorldXY", "scope": "static", "___id": "T000002R041440", "___s": true }, { "comment": "/**\r\n * Converts from staggered tile Y coordinates (tile units) to world Y coordinates (pixels), factoring in the\r\n * layers position, scale and scroll.\r\n *\r\n * @function Phaser.Tilemaps.Components.StaggeredTileToWorldY\r\n * @since 3.50.0\r\n *\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {number} The Y location in world coordinates.\r\n */", "meta": { "filename": "StaggeredTileToWorldY.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Converts from staggered tile Y coordinates (tile units) to world Y coordinates (pixels), factoring in the\rlayers position, scale and scroll.", "kind": "function", "name": "StaggeredTileToWorldY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y location in world coordinates." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.StaggeredTileToWorldY", "scope": "static", "___id": "T000002R041456", "___s": true }, { "comment": "/**\r\n * Converts from world XY coordinates (pixels) to staggered tile XY coordinates (tile units), factoring in the\r\n * layer's position, scale and scroll. This will return a new Vector2 object or update the given\r\n * `point` object.\r\n *\r\n * @function Phaser.Tilemaps.Components.StaggeredWorldToTileXY\r\n * @since 3.50.0\r\n *\r\n * @param {number} worldX - The x coordinate to be converted, in pixels, not tiles.\r\n * @param {number} worldY - The y coordinate to be converted, in pixels, not tiles.\r\n * @param {boolean} snapToFloor - Whether or not to round the tile coordinate down to the nearest integer.\r\n * @param {Phaser.Math.Vector2} point - A Vector2 to store the coordinates in. If not given a new Vector2 is created.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Math.Vector2} The XY location in tile units.\r\n */", "meta": { "filename": "StaggeredWorldToTileXY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Converts from world XY coordinates (pixels) to staggered tile XY coordinates (tile units), factoring in the\rlayer's position, scale and scroll. This will return a new Vector2 object or update the given\r`point` object.", "kind": "function", "name": "StaggeredWorldToTileXY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to be converted, in pixels, not tiles.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to be converted, in pixels, not tiles.", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether or not to round the tile coordinate down to the nearest integer.", "name": "snapToFloor" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 to store the coordinates in. If not given a new Vector2 is created.", "name": "point" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The XY location in tile units." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.StaggeredWorldToTileXY", "scope": "static", "___id": "T000002R041466", "___s": true }, { "comment": "/**\r\n * Converts from world Y coordinates (pixels) to staggered tile Y coordinates (tile units), factoring in the\r\n * layers position, scale and scroll.\r\n *\r\n * @function Phaser.Tilemaps.Components.StaggeredWorldToTileY\r\n * @since 3.50.0\r\n *\r\n * @param {number} worldY - The y coordinate to be converted, in pixels, not tiles.\r\n * @param {boolean} snapToFloor - Whether or not to round the tile coordinate down to the nearest integer.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {number} The Y location in tile units.\r\n */", "meta": { "filename": "StaggeredWorldToTileY.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Converts from world Y coordinates (pixels) to staggered tile Y coordinates (tile units), factoring in the\rlayers position, scale and scroll.", "kind": "function", "name": "StaggeredWorldToTileY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to be converted, in pixels, not tiles.", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether or not to round the tile coordinate down to the nearest integer.", "name": "snapToFloor" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y location in tile units." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.StaggeredWorldToTileY", "scope": "static", "___id": "T000002R041480", "___s": true }, { "comment": "/**\r\n * Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\r\n * `indexA` and swaps then with `indexB`. This only modifies the index and does not change collision\r\n * information.\r\n *\r\n * @function Phaser.Tilemaps.Components.SwapByIndex\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileA - First tile index.\r\n * @param {number} tileB - Second tile index.\r\n * @param {number} tileX - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} tileY - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} width - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} height - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "SwapByIndex.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\r`indexA` and swaps then with `indexB`. This only modifies the index and does not change collision\rinformation.", "kind": "function", "name": "SwapByIndex", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "First tile index.", "name": "tileA" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Second tile index.", "name": "tileB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.SwapByIndex", "scope": "static", "___id": "T000002R041489", "___s": true }, { "comment": "/**\r\n * Converts from tile X coordinates (tile units) to world X coordinates (pixels), factoring in the\r\n * layer's position, scale and scroll.\r\n *\r\n * @function Phaser.Tilemaps.Components.TileToWorldX\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {number}\r\n */", "meta": { "filename": "TileToWorldX.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Converts from tile X coordinates (tile units) to world X coordinates (pixels), factoring in the\rlayer's position, scale and scroll.", "kind": "function", "name": "TileToWorldX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } } } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.TileToWorldX", "scope": "static", "___id": "T000002R041496", "___s": true }, { "comment": "/**\r\n * Converts from tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\r\n * layer's position, scale and scroll. This will return a new Vector2 object or update the given\r\n * `point` object.\r\n *\r\n * @function Phaser.Tilemaps.Components.TileToWorldXY\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {Phaser.Math.Vector2} point - A Vector2 to store the coordinates in. If not given a new Vector2 is created.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Math.Vector2} The XY location in world coordinates.\r\n */", "meta": { "filename": "TileToWorldXY.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Converts from tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\rlayer's position, scale and scroll. This will return a new Vector2 object or update the given\r`point` object.", "kind": "function", "name": "TileToWorldXY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 to store the coordinates in. If not given a new Vector2 is created.", "name": "point" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The XY location in world coordinates." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.TileToWorldXY", "scope": "static", "___id": "T000002R041508", "___s": true }, { "comment": "/**\r\n * Converts from tile Y coordinates (tile units) to world Y coordinates (pixels), factoring in the\r\n * layer's position, scale and scroll.\r\n *\r\n * @function Phaser.Tilemaps.Components.TileToWorldY\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {number} The Y location in world coordinates.\r\n */", "meta": { "filename": "TileToWorldY.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Converts from tile Y coordinates (tile units) to world Y coordinates (pixels), factoring in the\rlayer's position, scale and scroll.", "kind": "function", "name": "TileToWorldY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y location in world coordinates." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.TileToWorldY", "scope": "static", "___id": "T000002R041514", "___s": true }, { "comment": "/**\r\n * Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\r\n * specified layer. Each tile will receive a new index. New indexes are drawn from the given\r\n * weightedIndexes array. An example weighted array:\r\n *\r\n * [\r\n * { index: 6, weight: 4 }, // Probability of index 6 is 4 / 8\r\n * { index: 7, weight: 2 }, // Probability of index 7 would be 2 / 8\r\n * { index: 8, weight: 1.5 }, // Probability of index 8 would be 1.5 / 8\r\n * { index: 26, weight: 0.5 } // Probability of index 27 would be 0.5 / 8\r\n * ]\r\n *\r\n * The probability of any index being choose is (the index's weight) / (sum of all weights). This\r\n * method only modifies tile indexes and does not change collision information.\r\n *\r\n * @function Phaser.Tilemaps.Components.WeightedRandomize\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} tileY - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} width - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} height - How many tiles tall from the `tileY` index the area will be.\r\n * @param {object[]} weightedIndexes - An array of objects to randomly draw from during\r\n * randomization. They should be in the form: { index: 0, weight: 4 } or\r\n * { index: [0, 1], weight: 4 } if you wish to draw from multiple tile indexes.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n */", "meta": { "filename": "WeightedRandomize.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\rspecified layer. Each tile will receive a new index. New indexes are drawn from the given\rweightedIndexes array. An example weighted array:\r\r[\r { index: 6, weight: 4 }, // Probability of index 6 is 4 / 8\r { index: 7, weight: 2 }, // Probability of index 7 would be 2 / 8\r { index: 8, weight: 1.5 }, // Probability of index 8 would be 1.5 / 8\r { index: 26, weight: 0.5 } // Probability of index 27 would be 0.5 / 8\r]\r\rThe probability of any index being choose is (the index's weight) / (sum of all weights). This\rmethod only modifies tile indexes and does not change collision information.", "kind": "function", "name": "WeightedRandomize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } }, "description": "An array of objects to randomly draw from during\rrandomization. They should be in the form: { index: 0, weight: 4 } or\r{ index: [0, 1], weight: 4 } if you wish to draw from multiple tile indexes.", "name": "weightedIndexes" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.WeightedRandomize", "scope": "static", "___id": "T000002R041524", "___s": true }, { "comment": "/**\r\n * Converts from world X coordinates (pixels) to tile X coordinates (tile units), factoring in the\r\n * layer's position, scale and scroll.\r\n *\r\n * @function Phaser.Tilemaps.Components.WorldToTileX\r\n * @since 3.0.0\r\n *\r\n * @param {number} worldX - The x coordinate to be converted, in pixels, not tiles.\r\n * @param {boolean} snapToFloor - Whether or not to round the tile coordinate down to the nearest integer.\r\n * @param {?Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {number} The X location in tile units.\r\n */", "meta": { "filename": "WorldToTileX.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Converts from world X coordinates (pixels) to tile X coordinates (tile units), factoring in the\rlayer's position, scale and scroll.", "kind": "function", "name": "WorldToTileX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to be converted, in pixels, not tiles.", "name": "worldX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether or not to round the tile coordinate down to the nearest integer.", "name": "snapToFloor" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera", "nullable": true } }, "nullable": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X location in tile units." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.WorldToTileX", "scope": "static", "___id": "T000002R041544", "___s": true }, { "comment": "/**\r\n * Converts from world XY coordinates (pixels) to tile XY coordinates (tile units), factoring in the\r\n * layer's position, scale and scroll. This will return a new Vector2 object or update the given\r\n * `point` object.\r\n *\r\n * @function Phaser.Tilemaps.Components.WorldToTileXY\r\n * @since 3.0.0\r\n *\r\n * @param {number} worldX - The x coordinate to be converted, in pixels, not tiles.\r\n * @param {number} worldY - The y coordinate to be converted, in pixels, not tiles.\r\n * @param {boolean} snapToFloor - Whether or not to round the tile coordinate down to the nearest integer.\r\n * @param {Phaser.Math.Vector2} point - A Vector2 to store the coordinates in. If not given a new Vector2 is created.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {Phaser.Math.Vector2} The XY location in tile units.\r\n */", "meta": { "filename": "WorldToTileXY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Converts from world XY coordinates (pixels) to tile XY coordinates (tile units), factoring in the\rlayer's position, scale and scroll. This will return a new Vector2 object or update the given\r`point` object.", "kind": "function", "name": "WorldToTileXY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to be converted, in pixels, not tiles.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to be converted, in pixels, not tiles.", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether or not to round the tile coordinate down to the nearest integer.", "name": "snapToFloor" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 to store the coordinates in. If not given a new Vector2 is created.", "name": "point" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The XY location in tile units." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.WorldToTileXY", "scope": "static", "___id": "T000002R041548", "___s": true }, { "comment": "/**\r\n * Converts from world Y coordinates (pixels) to tile Y coordinates (tile units), factoring in the\r\n * layer's position, scale and scroll.\r\n *\r\n * @function Phaser.Tilemaps.Components.WorldToTileY\r\n * @since 3.0.0\r\n *\r\n * @param {number} worldY - The y coordinate to be converted, in pixels, not tiles.\r\n * @param {boolean} snapToFloor - Whether or not to round the tile coordinate down to the nearest integer.\r\n * @param {?Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.\r\n * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.\r\n *\r\n * @return {number} The Y location in tile units.\r\n */", "meta": { "filename": "WorldToTileY.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\components", "code": {} }, "description": "Converts from world Y coordinates (pixels) to tile Y coordinates (tile units), factoring in the\rlayer's position, scale and scroll.", "kind": "function", "name": "WorldToTileY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to be converted, in pixels, not tiles.", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether or not to round the tile coordinate down to the nearest integer.", "name": "snapToFloor" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera", "nullable": true } }, "nullable": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The Tilemap Layer to act upon.", "name": "layer" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y location in tile units." } ], "memberof": "Phaser.Tilemaps.Components", "longname": "Phaser.Tilemaps.Components.WorldToTileY", "scope": "static", "___id": "T000002R041568", "___s": true }, { "comment": "/**\r\n * Phaser Tilemap constants for orientation.\r\n *\r\n * @namespace Phaser.Tilemaps.Orientation\r\n * @memberof Phaser.Tilemaps\r\n * @since 3.50.0\r\n */", "meta": { "filename": "ORIENTATION_CONST.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\const", "code": {} }, "description": "Phaser Tilemap constants for orientation.", "kind": "namespace", "name": "Orientation", "memberof": "Phaser.Tilemaps", "since": "3.50.0", "longname": "Phaser.Tilemaps.Orientation", "scope": "static", "___id": "T000002R041574", "___s": true }, { "comment": "/**\r\n * Phaser Tilemap constants for orientation.\r\n *\r\n * To find out what each mode does please see [Phaser.Tilemaps.Orientation]{@link Phaser.Tilemaps.Orientation}.\r\n *\r\n * @typedef {Phaser.Tilemaps.Orientation} Phaser.Tilemaps.OrientationType\r\n * @memberof Phaser.Tilemaps\r\n * @since 3.50.0\r\n */", "meta": { "filename": "ORIENTATION_CONST.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\const", "code": {} }, "description": "Phaser Tilemap constants for orientation.\r\rTo find out what each mode does please see [Phaser.Tilemaps.Orientation]{@link Phaser.Tilemaps.Orientation}.", "kind": "typedef", "name": "OrientationType", "type": { "names": [ "Phaser.Tilemaps.Orientation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Orientation" } }, "memberof": "Phaser.Tilemaps", "since": "3.50.0", "longname": "Phaser.Tilemaps.OrientationType", "scope": "static", "___id": "T000002R041575", "___s": true }, { "comment": "/**\r\n * Orthogonal Tilemap orientation constant.\r\n *\r\n * @name Phaser.Tilemaps.Orientation.ORTHOGONAL\r\n * @type {number}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "ORIENTATION_CONST.js", "lineno": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\const", "code": {} }, "description": "Orthogonal Tilemap orientation constant.", "name": "ORTHOGONAL", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Tilemaps.Orientation", "longname": "Phaser.Tilemaps.Orientation.ORTHOGONAL", "scope": "static", "___id": "T000002R041577", "___s": true }, { "comment": "/**\r\n * Isometric Tilemap orientation constant.\r\n *\r\n * @name Phaser.Tilemaps.Orientation.ISOMETRIC\r\n * @type {number}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "ORIENTATION_CONST.js", "lineno": 37, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\const", "code": {} }, "description": "Isometric Tilemap orientation constant.", "name": "ISOMETRIC", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Tilemaps.Orientation", "longname": "Phaser.Tilemaps.Orientation.ISOMETRIC", "scope": "static", "___id": "T000002R041579", "___s": true }, { "comment": "/**\r\n * Staggered Tilemap orientation constant.\r\n *\r\n * @name Phaser.Tilemaps.Orientation.STAGGERED\r\n * @type {number}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "ORIENTATION_CONST.js", "lineno": 47, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\const", "code": {} }, "description": "Staggered Tilemap orientation constant.", "name": "STAGGERED", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Tilemaps.Orientation", "longname": "Phaser.Tilemaps.Orientation.STAGGERED", "scope": "static", "___id": "T000002R041581", "___s": true }, { "comment": "/**\r\n * Hexagonal Tilemap orientation constant.\r\n *\r\n * @name Phaser.Tilemaps.Orientation.HEXAGONAL\r\n * @type {number}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "ORIENTATION_CONST.js", "lineno": 57, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\const", "code": {} }, "description": "Hexagonal Tilemap orientation constant.", "name": "HEXAGONAL", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Tilemaps.Orientation", "longname": "Phaser.Tilemaps.Orientation.HEXAGONAL", "scope": "static", "___id": "T000002R041583", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Tilemaps.Formats\r\n */", "meta": { "filename": "Formats.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "kind": "namespace", "name": "Formats", "memberof": "Phaser.Tilemaps", "longname": "Phaser.Tilemaps.Formats", "scope": "static", "___id": "T000002R041585", "___s": true }, { "comment": "/**\r\n * CSV Map Type\r\n *\r\n * @name Phaser.Tilemaps.Formats.CSV\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Formats.js", "lineno": 13, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "CSV Map Type", "name": "CSV", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Formats", "longname": "Phaser.Tilemaps.Formats.CSV", "scope": "static", "kind": "member", "___id": "T000002R041587", "___s": true }, { "comment": "/**\r\n * Tiled JSON Map Type\r\n *\r\n * @name Phaser.Tilemaps.Formats.TILED_JSON\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Formats.js", "lineno": 22, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Tiled JSON Map Type", "name": "TILED_JSON", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Formats", "longname": "Phaser.Tilemaps.Formats.TILED_JSON", "scope": "static", "kind": "member", "___id": "T000002R041589", "___s": true }, { "comment": "/**\r\n * 2D Array Map Type\r\n *\r\n * @name Phaser.Tilemaps.Formats.ARRAY_2D\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Formats.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "2D Array Map Type", "name": "ARRAY_2D", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Formats", "longname": "Phaser.Tilemaps.Formats.ARRAY_2D", "scope": "static", "kind": "member", "___id": "T000002R041591", "___s": true }, { "comment": "/**\r\n * Weltmeister (Impact.js) Map Type\r\n *\r\n * @name Phaser.Tilemaps.Formats.WELTMEISTER\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Formats.js", "lineno": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Weltmeister (Impact.js) Map Type", "name": "WELTMEISTER", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Formats", "longname": "Phaser.Tilemaps.Formats.WELTMEISTER", "scope": "static", "kind": "member", "___id": "T000002R041593", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * An Image Collection is a special Tile Set containing multiple images, with no slicing into each image.\r\n *\r\n * Image Collections are normally created automatically when Tiled data is loaded.\r\n *\r\n * @class ImageCollection\r\n * @memberof Phaser.Tilemaps\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {string} name - The name of the image collection in the map data.\r\n * @param {number} firstgid - The first image index this image collection contains.\r\n * @param {number} [width=32] - Width of widest image (in pixels).\r\n * @param {number} [height=32] - Height of tallest image (in pixels).\r\n * @param {number} [margin=0] - The margin around all images in the collection (in pixels).\r\n * @param {number} [spacing=0] - The spacing between each image in the collection (in pixels).\r\n * @param {object} [properties={}] - Custom Image Collection properties.\r\n */", "meta": { "filename": "ImageCollection.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "classdesc": "An Image Collection is a special Tile Set containing multiple images, with no slicing into each image.\r\rImage Collections are normally created automatically when Tiled data is loaded.", "kind": "class", "name": "ImageCollection", "memberof": "Phaser.Tilemaps", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the image collection in the map data.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The first image index this image collection contains.", "name": "firstgid" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "Width of widest image (in pixels).", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "Height of tallest image (in pixels).", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The margin around all images in the collection (in pixels).", "name": "margin" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The spacing between each image in the collection (in pixels).", "name": "spacing" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "defaultvalue": "{}", "description": "Custom Image Collection properties.", "name": "properties" } ], "scope": "static", "longname": "Phaser.Tilemaps.ImageCollection", "___id": "T000002R041596", "___s": true }, { "comment": "/**\r\n * The name of the Image Collection.\r\n *\r\n * @name Phaser.Tilemaps.ImageCollection#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ImageCollection.js", "lineno": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The name of the Image Collection.", "name": "name", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.ImageCollection", "longname": "Phaser.Tilemaps.ImageCollection#name", "scope": "instance", "kind": "member", "___id": "T000002R041603", "___s": true }, { "comment": "/**\r\n * The Tiled firstgid value.\r\n * This is the starting index of the first image index this Image Collection contains.\r\n *\r\n * @name Phaser.Tilemaps.ImageCollection#firstgid\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ImageCollection.js", "lineno": 48, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The Tiled firstgid value.\rThis is the starting index of the first image index this Image Collection contains.", "name": "firstgid", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.ImageCollection", "longname": "Phaser.Tilemaps.ImageCollection#firstgid", "scope": "instance", "kind": "member", "___id": "T000002R041605", "___s": true }, { "comment": "/**\r\n * The width of the widest image (in pixels).\r\n *\r\n * @name Phaser.Tilemaps.ImageCollection#imageWidth\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ImageCollection.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The width of the widest image (in pixels).", "name": "imageWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.ImageCollection", "longname": "Phaser.Tilemaps.ImageCollection#imageWidth", "scope": "instance", "kind": "member", "___id": "T000002R041607", "___s": true }, { "comment": "/**\r\n * The height of the tallest image (in pixels).\r\n *\r\n * @name Phaser.Tilemaps.ImageCollection#imageHeight\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ImageCollection.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The height of the tallest image (in pixels).", "name": "imageHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.ImageCollection", "longname": "Phaser.Tilemaps.ImageCollection#imageHeight", "scope": "instance", "kind": "member", "___id": "T000002R041609", "___s": true }, { "comment": "/**\r\n * The margin around the images in the collection (in pixels).\r\n * Use `setSpacing` to change.\r\n *\r\n * @name Phaser.Tilemaps.ImageCollection#imageMarge\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ImageCollection.js", "lineno": 78, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The margin around the images in the collection (in pixels).\rUse `setSpacing` to change.", "name": "imageMarge", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.ImageCollection", "longname": "Phaser.Tilemaps.ImageCollection#imageMarge", "scope": "instance", "kind": "member", "___id": "T000002R041611", "___s": true }, { "comment": "/**\r\n * The spacing between each image in the collection (in pixels).\r\n * Use `setSpacing` to change.\r\n *\r\n * @name Phaser.Tilemaps.ImageCollection#imageSpacing\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ImageCollection.js", "lineno": 89, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The spacing between each image in the collection (in pixels).\rUse `setSpacing` to change.", "name": "imageSpacing", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.ImageCollection", "longname": "Phaser.Tilemaps.ImageCollection#imageSpacing", "scope": "instance", "kind": "member", "___id": "T000002R041613", "___s": true }, { "comment": "/**\r\n * Image Collection-specific properties that are typically defined in the Tiled editor.\r\n *\r\n * @name Phaser.Tilemaps.ImageCollection#properties\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ImageCollection.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Image Collection-specific properties that are typically defined in the Tiled editor.", "name": "properties", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.ImageCollection", "longname": "Phaser.Tilemaps.ImageCollection#properties", "scope": "instance", "kind": "member", "___id": "T000002R041615", "___s": true }, { "comment": "/**\r\n * The cached images that are a part of this collection.\r\n *\r\n * @name Phaser.Tilemaps.ImageCollection#images\r\n * @type {array}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ImageCollection.js", "lineno": 109, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The cached images that are a part of this collection.", "name": "images", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.ImageCollection", "longname": "Phaser.Tilemaps.ImageCollection#images", "scope": "instance", "kind": "member", "___id": "T000002R041617", "___s": true }, { "comment": "/**\r\n * The total number of images in the image collection.\r\n *\r\n * @name Phaser.Tilemaps.ImageCollection#total\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ImageCollection.js", "lineno": 119, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The total number of images in the image collection.", "name": "total", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.ImageCollection", "longname": "Phaser.Tilemaps.ImageCollection#total", "scope": "instance", "kind": "member", "___id": "T000002R041619", "___s": true }, { "comment": "/**\r\n * Returns true if and only if this image collection contains the given image index.\r\n *\r\n * @method Phaser.Tilemaps.ImageCollection#containsImageIndex\r\n * @since 3.0.0\r\n *\r\n * @param {number} imageIndex - The image index to search for.\r\n *\r\n * @return {boolean} True if this Image Collection contains the given index.\r\n */", "meta": { "filename": "ImageCollection.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Returns true if and only if this image collection contains the given image index.", "kind": "function", "name": "containsImageIndex", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The image index to search for.", "name": "imageIndex" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if this Image Collection contains the given index." } ], "memberof": "Phaser.Tilemaps.ImageCollection", "longname": "Phaser.Tilemaps.ImageCollection#containsImageIndex", "scope": "instance", "___id": "T000002R041621", "___s": true }, { "comment": "/**\r\n * Add an image to this Image Collection.\r\n *\r\n * @method Phaser.Tilemaps.ImageCollection#addImage\r\n * @since 3.0.0\r\n *\r\n * @param {number} gid - The gid of the image in the Image Collection.\r\n * @param {string} image - The the key of the image in the Image Collection and in the cache.\r\n *\r\n * @return {Phaser.Tilemaps.ImageCollection} This ImageCollection object.\r\n */", "meta": { "filename": "ImageCollection.js", "lineno": 145, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Add an image to this Image Collection.", "kind": "function", "name": "addImage", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The gid of the image in the Image Collection.", "name": "gid" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The the key of the image in the Image Collection and in the cache.", "name": "image" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.ImageCollection" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.ImageCollection" } }, "description": "This ImageCollection object." } ], "memberof": "Phaser.Tilemaps.ImageCollection", "longname": "Phaser.Tilemaps.ImageCollection#addImage", "scope": "instance", "___id": "T000002R041623", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Tilemaps\r\n *\r\n * @borrows Phaser.Tilemaps.Orientation.ORTHOGONAL as ORTHOGONAL\r\n * @borrows Phaser.Tilemaps.Orientation.ISOMETRIC as ISOMETRIC\r\n * @borrows Phaser.Tilemaps.Orientation.STAGGERED as STAGGERED\r\n * @borrows Phaser.Tilemaps.Orientation.HEXAGONAL as HEXAGONAL\r\n */", "meta": { "filename": "index.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "kind": "namespace", "name": "Tilemaps", "memberof": "Phaser", "longname": "Phaser.Tilemaps", "scope": "static", "___id": "T000002R041630", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A class for representing data about about a layer in a map. Maps are parsed from CSV, Tiled,\r\n * etc. into this format. Tilemap and TilemapLayer objects have a reference\r\n * to this data and use it to look up and perform operations on tiles.\r\n *\r\n * @class LayerData\r\n * @memberof Phaser.Tilemaps\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Tilemaps.LayerDataConfig} [config] - The Layer Data configuration object.\r\n */", "meta": { "filename": "LayerData.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "classdesc": "A class for representing data about about a layer in a map. Maps are parsed from CSV, Tiled,\retc. into this format. Tilemap and TilemapLayer objects have a reference\rto this data and use it to look up and perform operations on tiles.", "kind": "class", "name": "LayerData", "memberof": "Phaser.Tilemaps", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Tilemaps.LayerDataConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.LayerDataConfig" } }, "optional": true, "description": "The Layer Data configuration object.", "name": "config" } ], "scope": "static", "longname": "Phaser.Tilemaps.LayerData", "___id": "T000002R041652", "___s": true }, { "comment": "/**\r\n * The name of the layer, if specified in Tiled.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 32, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The name of the layer, if specified in Tiled.", "name": "name", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#name", "scope": "instance", "kind": "member", "___id": "T000002R041656", "___s": true }, { "comment": "/**\r\n * The id of the layer, as specified in the map data.\r\n *\r\n * Note: This is not the index of the layer in the map data, but its actual ID in Tiled.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#id\r\n * @type {number}\r\n * @since 3.61.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 41, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The id of the layer, as specified in the map data.\r\rNote: This is not the index of the layer in the map data, but its actual ID in Tiled.", "name": "id", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.61.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#id", "scope": "instance", "kind": "member", "___id": "T000002R041658", "___s": true }, { "comment": "/**\r\n * The x offset of where to draw from the top left.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#x\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 52, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The x offset of where to draw from the top left.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#x", "scope": "instance", "kind": "member", "___id": "T000002R041660", "___s": true }, { "comment": "/**\r\n * The y offset of where to draw from the top left.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#y\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 61, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The y offset of where to draw from the top left.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#y", "scope": "instance", "kind": "member", "___id": "T000002R041662", "___s": true }, { "comment": "/**\r\n * The width of the layer in tiles.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The width of the layer in tiles.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#width", "scope": "instance", "kind": "member", "___id": "T000002R041664", "___s": true }, { "comment": "/**\r\n * The height of the layer in tiles.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The height of the layer in tiles.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#height", "scope": "instance", "kind": "member", "___id": "T000002R041666", "___s": true }, { "comment": "/**\r\n * The pixel width of the tiles.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#tileWidth\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The pixel width of the tiles.", "name": "tileWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#tileWidth", "scope": "instance", "kind": "member", "___id": "T000002R041668", "___s": true }, { "comment": "/**\r\n * The pixel height of the tiles.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#tileHeight\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The pixel height of the tiles.", "name": "tileHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#tileHeight", "scope": "instance", "kind": "member", "___id": "T000002R041670", "___s": true }, { "comment": "/**\r\n * The base tile width.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#baseTileWidth\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 106, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The base tile width.", "name": "baseTileWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#baseTileWidth", "scope": "instance", "kind": "member", "___id": "T000002R041672", "___s": true }, { "comment": "/**\r\n * The base tile height.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#baseTileHeight\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 115, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The base tile height.", "name": "baseTileHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#baseTileHeight", "scope": "instance", "kind": "member", "___id": "T000002R041674", "___s": true }, { "comment": "/**\r\n * The layers orientation, necessary to be able to determine a tiles pixelX and pixelY as well as the layers width and height.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#orientation\r\n * @type {Phaser.Tilemaps.OrientationType}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 124, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The layers orientation, necessary to be able to determine a tiles pixelX and pixelY as well as the layers width and height.", "name": "orientation", "type": { "names": [ "Phaser.Tilemaps.OrientationType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.OrientationType" } }, "since": "3.50.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#orientation", "scope": "instance", "kind": "member", "___id": "T000002R041676", "___s": true }, { "comment": "/**\r\n * The width in pixels of the entire layer.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#widthInPixels\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 133, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The width in pixels of the entire layer.", "name": "widthInPixels", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#widthInPixels", "scope": "instance", "kind": "member", "___id": "T000002R041678", "___s": true }, { "comment": "/**\r\n * The height in pixels of the entire layer.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#heightInPixels\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The height in pixels of the entire layer.", "name": "heightInPixels", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#heightInPixels", "scope": "instance", "kind": "member", "___id": "T000002R041680", "___s": true }, { "comment": "/**\r\n * The alpha value of the layer.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#alpha\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The alpha value of the layer.", "name": "alpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#alpha", "scope": "instance", "kind": "member", "___id": "T000002R041682", "___s": true }, { "comment": "/**\r\n * Is the layer visible or not?\r\n *\r\n * @name Phaser.Tilemaps.LayerData#visible\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "Is the layer visible or not?", "name": "visible", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#visible", "scope": "instance", "kind": "member", "___id": "T000002R041684", "___s": true }, { "comment": "/**\r\n * Layer specific properties (can be specified in Tiled)\r\n *\r\n * @name Phaser.Tilemaps.LayerData#properties\r\n * @type {object[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 169, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "Layer specific properties (can be specified in Tiled)", "name": "properties", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#properties", "scope": "instance", "kind": "member", "___id": "T000002R041686", "___s": true }, { "comment": "/**\r\n * Tile ID index map.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#indexes\r\n * @type {array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 178, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "Tile ID index map.", "name": "indexes", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#indexes", "scope": "instance", "kind": "member", "___id": "T000002R041688", "___s": true }, { "comment": "/**\r\n * Tile Collision ID index map.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#collideIndexes\r\n * @type {array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "Tile Collision ID index map.", "name": "collideIndexes", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#collideIndexes", "scope": "instance", "kind": "member", "___id": "T000002R041690", "___s": true }, { "comment": "/**\r\n * An array of callbacks.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#callbacks\r\n * @type {array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "An array of callbacks.", "name": "callbacks", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#callbacks", "scope": "instance", "kind": "member", "___id": "T000002R041692", "___s": true }, { "comment": "/**\r\n * An array of physics bodies.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#bodies\r\n * @type {array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 205, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "An array of physics bodies.", "name": "bodies", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#bodies", "scope": "instance", "kind": "member", "___id": "T000002R041694", "___s": true }, { "comment": "/**\r\n * An array of the tile data indexes.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#data\r\n * @type {Phaser.Tilemaps.Tile[][]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 214, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "An array of the tile data indexes.", "name": "data", "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } ] } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#data", "scope": "instance", "kind": "member", "___id": "T000002R041696", "___s": true }, { "comment": "/**\r\n * A reference to the Tilemap layer that owns this data.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#tilemapLayer\r\n * @type {Phaser.Tilemaps.TilemapLayer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 223, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "A reference to the Tilemap layer that owns this data.", "name": "tilemapLayer", "type": { "names": [ "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#tilemapLayer", "scope": "instance", "kind": "member", "___id": "T000002R041698", "___s": true }, { "comment": "/**\r\n * The length of the horizontal sides of the hexagon.\r\n * Only used for hexagonal orientation Tilemaps.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#hexSideLength\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 232, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The length of the horizontal sides of the hexagon.\rOnly used for hexagonal orientation Tilemaps.", "name": "hexSideLength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#hexSideLength", "scope": "instance", "kind": "member", "___id": "T000002R041700", "___s": true }, { "comment": "/**\r\n * The Stagger Axis as defined in Tiled.\r\n *\r\n * Only used for hexagonal orientation Tilemaps.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#staggerAxis\r\n * @type {string}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 242, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The Stagger Axis as defined in Tiled.\r\rOnly used for hexagonal orientation Tilemaps.", "name": "staggerAxis", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#staggerAxis", "scope": "instance", "kind": "member", "___id": "T000002R041702", "___s": true }, { "comment": "/**\r\n * The Stagger Index as defined in Tiled.\r\n *\r\n * Either 'odd' or 'even'.\r\n *\r\n * Only used for hexagonal orientation Tilemaps.\r\n *\r\n * @name Phaser.Tilemaps.LayerData#staggerIndex\r\n * @type {string}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "LayerData.js", "lineno": 253, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The Stagger Index as defined in Tiled.\r\rEither 'odd' or 'even'.\r\rOnly used for hexagonal orientation Tilemaps.", "name": "staggerIndex", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "memberof": "Phaser.Tilemaps.LayerData", "longname": "Phaser.Tilemaps.LayerData#staggerIndex", "scope": "instance", "kind": "member", "___id": "T000002R041704", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A class for representing data about a map. Maps are parsed from CSV, Tiled, etc. into this\r\n * format. A Tilemap object get a copy of this data and then unpacks the needed properties into\r\n * itself.\r\n *\r\n * @class MapData\r\n * @memberof Phaser.Tilemaps\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Tilemaps.MapDataConfig} [config] - The Map configuration object.\r\n */", "meta": { "filename": "MapData.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "classdesc": "A class for representing data about a map. Maps are parsed from CSV, Tiled, etc. into this\rformat. A Tilemap object get a copy of this data and then unpacks the needed properties into\ritself.", "kind": "class", "name": "MapData", "memberof": "Phaser.Tilemaps", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Tilemaps.MapDataConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.MapDataConfig" } }, "optional": true, "description": "The Map configuration object.", "name": "config" } ], "scope": "static", "longname": "Phaser.Tilemaps.MapData", "___id": "T000002R041710", "___s": true }, { "comment": "/**\r\n * The key in the Phaser cache that corresponds to the loaded tilemap data.\r\n *\r\n * @name Phaser.Tilemaps.MapData#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 32, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The key in the Phaser cache that corresponds to the loaded tilemap data.", "name": "name", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#name", "scope": "instance", "kind": "member", "___id": "T000002R041714", "___s": true }, { "comment": "/**\r\n * The width of the entire tilemap.\r\n *\r\n * @name Phaser.Tilemaps.MapData#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 41, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The width of the entire tilemap.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#width", "scope": "instance", "kind": "member", "___id": "T000002R041716", "___s": true }, { "comment": "/**\r\n * The height of the entire tilemap.\r\n *\r\n * @name Phaser.Tilemaps.MapData#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The height of the entire tilemap.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#height", "scope": "instance", "kind": "member", "___id": "T000002R041718", "___s": true }, { "comment": "/**\r\n * If the map is infinite or not.\r\n *\r\n * @name Phaser.Tilemaps.MapData#infinite\r\n * @type {boolean}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "If the map is infinite or not.", "name": "infinite", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.17.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#infinite", "scope": "instance", "kind": "member", "___id": "T000002R041720", "___s": true }, { "comment": "/**\r\n * The width of the tiles.\r\n *\r\n * @name Phaser.Tilemaps.MapData#tileWidth\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The width of the tiles.", "name": "tileWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#tileWidth", "scope": "instance", "kind": "member", "___id": "T000002R041722", "___s": true }, { "comment": "/**\r\n * The height of the tiles.\r\n *\r\n * @name Phaser.Tilemaps.MapData#tileHeight\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The height of the tiles.", "name": "tileHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#tileHeight", "scope": "instance", "kind": "member", "___id": "T000002R041724", "___s": true }, { "comment": "/**\r\n * The width in pixels of the entire tilemap.\r\n *\r\n * @name Phaser.Tilemaps.MapData#widthInPixels\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The width in pixels of the entire tilemap.", "name": "widthInPixels", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#widthInPixels", "scope": "instance", "kind": "member", "___id": "T000002R041726", "___s": true }, { "comment": "/**\r\n * The height in pixels of the entire tilemap.\r\n *\r\n * @name Phaser.Tilemaps.MapData#heightInPixels\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The height in pixels of the entire tilemap.", "name": "heightInPixels", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#heightInPixels", "scope": "instance", "kind": "member", "___id": "T000002R041728", "___s": true }, { "comment": "/**\r\n * The format of the map data.\r\n *\r\n * @name Phaser.Tilemaps.MapData#format\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The format of the map data.", "name": "format", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#format", "scope": "instance", "kind": "member", "___id": "T000002R041730", "___s": true }, { "comment": "/**\r\n * The orientation of the map data (i.e. orthogonal, isometric, hexagonal), default 'orthogonal'.\r\n *\r\n * @name Phaser.Tilemaps.MapData#orientation\r\n * @type {Phaser.Tilemaps.OrientationType}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The orientation of the map data (i.e. orthogonal, isometric, hexagonal), default 'orthogonal'.", "name": "orientation", "type": { "names": [ "Phaser.Tilemaps.OrientationType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.OrientationType" } }, "since": "3.50.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#orientation", "scope": "instance", "kind": "member", "___id": "T000002R041732", "___s": true }, { "comment": "/**\r\n * Determines the draw order of tilemap. Default is right-down\r\n *\r\n * 0, or 'right-down'\r\n * 1, or 'left-down'\r\n * 2, or 'right-up'\r\n * 3, or 'left-up'\r\n *\r\n * @name Phaser.Tilemaps.MapData#renderOrder\r\n * @type {string}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "Determines the draw order of tilemap. Default is right-down\r\r0, or 'right-down'\r1, or 'left-down'\r2, or 'right-up'\r3, or 'left-up'", "name": "renderOrder", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.12.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#renderOrder", "scope": "instance", "kind": "member", "___id": "T000002R041734", "___s": true }, { "comment": "/**\r\n * The version of the map data (as specified in Tiled).\r\n *\r\n * @name Phaser.Tilemaps.MapData#version\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The version of the map data (as specified in Tiled).", "name": "version", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#version", "scope": "instance", "kind": "member", "___id": "T000002R041736", "___s": true }, { "comment": "/**\r\n * Map specific properties (can be specified in Tiled)\r\n *\r\n * @name Phaser.Tilemaps.MapData#properties\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "Map specific properties (can be specified in Tiled)", "name": "properties", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#properties", "scope": "instance", "kind": "member", "___id": "T000002R041738", "___s": true }, { "comment": "/**\r\n * An array with all the layers configured to the MapData.\r\n *\r\n * @name Phaser.Tilemaps.MapData#layers\r\n * @type {(Phaser.Tilemaps.LayerData[]|Phaser.Tilemaps.ObjectLayer)}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "An array with all the layers configured to the MapData.", "name": "layers", "type": { "names": [ "Array.", "Phaser.Tilemaps.ObjectLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.LayerData", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Tilemaps.ObjectLayer" } ] } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#layers", "scope": "instance", "kind": "member", "___id": "T000002R041740", "___s": true }, { "comment": "/**\r\n * An array of Tiled Image Layers.\r\n *\r\n * @name Phaser.Tilemaps.MapData#images\r\n * @type {array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "An array of Tiled Image Layers.", "name": "images", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#images", "scope": "instance", "kind": "member", "___id": "T000002R041742", "___s": true }, { "comment": "/**\r\n * An object of Tiled Object Layers.\r\n *\r\n * @name Phaser.Tilemaps.MapData#objects\r\n * @type {Phaser.Types.Tilemaps.ObjectLayerConfig[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 172, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "An object of Tiled Object Layers.", "name": "objects", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Tilemaps.ObjectLayerConfig", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#objects", "scope": "instance", "kind": "member", "___id": "T000002R041744", "___s": true }, { "comment": "/**\r\n * An object of collision data. Must be created as physics object or will return undefined.\r\n *\r\n * @name Phaser.Tilemaps.MapData#collision\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "An object of collision data. Must be created as physics object or will return undefined.", "name": "collision", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#collision", "scope": "instance", "kind": "member", "___id": "T000002R041747", "___s": true }, { "comment": "/**\r\n * An array of Tilesets.\r\n *\r\n * @name Phaser.Tilemaps.MapData#tilesets\r\n * @type {Phaser.Tilemaps.Tileset[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "An array of Tilesets.", "name": "tilesets", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tileset", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#tilesets", "scope": "instance", "kind": "member", "___id": "T000002R041749", "___s": true }, { "comment": "/**\r\n * The collection of images the map uses(specified in Tiled)\r\n *\r\n * @name Phaser.Tilemaps.MapData#imageCollections\r\n * @type {array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 205, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The collection of images the map uses(specified in Tiled)", "name": "imageCollections", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#imageCollections", "scope": "instance", "kind": "member", "___id": "T000002R041751", "___s": true }, { "comment": "/**\r\n * An array of tile instances.\r\n *\r\n * @name Phaser.Tilemaps.MapData#tiles\r\n * @type {array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 214, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "An array of tile instances.", "name": "tiles", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#tiles", "scope": "instance", "kind": "member", "___id": "T000002R041753", "___s": true }, { "comment": "/**\r\n * The length of the horizontal sides of the hexagon.\r\n *\r\n * Only used for hexagonal orientation Tilemaps.\r\n *\r\n * @name Phaser.Tilemaps.MapData#hexSideLength\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 223, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The length of the horizontal sides of the hexagon.\r\rOnly used for hexagonal orientation Tilemaps.", "name": "hexSideLength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#hexSideLength", "scope": "instance", "kind": "member", "___id": "T000002R041755", "___s": true }, { "comment": "/**\r\n * The Stagger Axis as defined in Tiled.\r\n *\r\n * Only used for hexagonal orientation Tilemaps.\r\n *\r\n * @name Phaser.Tilemaps.MapData#staggerAxis\r\n * @type {string}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The Stagger Axis as defined in Tiled.\r\rOnly used for hexagonal orientation Tilemaps.", "name": "staggerAxis", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#staggerAxis", "scope": "instance", "kind": "member", "___id": "T000002R041757", "___s": true }, { "comment": "/**\r\n * The Stagger Index as defined in Tiled.\r\n *\r\n * Either 'odd' or 'even'.\r\n *\r\n * Only used for hexagonal orientation Tilemaps.\r\n *\r\n * @name Phaser.Tilemaps.MapData#staggerIndex\r\n * @type {string}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MapData.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The Stagger Index as defined in Tiled.\r\rEither 'odd' or 'even'.\r\rOnly used for hexagonal orientation Tilemaps.", "name": "staggerIndex", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "memberof": "Phaser.Tilemaps.MapData", "longname": "Phaser.Tilemaps.MapData#staggerIndex", "scope": "instance", "kind": "member", "___id": "T000002R041759", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A class for representing a Tiled object layer in a map. This mirrors the structure of a Tiled\r\n * object layer, except:\r\n * - \"x\" & \"y\" properties are ignored since these cannot be changed in Tiled.\r\n * - \"offsetx\" & \"offsety\" are applied to the individual object coordinates directly, so they\r\n * are ignored as well.\r\n * - \"draworder\" is ignored.\r\n *\r\n * @class ObjectLayer\r\n * @memberof Phaser.Tilemaps\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Tilemaps.ObjectLayerConfig} [config] - The data for the layer from the Tiled JSON object.\r\n */", "meta": { "filename": "ObjectLayer.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "classdesc": "A class for representing a Tiled object layer in a map. This mirrors the structure of a Tiled\robject layer, except:\r - \"x\" & \"y\" properties are ignored since these cannot be changed in Tiled.\r - \"offsetx\" & \"offsety\" are applied to the individual object coordinates directly, so they\r are ignored as well.\r - \"draworder\" is ignored.", "kind": "class", "name": "ObjectLayer", "memberof": "Phaser.Tilemaps", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Tilemaps.ObjectLayerConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.ObjectLayerConfig" } }, "optional": true, "description": "The data for the layer from the Tiled JSON object.", "name": "config" } ], "scope": "static", "longname": "Phaser.Tilemaps.ObjectLayer", "___id": "T000002R041764", "___s": true }, { "comment": "/**\r\n * The name of the Object Layer.\r\n *\r\n * @name Phaser.Tilemaps.ObjectLayer#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ObjectLayer.js", "lineno": 34, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The name of the Object Layer.", "name": "name", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.ObjectLayer", "longname": "Phaser.Tilemaps.ObjectLayer#name", "scope": "instance", "kind": "member", "___id": "T000002R041768", "___s": true }, { "comment": "/**\r\n * The id of the object layer, as specified in the map data.\r\n *\r\n * @name Phaser.Tilemaps.ObjectLayer#id\r\n * @type {number}\r\n * @since 3.61.0\r\n */", "meta": { "filename": "ObjectLayer.js", "lineno": 43, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The id of the object layer, as specified in the map data.", "name": "id", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.61.0", "memberof": "Phaser.Tilemaps.ObjectLayer", "longname": "Phaser.Tilemaps.ObjectLayer#id", "scope": "instance", "kind": "member", "___id": "T000002R041770", "___s": true }, { "comment": "/**\r\n * The opacity of the layer, between 0 and 1.\r\n *\r\n * @name Phaser.Tilemaps.ObjectLayer#opacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ObjectLayer.js", "lineno": 52, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The opacity of the layer, between 0 and 1.", "name": "opacity", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.ObjectLayer", "longname": "Phaser.Tilemaps.ObjectLayer#opacity", "scope": "instance", "kind": "member", "___id": "T000002R041772", "___s": true }, { "comment": "/**\r\n * The custom properties defined on the Object Layer, keyed by their name.\r\n *\r\n * @name Phaser.Tilemaps.ObjectLayer#properties\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ObjectLayer.js", "lineno": 61, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The custom properties defined on the Object Layer, keyed by their name.", "name": "properties", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.ObjectLayer", "longname": "Phaser.Tilemaps.ObjectLayer#properties", "scope": "instance", "kind": "member", "___id": "T000002R041774", "___s": true }, { "comment": "/**\r\n * The type of each custom property defined on the Object Layer, keyed by its name.\r\n *\r\n * @name Phaser.Tilemaps.ObjectLayer#propertyTypes\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ObjectLayer.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The type of each custom property defined on the Object Layer, keyed by its name.", "name": "propertyTypes", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.ObjectLayer", "longname": "Phaser.Tilemaps.ObjectLayer#propertyTypes", "scope": "instance", "kind": "member", "___id": "T000002R041776", "___s": true }, { "comment": "/**\r\n * The type of the layer, which should be `objectgroup`.\r\n *\r\n * @name Phaser.Tilemaps.ObjectLayer#type\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ObjectLayer.js", "lineno": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "The type of the layer, which should be `objectgroup`.", "name": "type", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.ObjectLayer", "longname": "Phaser.Tilemaps.ObjectLayer#type", "scope": "instance", "kind": "member", "___id": "T000002R041778", "___s": true }, { "comment": "/**\r\n * Whether the layer is shown (`true`) or hidden (`false`).\r\n *\r\n * @name Phaser.Tilemaps.ObjectLayer#visible\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ObjectLayer.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "Whether the layer is shown (`true`) or hidden (`false`).", "name": "visible", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.ObjectLayer", "longname": "Phaser.Tilemaps.ObjectLayer#visible", "scope": "instance", "kind": "member", "___id": "T000002R041780", "___s": true }, { "comment": "/**\r\n * An array of all objects on this Object Layer.\r\n *\r\n * Each Tiled object corresponds to a JavaScript object in this array. It has an `id` (unique),\r\n * `name` (as assigned in Tiled), `type` (as assigned in Tiled), `rotation` (in clockwise degrees),\r\n * `properties` (if any), `visible` state (`true` if visible, `false` otherwise),\r\n * `x` and `y` coordinates (in pixels, relative to the tilemap), and a `width` and `height` (in pixels).\r\n *\r\n * An object tile has a `gid` property (GID of the represented tile), a `flippedHorizontal` property,\r\n * a `flippedVertical` property, and `flippedAntiDiagonal` property.\r\n * The {@link http://docs.mapeditor.org/en/latest/reference/tmx-map-format/|Tiled documentation} contains\r\n * information on flipping and rotation.\r\n *\r\n * Polylines have a `polyline` property, which is an array of objects corresponding to points,\r\n * where each point has an `x` property and a `y` property. Polygons have an identically structured\r\n * array in their `polygon` property. Text objects have a `text` property with the text's properties.\r\n *\r\n * Rectangles and ellipses have a `rectangle` or `ellipse` property set to `true`.\r\n *\r\n * @name Phaser.Tilemaps.ObjectLayer#objects\r\n * @type {Phaser.Types.Tilemaps.TiledObject[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ObjectLayer.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\mapdata", "code": {} }, "description": "An array of all objects on this Object Layer.\r\rEach Tiled object corresponds to a JavaScript object in this array. It has an `id` (unique),\r`name` (as assigned in Tiled), `type` (as assigned in Tiled), `rotation` (in clockwise degrees),\r`properties` (if any), `visible` state (`true` if visible, `false` otherwise),\r`x` and `y` coordinates (in pixels, relative to the tilemap), and a `width` and `height` (in pixels).\r\rAn object tile has a `gid` property (GID of the represented tile), a `flippedHorizontal` property,\ra `flippedVertical` property, and `flippedAntiDiagonal` property.\rThe {@link http://docs.mapeditor.org/en/latest/reference/tmx-map-format/|Tiled documentation} contains\rinformation on flipping and rotation.\r\rPolylines have a `polyline` property, which is an array of objects corresponding to points,\rwhere each point has an `x` property and a `y` property. Polygons have an identically structured\rarray in their `polygon` property. Text objects have a `text` property with the text's properties.\r\rRectangles and ellipses have a `rectangle` or `ellipse` property set to `true`.", "name": "objects", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Tilemaps.TiledObject", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.ObjectLayer", "longname": "Phaser.Tilemaps.ObjectLayer#objects", "scope": "instance", "kind": "member", "___id": "T000002R041782", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The ObjectHelper helps tie objects with `gids` into the tileset\r\n * that sits behind them.\r\n *\r\n * @class ObjectHelper\r\n * @memberof Phaser.Tilemaps\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Tilemaps.Tileset[]} tilesets - The backing tileset data.\r\n */", "meta": { "filename": "ObjectHelper.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "classdesc": "The ObjectHelper helps tie objects with `gids` into the tileset\rthat sits behind them.", "kind": "class", "name": "ObjectHelper", "memberof": "Phaser.Tilemaps", "since": "3.60.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tileset", "type": "NameExpression" } ] } }, "description": "The backing tileset data.", "name": "tilesets" } ], "scope": "static", "longname": "Phaser.Tilemaps.ObjectHelper", "___id": "T000002R041787", "___s": true }, { "comment": "/**\r\n * The Tile GIDs array.\r\n *\r\n * @name Phaser.Tilemaps.ObjectHelper#gids\r\n * @type {array}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ObjectHelper.js", "lineno": 27, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The Tile GIDs array.", "name": "gids", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.60.0", "memberof": "Phaser.Tilemaps.ObjectHelper", "longname": "Phaser.Tilemaps.ObjectHelper#gids", "scope": "instance", "kind": "member", "___id": "T000002R041790", "___s": true }, { "comment": "/**\r\n * Enabled if the object helper reaches in to tilesets for data.\r\n * Disabled if it only uses data directly on a gid object.\r\n *\r\n * @name Phaser.Tilemaps.ObjectHelper#enabled\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ObjectHelper.js", "lineno": 60, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Enabled if the object helper reaches in to tilesets for data.\rDisabled if it only uses data directly on a gid object.", "name": "enabled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Tilemaps.ObjectHelper", "longname": "Phaser.Tilemaps.ObjectHelper#enabled", "scope": "instance", "kind": "member", "___id": "T000002R041798", "___s": true }, { "comment": "/**\r\n * Gets the Tiled `type` field value from the object or the `gid` behind it.\r\n *\r\n * @method Phaser.Tilemaps.ObjectHelper#getTypeIncludingTile\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Tilemaps.TiledObject} obj - The Tiled object to investigate.\r\n *\r\n * @return {?string} The `type` of the object, the tile behind the `gid` of the object, or `undefined`.\r\n */", "meta": { "filename": "ObjectHelper.js", "lineno": 82, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the Tiled `type` field value from the object or the `gid` behind it.", "kind": "function", "name": "getTypeIncludingTile", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.Tilemaps.TiledObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.TiledObject" } }, "description": "The Tiled object to investigate.", "name": "obj" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "description": "The `type` of the object, the tile behind the `gid` of the object, or `undefined`." } ], "memberof": "Phaser.Tilemaps.ObjectHelper", "longname": "Phaser.Tilemaps.ObjectHelper#getTypeIncludingTile", "scope": "instance", "___id": "T000002R041803", "___s": true }, { "comment": "/**\r\n * Sets the sprite texture data as specified (usually in a config) or, failing that,\r\n * as specified in the `gid` of the object being loaded (if any).\r\n *\r\n * This fallback will only work if the tileset was loaded as a spritesheet matching\r\n * the geometry of sprites fed into tiled, so that, for example: \"tile id #`3`\"\" within\r\n * the tileset is the same as texture frame `3` from the image of the tileset.\r\n *\r\n * @method Phaser.Tilemaps.ObjectHelper#setTextureAndFrame\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} sprite - The Game Object to modify.\r\n * @param {string|Phaser.Textures.Texture} [key] - The texture key to set (or else the `obj.gid`'s tile is used if available).\r\n * @param {string|number|Phaser.Textures.Frame} [frame] - The frames key to set (or else the `obj.gid`'s tile is used if available).\r\n * @param {Phaser.Types.Tilemaps.TiledObject} [obj] - The Tiled object for fallback.\r\n */", "meta": { "filename": "ObjectHelper.js", "lineno": 121, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets the sprite texture data as specified (usually in a config) or, failing that,\ras specified in the `gid` of the object being loaded (if any).\r\rThis fallback will only work if the tileset was loaded as a spritesheet matching\rthe geometry of sprites fed into tiled, so that, for example: \"tile id #`3`\"\" within\rthe tileset is the same as texture frame `3` from the image of the tileset.", "kind": "function", "name": "setTextureAndFrame", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to modify.", "name": "sprite" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "optional": true, "description": "The texture key to set (or else the `obj.gid`'s tile is used if available).", "name": "key" }, { "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 frames key to set (or else the `obj.gid`'s tile is used if available).", "name": "frame" }, { "type": { "names": [ "Phaser.Types.Tilemaps.TiledObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.TiledObject" } }, "optional": true, "description": "The Tiled object for fallback.", "name": "obj" } ], "memberof": "Phaser.Tilemaps.ObjectHelper", "longname": "Phaser.Tilemaps.ObjectHelper#setTextureAndFrame", "scope": "instance", "___id": "T000002R041807", "___s": true }, { "comment": "/**\r\n * Sets the `sprite.data` field from the tiled properties on the object and its tile (if any).\r\n *\r\n * @method Phaser.Tilemaps.ObjectHelper#setPropertiesFromTiledObject\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} sprite\r\n * @param {Phaser.Types.Tilemaps.TiledObject} obj\r\n */", "meta": { "filename": "ObjectHelper.js", "lineno": 168, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets the `sprite.data` field from the tiled properties on the object and its tile (if any).", "kind": "function", "name": "setPropertiesFromTiledObject", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "name": "sprite" }, { "type": { "names": [ "Phaser.Types.Tilemaps.TiledObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.TiledObject" } }, "name": "obj" } ], "memberof": "Phaser.Tilemaps.ObjectHelper", "longname": "Phaser.Tilemaps.ObjectHelper#setPropertiesFromTiledObject", "scope": "instance", "___id": "T000002R041814", "___s": true }, { "comment": "/**\r\n * Get the Tilemap orientation from the given string.\r\n *\r\n * @function Phaser.Tilemaps.Parsers.FromOrientationString\r\n * @since 3.50.0\r\n *\r\n * @param {string} [orientation] - The orientation type as a string.\r\n *\r\n * @return {Phaser.Tilemaps.OrientationType} The Tilemap Orientation type.\r\n */", "meta": { "filename": "FromOrientationString.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers", "code": {} }, "description": "Get the Tilemap orientation from the given string.", "kind": "function", "name": "FromOrientationString", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The orientation type as a string.", "name": "orientation" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.OrientationType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.OrientationType" } }, "description": "The Tilemap Orientation type." } ], "memberof": "Phaser.Tilemaps.Parsers", "longname": "Phaser.Tilemaps.Parsers.FromOrientationString", "scope": "static", "___id": "T000002R041826", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Tilemaps.Parsers.Impact\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\impact", "code": {} }, "kind": "namespace", "name": "Impact", "memberof": "Phaser.Tilemaps.Parsers", "longname": "Phaser.Tilemaps.Parsers.Impact", "scope": "static", "___id": "T000002R041830", "___s": true }, { "comment": "/**\r\n * Parses all tilemap layers in an Impact JSON object into new LayerData objects.\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Impact.ParseTileLayers\r\n * @since 3.0.0\r\n *\r\n * @param {object} json - The Impact JSON object.\r\n * @param {boolean} insertNull - Controls how empty tiles, tiles with an index of -1, in the map\r\n * data are handled (see {@link Phaser.Tilemaps.Parsers.Tiled.ParseJSONTiled}).\r\n *\r\n * @return {Phaser.Tilemaps.LayerData[]} - An array of LayerData objects, one for each entry in\r\n * json.layers with the type 'tilelayer'.\r\n */", "meta": { "filename": "ParseTileLayers.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\impact", "code": {} }, "description": "Parses all tilemap layers in an Impact JSON object into new LayerData objects.", "kind": "function", "name": "ParseTileLayers", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The Impact JSON object.", "name": "json" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Controls how empty tiles, tiles with an index of -1, in the map\rdata are handled (see {@link Phaser.Tilemaps.Parsers.Tiled.ParseJSONTiled}).", "name": "insertNull" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.LayerData", "type": "NameExpression" } ] } }, "description": "- An array of LayerData objects, one for each entry in\rjson.layers with the type 'tilelayer'." } ], "memberof": "Phaser.Tilemaps.Parsers.Impact", "longname": "Phaser.Tilemaps.Parsers.Impact.ParseTileLayers", "scope": "static", "___id": "T000002R041837", "___s": true }, { "comment": "/**\r\n * Tilesets and Image Collections\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Impact.ParseTilesets\r\n * @since 3.0.0\r\n *\r\n * @param {object} json - The Impact JSON data.\r\n *\r\n * @return {array} An array of Tilesets.\r\n */", "meta": { "filename": "ParseTilesets.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\impact", "code": {} }, "description": "Tilesets and Image Collections", "kind": "function", "name": "ParseTilesets", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The Impact JSON data.", "name": "json" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "An array of Tilesets." } ], "memberof": "Phaser.Tilemaps.Parsers.Impact", "longname": "Phaser.Tilemaps.Parsers.Impact.ParseTilesets", "scope": "static", "___id": "T000002R041861", "___s": true }, { "comment": "/**\r\n * Parses a Weltmeister JSON object into a new MapData object.\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Impact.ParseWeltmeister\r\n * @since 3.0.0\r\n *\r\n * @param {string} name - The name of the tilemap, used to set the name on the MapData.\r\n * @param {object} json - The Weltmeister JSON object.\r\n * @param {boolean} insertNull - Controls how empty tiles, tiles with an index of -1, in the map\r\n * data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\r\n * location will get a Tile object with an index of -1. If you've a large sparsely populated map and\r\n * the tile data doesn't need to change then setting this value to `true` will help with memory\r\n * consumption. However if your map is small or you need to update the tiles dynamically, then leave\r\n * the default value set.\r\n *\r\n * @return {?Phaser.Tilemaps.MapData} The created MapData object, or `null` if the data can't be parsed.\r\n */", "meta": { "filename": "ParseWeltmeister.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\impact", "code": {} }, "description": "Parses a Weltmeister JSON object into a new MapData object.", "kind": "function", "name": "ParseWeltmeister", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the tilemap, used to set the name on the MapData.", "name": "name" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The Weltmeister JSON object.", "name": "json" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Controls how empty tiles, tiles with an index of -1, in the map\rdata are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\rlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\rthe tile data doesn't need to change then setting this value to `true` will help with memory\rconsumption. However if your map is small or you need to update the tiles dynamically, then leave\rthe default value set.", "name": "insertNull" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.MapData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.MapData", "nullable": true } }, "nullable": true, "description": "The created MapData object, or `null` if the data can't be parsed." } ], "memberof": "Phaser.Tilemaps.Parsers.Impact", "longname": "Phaser.Tilemaps.Parsers.Impact.ParseWeltmeister", "scope": "static", "___id": "T000002R041873", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Tilemaps.Parsers\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers", "code": {} }, "kind": "namespace", "name": "Parsers", "memberof": "Phaser.Tilemaps", "longname": "Phaser.Tilemaps.Parsers", "scope": "static", "___id": "T000002R041890", "___s": true }, { "comment": "/**\r\n * Parses raw data of a given Tilemap format into a new MapData object. If no recognized data format\r\n * is found, returns `null`. When loading from CSV or a 2D array, you should specify the tileWidth &\r\n * tileHeight. When parsing from a map from Tiled, the tileWidth & tileHeight will be pulled from\r\n * the map data.\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Parse\r\n * @since 3.0.0\r\n *\r\n * @param {string} name - The name of the tilemap, used to set the name on the MapData.\r\n * @param {number} mapFormat - See ../Formats.js.\r\n * @param {(number[][]|string|object)} data - 2D array, CSV string or Tiled JSON object.\r\n * @param {number} tileWidth - The width of a tile in pixels. Required for 2D array and CSV, but\r\n * ignored for Tiled JSON.\r\n * @param {number} tileHeight - The height of a tile in pixels. Required for 2D array and CSV, but\r\n * ignored for Tiled JSON.\r\n * @param {boolean} insertNull - Controls how empty tiles, tiles with an index of -1, in the map\r\n * data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\r\n * location will get a Tile object with an index of -1. If you've a large sparsely populated map and\r\n * the tile data doesn't need to change then setting this value to `true` will help with memory\r\n * consumption. However if your map is small or you need to update the tiles dynamically, then leave\r\n * the default value set.\r\n *\r\n * @return {Phaser.Tilemaps.MapData} The created `MapData` object.\r\n */", "meta": { "filename": "Parse.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers", "code": {} }, "description": "Parses raw data of a given Tilemap format into a new MapData object. If no recognized data format\ris found, returns `null`. When loading from CSV or a 2D array, you should specify the tileWidth &\rtileHeight. When parsing from a map from Tiled, the tileWidth & tileHeight will be pulled from\rthe map data.", "kind": "function", "name": "Parse", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the tilemap, used to set the name on the MapData.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "See ../Formats.js.", "name": "mapFormat" }, { "type": { "names": [ "Array.>", "string", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] }, { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "2D array, CSV string or Tiled JSON object.", "name": "data" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of a tile in pixels. Required for 2D array and CSV, but\rignored for Tiled JSON.", "name": "tileWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of a tile in pixels. Required for 2D array and CSV, but\rignored for Tiled JSON.", "name": "tileHeight" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Controls how empty tiles, tiles with an index of -1, in the map\rdata are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\rlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\rthe tile data doesn't need to change then setting this value to `true` will help with memory\rconsumption. However if your map is small or you need to update the tiles dynamically, then leave\rthe default value set.", "name": "insertNull" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.MapData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.MapData" } }, "description": "The created `MapData` object." } ], "memberof": "Phaser.Tilemaps.Parsers", "longname": "Phaser.Tilemaps.Parsers.Parse", "scope": "static", "___id": "T000002R041903", "___s": true }, { "comment": "/**\r\n * Parses a 2D array of tile indexes into a new MapData object with a single layer.\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Parse2DArray\r\n * @since 3.0.0\r\n *\r\n * @param {string} name - The name of the tilemap, used to set the name on the MapData.\r\n * @param {number[][]} data - 2D array, CSV string or Tiled JSON object.\r\n * @param {number} tileWidth - The width of a tile in pixels.\r\n * @param {number} tileHeight - The height of a tile in pixels.\r\n * @param {boolean} insertNull - Controls how empty tiles, tiles with an index of -1, in the map\r\n * data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\r\n * location will get a Tile object with an index of -1. If you've a large sparsely populated map and\r\n * the tile data doesn't need to change then setting this value to `true` will help with memory\r\n * consumption. However if your map is small or you need to update the tiles dynamically, then leave\r\n * the default value set.\r\n *\r\n * @return {Phaser.Tilemaps.MapData} The MapData object.\r\n */", "meta": { "filename": "Parse2DArray.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers", "code": {} }, "description": "Parses a 2D array of tile indexes into a new MapData object with a single layer.", "kind": "function", "name": "Parse2DArray", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the tilemap, used to set the name on the MapData.", "name": "name" }, { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "description": "2D array, CSV string or Tiled JSON object.", "name": "data" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of a tile in pixels.", "name": "tileWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of a tile in pixels.", "name": "tileHeight" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Controls how empty tiles, tiles with an index of -1, in the map\rdata are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\rlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\rthe tile data doesn't need to change then setting this value to `true` will help with memory\rconsumption. However if your map is small or you need to update the tiles dynamically, then leave\rthe default value set.", "name": "insertNull" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.MapData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.MapData" } }, "description": "The MapData object." } ], "memberof": "Phaser.Tilemaps.Parsers", "longname": "Phaser.Tilemaps.Parsers.Parse2DArray", "scope": "static", "___id": "T000002R041916", "___s": true }, { "comment": "/**\r\n * Parses a CSV string of tile indexes into a new MapData object with a single layer.\r\n *\r\n * @function Phaser.Tilemaps.Parsers.ParseCSV\r\n * @since 3.0.0\r\n *\r\n * @param {string} name - The name of the tilemap, used to set the name on the MapData.\r\n * @param {string} data - CSV string of tile indexes.\r\n * @param {number} tileWidth - The width of a tile in pixels.\r\n * @param {number} tileHeight - The height of a tile in pixels.\r\n * @param {boolean} insertNull - Controls how empty tiles, tiles with an index of -1, in the map\r\n * data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\r\n * location will get a Tile object with an index of -1. If you've a large sparsely populated map and\r\n * the tile data doesn't need to change then setting this value to `true` will help with memory\r\n * consumption. However if your map is small or you need to update the tiles dynamically, then leave\r\n * the default value set.\r\n *\r\n * @return {Phaser.Tilemaps.MapData} The resulting MapData object.\r\n */", "meta": { "filename": "ParseCSV.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers", "code": {} }, "description": "Parses a CSV string of tile indexes into a new MapData object with a single layer.", "kind": "function", "name": "ParseCSV", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the tilemap, used to set the name on the MapData.", "name": "name" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "CSV string of tile indexes.", "name": "data" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of a tile in pixels.", "name": "tileWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of a tile in pixels.", "name": "tileHeight" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Controls how empty tiles, tiles with an index of -1, in the map\rdata are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\rlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\rthe tile data doesn't need to change then setting this value to `true` will help with memory\rconsumption. However if your map is small or you need to update the tiles dynamically, then leave\rthe default value set.", "name": "insertNull" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.MapData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.MapData" } }, "description": "The resulting MapData object." } ], "memberof": "Phaser.Tilemaps.Parsers", "longname": "Phaser.Tilemaps.Parsers.ParseCSV", "scope": "static", "___id": "T000002R041950", "___s": true }, { "comment": "/**\r\n * Copy properties from tileset to tiles.\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Tiled.AssignTileProperties\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Tilemaps.MapData} mapData - The Map Data object.\r\n */", "meta": { "filename": "AssignTileProperties.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\tiled", "code": {} }, "description": "Copy properties from tileset to tiles.", "kind": "function", "name": "AssignTileProperties", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.MapData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.MapData" } }, "description": "The Map Data object.", "name": "mapData" } ], "memberof": "Phaser.Tilemaps.Parsers.Tiled", "longname": "Phaser.Tilemaps.Parsers.Tiled.AssignTileProperties", "scope": "static", "___id": "T000002R041957", "___s": true }, { "comment": "/**\r\n * Decode base-64 encoded data, for example as exported by Tiled.\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Tiled.Base64Decode\r\n * @since 3.0.0\r\n *\r\n * @param {object} data - Base-64 encoded data to decode.\r\n *\r\n * @return {array} Array containing the decoded bytes.\r\n */", "meta": { "filename": "Base64Decode.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\tiled", "code": {} }, "description": "Decode base-64 encoded data, for example as exported by Tiled.", "kind": "function", "name": "Base64Decode", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "Base-64 encoded data to decode.", "name": "data" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "Array containing the decoded bytes." } ], "memberof": "Phaser.Tilemaps.Parsers.Tiled", "longname": "Phaser.Tilemaps.Parsers.Tiled.Base64Decode", "scope": "static", "___id": "T000002R041977", "___s": true }, { "comment": "/**\r\n * Master list of tiles -> x, y, index in tileset.\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Tiled.BuildTilesetIndex\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Tilemaps.MapData|Phaser.Tilemaps.Tilemap)} mapData - The Map Data object.\r\n *\r\n * @return {array} An array of Tileset objects.\r\n */", "meta": { "filename": "BuildTilesetIndex.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\tiled", "code": {} }, "description": "Master list of tiles -> x, y, index in tileset.", "kind": "function", "name": "BuildTilesetIndex", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.MapData", "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Tilemaps.MapData" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap" } ] } }, "description": "The Map Data object.", "name": "mapData" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "An array of Tileset objects." } ], "memberof": "Phaser.Tilemaps.Parsers.Tiled", "longname": "Phaser.Tilemaps.Parsers.Tiled.BuildTilesetIndex", "scope": "static", "___id": "T000002R041987", "___s": true }, { "comment": "/**\r\n * Parse a Tiled group layer and create a state object for inheriting.\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Tiled.CreateGroupLayer\r\n * @since 3.21.0\r\n *\r\n * @param {object} json - The Tiled JSON object.\r\n * @param {object} [group] - The current group layer from the Tiled JSON file.\r\n * @param {object} [parentState] - The state of the parent group (if any).\r\n *\r\n * @return {object} A group state object with proper values for updating children layers.\r\n */", "meta": { "filename": "CreateGroupLayer.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\tiled", "code": {} }, "description": "Parse a Tiled group layer and create a state object for inheriting.", "kind": "function", "name": "CreateGroupLayer", "since": "3.21.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The Tiled JSON object.", "name": "json" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The current group layer from the Tiled JSON file.", "name": "group" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The state of the parent group (if any).", "name": "parentState" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "A group state object with proper values for updating children layers." } ], "memberof": "Phaser.Tilemaps.Parsers.Tiled", "longname": "Phaser.Tilemaps.Parsers.Tiled.CreateGroupLayer", "scope": "static", "___id": "T000002R042013", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Tilemaps.Parsers.Tiled\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\tiled", "code": {} }, "kind": "namespace", "name": "Tiled", "memberof": "Phaser.Tilemaps.Parsers", "longname": "Phaser.Tilemaps.Parsers.Tiled", "scope": "static", "___id": "T000002R042032", "___s": true }, { "comment": "/**\r\n * See Tiled documentation on tile flipping:\r\n * http://docs.mapeditor.org/en/latest/reference/tmx-map-format/\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Tiled.ParseGID\r\n * @since 3.0.0\r\n *\r\n * @param {number} gid - A Tiled GID.\r\n *\r\n * @return {Phaser.Types.Tilemaps.GIDData} The GID Data.\r\n */", "meta": { "filename": "ParseGID.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\tiled", "code": {} }, "description": "See Tiled documentation on tile flipping:\rhttp://docs.mapeditor.org/en/latest/reference/tmx-map-format/", "kind": "function", "name": "ParseGID", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A Tiled GID.", "name": "gid" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Tilemaps.GIDData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.GIDData" } }, "description": "The GID Data." } ], "memberof": "Phaser.Tilemaps.Parsers.Tiled", "longname": "Phaser.Tilemaps.Parsers.Tiled.ParseGID", "scope": "static", "___id": "T000002R042048", "___s": true }, { "comment": "/**\r\n * Parses a Tiled JSON object into an array of objects with details about the image layers.\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Tiled.ParseImageLayers\r\n * @since 3.0.0\r\n *\r\n * @param {object} json - The Tiled JSON object.\r\n *\r\n * @return {array} Array of objects that include critical info about the map's image layers\r\n */", "meta": { "filename": "ParseImageLayers.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\tiled", "code": {} }, "description": "Parses a Tiled JSON object into an array of objects with details about the image layers.", "kind": "function", "name": "ParseImageLayers", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The Tiled JSON object.", "name": "json" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "Array of objects that include critical info about the map's image layers" } ], "memberof": "Phaser.Tilemaps.Parsers.Tiled", "longname": "Phaser.Tilemaps.Parsers.Tiled.ParseImageLayers", "scope": "static", "___id": "T000002R042081", "___s": true }, { "comment": "/**\r\n * Parses a Tiled JSON object into a new MapData object.\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Tiled.ParseJSONTiled\r\n * @since 3.0.0\r\n *\r\n * @param {string} name - The name of the tilemap, used to set the name on the MapData.\r\n * @param {object} source - The original Tiled JSON object. This is deep copied by this function.\r\n * @param {boolean} insertNull - Controls how empty tiles, tiles with an index of -1, in the map\r\n * data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\r\n * location will get a Tile object with an index of -1. If you've a large sparsely populated map and\r\n * the tile data doesn't need to change then setting this value to `true` will help with memory\r\n * consumption. However if your map is small or you need to update the tiles dynamically, then leave\r\n * the default value set.\r\n *\r\n * @return {?Phaser.Tilemaps.MapData} The created MapData object, or `null` if the data can't be parsed.\r\n */", "meta": { "filename": "ParseJSONTiled.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\tiled", "code": {} }, "description": "Parses a Tiled JSON object into a new MapData object.", "kind": "function", "name": "ParseJSONTiled", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the tilemap, used to set the name on the MapData.", "name": "name" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The original Tiled JSON object. This is deep copied by this function.", "name": "source" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Controls how empty tiles, tiles with an index of -1, in the map\rdata are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\rlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\rthe tile data doesn't need to change then setting this value to `true` will help with memory\rconsumption. However if your map is small or you need to update the tiles dynamically, then leave\rthe default value set.", "name": "insertNull" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.MapData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.MapData", "nullable": true } }, "nullable": true, "description": "The created MapData object, or `null` if the data can't be parsed." } ], "memberof": "Phaser.Tilemaps.Parsers.Tiled", "longname": "Phaser.Tilemaps.Parsers.Tiled.ParseJSONTiled", "scope": "static", "___id": "T000002R042111", "___s": true }, { "comment": "/**\r\n * Convert a Tiled object to an internal parsed object normalising and copying properties over, while applying optional x and y offsets. The parsed object will always have the properties `id`, `name`, `type`, `rotation`, `properties`, `visible`, `x`, `y`, `width` and `height`. Other properties will be added according to the object type (such as text, polyline, gid etc.)\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Tiled.ParseObject\r\n * @since 3.0.0\r\n *\r\n * @param {object} tiledObject - Tiled object to convert to an internal parsed object normalising and copying properties over.\r\n * @param {number} [offsetX=0] - Optional additional offset to apply to the object's x property. Defaults to 0.\r\n * @param {number} [offsetY=0] - Optional additional offset to apply to the object's y property. Defaults to 0.\r\n *\r\n * @return {object} The parsed object containing properties read from the Tiled object according to it's type with x and y values updated according to the given offsets.\r\n */", "meta": { "filename": "ParseObject.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\tiled", "code": {} }, "description": "Convert a Tiled object to an internal parsed object normalising and copying properties over, while applying optional x and y offsets. The parsed object will always have the properties `id`, `name`, `type`, `rotation`, `properties`, `visible`, `x`, `y`, `width` and `height`. Other properties will be added according to the object type (such as text, polyline, gid etc.)", "kind": "function", "name": "ParseObject", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "Tiled object to convert to an internal parsed object normalising and copying properties over.", "name": "tiledObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional additional offset to apply to the object's x property. Defaults to 0.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional additional offset to apply to the object's y property. Defaults to 0.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The parsed object containing properties read from the Tiled object according to it's type with x and y values updated according to the given offsets." } ], "memberof": "Phaser.Tilemaps.Parsers.Tiled", "longname": "Phaser.Tilemaps.Parsers.Tiled.ParseObject", "scope": "static", "___id": "T000002R042143", "___s": true }, { "comment": "/**\r\n * Parses a Tiled JSON object into an array of ObjectLayer objects.\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Tiled.ParseObjectLayers\r\n * @since 3.0.0\r\n *\r\n * @param {object} json - The Tiled JSON object.\r\n *\r\n * @return {array} An array of all object layers in the tilemap as `ObjectLayer`s.\r\n */", "meta": { "filename": "ParseObjectLayers.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\tiled", "code": {} }, "description": "Parses a Tiled JSON object into an array of ObjectLayer objects.", "kind": "function", "name": "ParseObjectLayers", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The Tiled JSON object.", "name": "json" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "An array of all object layers in the tilemap as `ObjectLayer`s." } ], "memberof": "Phaser.Tilemaps.Parsers.Tiled", "longname": "Phaser.Tilemaps.Parsers.Tiled.ParseObjectLayers", "scope": "static", "___id": "T000002R042166", "___s": true }, { "comment": "/**\r\n * Parses all tilemap layers in a Tiled JSON object into new LayerData objects.\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Tiled.ParseTileLayers\r\n * @since 3.0.0\r\n *\r\n * @param {object} json - The Tiled JSON object.\r\n * @param {boolean} insertNull - Controls how empty tiles, tiles with an index of -1, in the map\r\n * data are handled (see {@link Phaser.Tilemaps.Parsers.Tiled.ParseJSONTiled}).\r\n *\r\n * @return {Phaser.Tilemaps.LayerData[]} - An array of LayerData objects, one for each entry in\r\n * json.layers with the type 'tilelayer'.\r\n */", "meta": { "filename": "ParseTileLayers.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\tiled", "code": {} }, "description": "Parses all tilemap layers in a Tiled JSON object into new LayerData objects.", "kind": "function", "name": "ParseTileLayers", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The Tiled JSON object.", "name": "json" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Controls how empty tiles, tiles with an index of -1, in the map\rdata are handled (see {@link Phaser.Tilemaps.Parsers.Tiled.ParseJSONTiled}).", "name": "insertNull" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.LayerData", "type": "NameExpression" } ] } }, "description": "- An array of LayerData objects, one for each entry in\rjson.layers with the type 'tilelayer'." } ], "memberof": "Phaser.Tilemaps.Parsers.Tiled", "longname": "Phaser.Tilemaps.Parsers.Tiled.ParseTileLayers", "scope": "static", "___id": "T000002R042194", "___s": true }, { "comment": "/**\r\n * Tilesets and Image Collections.\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Tiled.ParseTilesets\r\n * @since 3.0.0\r\n *\r\n * @param {object} json - The Tiled JSON data.\r\n *\r\n * @return {object} An object containing the tileset and image collection data.\r\n */", "meta": { "filename": "ParseTilesets.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\tiled", "code": {} }, "description": "Tilesets and Image Collections.", "kind": "function", "name": "ParseTilesets", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The Tiled JSON data.", "name": "json" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "An object containing the tileset and image collection data." } ], "memberof": "Phaser.Tilemaps.Parsers.Tiled", "longname": "Phaser.Tilemaps.Parsers.Tiled.ParseTilesets", "scope": "static", "___id": "T000002R042285", "___s": true }, { "comment": "/**\r\n * Parses out the Wangset information from Tiled 1.1.5+ map data, if present.\r\n *\r\n * Since a given tile can be in more than one wangset, the resulting properties\r\n * are nested. `tile.data.wangid[someWangsetName]` will return the array-based wang id in\r\n * this implementation.\r\n *\r\n * Note that we're not guaranteed that there will be any 'normal' tiles if the only\r\n * thing in the tilset are wangtile definitions, so this has to be parsed separately.\r\n *\r\n * See https://doc.mapeditor.org/en/latest/manual/using-wang-tiles/ for more information.\r\n *\r\n * @function Phaser.Tilemaps.Parsers.Tiled.ParseWangsets\r\n * @since 3.53.0\r\n *\r\n * @param {Array.} wangsets - The array of wangset objects (parsed from JSON)\r\n * @param {object} datas - The field into which to put wangset data from Tiled.\r\n *\r\n * @return {object} An object containing the tileset and image collection data.\r\n */", "meta": { "filename": "ParseWangsets.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\parsers\\tiled", "code": {} }, "description": "Parses out the Wangset information from Tiled 1.1.5+ map data, if present.\r\rSince a given tile can be in more than one wangset, the resulting properties\rare nested. `tile.data.wangid[someWangsetName]` will return the array-based wang id in\rthis implementation.\r\rNote that we're not guaranteed that there will be any 'normal' tiles if the only\rthing in the tilset are wangtile definitions, so this has to be parsed separately.\r\rSee https://doc.mapeditor.org/en/latest/manual/using-wang-tiles/ for more information.", "kind": "function", "name": "ParseWangsets", "since": "3.53.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "object" } ] } }, "description": "The array of wangset objects (parsed from JSON)", "name": "wangsets" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The field into which to put wangset data from Tiled.", "name": "datas" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "An object containing the tileset and image collection data." } ], "memberof": "Phaser.Tilemaps.Parsers.Tiled", "longname": "Phaser.Tilemaps.Parsers.Tiled.ParseWangsets", "scope": "static", "___id": "T000002R042334", "___s": true }, { "comment": "/**\r\n * Create a Tilemap from the given key or data. If neither is given, make a blank Tilemap. When\r\n * loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing from\r\n * a map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map data. For\r\n * an empty map, you should specify tileWidth, tileHeight, width & height.\r\n *\r\n * @function Phaser.Tilemaps.ParseToTilemap\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Tilemap belongs.\r\n * @param {string} [key] - The key in the Phaser cache that corresponds to the loaded tilemap data.\r\n * @param {number} [tileWidth=32] - The width of a tile in pixels.\r\n * @param {number} [tileHeight=32] - The height of a tile in pixels.\r\n * @param {number} [width=10] - The width of the map in tiles.\r\n * @param {number} [height=10] - The height of the map in tiles.\r\n * @param {number[][]} [data] - Instead of loading from the cache, you can also load directly from\r\n * a 2D array of tile indexes.\r\n * @param {boolean} [insertNull=false] - Controls how empty tiles, tiles with an index of -1, in the\r\n * map data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\r\n * location will get a Tile object with an index of -1. If you've a large sparsely populated map and\r\n * the tile data doesn't need to change then setting this value to `true` will help with memory\r\n * consumption. However if your map is small or you need to update the tiles dynamically, then leave\r\n * the default value set.\r\n *\r\n * @return {Phaser.Tilemaps.Tilemap}\r\n */", "meta": { "filename": "ParseToTilemap.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Create a Tilemap from the given key or data. If neither is given, make a blank Tilemap. When\rloading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing from\ra map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map data. For\ran empty map, you should specify tileWidth, tileHeight, width & height.", "kind": "function", "name": "ParseToTilemap", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Tilemap belongs.", "name": "scene" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The key in the Phaser cache that corresponds to the loaded tilemap data.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The width of a tile in pixels.", "name": "tileWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The height of a tile in pixels.", "name": "tileHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The width of the map in tiles.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The height of the map in tiles.", "name": "height" }, { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "Instead of loading from the cache, you can also load directly from\ra 2D array of tile indexes.", "name": "data" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Controls how empty tiles, tiles with an index of -1, in the\rmap data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\rlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\rthe tile data doesn't need to change then setting this value to `true` will help with memory\rconsumption. However if your map is small or you need to update the tiles dynamically, then leave\rthe default value set.", "name": "insertNull" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap" } } } ], "memberof": "Phaser.Tilemaps", "longname": "Phaser.Tilemaps.ParseToTilemap", "scope": "static", "___id": "T000002R042375", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Tile is a representation of a single tile within the Tilemap. This is a lightweight data\r\n * representation, so its position information is stored without factoring in scroll, layer\r\n * scale or layer position.\r\n *\r\n * @class Tile\r\n * @memberof Phaser.Tilemaps\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.GameObjects.Components.AlphaSingle\r\n * @extends Phaser.GameObjects.Components.Flip\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Tilemaps.LayerData} layer - The LayerData object in the Tilemap that this tile belongs to.\r\n * @param {number} index - The unique index of this tile within the map.\r\n * @param {number} x - The x coordinate of this tile in tile coordinates.\r\n * @param {number} y - The y coordinate of this tile in tile coordinates.\r\n * @param {number} width - Width of the tile in pixels.\r\n * @param {number} height - Height of the tile in pixels.\r\n * @param {number} baseWidth - The base width a tile in the map (in pixels). Tiled maps support\r\n * multiple tileset sizes within one map, but they are still placed at intervals of the base\r\n * tile width.\r\n * @param {number} baseHeight - The base height of the tile in pixels (in pixels). Tiled maps\r\n * support multiple tileset sizes within one map, but they are still placed at intervals of the\r\n * base tile height.\r\n */", "meta": { "filename": "Tile.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "classdesc": "A Tile is a representation of a single tile within the Tilemap. This is a lightweight data\rrepresentation, so its position information is stored without factoring in scroll, layer\rscale or layer position.", "kind": "class", "name": "Tile", "memberof": "Phaser.Tilemaps", "since": "3.0.0", "augments": [ "Phaser.GameObjects.Components.AlphaSingle", "Phaser.GameObjects.Components.Flip", "Phaser.GameObjects.Components.Visible" ], "params": [ { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "description": "The LayerData object in the Tilemap that this tile belongs to.", "name": "layer" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The unique index of this tile within the map.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of this tile in tile coordinates.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of this tile in tile coordinates.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the tile in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the tile in pixels.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The base width a tile in the map (in pixels). Tiled maps support\rmultiple tileset sizes within one map, but they are still placed at intervals of the base\rtile width.", "name": "baseWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The base height of the tile in pixels (in pixels). Tiled maps\rsupport multiple tileset sizes within one map, but they are still placed at intervals of the\rbase tile height.", "name": "baseHeight" } ], "scope": "static", "longname": "Phaser.Tilemaps.Tile", "___id": "T000002R042398", "___s": true }, { "comment": "/**\r\n * The LayerData in the Tilemap data that this tile belongs to.\r\n *\r\n * @name Phaser.Tilemaps.Tile#layer\r\n * @type {Phaser.Tilemaps.LayerData}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The LayerData in the Tilemap data that this tile belongs to.", "name": "layer", "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#layer", "scope": "instance", "kind": "member", "___id": "T000002R042402", "___s": true }, { "comment": "/**\r\n * The index of this tile within the map data corresponding to the tileset, or -1 if this\r\n * represents a blank tile.\r\n *\r\n * @name Phaser.Tilemaps.Tile#index\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The index of this tile within the map data corresponding to the tileset, or -1 if this\rrepresents a blank tile.", "name": "index", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#index", "scope": "instance", "kind": "member", "___id": "T000002R042404", "___s": true }, { "comment": "/**\r\n * The x map coordinate of this tile in tile units.\r\n *\r\n * @name Phaser.Tilemaps.Tile#x\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The x map coordinate of this tile in tile units.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#x", "scope": "instance", "kind": "member", "___id": "T000002R042406", "___s": true }, { "comment": "/**\r\n * The y map coordinate of this tile in tile units.\r\n *\r\n * @name Phaser.Tilemaps.Tile#y\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 81, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The y map coordinate of this tile in tile units.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#y", "scope": "instance", "kind": "member", "___id": "T000002R042408", "___s": true }, { "comment": "/**\r\n * The width of the tile in pixels.\r\n *\r\n * @name Phaser.Tilemaps.Tile#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 90, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The width of the tile in pixels.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#width", "scope": "instance", "kind": "member", "___id": "T000002R042410", "___s": true }, { "comment": "/**\r\n * The height of the tile in pixels.\r\n *\r\n * @name Phaser.Tilemaps.Tile#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The height of the tile in pixels.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#height", "scope": "instance", "kind": "member", "___id": "T000002R042412", "___s": true }, { "comment": "/**\r\n * The right of the tile in pixels.\r\n *\r\n * Set in the `updatePixelXY` method.\r\n *\r\n * @name Phaser.Tilemaps.Tile#right\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The right of the tile in pixels.\r\rSet in the `updatePixelXY` method.", "name": "right", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#right", "scope": "instance", "kind": "member", "___id": "T000002R042414", "___s": true }, { "comment": "/**\r\n * The bottom of the tile in pixels.\r\n *\r\n * Set in the `updatePixelXY` method.\r\n *\r\n * @name Phaser.Tilemaps.Tile#bottom\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 119, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The bottom of the tile in pixels.\r\rSet in the `updatePixelXY` method.", "name": "bottom", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#bottom", "scope": "instance", "kind": "member", "___id": "T000002R042416", "___s": true }, { "comment": "/**\r\n * The maps base width of a tile in pixels. Tiled maps support multiple tileset sizes\r\n * within one map, but they are still placed at intervals of the base tile size.\r\n *\r\n * @name Phaser.Tilemaps.Tile#baseWidth\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The maps base width of a tile in pixels. Tiled maps support multiple tileset sizes\rwithin one map, but they are still placed at intervals of the base tile size.", "name": "baseWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#baseWidth", "scope": "instance", "kind": "member", "___id": "T000002R042418", "___s": true }, { "comment": "/**\r\n * The maps base height of a tile in pixels. Tiled maps support multiple tileset sizes\r\n * within one map, but they are still placed at intervals of the base tile size.\r\n *\r\n * @name Phaser.Tilemaps.Tile#baseHeight\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The maps base height of a tile in pixels. Tiled maps support multiple tileset sizes\rwithin one map, but they are still placed at intervals of the base tile size.", "name": "baseHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#baseHeight", "scope": "instance", "kind": "member", "___id": "T000002R042420", "___s": true }, { "comment": "/**\r\n * The x coordinate of the top left of this tile in pixels. This is relative to the top left\r\n * of the layer this tile is being rendered within. This property does NOT factor in camera\r\n * scroll, layer scale or layer position.\r\n *\r\n * @name Phaser.Tilemaps.Tile#pixelX\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The x coordinate of the top left of this tile in pixels. This is relative to the top left\rof the layer this tile is being rendered within. This property does NOT factor in camera\rscroll, layer scale or layer position.", "name": "pixelX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#pixelX", "scope": "instance", "kind": "member", "___id": "T000002R042422", "___s": true }, { "comment": "/**\r\n * The y coordinate of the top left of this tile in pixels. This is relative to the top left\r\n * of the layer this tile is being rendered within. This property does NOT factor in camera\r\n * scroll, layer scale or layer position.\r\n *\r\n * @name Phaser.Tilemaps.Tile#pixelY\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The y coordinate of the top left of this tile in pixels. This is relative to the top left\rof the layer this tile is being rendered within. This property does NOT factor in camera\rscroll, layer scale or layer position.", "name": "pixelY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#pixelY", "scope": "instance", "kind": "member", "___id": "T000002R042424", "___s": true }, { "comment": "/**\r\n * Tile specific properties. These usually come from Tiled.\r\n *\r\n * @name Phaser.Tilemaps.Tile#properties\r\n * @type {any}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Tile specific properties. These usually come from Tiled.", "name": "properties", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#properties", "scope": "instance", "kind": "member", "___id": "T000002R042426", "___s": true }, { "comment": "/**\r\n * The rotation angle of this tile.\r\n *\r\n * @name Phaser.Tilemaps.Tile#rotation\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 183, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The rotation angle of this tile.", "name": "rotation", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#rotation", "scope": "instance", "kind": "member", "___id": "T000002R042428", "___s": true }, { "comment": "/**\r\n * Whether the tile should collide with any object on the left side.\r\n *\r\n * This property is used by Arcade Physics only, however, you can also use it\r\n * in your own checks.\r\n *\r\n * @name Phaser.Tilemaps.Tile#collideLeft\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 192, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Whether the tile should collide with any object on the left side.\r\rThis property is used by Arcade Physics only, however, you can also use it\rin your own checks.", "name": "collideLeft", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#collideLeft", "scope": "instance", "kind": "member", "___id": "T000002R042430", "___s": true }, { "comment": "/**\r\n * Whether the tile should collide with any object on the right side.\r\n *\r\n * This property is used by Arcade Physics only, however, you can also use it\r\n * in your own checks.\r\n *\r\n * @name Phaser.Tilemaps.Tile#collideRight\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 204, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Whether the tile should collide with any object on the right side.\r\rThis property is used by Arcade Physics only, however, you can also use it\rin your own checks.", "name": "collideRight", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#collideRight", "scope": "instance", "kind": "member", "___id": "T000002R042432", "___s": true }, { "comment": "/**\r\n * Whether the tile should collide with any object on the top side.\r\n *\r\n * This property is used by Arcade Physics only, however, you can also use it\r\n * in your own checks.\r\n *\r\n * @name Phaser.Tilemaps.Tile#collideUp\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Whether the tile should collide with any object on the top side.\r\rThis property is used by Arcade Physics only, however, you can also use it\rin your own checks.", "name": "collideUp", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#collideUp", "scope": "instance", "kind": "member", "___id": "T000002R042434", "___s": true }, { "comment": "/**\r\n * Whether the tile should collide with any object on the bottom side.\r\n *\r\n * This property is used by Arcade Physics only, however, you can also use it\r\n * in your own checks.\r\n *\r\n * @name Phaser.Tilemaps.Tile#collideDown\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 228, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Whether the tile should collide with any object on the bottom side.\r\rThis property is used by Arcade Physics only, however, you can also use it\rin your own checks.", "name": "collideDown", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#collideDown", "scope": "instance", "kind": "member", "___id": "T000002R042436", "___s": true }, { "comment": "/**\r\n * Whether the tiles left edge is interesting for collisions.\r\n *\r\n * @name Phaser.Tilemaps.Tile#faceLeft\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 240, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Whether the tiles left edge is interesting for collisions.", "name": "faceLeft", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#faceLeft", "scope": "instance", "kind": "member", "___id": "T000002R042438", "___s": true }, { "comment": "/**\r\n * Whether the tiles right edge is interesting for collisions.\r\n *\r\n * @name Phaser.Tilemaps.Tile#faceRight\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 249, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Whether the tiles right edge is interesting for collisions.", "name": "faceRight", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#faceRight", "scope": "instance", "kind": "member", "___id": "T000002R042440", "___s": true }, { "comment": "/**\r\n * Whether the tiles top edge is interesting for collisions.\r\n *\r\n * @name Phaser.Tilemaps.Tile#faceTop\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 258, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Whether the tiles top edge is interesting for collisions.", "name": "faceTop", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#faceTop", "scope": "instance", "kind": "member", "___id": "T000002R042442", "___s": true }, { "comment": "/**\r\n * Whether the tiles bottom edge is interesting for collisions.\r\n *\r\n * @name Phaser.Tilemaps.Tile#faceBottom\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 267, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Whether the tiles bottom edge is interesting for collisions.", "name": "faceBottom", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#faceBottom", "scope": "instance", "kind": "member", "___id": "T000002R042444", "___s": true }, { "comment": "/**\r\n * Tile collision callback.\r\n *\r\n * @name Phaser.Tilemaps.Tile#collisionCallback\r\n * @type {function}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 276, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Tile collision callback.", "name": "collisionCallback", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#collisionCallback", "scope": "instance", "kind": "member", "___id": "T000002R042446", "___s": true }, { "comment": "/**\r\n * The context in which the collision callback will be called.\r\n *\r\n * @name Phaser.Tilemaps.Tile#collisionCallbackContext\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 285, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The context in which the collision callback will be called.", "name": "collisionCallbackContext", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#collisionCallbackContext", "scope": "instance", "kind": "member", "___id": "T000002R042448", "___s": true }, { "comment": "/**\r\n * The tint to apply to this tile. Note: tint is currently a single color value instead of\r\n * the 4 corner tint component on other GameObjects.\r\n *\r\n * @name Phaser.Tilemaps.Tile#tint\r\n * @type {number}\r\n * @default\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 294, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The tint to apply to this tile. Note: tint is currently a single color value instead of\rthe 4 corner tint component on other GameObjects.", "name": "tint", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#tint", "scope": "instance", "kind": "member", "___id": "T000002R042450", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.Tilemaps.Tile#tintFill\r\n * @type {boolean}\r\n * @default\r\n * @since 3.61.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 305, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "name": "tintFill", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.61.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#tintFill", "scope": "instance", "kind": "member", "___id": "T000002R042452", "___s": true }, { "comment": "/**\r\n * An empty object where physics-engine specific information (e.g. bodies) may be stored.\r\n *\r\n * @name Phaser.Tilemaps.Tile#physics\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 318, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "An empty object where physics-engine specific information (e.g. bodies) may be stored.", "name": "physics", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#physics", "scope": "instance", "kind": "member", "___id": "T000002R042454", "___s": true }, { "comment": "/**\r\n * Check if the given x and y world coordinates are within this Tile. This does not factor in\r\n * camera scroll, layer scale or layer position.\r\n *\r\n * @method Phaser.Tilemaps.Tile#containsPoint\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate to test.\r\n * @param {number} y - The y coordinate to test.\r\n *\r\n * @return {boolean} True if the coordinates are within this Tile, otherwise false.\r\n */", "meta": { "filename": "Tile.js", "lineno": 328, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Check if the given x and y world coordinates are within this Tile. This does not factor in\rcamera scroll, layer scale or layer position.", "kind": "function", "name": "containsPoint", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to test.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to test.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the coordinates are within this Tile, otherwise false." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#containsPoint", "scope": "instance", "___id": "T000002R042456", "___s": true }, { "comment": "/**\r\n * Copies the tile data and properties from the given Tile to this Tile. This copies everything\r\n * except for position and interesting face calculations.\r\n *\r\n * @method Phaser.Tilemaps.Tile#copy\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Tilemaps.Tile} tile - The tile to copy from.\r\n *\r\n * @return {this} This Tile object instance.\r\n */", "meta": { "filename": "Tile.js", "lineno": 345, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Copies the tile data and properties from the given Tile to this Tile. This copies everything\rexcept for position and interesting face calculations.", "kind": "function", "name": "copy", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The tile to copy from.", "name": "tile" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tile object instance." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#copy", "scope": "instance", "___id": "T000002R042458", "___s": true }, { "comment": "/**\r\n * The collision group for this Tile, defined within the Tileset. This returns a reference to\r\n * the collision group stored within the Tileset, so any modification of the returned object\r\n * will impact all tiles that have the same index as this tile.\r\n *\r\n * @method Phaser.Tilemaps.Tile#getCollisionGroup\r\n * @since 3.0.0\r\n *\r\n * @return {?object} The collision group for this Tile, as defined in the Tileset, or `null` if no group was defined.\r\n */", "meta": { "filename": "Tile.js", "lineno": 375, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The collision group for this Tile, defined within the Tileset. This returns a reference to\rthe collision group stored within the Tileset, so any modification of the returned object\rwill impact all tiles that have the same index as this tile.", "kind": "function", "name": "getCollisionGroup", "since": "3.0.0", "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "nullable": true, "description": "The collision group for this Tile, as defined in the Tileset, or `null` if no group was defined." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#getCollisionGroup", "scope": "instance", "___id": "T000002R042472", "___s": true }, { "comment": "/**\r\n * The tile data for this Tile, defined within the Tileset. This typically contains Tiled\r\n * collision data, tile animations and terrain information. This returns a reference to the tile\r\n * data stored within the Tileset, so any modification of the returned object will impact all\r\n * tiles that have the same index as this tile.\r\n *\r\n * @method Phaser.Tilemaps.Tile#getTileData\r\n * @since 3.0.0\r\n *\r\n * @return {?object} The tile data for this Tile, as defined in the Tileset, or `null` if no data was defined.\r\n */", "meta": { "filename": "Tile.js", "lineno": 390, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The tile data for this Tile, defined within the Tileset. This typically contains Tiled\rcollision data, tile animations and terrain information. This returns a reference to the tile\rdata stored within the Tileset, so any modification of the returned object will impact all\rtiles that have the same index as this tile.", "kind": "function", "name": "getTileData", "since": "3.0.0", "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "nullable": true, "description": "The tile data for this Tile, as defined in the Tileset, or `null` if no data was defined." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#getTileData", "scope": "instance", "___id": "T000002R042474", "___s": true }, { "comment": "/**\r\n * Gets the world X position of the left side of the tile, factoring in the layers position,\r\n * scale and scroll.\r\n *\r\n * @method Phaser.Tilemaps.Tile#getLeft\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use to perform the check.\r\n *\r\n * @return {number} The left (x) value of this tile.\r\n */", "meta": { "filename": "Tile.js", "lineno": 406, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the world X position of the left side of the tile, factoring in the layers position,\rscale and scroll.", "kind": "function", "name": "getLeft", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use to perform the check.", "name": "camera" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left (x) value of this tile." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#getLeft", "scope": "instance", "___id": "T000002R042476", "___s": true }, { "comment": "/**\r\n * Gets the world X position of the right side of the tile, factoring in the layer's position,\r\n * scale and scroll.\r\n *\r\n * @method Phaser.Tilemaps.Tile#getRight\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use to perform the check.\r\n *\r\n * @return {number} The right (x) value of this tile.\r\n */", "meta": { "filename": "Tile.js", "lineno": 431, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the world X position of the right side of the tile, factoring in the layer's position,\rscale and scroll.", "kind": "function", "name": "getRight", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use to perform the check.", "name": "camera" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The right (x) value of this tile." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#getRight", "scope": "instance", "___id": "T000002R042480", "___s": true }, { "comment": "/**\r\n * Gets the world Y position of the top side of the tile, factoring in the layer's position,\r\n * scale and scroll.\r\n *\r\n * @method Phaser.Tilemaps.Tile#getTop\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use to perform the check.\r\n *\r\n * @return {number} The top (y) value of this tile.\r\n */", "meta": { "filename": "Tile.js", "lineno": 449, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the world Y position of the top side of the tile, factoring in the layer's position,\rscale and scroll.", "kind": "function", "name": "getTop", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use to perform the check.", "name": "camera" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top (y) value of this tile." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#getTop", "scope": "instance", "___id": "T000002R042483", "___s": true }, { "comment": "/**\r\n * Gets the world Y position of the bottom side of the tile, factoring in the layer's position,\r\n * scale and scroll.\r\n\r\n * @method Phaser.Tilemaps.Tile#getBottom\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use to perform the check.\r\n *\r\n * @return {number} The bottom (y) value of this tile.\r\n */", "meta": { "filename": "Tile.js", "lineno": 477, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the world Y position of the bottom side of the tile, factoring in the layer's position,\rscale and scroll.", "kind": "function", "name": "getBottom", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use to perform the check.", "name": "camera" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom (y) value of this tile." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#getBottom", "scope": "instance", "___id": "T000002R042487", "___s": true }, { "comment": "/**\r\n * Gets the world rectangle bounding box for the tile, factoring in the layers position,\r\n * scale and scroll.\r\n *\r\n * @method Phaser.Tilemaps.Tile#getBounds\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use to perform the check.\r\n * @param {Phaser.Geom.Rectangle} [output] - Optional Rectangle object to store the results in.\r\n *\r\n * @return {(Phaser.Geom.Rectangle|object)} The bounds of this Tile.\r\n */", "meta": { "filename": "Tile.js", "lineno": 497, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the world rectangle bounding box for the tile, factoring in the layers position,\rscale and scroll.", "kind": "function", "name": "getBounds", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use to perform the check.", "name": "camera" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "optional": true, "description": "Optional Rectangle object to store the results in.", "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 this Tile." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#getBounds", "scope": "instance", "___id": "T000002R042490", "___s": true }, { "comment": "/**\r\n * Gets the world X position of the center of the tile, factoring in the layer's position,\r\n * scale and scroll.\r\n *\r\n * @method Phaser.Tilemaps.Tile#getCenterX\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use to perform the check.\r\n *\r\n * @return {number} The center x position of this Tile.\r\n */", "meta": { "filename": "Tile.js", "lineno": 521, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the world X position of the center of the tile, factoring in the layer's position,\rscale and scroll.", "kind": "function", "name": "getCenterX", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use to perform the check.", "name": "camera" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The center x position of this Tile." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#getCenterX", "scope": "instance", "___id": "T000002R042497", "___s": true }, { "comment": "/**\r\n * Gets the world Y position of the center of the tile, factoring in the layer's position,\r\n * scale and scroll.\r\n *\r\n * @method Phaser.Tilemaps.Tile#getCenterY\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use to perform the check.\r\n *\r\n * @return {number} The center y position of this Tile.\r\n */", "meta": { "filename": "Tile.js", "lineno": 537, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the world Y position of the center of the tile, factoring in the layer's position,\rscale and scroll.", "kind": "function", "name": "getCenterY", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use to perform the check.", "name": "camera" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The center y position of this Tile." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#getCenterY", "scope": "instance", "___id": "T000002R042499", "___s": true }, { "comment": "/**\r\n * Check for intersection with this tile. This does not factor in camera scroll, layer scale or\r\n * layer position.\r\n *\r\n * @method Phaser.Tilemaps.Tile#intersects\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x axis in pixels.\r\n * @param {number} y - The y axis in pixels.\r\n * @param {number} right - The right point.\r\n * @param {number} bottom - The bottom point.\r\n *\r\n * @return {boolean} `true` if the Tile intersects with the given dimensions, otherwise `false`.\r\n */", "meta": { "filename": "Tile.js", "lineno": 553, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Check for intersection with this tile. This does not factor in camera scroll, layer scale or\rlayer position.", "kind": "function", "name": "intersects", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x axis in pixels.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y axis in pixels.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The right point.", "name": "right" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom point.", "name": "bottom" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Tile intersects with the given dimensions, otherwise `false`." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#intersects", "scope": "instance", "___id": "T000002R042501", "___s": true }, { "comment": "/**\r\n * Checks if the tile is interesting.\r\n *\r\n * @method Phaser.Tilemaps.Tile#isInteresting\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} collides - If true, will consider the tile interesting if it collides on any side.\r\n * @param {boolean} faces - If true, will consider the tile interesting if it has an interesting face.\r\n *\r\n * @return {boolean} True if the Tile is interesting, otherwise false.\r\n */", "meta": { "filename": "Tile.js", "lineno": 575, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Checks if the tile is interesting.", "kind": "function", "name": "isInteresting", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If true, will consider the tile interesting if it collides on any side.", "name": "collides" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If true, will consider the tile interesting if it has an interesting face.", "name": "faces" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Tile is interesting, otherwise false." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#isInteresting", "scope": "instance", "___id": "T000002R042503", "___s": true }, { "comment": "/**\r\n * Reset collision status flags.\r\n *\r\n * @method Phaser.Tilemaps.Tile#resetCollision\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [recalculateFaces=true] - Whether or not to recalculate interesting faces for this tile and its neighbors.\r\n *\r\n * @return {this} This Tile object instance.\r\n */", "meta": { "filename": "Tile.js", "lineno": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Reset collision status flags.", "kind": "function", "name": "resetCollision", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether or not to recalculate interesting faces for this tile and its neighbors.", "name": "recalculateFaces" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tile object instance." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#resetCollision", "scope": "instance", "___id": "T000002R042505", "___s": true }, { "comment": "/**\r\n * Reset faces.\r\n *\r\n * @method Phaser.Tilemaps.Tile#resetFaces\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Tile object instance.\r\n */", "meta": { "filename": "Tile.js", "lineno": 641, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Reset faces.", "kind": "function", "name": "resetFaces", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tile object instance." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#resetFaces", "scope": "instance", "___id": "T000002R042517", "___s": true }, { "comment": "/**\r\n * Sets the collision flags for each side of this tile and updates the interesting faces list.\r\n *\r\n * @method Phaser.Tilemaps.Tile#setCollision\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} left - Indicating collide with any object on the left.\r\n * @param {boolean} [right] - Indicating collide with any object on the right.\r\n * @param {boolean} [up] - Indicating collide with any object on the top.\r\n * @param {boolean} [down] - Indicating collide with any object on the bottom.\r\n * @param {boolean} [recalculateFaces=true] - Whether or not to recalculate interesting faces for this tile and its neighbors.\r\n *\r\n * @return {this} This Tile object instance.\r\n */", "meta": { "filename": "Tile.js", "lineno": 659, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets the collision flags for each side of this tile and updates the interesting faces list.", "kind": "function", "name": "setCollision", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicating collide with any object on the left.", "name": "left" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Indicating collide with any object on the right.", "name": "right" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Indicating collide with any object on the top.", "name": "up" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Indicating collide with any object on the bottom.", "name": "down" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether or not to recalculate interesting faces for this tile and its neighbors.", "name": "recalculateFaces" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tile object instance." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#setCollision", "scope": "instance", "___id": "T000002R042523", "___s": true }, { "comment": "/**\r\n * Set a callback to be called when this tile is hit by an object. The callback must true for\r\n * collision processing to take place.\r\n *\r\n * @method Phaser.Tilemaps.Tile#setCollisionCallback\r\n * @since 3.0.0\r\n *\r\n * @param {function} callback - Callback function.\r\n * @param {object} context - Callback will be called within this context.\r\n *\r\n * @return {this} This Tile object instance.\r\n */", "meta": { "filename": "Tile.js", "lineno": 703, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Set a callback to be called when this tile is hit by an object. The callback must true for\rcollision processing to take place.", "kind": "function", "name": "setCollisionCallback", "since": "3.0.0", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "Callback function.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "Callback will be called within this context.", "name": "context" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tile object instance." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#setCollisionCallback", "scope": "instance", "___id": "T000002R042538", "___s": true }, { "comment": "/**\r\n * Sets the size of the tile and updates its pixelX and pixelY.\r\n *\r\n * @method Phaser.Tilemaps.Tile#setSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileWidth - The width of the tile in pixels.\r\n * @param {number} tileHeight - The height of the tile in pixels.\r\n * @param {number} baseWidth - The base width a tile in the map (in pixels).\r\n * @param {number} baseHeight - The base height of the tile in pixels (in pixels).\r\n *\r\n * @return {this} This Tile object instance.\r\n */", "meta": { "filename": "Tile.js", "lineno": 731, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets the size of the tile and updates its pixelX and pixelY.", "kind": "function", "name": "setSize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the tile in pixels.", "name": "tileWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the tile in pixels.", "name": "tileHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The base width a tile in the map (in pixels).", "name": "baseWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The base height of the tile in pixels (in pixels).", "name": "baseHeight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tile object instance." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#setSize", "scope": "instance", "___id": "T000002R042544", "___s": true }, { "comment": "/**\r\n * Used internally. Updates the tiles world XY position based on the current tile size.\r\n *\r\n * @method Phaser.Tilemaps.Tile#updatePixelXY\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Tile object instance.\r\n */", "meta": { "filename": "Tile.js", "lineno": 756, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Used internally. Updates the tiles world XY position based on the current tile size.", "kind": "function", "name": "updatePixelXY", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tile object instance." } ], "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#updatePixelXY", "scope": "instance", "___id": "T000002R042550", "___s": true }, { "comment": "/**\r\n * Clean up memory.\r\n *\r\n * @method Phaser.Tilemaps.Tile#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 836, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Clean up memory.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#destroy", "scope": "instance", "___id": "T000002R042574", "___s": true }, { "comment": "/**\r\n * True if this tile can collide on any of its faces or has a collision callback set.\r\n *\r\n * @name Phaser.Tilemaps.Tile#canCollide\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 849, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "True if this tile can collide on any of its faces or has a collision callback set.", "name": "canCollide", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#canCollide", "scope": "instance", "kind": "member", "___id": "T000002R042579", "___s": true }, { "comment": "/**\r\n * True if this tile can collide on any of its faces.\r\n *\r\n * @name Phaser.Tilemaps.Tile#collides\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 866, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "True if this tile can collide on any of its faces.", "name": "collides", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#collides", "scope": "instance", "kind": "member", "___id": "T000002R042582", "___s": true }, { "comment": "/**\r\n * True if this tile has any interesting faces.\r\n *\r\n * @name Phaser.Tilemaps.Tile#hasInterestingFace\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 883, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "True if this tile has any interesting faces.", "name": "hasInterestingFace", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#hasInterestingFace", "scope": "instance", "kind": "member", "___id": "T000002R042585", "___s": true }, { "comment": "/**\r\n * The tileset that contains this Tile. This is null if accessed from a LayerData instance\r\n * before the tile is placed in a TilemapLayer, or if the tile has an index that doesn't correspond\r\n * to any of the maps tilesets.\r\n *\r\n * @name Phaser.Tilemaps.Tile#tileset\r\n * @type {?Phaser.Tilemaps.Tileset}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The tileset that contains this Tile. This is null if accessed from a LayerData instance\rbefore the tile is placed in a TilemapLayer, or if the tile has an index that doesn't correspond\rto any of the maps tilesets.", "name": "tileset", "type": { "names": [ "Phaser.Tilemaps.Tileset" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tileset", "nullable": true } }, "nullable": true, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#tileset", "scope": "instance", "kind": "member", "___id": "T000002R042588", "___s": true }, { "comment": "/**\r\n * The tilemap layer that contains this Tile. This will only return null if accessed from a\r\n * LayerData instance before the tile is placed within a TilemapLayer.\r\n *\r\n * @name Phaser.Tilemaps.Tile#tilemapLayer\r\n * @type {?Phaser.Tilemaps.TilemapLayer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 931, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The tilemap layer that contains this Tile. This will only return null if accessed from a\rLayerData instance before the tile is placed within a TilemapLayer.", "name": "tilemapLayer", "type": { "names": [ "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer", "nullable": true } }, "nullable": true, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#tilemapLayer", "scope": "instance", "kind": "member", "___id": "T000002R042593", "___s": true }, { "comment": "/**\r\n * The tilemap that contains this Tile. This will only return null if accessed from a LayerData\r\n * instance before the tile is placed within a TilemapLayer.\r\n *\r\n * @name Phaser.Tilemaps.Tile#tilemap\r\n * @type {?Phaser.Tilemaps.Tilemap}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tile.js", "lineno": 949, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The tilemap that contains this Tile. This will only return null if accessed from a LayerData\rinstance before the tile is placed within a TilemapLayer.", "name": "tilemap", "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "longname": "Phaser.Tilemaps.Tile#tilemap", "scope": "instance", "kind": "member", "___id": "T000002R042596", "___s": true }, { "comment": "/**\r\n * A predicate, to test each element of the array.\r\n *\r\n * @callback TilemapFilterCallback\r\n *\r\n * @param {Phaser.GameObjects.GameObject} value - An object found in the filtered area.\r\n * @param {number} index - The index of the object within the array.\r\n * @param {Phaser.GameObjects.GameObject[]} array - An array of all the objects found.\r\n *\r\n * @return {boolean} A value that coerces to `true` to keep the element, or to `false` otherwise.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 23, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "A predicate, to test each element of the array.", "kind": "typedef", "name": "TilemapFilterCallback", "type": { "names": [ "function" ] }, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "An object found in the filtered area.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the object within the array.", "name": "index" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "An array of all the objects found.", "name": "array" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "A value that coerces to `true` to keep the element, or to `false` otherwise." } ], "longname": "TilemapFilterCallback", "scope": "global", "___id": "T000002R042616", "___s": true }, { "comment": "/**\r\n * @callback TilemapFindCallback\r\n *\r\n * @param {Phaser.GameObjects.GameObject} value - An object found.\r\n * @param {number} index - The index of the object within the array.\r\n * @param {Phaser.GameObjects.GameObject[]} array - An array of all the objects found.\r\n *\r\n * @return {boolean} `true` if the callback should be invoked, otherwise `false`.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 35, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "kind": "typedef", "name": "TilemapFindCallback", "type": { "names": [ "function" ] }, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "An object found.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the object within the array.", "name": "index" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "An array of all the objects found.", "name": "array" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the callback should be invoked, otherwise `false`." } ], "longname": "TilemapFindCallback", "scope": "global", "___id": "T000002R042617", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Tilemap is a container for Tilemap data. This isn't a display object, rather, it holds data\r\n * about the map and allows you to add tilesets and tilemap layers to it. A map can have one or\r\n * more tilemap layers, which are the display objects that actually render the tiles.\r\n *\r\n * The Tilemap data can be parsed from a Tiled JSON file, a CSV file or a 2D array. Tiled is a free\r\n * software package specifically for creating tile maps, and is available from:\r\n * http://www.mapeditor.org\r\n *\r\n * As of Phaser 3.50.0 the Tilemap API now supports the following types of map:\r\n *\r\n * 1) Orthogonal\r\n * 2) Isometric\r\n * 3) Hexagonal\r\n * 4) Staggered\r\n *\r\n * Prior to this release, only orthogonal maps were supported.\r\n *\r\n * Another large change in 3.50 was the consolidation of Tilemap Layers. Previously, you created\r\n * either a Static or Dynamic Tilemap Layer. However, as of 3.50 the features of both have been\r\n * merged and the API simplified, so now there is just the single `TilemapLayer` class.\r\n *\r\n * A Tilemap has handy methods for getting and manipulating the tiles within a layer, allowing\r\n * you to build or modify the tilemap data at runtime.\r\n *\r\n * Note that all Tilemaps use a base tile size to calculate dimensions from, but that a\r\n * TilemapLayer may have its own unique tile size that overrides this.\r\n *\r\n * As of Phaser 3.21.0, if your tilemap includes layer groups (a feature of Tiled 1.2.0+) these\r\n * will be traversed and the following properties will impact children:\r\n *\r\n * - Opacity (blended with parent) and visibility (parent overrides child)\r\n * - Vertical and horizontal offset\r\n *\r\n * The grouping hierarchy is not preserved and all layers will be flattened into a single array.\r\n *\r\n * Group layers are parsed during Tilemap construction but are discarded after parsing so dynamic\r\n * layers will NOT continue to be affected by a parent.\r\n *\r\n * To avoid duplicate layer names, a layer that is a child of a group layer will have its parent\r\n * group name prepended with a '/'. For example, consider a group called 'ParentGroup' with a\r\n * child called 'Layer 1'. In the Tilemap object, 'Layer 1' will have the name\r\n * 'ParentGroup/Layer 1'.\r\n *\r\n * The Phaser Tiled Parser does **not** support the 'Collection of Images' feature for a Tileset.\r\n * You must ensure all of your tiles are contained in a single tileset image file (per layer)\r\n * and have this 'embedded' in the exported Tiled JSON map data.\r\n *\r\n * @class Tilemap\r\n * @memberof Phaser.Tilemaps\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Tilemap belongs.\r\n * @param {Phaser.Tilemaps.MapData} mapData - A MapData instance containing Tilemap data.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 45, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "classdesc": "A Tilemap is a container for Tilemap data. This isn't a display object, rather, it holds data\rabout the map and allows you to add tilesets and tilemap layers to it. A map can have one or\rmore tilemap layers, which are the display objects that actually render the tiles.\r\rThe Tilemap data can be parsed from a Tiled JSON file, a CSV file or a 2D array. Tiled is a free\rsoftware package specifically for creating tile maps, and is available from:\rhttp://www.mapeditor.org\r\rAs of Phaser 3.50.0 the Tilemap API now supports the following types of map:\r\r1) Orthogonal\r2) Isometric\r3) Hexagonal\r4) Staggered\r\rPrior to this release, only orthogonal maps were supported.\r\rAnother large change in 3.50 was the consolidation of Tilemap Layers. Previously, you created\reither a Static or Dynamic Tilemap Layer. However, as of 3.50 the features of both have been\rmerged and the API simplified, so now there is just the single `TilemapLayer` class.\r\rA Tilemap has handy methods for getting and manipulating the tiles within a layer, allowing\ryou to build or modify the tilemap data at runtime.\r\rNote that all Tilemaps use a base tile size to calculate dimensions from, but that a\rTilemapLayer may have its own unique tile size that overrides this.\r\rAs of Phaser 3.21.0, if your tilemap includes layer groups (a feature of Tiled 1.2.0+) these\rwill be traversed and the following properties will impact children:\r\r- Opacity (blended with parent) and visibility (parent overrides child)\r- Vertical and horizontal offset\r\rThe grouping hierarchy is not preserved and all layers will be flattened into a single array.\r\rGroup layers are parsed during Tilemap construction but are discarded after parsing so dynamic\rlayers will NOT continue to be affected by a parent.\r\rTo avoid duplicate layer names, a layer that is a child of a group layer will have its parent\rgroup name prepended with a '/'. For example, consider a group called 'ParentGroup' with a\rchild called 'Layer 1'. In the Tilemap object, 'Layer 1' will have the name\r'ParentGroup/Layer 1'.\r\rThe Phaser Tiled Parser does **not** support the 'Collection of Images' feature for a Tileset.\rYou must ensure all of your tiles are contained in a single tileset image file (per layer)\rand have this 'embedded' in the exported Tiled JSON map data.", "kind": "class", "name": "Tilemap", "memberof": "Phaser.Tilemaps", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Tilemap belongs.", "name": "scene" }, { "type": { "names": [ "Phaser.Tilemaps.MapData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.MapData" } }, "description": "A MapData instance containing Tilemap data.", "name": "mapData" } ], "scope": "static", "longname": "Phaser.Tilemaps.Tilemap", "___id": "T000002R042618", "___s": true }, { "comment": "/**\r\n * @name Phaser.Tilemaps.Tilemap#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#scene", "scope": "instance", "kind": "member", "___id": "T000002R042621", "___s": true }, { "comment": "/**\r\n * The base width of a tile in pixels. Note that individual layers may have a different tile\r\n * width.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#tileWidth\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 115, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The base width of a tile in pixels. Note that individual layers may have a different tile\rwidth.", "name": "tileWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#tileWidth", "scope": "instance", "kind": "member", "___id": "T000002R042623", "___s": true }, { "comment": "/**\r\n * The base height of a tile in pixels. Note that individual layers may have a different\r\n * tile height.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#tileHeight\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The base height of a tile in pixels. Note that individual layers may have a different\rtile height.", "name": "tileHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#tileHeight", "scope": "instance", "kind": "member", "___id": "T000002R042625", "___s": true }, { "comment": "/**\r\n * The width of the map (in tiles).\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 135, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The width of the map (in tiles).", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#width", "scope": "instance", "kind": "member", "___id": "T000002R042627", "___s": true }, { "comment": "/**\r\n * The height of the map (in tiles).\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 144, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The height of the map (in tiles).", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#height", "scope": "instance", "kind": "member", "___id": "T000002R042629", "___s": true }, { "comment": "/**\r\n * The orientation of the map data (as specified in Tiled), usually 'orthogonal'.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#orientation\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 153, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The orientation of the map data (as specified in Tiled), usually 'orthogonal'.", "name": "orientation", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#orientation", "scope": "instance", "kind": "member", "___id": "T000002R042631", "___s": true }, { "comment": "/**\r\n * The render (draw) order of the map data (as specified in Tiled), usually 'right-down'.\r\n *\r\n * The draw orders are:\r\n *\r\n * right-down\r\n * left-down\r\n * right-up\r\n * left-up\r\n *\r\n * This can be changed via the `setRenderOrder` method.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#renderOrder\r\n * @type {string}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 162, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The render (draw) order of the map data (as specified in Tiled), usually 'right-down'.\r\rThe draw orders are:\r\rright-down\rleft-down\rright-up\rleft-up\r\rThis can be changed via the `setRenderOrder` method.", "name": "renderOrder", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.12.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#renderOrder", "scope": "instance", "kind": "member", "___id": "T000002R042633", "___s": true }, { "comment": "/**\r\n * The format of the map data.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#format\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 180, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The format of the map data.", "name": "format", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#format", "scope": "instance", "kind": "member", "___id": "T000002R042635", "___s": true }, { "comment": "/**\r\n * The version of the map data (as specified in Tiled, usually 1).\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#version\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 189, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The version of the map data (as specified in Tiled, usually 1).", "name": "version", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#version", "scope": "instance", "kind": "member", "___id": "T000002R042637", "___s": true }, { "comment": "/**\r\n * Map specific properties as specified in Tiled.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#properties\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 198, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Map specific properties as specified in Tiled.", "name": "properties", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#properties", "scope": "instance", "kind": "member", "___id": "T000002R042639", "___s": true }, { "comment": "/**\r\n * The width of the map in pixels based on width * tileWidth.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#widthInPixels\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The width of the map in pixels based on width * tileWidth.", "name": "widthInPixels", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#widthInPixels", "scope": "instance", "kind": "member", "___id": "T000002R042641", "___s": true }, { "comment": "/**\r\n * The height of the map in pixels based on height * tileHeight.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#heightInPixels\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The height of the map in pixels based on height * tileHeight.", "name": "heightInPixels", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#heightInPixels", "scope": "instance", "kind": "member", "___id": "T000002R042643", "___s": true }, { "comment": "/**\r\n * A collection of Images, as parsed from Tiled map data.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#imageCollections\r\n * @type {Phaser.Tilemaps.ImageCollection[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "A collection of Images, as parsed from Tiled map data.", "name": "imageCollections", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.ImageCollection", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#imageCollections", "scope": "instance", "kind": "member", "___id": "T000002R042645", "___s": true }, { "comment": "/**\r\n * An array of Tiled Image Layers.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#images\r\n * @type {array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "An array of Tiled Image Layers.", "name": "images", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#images", "scope": "instance", "kind": "member", "___id": "T000002R042647", "___s": true }, { "comment": "/**\r\n * An array of Tilemap layer data.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#layers\r\n * @type {Phaser.Tilemaps.LayerData[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 243, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "An array of Tilemap layer data.", "name": "layers", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.LayerData", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#layers", "scope": "instance", "kind": "member", "___id": "T000002R042649", "___s": true }, { "comment": "/**\r\n * Master list of tiles -> x, y, index in tileset.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#tiles\r\n * @type {array}\r\n * @since 3.60.0\r\n * @see Phaser.Tilemaps.Parsers.Tiled.BuildTilesetIndex\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 252, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Master list of tiles -> x, y, index in tileset.", "name": "tiles", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.60.0", "see": [ "Phaser.Tilemaps.Parsers.Tiled.BuildTilesetIndex" ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#tiles", "scope": "instance", "kind": "member", "___id": "T000002R042651", "___s": true }, { "comment": "/**\r\n * An array of Tilesets used in the map.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#tilesets\r\n * @type {Phaser.Tilemaps.Tileset[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 262, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "An array of Tilesets used in the map.", "name": "tilesets", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tileset", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#tilesets", "scope": "instance", "kind": "member", "___id": "T000002R042653", "___s": true }, { "comment": "/**\r\n * An array of ObjectLayer instances parsed from Tiled object layers.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#objects\r\n * @type {Phaser.Tilemaps.ObjectLayer[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 271, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "An array of ObjectLayer instances parsed from Tiled object layers.", "name": "objects", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.ObjectLayer", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#objects", "scope": "instance", "kind": "member", "___id": "T000002R042655", "___s": true }, { "comment": "/**\r\n * The index of the currently selected LayerData object.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#currentLayerIndex\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 280, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The index of the currently selected LayerData object.", "name": "currentLayerIndex", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#currentLayerIndex", "scope": "instance", "kind": "member", "___id": "T000002R042657", "___s": true }, { "comment": "/**\r\n * The length of the horizontal sides of the hexagon.\r\n * Only used for hexagonal orientation Tilemaps.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#hexSideLength\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The length of the horizontal sides of the hexagon.\rOnly used for hexagonal orientation Tilemaps.", "name": "hexSideLength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#hexSideLength", "scope": "instance", "kind": "member", "___id": "T000002R042659", "___s": true }, { "comment": "/**\r\n * Sets the rendering (draw) order of the tiles in this map.\r\n *\r\n * The default is 'right-down', meaning it will order the tiles starting from the top-left,\r\n * drawing to the right and then moving down to the next row.\r\n *\r\n * The draw orders are:\r\n *\r\n * 0 = right-down\r\n * 1 = left-down\r\n * 2 = right-up\r\n * 3 = left-up\r\n *\r\n * Setting the render order does not change the tiles or how they are stored in the layer,\r\n * it purely impacts the order in which they are rendered.\r\n *\r\n * You can provide either an integer (0 to 3), or the string version of the order.\r\n *\r\n * Calling this method _after_ creating Tilemap Layers will **not** automatically\r\n * update them to use the new render order. If you call this method after creating layers, use their\r\n * own `setRenderOrder` methods to change them as needed.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#setRenderOrder\r\n * @since 3.12.0\r\n *\r\n * @param {(number|string)} renderOrder - The render (draw) order value. Either an integer between 0 and 3, or a string: 'right-down', 'left-down', 'right-up' or 'left-up'.\r\n *\r\n * @return {this} This Tilemap object.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 321, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets the rendering (draw) order of the tiles in this map.\r\rThe default is 'right-down', meaning it will order the tiles starting from the top-left,\rdrawing to the right and then moving down to the next row.\r\rThe draw orders are:\r\r0 = right-down\r1 = left-down\r2 = right-up\r3 = left-up\r\rSetting the render order does not change the tiles or how they are stored in the layer,\rit purely impacts the order in which they are rendered.\r\rYou can provide either an integer (0 to 3), or the string version of the order.\r\rCalling this method _after_ creating Tilemap Layers will **not** automatically\rupdate them to use the new render order. If you call this method after creating layers, use their\rown `setRenderOrder` methods to change them as needed.", "kind": "function", "name": "setRenderOrder", "since": "3.12.0", "params": [ { "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The render (draw) order value. Either an integer between 0 and 3, or a string: 'right-down', 'left-down', 'right-up' or 'left-up'.", "name": "renderOrder" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap object." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#setRenderOrder", "scope": "instance", "___id": "T000002R042671", "___s": true }, { "comment": "/**\r\n * Adds an image to the map to be used as a tileset. A single map may use multiple tilesets.\r\n * Note that the tileset name can be found in the JSON file exported from Tiled, or in the Tiled\r\n * editor.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#addTilesetImage\r\n * @since 3.0.0\r\n *\r\n * @param {string} tilesetName - The name of the tileset as specified in the map data.\r\n * @param {string} [key] - The key of the Phaser.Cache image used for this tileset. If\r\n * `undefined` or `null` it will look for an image with a key matching the tilesetName parameter.\r\n * @param {number} [tileWidth] - The width of the tile (in pixels) in the Tileset Image. If not\r\n * given it will default to the map's tileWidth value, or the tileWidth specified in the Tiled\r\n * JSON file.\r\n * @param {number} [tileHeight] - The height of the tiles (in pixels) in the Tileset Image. If\r\n * not given it will default to the map's tileHeight value, or the tileHeight specified in the\r\n * Tiled JSON file.\r\n * @param {number} [tileMargin] - The margin around the tiles in the sheet (in pixels). If not\r\n * specified, it will default to 0 or the value specified in the Tiled JSON file.\r\n * @param {number} [tileSpacing] - The spacing between each the tile in the sheet (in pixels).\r\n * If not specified, it will default to 0 or the value specified in the Tiled JSON file.\r\n * @param {number} [gid=0] - If adding multiple tilesets to a blank map, specify the starting\r\n * GID this set will use here.\r\n * @param {object} [tileOffset={x: 0, y: 0}] - Tile texture drawing offset.\r\n * If not specified, it will default to {0, 0}\r\n *\r\n * @return {?Phaser.Tilemaps.Tileset} Returns the Tileset object that was created or updated, or null if it\r\n * failed.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 367, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Adds an image to the map to be used as a tileset. A single map may use multiple tilesets.\rNote that the tileset name can be found in the JSON file exported from Tiled, or in the Tiled\reditor.", "kind": "function", "name": "addTilesetImage", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the tileset as specified in the map data.", "name": "tilesetName" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The key of the Phaser.Cache image used for this tileset. If\r`undefined` or `null` it will look for an image with a key matching the tilesetName parameter.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the tile (in pixels) in the Tileset Image. If not\rgiven it will default to the map's tileWidth value, or the tileWidth specified in the Tiled\rJSON file.", "name": "tileWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the tiles (in pixels) in the Tileset Image. If\rnot given it will default to the map's tileHeight value, or the tileHeight specified in the\rTiled JSON file.", "name": "tileHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The margin around the tiles in the sheet (in pixels). If not\rspecified, it will default to 0 or the value specified in the Tiled JSON file.", "name": "tileMargin" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The spacing between each the tile in the sheet (in pixels).\rIf not specified, it will default to 0 or the value specified in the Tiled JSON file.", "name": "tileSpacing" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "If adding multiple tilesets to a blank map, specify the starting\rGID this set will use here.", "name": "gid" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "defaultvalue": "{x: 0, y: 0}", "description": "Tile texture drawing offset.\rIf not specified, it will default to {0, 0}", "name": "tileOffset" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tileset" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tileset", "nullable": true } }, "nullable": true, "description": "Returns the Tileset object that was created or updated, or null if it\rfailed." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#addTilesetImage", "scope": "instance", "___id": "T000002R042676", "___s": true }, { "comment": "/**\r\n * Copies the tiles in the source rectangular area to a new destination (all specified in tile\r\n * coordinates) within the layer. This copies all tile properties & recalculates collision\r\n * information in the destination region.\r\n *\r\n * If no layer specified, the map's current layer is used. This cannot be applied to StaticTilemapLayers.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#copy\r\n * @since 3.0.0\r\n *\r\n * @param {number} srcTileX - The x coordinate of the area to copy from, in tiles, not pixels.\r\n * @param {number} srcTileY - The y coordinate of the area to copy from, in tiles, not pixels.\r\n * @param {number} width - The width of the area to copy, in tiles, not pixels.\r\n * @param {number} height - The height of the area to copy, in tiles, not pixels.\r\n * @param {number} destTileX - The x coordinate of the area to copy to, in tiles, not pixels.\r\n * @param {number} destTileY - The y coordinate of the area to copy to, in tiles, not pixels.\r\n * @param {boolean} [recalculateFaces=true] - `true` if the faces data should be recalculated.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Returns this, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 446, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Copies the tiles in the source rectangular area to a new destination (all specified in tile\rcoordinates) within the layer. This copies all tile properties & recalculates collision\rinformation in the destination region.\r\rIf no layer specified, the map's current layer is used. This cannot be applied to StaticTilemapLayers.", "kind": "function", "name": "copy", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the area to copy from, in tiles, not pixels.", "name": "srcTileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the area to copy from, in tiles, not pixels.", "name": "srcTileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the area to copy, in tiles, not pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the area to copy, in tiles, not pixels.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the area to copy to, in tiles, not pixels.", "name": "destTileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the area to copy to, in tiles, not pixels.", "name": "destTileY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Returns this, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#copy", "scope": "instance", "___id": "T000002R042692", "___s": true }, { "comment": "/**\r\n * Creates a new and empty Tilemap Layer. The currently selected layer in the map is set to this new layer.\r\n *\r\n * Prior to v3.50.0 this method was called `createBlankDynamicLayer`.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#createBlankLayer\r\n * @since 3.0.0\r\n *\r\n * @param {string} name - The name of this layer. Must be unique within the map.\r\n * @param {(string|string[]|Phaser.Tilemaps.Tileset|Phaser.Tilemaps.Tileset[])} tileset - The tileset, or an array of tilesets, used to render this layer. Can be a string or a Tileset object.\r\n * @param {number} [x=0] - The world x position where the top left of this layer will be placed.\r\n * @param {number} [y=0] - The world y position where the top left of this layer will be placed.\r\n * @param {number} [width] - The width of the layer in tiles. If not specified, it will default to the map's width.\r\n * @param {number} [height] - The height of the layer in tiles. If not specified, it will default to the map's height.\r\n * @param {number} [tileWidth] - The width of the tiles the layer uses for calculations. If not specified, it will default to the map's tileWidth.\r\n * @param {number} [tileHeight] - The height of the tiles the layer uses for calculations. If not specified, it will default to the map's tileHeight.\r\n *\r\n * @return {?Phaser.Tilemaps.TilemapLayer} Returns the new layer that was created, or `null` if it failed.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 488, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Creates a new and empty Tilemap Layer. The currently selected layer in the map is set to this new layer.\r\rPrior to v3.50.0 this method was called `createBlankDynamicLayer`.", "kind": "function", "name": "createBlankLayer", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of this layer. Must be unique within the map.", "name": "name" }, { "type": { "names": [ "string", "Array.", "Phaser.Tilemaps.Tileset", "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.Tilemaps.Tileset" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tileset", "type": "NameExpression" } ] } ] } }, "description": "The tileset, or an array of tilesets, used to render this layer. Can be a string or a Tileset object.", "name": "tileset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The world x position where the top left of this layer will be placed.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The world y position where the top left of this layer will be placed.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the layer in tiles. If not specified, it will default to the map's width.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the layer in tiles. If not specified, it will default to the map's height.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the tiles the layer uses for calculations. If not specified, it will default to the map's tileWidth.", "name": "tileWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the tiles the layer uses for calculations. If not specified, it will default to the map's tileHeight.", "name": "tileHeight" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer", "nullable": true } }, "nullable": true, "description": "Returns the new layer that was created, or `null` if it failed." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#createBlankLayer", "scope": "instance", "___id": "T000002R042695", "___s": true }, { "comment": "/**\r\n * Creates a new Tilemap Layer that renders the LayerData associated with the given\r\n * `layerID`. The currently selected layer in the map is set to this new layer.\r\n *\r\n * The `layerID` is important. If you've created your map in Tiled then you can get this by\r\n * looking in Tiled and looking at the layer name. Or you can open the JSON file it exports and\r\n * look at the layers[].name value. Either way it must match.\r\n *\r\n * Prior to v3.50.0 this method was called `createDynamicLayer`.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#createLayer\r\n * @since 3.0.0\r\n *\r\n * @param {(number|string)} layerID - The layer array index value, or if a string is given, the layer name from Tiled.\r\n * @param {(string|string[]|Phaser.Tilemaps.Tileset|Phaser.Tilemaps.Tileset[])} tileset - The tileset, or an array of tilesets, used to render this layer. Can be a string or a Tileset object.\r\n * @param {number} [x=0] - The x position to place the layer in the world. If not specified, it will default to the layer offset from Tiled or 0.\r\n * @param {number} [y=0] - The y position to place the layer in the world. If not specified, it will default to the layer offset from Tiled or 0.\r\n *\r\n * @return {?Phaser.Tilemaps.TilemapLayer} Returns the new layer was created, or null if it failed.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 560, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Creates a new Tilemap Layer that renders the LayerData associated with the given\r`layerID`. The currently selected layer in the map is set to this new layer.\r\rThe `layerID` is important. If you've created your map in Tiled then you can get this by\rlooking in Tiled and looking at the layer name. Or you can open the JSON file it exports and\rlook at the layers[].name value. Either way it must match.\r\rPrior to v3.50.0 this method was called `createDynamicLayer`.", "kind": "function", "name": "createLayer", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The layer array index value, or if a string is given, the layer name from Tiled.", "name": "layerID" }, { "type": { "names": [ "string", "Array.", "Phaser.Tilemaps.Tileset", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Tilemaps.Tileset" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tileset", "type": "NameExpression" } ] } ] } }, "description": "The tileset, or an array of tilesets, used to render this layer. Can be a string or a Tileset object.", "name": "tileset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position to place the layer in the world. If not specified, it will default to the layer offset from Tiled or 0.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position to place the layer in the world. If not specified, it will default to the layer offset from Tiled or 0.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer", "nullable": true } }, "nullable": true, "description": "Returns the new layer was created, or null if it failed." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#createLayer", "scope": "instance", "___id": "T000002R042717", "___s": true }, { "comment": "/**\r\n * This method will iterate through all of the objects defined in a Tiled Object Layer and then\r\n * convert the matching results into Phaser Game Objects (by default, Sprites)\r\n *\r\n * Objects are matched on one of 4 criteria: The Object ID, the Object GID, the Object Name, or the Object Type.\r\n *\r\n * Within Tiled, Object IDs are unique per Object. Object GIDs, however, are shared by all objects\r\n * using the same image. Finally, Object Names and Types are strings and the same name can be used on multiple\r\n * Objects in Tiled, they do not have to be unique; Names are specific to Objects while Types can be inherited\r\n * from Object GIDs using the same image.\r\n *\r\n * You set the configuration parameter accordingly, based on which type of criteria you wish\r\n * to match against. For example, to convert all items on an Object Layer with a `gid` of 26:\r\n *\r\n * ```javascript\r\n * createFromObjects(layerName, {\r\n * gid: 26\r\n * });\r\n * ```\r\n *\r\n * Or, to convert objects with the name 'bonus':\r\n *\r\n * ```javascript\r\n * createFromObjects(layerName, {\r\n * name: 'bonus'\r\n * });\r\n * ```\r\n *\r\n * Or, to convert an object with a specific id:\r\n *\r\n * ```javascript\r\n * createFromObjects(layerName, {\r\n * id: 9\r\n * });\r\n * ```\r\n *\r\n * You should only specify either `id`, `gid`, `name`, `type`, or none of them. Do not add more than\r\n * one criteria to your config. If you do not specify any criteria, then _all_ objects in the\r\n * Object Layer will be converted.\r\n *\r\n * By default this method will convert Objects into {@link Phaser.GameObjects.Sprite} instances, but you can override\r\n * this by providing your own class type:\r\n *\r\n * ```javascript\r\n * createFromObjects(layerName, {\r\n * gid: 26,\r\n * classType: Coin\r\n * });\r\n * ```\r\n *\r\n * This will convert all Objects with a gid of 26 into your custom `Coin` class. You can pass\r\n * any class type here, but it _must_ extend {@link Phaser.GameObjects.GameObject} as its base class.\r\n * Your class will always be passed 1 parameter: `scene`, which is a reference to either the Scene\r\n * specified in the config object or, if not given, the Scene to which this Tilemap belongs. The\r\n * class must have {@link Phaser.GameObjects.Components.Transform#setPosition setPosition} and\r\n * {@link Phaser.GameObjects.Components.Texture#setTexture setTexture} methods.\r\n *\r\n * This method will set the following Tiled Object properties on the new Game Object:\r\n *\r\n * - `flippedHorizontal` as `flipX`\r\n * - `flippedVertical` as `flipY`\r\n * - `height` as `displayHeight`\r\n * - `name`\r\n * - `rotation`\r\n * - `visible`\r\n * - `width` as `displayWidth`\r\n * - `x`, adjusted for origin\r\n * - `y`, adjusted for origin\r\n *\r\n * Additionally, this method will set Tiled Object custom properties\r\n *\r\n * - on the Game Object, if it has the same property name and a value that isn't `undefined`; or\r\n * - on the Game Object's {@link Phaser.GameObjects.GameObject#data data store} otherwise.\r\n *\r\n * For example, a Tiled Object with custom properties `{ alpha: 0.5, gold: 1 }` will be created as a Game\r\n * Object with an `alpha` value of 0.5 and a `data.values.gold` value of 1.\r\n *\r\n * When `useTileset` is `true` (the default), Tile Objects will inherit the texture and any tile properties\r\n * from the tileset, and the local tile ID will be used as the texture frame. For the frame selection to work\r\n * you need to load the tileset texture as a spritesheet so its frame names match the local tile IDs.\r\n *\r\n * For instance, a tileset tile\r\n *\r\n * ```\r\n * { id: 3, type: 'treadmill', speed: 4 }\r\n * ```\r\n *\r\n * with gid 19 and an object\r\n *\r\n * ```\r\n * { id: 7, gid: 19, speed: 5, rotation: 90 }\r\n * ```\r\n *\r\n * will be interpreted as\r\n *\r\n * ```\r\n * { id: 7, gid: 19, speed: 5, rotation: 90, type: 'treadmill', texture: '[the tileset texture]', frame: 3 }\r\n * ```\r\n *\r\n * You can suppress this behavior by setting the boolean `ignoreTileset` for each `config` that should ignore\r\n * object gid tilesets.\r\n *\r\n * You can set a `container` property in the config. If given, the new Game Object will be added to\r\n * the Container or Layer instance instead of the Scene.\r\n *\r\n * You can set named texture-`key` and texture-`frame` properties, which will be set on the new Game Object.\r\n *\r\n * Finally, you can provide an array of config objects, to convert multiple types of object in\r\n * a single call:\r\n *\r\n * ```javascript\r\n * createFromObjects(layerName, [\r\n * {\r\n * gid: 26,\r\n * classType: Coin\r\n * },\r\n * {\r\n * id: 9,\r\n * classType: BossMonster\r\n * },\r\n * {\r\n * name: 'lava',\r\n * classType: LavaTile\r\n * },\r\n * {\r\n * type: 'endzone',\r\n * classType: Phaser.GameObjects.Zone\r\n * }\r\n * ]);\r\n * ```\r\n *\r\n * The signature of this method changed significantly in v3.60.0. Prior to this, it did not take config objects.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#createFromObjects\r\n * @since 3.0.0\r\n *\r\n * @param {string} objectLayerName - The name of the Tiled object layer to create the Game Objects from.\r\n * @param {Phaser.Types.Tilemaps.CreateFromObjectLayerConfig|Phaser.Types.Tilemaps.CreateFromObjectLayerConfig[]} config - A CreateFromObjects configuration object, or an array of them.\r\n * @param {boolean} [useTileset=true] - True if objects that set gids should also search the underlying tile for properties and data.\r\n *\r\n * @return {Phaser.GameObjects.GameObject[]} An array containing the Game Objects that were created. Empty if invalid object layer, or no matching id/gid/name was found.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 628, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "This method will iterate through all of the objects defined in a Tiled Object Layer and then\rconvert the matching results into Phaser Game Objects (by default, Sprites)\r\rObjects are matched on one of 4 criteria: The Object ID, the Object GID, the Object Name, or the Object Type.\r\rWithin Tiled, Object IDs are unique per Object. Object GIDs, however, are shared by all objects\rusing the same image. Finally, Object Names and Types are strings and the same name can be used on multiple\rObjects in Tiled, they do not have to be unique; Names are specific to Objects while Types can be inherited\rfrom Object GIDs using the same image.\r\rYou set the configuration parameter accordingly, based on which type of criteria you wish\rto match against. For example, to convert all items on an Object Layer with a `gid` of 26:\r\r```javascript\rcreateFromObjects(layerName, {\r gid: 26\r});\r```\r\rOr, to convert objects with the name 'bonus':\r\r```javascript\rcreateFromObjects(layerName, {\r name: 'bonus'\r});\r```\r\rOr, to convert an object with a specific id:\r\r```javascript\rcreateFromObjects(layerName, {\r id: 9\r});\r```\r\rYou should only specify either `id`, `gid`, `name`, `type`, or none of them. Do not add more than\rone criteria to your config. If you do not specify any criteria, then _all_ objects in the\rObject Layer will be converted.\r\rBy default this method will convert Objects into {@link Phaser.GameObjects.Sprite} instances, but you can override\rthis by providing your own class type:\r\r```javascript\rcreateFromObjects(layerName, {\r gid: 26,\r classType: Coin\r});\r```\r\rThis will convert all Objects with a gid of 26 into your custom `Coin` class. You can pass\rany class type here, but it _must_ extend {@link Phaser.GameObjects.GameObject} as its base class.\rYour class will always be passed 1 parameter: `scene`, which is a reference to either the Scene\rspecified in the config object or, if not given, the Scene to which this Tilemap belongs. The\rclass must have {@link Phaser.GameObjects.Components.Transform#setPosition setPosition} and\r{@link Phaser.GameObjects.Components.Texture#setTexture setTexture} methods.\r\rThis method will set the following Tiled Object properties on the new Game Object:\r\r- `flippedHorizontal` as `flipX`\r- `flippedVertical` as `flipY`\r- `height` as `displayHeight`\r- `name`\r- `rotation`\r- `visible`\r- `width` as `displayWidth`\r- `x`, adjusted for origin\r- `y`, adjusted for origin\r\rAdditionally, this method will set Tiled Object custom properties\r\r- on the Game Object, if it has the same property name and a value that isn't `undefined`; or\r- on the Game Object's {@link Phaser.GameObjects.GameObject#data data store} otherwise.\r\rFor example, a Tiled Object with custom properties `{ alpha: 0.5, gold: 1 }` will be created as a Game\rObject with an `alpha` value of 0.5 and a `data.values.gold` value of 1.\r\rWhen `useTileset` is `true` (the default), Tile Objects will inherit the texture and any tile properties\rfrom the tileset, and the local tile ID will be used as the texture frame. For the frame selection to work\ryou need to load the tileset texture as a spritesheet so its frame names match the local tile IDs.\r\rFor instance, a tileset tile\r\r```\r{ id: 3, type: 'treadmill', speed: 4 }\r```\r\rwith gid 19 and an object\r\r```\r{ id: 7, gid: 19, speed: 5, rotation: 90 }\r```\r\rwill be interpreted as\r\r```\r{ id: 7, gid: 19, speed: 5, rotation: 90, type: 'treadmill', texture: '[the tileset texture]', frame: 3 }\r```\r\rYou can suppress this behavior by setting the boolean `ignoreTileset` for each `config` that should ignore\robject gid tilesets.\r\rYou can set a `container` property in the config. If given, the new Game Object will be added to\rthe Container or Layer instance instead of the Scene.\r\rYou can set named texture-`key` and texture-`frame` properties, which will be set on the new Game Object.\r\rFinally, you can provide an array of config objects, to convert multiple types of object in\ra single call:\r\r```javascript\rcreateFromObjects(layerName, [\r {\r gid: 26,\r classType: Coin\r },\r {\r id: 9,\r classType: BossMonster\r },\r {\r name: 'lava',\r classType: LavaTile\r },\r {\r type: 'endzone',\r classType: Phaser.GameObjects.Zone\r }\r]);\r```\r\rThe signature of this method changed significantly in v3.60.0. Prior to this, it did not take config objects.", "kind": "function", "name": "createFromObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the Tiled object layer to create the Game Objects from.", "name": "objectLayerName" }, { "type": { "names": [ "Phaser.Types.Tilemaps.CreateFromObjectLayerConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.CreateFromObjectLayerConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Tilemaps.CreateFromObjectLayerConfig", "type": "NameExpression" } ] } ] } }, "description": "A CreateFromObjects configuration object, or an array of them.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "True if objects that set gids should also search the underlying tile for properties and data.", "name": "useTileset" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "An array containing the Game Objects that were created. Empty if invalid object layer, or no matching id/gid/name was found." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#createFromObjects", "scope": "instance", "___id": "T000002R042725", "___s": true }, { "comment": "/**\r\n * Creates a Sprite for every object matching the given tile indexes in the layer. You can\r\n * optionally specify if each tile will be replaced with a new tile after the Sprite has been\r\n * created. This is useful if you want to lay down special tiles in a level that are converted to\r\n * Sprites, but want to replace the tile itself with a floor tile or similar once converted.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#createFromTiles\r\n * @since 3.0.0\r\n *\r\n * @param {(number|array)} indexes - The tile index, or array of indexes, to create Sprites from.\r\n * @param {?(number|array)} replacements - The tile index, or array of indexes, to change a converted\r\n * tile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a\r\n * one-to-one mapping with the indexes array.\r\n * @param {Phaser.Types.GameObjects.Sprite.SpriteConfig} spriteConfig - The config object to pass into the Sprite creator (i.e. scene.make.sprite).\r\n * @param {Phaser.Scene} [scene] - The Scene to create the Sprites within.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.GameObjects.Sprite[]} Returns an array of Tiles, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 912, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Creates a Sprite for every object matching the given tile indexes in the layer. You can\roptionally specify if each tile will be replaced with a new tile after the Sprite has been\rcreated. This is useful if you want to lay down special tiles in a level that are converted to\rSprites, but want to replace the tile itself with a floor tile or similar once converted.", "kind": "function", "name": "createFromTiles", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "array" } ] } }, "description": "The tile index, or array of indexes, to create Sprites from.", "name": "indexes" }, { "type": { "names": [ "number", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "array" } ], "nullable": true } }, "nullable": true, "description": "The tile index, or array of indexes, to change a converted\rtile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a\rone-to-one mapping with the indexes array.", "name": "replacements" }, { "type": { "names": [ "Phaser.Types.GameObjects.Sprite.SpriteConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Sprite.SpriteConfig" } }, "description": "The config object to pass into the Sprite creator (i.e. scene.make.sprite).", "name": "spriteConfig" }, { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "optional": true, "description": "The Scene to create the Sprites within.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Sprite", "type": "NameExpression" } ], "nullable": true } }, "nullable": true, "description": "Returns an array of Tiles, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#createFromTiles", "scope": "instance", "___id": "T000002R042768", "___s": true }, { "comment": "/**\r\n * Sets the tiles in the given rectangular area (in tile coordinates) of the layer with the\r\n * specified index. Tiles will be set to collide if the given index is a colliding index.\r\n * Collision information in the region will be recalculated.\r\n *\r\n * If no layer specified, the map's current layer is used.\r\n * This cannot be applied to StaticTilemapLayers.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#fill\r\n * @since 3.0.0\r\n *\r\n * @param {number} index - The tile index to fill the area with.\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {boolean} [recalculateFaces=true] - `true` if the faces data should be recalculated.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Returns this, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 941, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets the tiles in the given rectangular area (in tile coordinates) of the layer with the\rspecified index. Tiles will be set to collide if the given index is a colliding index.\rCollision information in the region will be recalculated.\r\rIf no layer specified, the map's current layer is used.\rThis cannot be applied to StaticTilemapLayers.", "kind": "function", "name": "fill", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tile index to fill the area with.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Returns this, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#fill", "scope": "instance", "___id": "T000002R042771", "___s": true }, { "comment": "/**\r\n * For each object in the given object layer, run the given filter callback function. Any\r\n * objects that pass the filter test (i.e. where the callback returns true) will be returned in a\r\n * new array. Similar to Array.prototype.Filter in vanilla JS.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#filterObjects\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Tilemaps.ObjectLayer|string)} objectLayer - The name of an object layer (from Tiled) or an ObjectLayer instance.\r\n * @param {TilemapFilterCallback} callback - The callback. Each object in the given area will be passed to this callback as the first and only parameter.\r\n * @param {object} [context] - The context under which the callback should be run.\r\n *\r\n * @return {?Phaser.Types.Tilemaps.TiledObject[]} An array of object that match the search, or null if the objectLayer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 975, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "For each object in the given object layer, run the given filter callback function. Any\robjects that pass the filter test (i.e. where the callback returns true) will be returned in a\rnew array. Similar to Array.prototype.Filter in vanilla JS.", "kind": "function", "name": "filterObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.ObjectLayer", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Tilemaps.ObjectLayer" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The name of an object layer (from Tiled) or an ObjectLayer instance.", "name": "objectLayer" }, { "type": { "names": [ "TilemapFilterCallback" ], "parsedType": { "type": "NameExpression", "name": "TilemapFilterCallback" } }, "description": "The callback. Each object in the given area will be passed to this callback as the first and only parameter.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The context under which the callback should be run.", "name": "context" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Tilemaps.TiledObject", "type": "NameExpression" } ], "nullable": true } }, "nullable": true, "description": "An array of object that match the search, or null if the objectLayer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#filterObjects", "scope": "instance", "___id": "T000002R042775", "___s": true }, { "comment": "/**\r\n * For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\r\n * filter callback function. Any tiles that pass the filter test (i.e. where the callback returns\r\n * true) will returned as a new array. Similar to Array.prototype.Filter in vanilla JS.\r\n * If no layer specified, the map's current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#filterTiles\r\n * @since 3.0.0\r\n *\r\n * @param {function} callback - The callback. Each tile in the given area will be passed to this\r\n * callback as the first and only parameter. The callback should return true for tiles that pass the\r\n * filter.\r\n * @param {object} [context] - The context under which the callback should be run.\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area to filter.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area to filter.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tile[]} Returns an array of Tiles, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1007, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\rfilter callback function. Any tiles that pass the filter test (i.e. where the callback returns\rtrue) will returned as a new array. Similar to Array.prototype.Filter in vanilla JS.\rIf no layer specified, the map's current layer is used.", "kind": "function", "name": "filterTiles", "since": "3.0.0", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback. Each tile in the given area will be passed to this\rcallback as the first and only parameter. The callback should return true for tiles that pass the\rfilter.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The context under which the callback should be run.", "name": "context" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area to filter.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area to filter.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "optional": true, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ], "nullable": true } }, "nullable": true, "description": "Returns an array of Tiles, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#filterTiles", "scope": "instance", "___id": "T000002R042779", "___s": true }, { "comment": "/**\r\n * Searches the entire map layer for the first tile matching the given index, then returns that Tile\r\n * object. If no match is found, it returns null. The search starts from the top-left tile and\r\n * continues horizontally until it hits the end of the row, then it drops down to the next column.\r\n * If the reverse boolean is true, it scans starting from the bottom-right corner traveling up to\r\n * the top-left.\r\n * If no layer specified, the map's current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#findByIndex\r\n * @since 3.0.0\r\n *\r\n * @param {number} index - The tile index value to search for.\r\n * @param {number} [skip=0] - The number of times to skip a matching tile before returning.\r\n * @param {boolean} [reverse=false] - If true it will scan the layer in reverse, starting at the bottom-right. Otherwise it scans from the top-left.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tile} Returns a Tiles, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1038, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Searches the entire map layer for the first tile matching the given index, then returns that Tile\robject. If no match is found, it returns null. The search starts from the top-left tile and\rcontinues horizontally until it hits the end of the row, then it drops down to the next column.\rIf the reverse boolean is true, it scans starting from the bottom-right corner traveling up to\rthe top-left.\rIf no layer specified, the map's current layer is used.", "kind": "function", "name": "findByIndex", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tile index value to search for.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of times to skip a matching tile before returning.", "name": "skip" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If true it will scan the layer in reverse, starting at the bottom-right. Otherwise it scans from the top-left.", "name": "reverse" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile", "nullable": true } }, "nullable": true, "description": "Returns a Tiles, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#findByIndex", "scope": "instance", "___id": "T000002R042782", "___s": true }, { "comment": "/**\r\n * Find the first object in the given object layer that satisfies the provided testing function.\r\n * I.e. finds the first object for which `callback` returns true. Similar to\r\n * Array.prototype.find in vanilla JS.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#findObject\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Tilemaps.ObjectLayer|string)} objectLayer - The name of an object layer (from Tiled) or an ObjectLayer instance.\r\n * @param {TilemapFindCallback} callback - The callback. Each object in the given area will be passed to this callback as the first and only parameter.\r\n * @param {object} [context] - The context under which the callback should be run.\r\n *\r\n * @return {?Phaser.Types.Tilemaps.TiledObject} An object that matches the search, or null if no object found.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1065, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Find the first object in the given object layer that satisfies the provided testing function.\rI.e. finds the first object for which `callback` returns true. Similar to\rArray.prototype.find in vanilla JS.", "kind": "function", "name": "findObject", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.ObjectLayer", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Tilemaps.ObjectLayer" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The name of an object layer (from Tiled) or an ObjectLayer instance.", "name": "objectLayer" }, { "type": { "names": [ "TilemapFindCallback" ], "parsedType": { "type": "NameExpression", "name": "TilemapFindCallback" } }, "description": "The callback. Each object in the given area will be passed to this callback as the first and only parameter.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The context under which the callback should be run.", "name": "context" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Tilemaps.TiledObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.TiledObject", "nullable": true } }, "nullable": true, "description": "An object that matches the search, or null if no object found." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#findObject", "scope": "instance", "___id": "T000002R042785", "___s": true }, { "comment": "/**\r\n * Find the first tile in the given rectangular area (in tile coordinates) of the layer that\r\n * satisfies the provided testing function. I.e. finds the first tile for which `callback` returns\r\n * true. Similar to Array.prototype.find in vanilla JS.\r\n * If no layer specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#findTile\r\n * @since 3.0.0\r\n *\r\n * @param {FindTileCallback} callback - The callback. Each tile in the given area will be passed to this callback as the first and only parameter.\r\n * @param {object} [context] - The context under which the callback should be run.\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area to search.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area to search.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The Tile layer to run the search on. If not provided will use the current layer.\r\n *\r\n * @return {?Phaser.Tilemaps.Tile} Returns a Tiles, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1097, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Find the first tile in the given rectangular area (in tile coordinates) of the layer that\rsatisfies the provided testing function. I.e. finds the first tile for which `callback` returns\rtrue. Similar to Array.prototype.find in vanilla JS.\rIf no layer specified, the maps current layer is used.", "kind": "function", "name": "findTile", "since": "3.0.0", "params": [ { "type": { "names": [ "FindTileCallback" ], "parsedType": { "type": "NameExpression", "name": "FindTileCallback" } }, "description": "The callback. Each tile in the given area will be passed to this callback as the first and only parameter.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The context under which the callback should be run.", "name": "context" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area to search.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area to search.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "optional": true, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The Tile layer to run the search on. If not provided will use the current layer.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile", "nullable": true } }, "nullable": true, "description": "Returns a Tiles, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#findTile", "scope": "instance", "___id": "T000002R042789", "___s": true }, { "comment": "/**\r\n * For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\r\n * callback. Similar to Array.prototype.forEach in vanilla JS.\r\n *\r\n * If no layer specified, the map's current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#forEachTile\r\n * @since 3.0.0\r\n *\r\n * @param {EachTileCallback} callback - The callback. Each tile in the given area will be passed to this callback as the first and only parameter.\r\n * @param {object} [context] - The context under which the callback should be run.\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area to search.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area to search.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The Tile layer to run the search on. If not provided will use the current layer.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Returns this, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1126, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\rcallback. Similar to Array.prototype.forEach in vanilla JS.\r\rIf no layer specified, the map's current layer is used.", "kind": "function", "name": "forEachTile", "since": "3.0.0", "params": [ { "type": { "names": [ "EachTileCallback" ], "parsedType": { "type": "NameExpression", "name": "EachTileCallback" } }, "description": "The callback. Each tile in the given area will be passed to this callback as the first and only parameter.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The context under which the callback should be run.", "name": "context" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area to search.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area to search.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "optional": true, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The Tile layer to run the search on. If not provided will use the current layer.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Returns this, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#forEachTile", "scope": "instance", "___id": "T000002R042792", "___s": true }, { "comment": "/**\r\n * Gets the image layer index based on its name.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getImageIndex\r\n * @since 3.0.0\r\n *\r\n * @param {string} name - The name of the image to get.\r\n *\r\n * @return {number} The index of the image in this tilemap, or null if not found.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1157, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the image layer index based on its name.", "kind": "function", "name": "getImageIndex", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the image to get.", "name": "name" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the image in this tilemap, or null if not found." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getImageIndex", "scope": "instance", "___id": "T000002R042795", "___s": true }, { "comment": "/**\r\n * Return a list of all valid imagelayer names loaded in this Tilemap.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getImageLayerNames\r\n * @since 3.21.0\r\n *\r\n * @return {string[]} Array of valid imagelayer names / IDs loaded into this Tilemap.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1172, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Return a list of all valid imagelayer names loaded in this Tilemap.", "kind": "function", "name": "getImageLayerNames", "since": "3.21.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "Array of valid imagelayer names / IDs loaded into this Tilemap." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getImageLayerNames", "scope": "instance", "___id": "T000002R042797", "___s": true }, { "comment": "/**\r\n * Internally used. Returns the index of the object in one of the Tilemaps arrays whose name\r\n * property matches the given `name`.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getIndex\r\n * @since 3.0.0\r\n *\r\n * @param {array} location - The Tilemap array to search.\r\n * @param {string} name - The name of the array element to get.\r\n *\r\n * @return {number} The index of the element in the array, or null if not found.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1193, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Internally used. Returns the index of the object in one of the Tilemaps arrays whose name\rproperty matches the given `name`.", "kind": "function", "name": "getIndex", "since": "3.0.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The Tilemap array to search.", "name": "location" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the array element to get.", "name": "name" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the element in the array, or null if not found." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getIndex", "scope": "instance", "___id": "T000002R042799", "___s": true }, { "comment": "/**\r\n * Gets the LayerData from `this.layers` that is associated with the given `layer`, or null if the layer is invalid.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getLayer\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The name of the layer from Tiled, the index of the layer in the map or Tilemap Layer. If not given will default to the maps current layer index.\r\n *\r\n * @return {?Phaser.Tilemaps.LayerData} The corresponding `LayerData` within `this.layers`, or null.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the LayerData from `this.layers` that is associated with the given `layer`, or null if the layer is invalid.", "kind": "function", "name": "getLayer", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The name of the layer from Tiled, the index of the layer in the map or Tilemap Layer. If not given will default to the maps current layer index.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData", "nullable": true } }, "nullable": true, "description": "The corresponding `LayerData` within `this.layers`, or null." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getLayer", "scope": "instance", "___id": "T000002R042802", "___s": true }, { "comment": "/**\r\n * Gets the ObjectLayer from `this.objects` that has the given `name`, or null if no ObjectLayer is found with that name.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getObjectLayer\r\n * @since 3.0.0\r\n *\r\n * @param {string} [name] - The name of the object layer from Tiled.\r\n *\r\n * @return {?Phaser.Tilemaps.ObjectLayer} The corresponding `ObjectLayer` within `this.objects`, or null.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1235, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the ObjectLayer from `this.objects` that has the given `name`, or null if no ObjectLayer is found with that name.", "kind": "function", "name": "getObjectLayer", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The name of the object layer from Tiled.", "name": "name" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.ObjectLayer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.ObjectLayer", "nullable": true } }, "nullable": true, "description": "The corresponding `ObjectLayer` within `this.objects`, or null." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getObjectLayer", "scope": "instance", "___id": "T000002R042805", "___s": true }, { "comment": "/**\r\n * Return a list of all valid objectgroup names loaded in this Tilemap.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getObjectLayerNames\r\n * @since 3.21.0\r\n *\r\n * @return {string[]} Array of valid objectgroup names / IDs loaded into this Tilemap.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Return a list of all valid objectgroup names loaded in this Tilemap.", "kind": "function", "name": "getObjectLayerNames", "since": "3.21.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "Array of valid objectgroup names / IDs loaded into this Tilemap." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getObjectLayerNames", "scope": "instance", "___id": "T000002R042808", "___s": true }, { "comment": "/**\r\n * Gets the LayerData index of the given `layer` within this.layers, or null if an invalid\r\n * `layer` is given.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getLayerIndex\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The name of the layer from Tiled, the index of the layer in the map or a Tilemap Layer. If not given will default to the map's current layer index.\r\n *\r\n * @return {number} The LayerData index within this.layers.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1273, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the LayerData index of the given `layer` within this.layers, or null if an invalid\r`layer` is given.", "kind": "function", "name": "getLayerIndex", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The name of the layer from Tiled, the index of the layer in the map or a Tilemap Layer. If not given will default to the map's current layer index.", "name": "layer" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The LayerData index within this.layers." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getLayerIndex", "scope": "instance", "___id": "T000002R042810", "___s": true }, { "comment": "/**\r\n * Gets the index of the LayerData within this.layers that has the given `name`, or null if an\r\n * invalid `name` is given.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getLayerIndexByName\r\n * @since 3.0.0\r\n *\r\n * @param {string} name - The name of the layer to get.\r\n *\r\n * @return {number} The LayerData index within this.layers.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1308, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the index of the LayerData within this.layers that has the given `name`, or null if an\rinvalid `name` is given.", "kind": "function", "name": "getLayerIndexByName", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the layer to get.", "name": "name" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The LayerData index within this.layers." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getLayerIndexByName", "scope": "instance", "___id": "T000002R042812", "___s": true }, { "comment": "/**\r\n * Gets a tile at the given tile coordinates from the given layer.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getTileAt\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - X position to get the tile from (given in tile units, not pixels).\r\n * @param {number} tileY - Y position to get the tile from (given in tile units, not pixels).\r\n * @param {boolean} [nonNull] - If true getTile won't return null for empty tiles, but a Tile object with an index of -1.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tile} Returns a Tile, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1324, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets a tile at the given tile coordinates from the given layer.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "getTileAt", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X position to get the tile from (given in tile units, not pixels).", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y position to get the tile from (given in tile units, not pixels).", "name": "tileY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If true getTile won't return null for empty tiles, but a Tile object with an index of -1.", "name": "nonNull" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile", "nullable": true } }, "nullable": true, "description": "Returns a Tile, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getTileAt", "scope": "instance", "___id": "T000002R042814", "___s": true }, { "comment": "/**\r\n * Gets a tile at the given world coordinates from the given layer.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getTileAtWorldXY\r\n * @since 3.0.0\r\n *\r\n * @param {number} worldX - X position to get the tile from (given in pixels)\r\n * @param {number} worldY - Y position to get the tile from (given in pixels)\r\n * @param {boolean} [nonNull] - If true, function won't return null for empty tiles, but a Tile object with an index of -1.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tile} Returns a Tile, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1348, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets a tile at the given world coordinates from the given layer.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "getTileAtWorldXY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X position to get the tile from (given in pixels)", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y position to get the tile from (given in pixels)", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If true, function won't return null for empty tiles, but a Tile object with an index of -1.", "name": "nonNull" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile", "nullable": true } }, "nullable": true, "description": "Returns a Tile, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getTileAtWorldXY", "scope": "instance", "___id": "T000002R042817", "___s": true }, { "comment": "/**\r\n * Return a list of all valid tilelayer names loaded in this Tilemap.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getTileLayerNames\r\n * @since 3.21.0\r\n *\r\n * @return {string[]} Array of valid tilelayer names / IDs loaded into this Tilemap.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Return a list of all valid tilelayer names loaded in this Tilemap.", "kind": "function", "name": "getTileLayerNames", "since": "3.21.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "Array of valid tilelayer names / IDs loaded into this Tilemap." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getTileLayerNames", "scope": "instance", "___id": "T000002R042820", "___s": true }, { "comment": "/**\r\n * Gets the tiles in the given rectangular area (in tile coordinates) of the layer.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getTilesWithin\r\n * @since 3.0.0\r\n *\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tile[]} Returns an array of Tiles, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the tiles in the given rectangular area (in tile coordinates) of the layer.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "getTilesWithin", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "optional": true, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ], "nullable": true } }, "nullable": true, "description": "Returns an array of Tiles, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getTilesWithin", "scope": "instance", "___id": "T000002R042822", "___s": true }, { "comment": "/**\r\n * Gets the tiles that overlap with the given shape in the given layer. The shape must be a Circle,\r\n * Line, Rectangle or Triangle. The shape should be in world coordinates.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getTilesWithinShape\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Geom.Circle|Phaser.Geom.Line|Phaser.Geom.Rectangle|Phaser.Geom.Triangle)} shape - A shape in world (pixel) coordinates\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when factoring in which tiles to return.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tile[]} Returns an array of Tiles, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1420, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the tiles that overlap with the given shape in the given layer. The shape must be a Circle,\rLine, Rectangle or Triangle. The shape should be in world coordinates.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "getTilesWithinShape", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Circle", "Phaser.Geom.Line", "Phaser.Geom.Rectangle", "Phaser.Geom.Triangle" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Circle" }, { "type": "NameExpression", "name": "Phaser.Geom.Line" }, { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } ] } }, "description": "A shape in world (pixel) coordinates", "name": "shape" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "optional": true, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when factoring in which tiles to return.", "name": "camera" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ], "nullable": true } }, "nullable": true, "description": "Returns an array of Tiles, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getTilesWithinShape", "scope": "instance", "___id": "T000002R042825", "___s": true }, { "comment": "/**\r\n * Gets the tiles in the given rectangular area (in world coordinates) of the layer.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getTilesWithinWorldXY\r\n * @since 3.0.0\r\n *\r\n * @param {number} worldX - The world x coordinate for the top-left of the area.\r\n * @param {number} worldY - The world y coordinate for the top-left of the area.\r\n * @param {number} width - The width of the area.\r\n * @param {number} height - The height of the area.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when factoring in which tiles to return.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tile[]} Returns an array of Tiles, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the tiles in the given rectangular area (in world coordinates) of the layer.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "getTilesWithinWorldXY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The world x coordinate for the top-left of the area.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The world y coordinate for the top-left of the area.", "name": "worldY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the area.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the area.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "optional": true, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when factoring in which tiles to return.", "name": "camera" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ], "nullable": true } }, "nullable": true, "description": "Returns an array of Tiles, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getTilesWithinWorldXY", "scope": "instance", "___id": "T000002R042828", "___s": true }, { "comment": "/**\r\n * Gets the Tileset that has the given `name`, or null if an invalid `name` is given.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getTileset\r\n * @since 3.14.0\r\n *\r\n * @param {string} name - The name of the Tileset to get.\r\n *\r\n * @return {?Phaser.Tilemaps.Tileset} The Tileset, or `null` if no matching named tileset was found.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1472, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the Tileset that has the given `name`, or null if an invalid `name` is given.", "kind": "function", "name": "getTileset", "since": "3.14.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the Tileset to get.", "name": "name" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tileset" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tileset", "nullable": true } }, "nullable": true, "description": "The Tileset, or `null` if no matching named tileset was found." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getTileset", "scope": "instance", "___id": "T000002R042831", "___s": true }, { "comment": "/**\r\n * Gets the index of the Tileset within this.tilesets that has the given `name`, or null if an\r\n * invalid `name` is given.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getTilesetIndex\r\n * @since 3.0.0\r\n *\r\n * @param {string} name - The name of the Tileset to get.\r\n *\r\n * @return {number} The Tileset index within this.tilesets.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1489, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the index of the Tileset within this.tilesets that has the given `name`, or null if an\rinvalid `name` is given.", "kind": "function", "name": "getTilesetIndex", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the Tileset to get.", "name": "name" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Tileset index within this.tilesets." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getTilesetIndex", "scope": "instance", "___id": "T000002R042834", "___s": true }, { "comment": "/**\r\n * Checks if there is a tile at the given location (in tile coordinates) in the given layer. Returns\r\n * false if there is no tile or if the tile at that location has an index of -1.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#hasTileAt\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?boolean} Returns a boolean, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1505, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Checks if there is a tile at the given location (in tile coordinates) in the given layer. Returns\rfalse if there is no tile or if the tile at that location has an index of -1.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "hasTileAt", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "nullable": true, "description": "Returns a boolean, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#hasTileAt", "scope": "instance", "___id": "T000002R042836", "___s": true }, { "comment": "/**\r\n * Checks if there is a tile at the given location (in world coordinates) in the given layer. Returns\r\n * false if there is no tile or if the tile at that location has an index of -1.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#hasTileAtWorldXY\r\n * @since 3.0.0\r\n *\r\n * @param {number} worldX - The x coordinate, in pixels.\r\n * @param {number} worldY - The y coordinate, in pixels.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when factoring in which tiles to return.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?boolean} Returns a boolean, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1529, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Checks if there is a tile at the given location (in world coordinates) in the given layer. Returns\rfalse if there is no tile or if the tile at that location has an index of -1.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "hasTileAtWorldXY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in pixels.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in pixels.", "name": "worldY" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when factoring in which tiles to return.", "name": "camera" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "nullable": true, "description": "Returns a boolean, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#hasTileAtWorldXY", "scope": "instance", "___id": "T000002R042839", "___s": true }, { "comment": "/**\r\n * The LayerData object that is currently selected in the map. You can set this property using\r\n * any type supported by setLayer.\r\n *\r\n * @name Phaser.Tilemaps.Tilemap#layer\r\n * @type {Phaser.Tilemaps.LayerData}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1554, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The LayerData object that is currently selected in the map. You can set this property using\rany type supported by setLayer.", "name": "layer", "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#layer", "scope": "instance", "kind": "member", "___id": "T000002R042842", "___s": true }, { "comment": "/**\r\n * Puts a tile at the given tile coordinates in the specified layer. You can pass in either an index\r\n * or a Tile object. If you pass in a Tile, all attributes will be copied over to the specified\r\n * location. If you pass in an index, only the index at the specified location will be changed.\r\n * Collision information will be recalculated at the specified location.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#putTileAt\r\n * @since 3.0.0\r\n *\r\n * @param {(number|Phaser.Tilemaps.Tile)} tile - The index of this tile to set or a Tile object.\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {boolean} [recalculateFaces] - `true` if the faces data should be recalculated.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tile} Returns a Tile, or null if the layer given was invalid or the coordinates were out of bounds.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1574, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Puts a tile at the given tile coordinates in the specified layer. You can pass in either an index\ror a Tile object. If you pass in a Tile, all attributes will be copied over to the specified\rlocation. If you pass in an index, only the index at the specified location will be changed.\rCollision information will be recalculated at the specified location.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "putTileAt", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } ] } }, "description": "The index of this tile to set or a Tile object.", "name": "tile" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile", "nullable": true } }, "nullable": true, "description": "Returns a Tile, or null if the layer given was invalid or the coordinates were out of bounds." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#putTileAt", "scope": "instance", "___id": "T000002R042846", "___s": true }, { "comment": "/**\r\n * Puts a tile at the given world coordinates (pixels) in the specified layer. You can pass in either\r\n * an index or a Tile object. If you pass in a Tile, all attributes will be copied over to the\r\n * specified location. If you pass in an index, only the index at the specified location will be\r\n * changed. Collision information will be recalculated at the specified location.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#putTileAtWorldXY\r\n * @since 3.0.0\r\n *\r\n * @param {(number|Phaser.Tilemaps.Tile)} tile - The index of this tile to set or a Tile object.\r\n * @param {number} worldX - The x coordinate, in pixels.\r\n * @param {number} worldY - The y coordinate, in pixels.\r\n * @param {boolean} [recalculateFaces] - `true` if the faces data should be recalculated.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tile} Returns a Tile, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Puts a tile at the given world coordinates (pixels) in the specified layer. You can pass in either\ran index or a Tile object. If you pass in a Tile, all attributes will be copied over to the\rspecified location. If you pass in an index, only the index at the specified location will be\rchanged. Collision information will be recalculated at the specified location.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "putTileAtWorldXY", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } ] } }, "description": "The index of this tile to set or a Tile object.", "name": "tile" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in pixels.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in pixels.", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile", "nullable": true } }, "nullable": true, "description": "Returns a Tile, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#putTileAtWorldXY", "scope": "instance", "___id": "T000002R042850", "___s": true }, { "comment": "/**\r\n * Puts an array of tiles or a 2D array of tiles at the given tile coordinates in the specified\r\n * layer. The array can be composed of either tile indexes or Tile objects. If you pass in a Tile,\r\n * all attributes will be copied over to the specified location. If you pass in an index, only the\r\n * index at the specified location will be changed. Collision information will be recalculated\r\n * within the region tiles were changed.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#putTilesAt\r\n * @since 3.0.0\r\n *\r\n * @param {(number[]|number[][]|Phaser.Tilemaps.Tile[]|Phaser.Tilemaps.Tile[][])} tile - A row (array) or grid (2D array) of Tiles or tile indexes to place.\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {boolean} [recalculateFaces] - `true` if the faces data should be recalculated.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Returns this, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1635, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Puts an array of tiles or a 2D array of tiles at the given tile coordinates in the specified\rlayer. The array can be composed of either tile indexes or Tile objects. If you pass in a Tile,\rall attributes will be copied over to the specified location. If you pass in an index, only the\rindex at the specified location will be changed. Collision information will be recalculated\rwithin the region tiles were changed.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "putTilesAt", "since": "3.0.0", "params": [ { "type": { "names": [ "Array.", "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": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } ] } ] } }, "description": "A row (array) or grid (2D array) of Tiles or tile indexes to place.", "name": "tile" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Returns this, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#putTilesAt", "scope": "instance", "___id": "T000002R042854", "___s": true }, { "comment": "/**\r\n * Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\r\n * specified layer. Each tile will receive a new index. If an array of indexes is passed in, then\r\n * those will be used for randomly assigning new tile indexes. If an array is not provided, the\r\n * indexes found within the region (excluding -1) will be used for randomly assigning new tile\r\n * indexes. This method only modifies tile indexes and does not change collision information.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#randomize\r\n * @since 3.0.0\r\n *\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {number[]} [indexes] - An array of indexes to randomly draw from during randomization.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Returns this, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1668, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\rspecified layer. Each tile will receive a new index. If an array of indexes is passed in, then\rthose will be used for randomly assigning new tile indexes. If an array is not provided, the\rindexes found within the region (excluding -1) will be used for randomly assigning new tile\rindexes. This method only modifies tile indexes and does not change collision information.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "randomize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of indexes to randomly draw from during randomization.", "name": "indexes" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Returns this, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#randomize", "scope": "instance", "___id": "T000002R042858", "___s": true }, { "comment": "/**\r\n * Calculates interesting faces at the given tile coordinates of the specified layer. Interesting\r\n * faces are used internally for optimizing collisions against tiles. This method is mostly used\r\n * internally to optimize recalculating faces when only one tile has been changed.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#calculateFacesAt\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Returns this, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1700, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Calculates interesting faces at the given tile coordinates of the specified layer. Interesting\rfaces are used internally for optimizing collisions against tiles. This method is mostly used\rinternally to optimize recalculating faces when only one tile has been changed.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "calculateFacesAt", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Returns this, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#calculateFacesAt", "scope": "instance", "___id": "T000002R042861", "___s": true }, { "comment": "/**\r\n * Calculates interesting faces within the rectangular area specified (in tile coordinates) of the\r\n * layer. Interesting faces are used internally for optimizing collisions against tiles. This method\r\n * is mostly used internally.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#calculateFacesWithin\r\n * @since 3.0.0\r\n *\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Returns this, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1727, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Calculates interesting faces within the rectangular area specified (in tile coordinates) of the\rlayer. Interesting faces are used internally for optimizing collisions against tiles. This method\ris mostly used internally.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "calculateFacesWithin", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Returns this, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#calculateFacesWithin", "scope": "instance", "___id": "T000002R042864", "___s": true }, { "comment": "/**\r\n * Removes the given TilemapLayer from this Tilemap without destroying it.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#removeLayer\r\n * @since 3.17.0\r\n *\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to be removed.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Returns this, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1756, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Removes the given TilemapLayer from this Tilemap without destroying it.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "removeLayer", "since": "3.17.0", "params": [ { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to be removed.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Returns this, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#removeLayer", "scope": "instance", "___id": "T000002R042867", "___s": true }, { "comment": "/**\r\n * Destroys the given TilemapLayer and removes it from this Tilemap.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#destroyLayer\r\n * @since 3.17.0\r\n *\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to be destroyed.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Returns this, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1797, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Destroys the given TilemapLayer and removes it from this Tilemap.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "destroyLayer", "since": "3.17.0", "params": [ { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to be destroyed.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Returns this, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#destroyLayer", "scope": "instance", "___id": "T000002R042872", "___s": true }, { "comment": "/**\r\n * Removes all Tilemap Layers from this Tilemap and calls `destroy` on each of them.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#removeAllLayers\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Tilemap object.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1834, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Removes all Tilemap Layers from this Tilemap and calls `destroy` on each of them.", "kind": "function", "name": "removeAllLayers", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap object." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#removeAllLayers", "scope": "instance", "___id": "T000002R042877", "___s": true }, { "comment": "/**\r\n * Removes the given Tile, or an array of Tiles, from the layer to which they belong,\r\n * and optionally recalculates the collision information.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#removeTile\r\n * @since 3.17.0\r\n *\r\n * @param {(Phaser.Tilemaps.Tile|Phaser.Tilemaps.Tile[])} tiles - The Tile to remove, or an array of Tiles.\r\n * @param {number} [replaceIndex=-1] - After removing the Tile, insert a brand new Tile into its location with the given index. Leave as -1 to just remove the tile.\r\n * @param {boolean} [recalculateFaces=true] - `true` if the faces data should be recalculated.\r\n *\r\n * @return {Phaser.Tilemaps.Tile[]} Returns an array of Tiles that were removed.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1861, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Removes the given Tile, or an array of Tiles, from the layer to which they belong,\rand optionally recalculates the collision information.", "kind": "function", "name": "removeTile", "since": "3.17.0", "params": [ { "type": { "names": [ "Phaser.Tilemaps.Tile", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } ] } }, "description": "The Tile to remove, or an array of Tiles.", "name": "tiles" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": -1, "description": "After removing the Tile, insert a brand new Tile into its location with the given index. Leave as -1 to just remove the tile.", "name": "replaceIndex" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "Returns an array of Tiles that were removed." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#removeTile", "scope": "instance", "___id": "T000002R042883", "___s": true }, { "comment": "/**\r\n * Removes the tile at the given tile coordinates in the specified layer and updates the layers collision information.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#removeTileAt\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {boolean} [replaceWithNull] - If `true` (the default), this will replace the tile at the specified location with null instead of a Tile with an index of -1.\r\n * @param {boolean} [recalculateFaces] - If `true` (the default), the faces data will be recalculated.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tile} Returns the Tile that was removed, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1901, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Removes the tile at the given tile coordinates in the specified layer and updates the layers collision information.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "removeTileAt", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If `true` (the default), this will replace the tile at the specified location with null instead of a Tile with an index of -1.", "name": "replaceWithNull" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If `true` (the default), the faces data will be recalculated.", "name": "recalculateFaces" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile", "nullable": true } }, "nullable": true, "description": "Returns the Tile that was removed, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#removeTileAt", "scope": "instance", "___id": "T000002R042891", "___s": true }, { "comment": "/**\r\n * Removes the tile at the given world coordinates in the specified layer and updates the layers collision information.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#removeTileAtWorldXY\r\n * @since 3.0.0\r\n *\r\n * @param {number} worldX - The x coordinate, in pixels.\r\n * @param {number} worldY - The y coordinate, in pixels.\r\n * @param {boolean} [replaceWithNull] - If `true` (the default), this will replace the tile at the specified location with null instead of a Tile with an index of -1.\r\n * @param {boolean} [recalculateFaces] - If `true` (the default), the faces data will be recalculated.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tile} Returns a Tile, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1929, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Removes the tile at the given world coordinates in the specified layer and updates the layers collision information.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "removeTileAtWorldXY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in pixels.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in pixels.", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If `true` (the default), this will replace the tile at the specified location with null instead of a Tile with an index of -1.", "name": "replaceWithNull" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If `true` (the default), the faces data will be recalculated.", "name": "recalculateFaces" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile", "nullable": true } }, "nullable": true, "description": "Returns a Tile, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#removeTileAtWorldXY", "scope": "instance", "___id": "T000002R042896", "___s": true }, { "comment": "/**\r\n * Draws a debug representation of the layer to the given Graphics object. This is helpful when you want to\r\n * get a quick idea of which of your tiles are colliding and which have interesting faces. The tiles\r\n * are drawn starting at (0, 0) in the Graphics, allowing you to place the debug representation\r\n * wherever you want on the screen.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * **Note:** This method currently only works with orthogonal tilemap layers.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#renderDebug\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Graphics} graphics - The target Graphics object to draw upon.\r\n * @param {Phaser.Types.Tilemaps.StyleConfig} [styleConfig] - An object specifying the colors to use for the debug drawing.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Return this Tilemap object, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1958, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Draws a debug representation of the layer to the given Graphics object. This is helpful when you want to\rget a quick idea of which of your tiles are colliding and which have interesting faces. The tiles\rare drawn starting at (0, 0) in the Graphics, allowing you to place the debug representation\rwherever you want on the screen.\r\rIf no layer is specified, the maps current layer is used.\r\r**Note:** This method currently only works with orthogonal tilemap layers.", "kind": "function", "name": "renderDebug", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The target Graphics object to draw upon.", "name": "graphics" }, { "type": { "names": [ "Phaser.Types.Tilemaps.StyleConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.StyleConfig" } }, "optional": true, "description": "An object specifying the colors to use for the debug drawing.", "name": "styleConfig" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Return this Tilemap object, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#renderDebug", "scope": "instance", "___id": "T000002R042901", "___s": true }, { "comment": "/**\r\n * Draws a debug representation of all layers within this Tilemap to the given Graphics object.\r\n *\r\n * This is helpful when you want to get a quick idea of which of your tiles are colliding and which\r\n * have interesting faces. The tiles are drawn starting at (0, 0) in the Graphics, allowing you to\r\n * place the debug representation wherever you want on the screen.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#renderDebugFull\r\n * @since 3.17.0\r\n *\r\n * @param {Phaser.GameObjects.Graphics} graphics - The target Graphics object to draw upon.\r\n * @param {Phaser.Types.Tilemaps.StyleConfig} [styleConfig] - An object specifying the colors to use for the debug drawing.\r\n *\r\n * @return {this} This Tilemap instance.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 1991, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Draws a debug representation of all layers within this Tilemap to the given Graphics object.\r\rThis is helpful when you want to get a quick idea of which of your tiles are colliding and which\rhave interesting faces. The tiles are drawn starting at (0, 0) in the Graphics, allowing you to\rplace the debug representation wherever you want on the screen.", "kind": "function", "name": "renderDebugFull", "since": "3.17.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The target Graphics object to draw upon.", "name": "graphics" }, { "type": { "names": [ "Phaser.Types.Tilemaps.StyleConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.StyleConfig" } }, "optional": true, "description": "An object specifying the colors to use for the debug drawing.", "name": "styleConfig" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap instance." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#renderDebugFull", "scope": "instance", "___id": "T000002R042904", "___s": true }, { "comment": "/**\r\n * Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\r\n * `findIndex` and updates their index to match `newIndex`. This only modifies the index and does\r\n * not change collision information.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#replaceByIndex\r\n * @since 3.0.0\r\n *\r\n * @param {number} findIndex - The index of the tile to search for.\r\n * @param {number} newIndex - The index of the tile to replace it with.\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Return this Tilemap object, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2018, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\r`findIndex` and updates their index to match `newIndex`. This only modifies the index and does\rnot change collision information.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "replaceByIndex", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the tile to search for.", "name": "findIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the tile to replace it with.", "name": "newIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Return this Tilemap object, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#replaceByIndex", "scope": "instance", "___id": "T000002R042908", "___s": true }, { "comment": "/**\r\n * Sets collision on the given tile or tiles within a layer by index. You can pass in either a\r\n * single numeric index or an array of indexes: [2, 3, 15, 20]. The `collides` parameter controls if\r\n * collision will be enabled (true) or disabled (false).\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#setCollision\r\n * @since 3.0.0\r\n *\r\n * @param {(number|array)} indexes - Either a single tile index, or an array of tile indexes.\r\n * @param {boolean} [collides] - If true it will enable collision. If false it will clear collision.\r\n * @param {boolean} [recalculateFaces] - Whether or not to recalculate the tile faces after the update.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n * @param {boolean} [updateLayer=true] - If true, updates the current tiles on the layer. Set to false if no tiles have been placed for significant performance boost.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Return this Tilemap object, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2049, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets collision on the given tile or tiles within a layer by index. You can pass in either a\rsingle numeric index or an array of indexes: [2, 3, 15, 20]. The `collides` parameter controls if\rcollision will be enabled (true) or disabled (false).\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "setCollision", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "array" } ] } }, "description": "Either a single tile index, or an array of tile indexes.", "name": "indexes" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If true it will enable collision. If false it will clear collision.", "name": "collides" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether or not to recalculate the tile faces after the update.", "name": "recalculateFaces" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If true, updates the current tiles on the layer. Set to false if no tiles have been placed for significant performance boost.", "name": "updateLayer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Return this Tilemap object, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#setCollision", "scope": "instance", "___id": "T000002R042911", "___s": true }, { "comment": "/**\r\n * Sets collision on a range of tiles in a layer whose index is between the specified `start` and\r\n * `stop` (inclusive). Calling this with a start value of 10 and a stop value of 14 would set\r\n * collision for tiles 10, 11, 12, 13 and 14. The `collides` parameter controls if collision will be\r\n * enabled (true) or disabled (false).\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#setCollisionBetween\r\n * @since 3.0.0\r\n *\r\n * @param {number} start - The first index of the tile to be set for collision.\r\n * @param {number} stop - The last index of the tile to be set for collision.\r\n * @param {boolean} [collides] - If true it will enable collision. If false it will clear collision.\r\n * @param {boolean} [recalculateFaces] - Whether or not to recalculate the tile faces after the update.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Return this Tilemap object, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2082, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets collision on a range of tiles in a layer whose index is between the specified `start` and\r`stop` (inclusive). Calling this with a start value of 10 and a stop value of 14 would set\rcollision for tiles 10, 11, 12, 13 and 14. The `collides` parameter controls if collision will be\renabled (true) or disabled (false).\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "setCollisionBetween", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The first index of the tile to be set for collision.", "name": "start" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The last index of the tile to be set for collision.", "name": "stop" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If true it will enable collision. If false it will clear collision.", "name": "collides" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether or not to recalculate the tile faces after the update.", "name": "recalculateFaces" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Return this Tilemap object, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#setCollisionBetween", "scope": "instance", "___id": "T000002R042917", "___s": true }, { "comment": "/**\r\n * Sets collision on the tiles within a layer by checking tile properties. If a tile has a property\r\n * that matches the given properties object, its collision flag will be set. The `collides`\r\n * parameter controls if collision will be enabled (true) or disabled (false). Passing in\r\n * `{ collides: true }` would update the collision flag on any tiles with a \"collides\" property that\r\n * has a value of true. Any tile that doesn't have \"collides\" set to true will be ignored. You can\r\n * also use an array of values, e.g. `{ types: [\"stone\", \"lava\", \"sand\" ] }`. If a tile has a\r\n * \"types\" property that matches any of those values, its collision flag will be updated.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#setCollisionByProperty\r\n * @since 3.0.0\r\n *\r\n * @param {object} properties - An object with tile properties and corresponding values that should be checked.\r\n * @param {boolean} [collides] - If true it will enable collision. If false it will clear collision.\r\n * @param {boolean} [recalculateFaces] - Whether or not to recalculate the tile faces after the update.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Return this Tilemap object, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2115, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets collision on the tiles within a layer by checking tile properties. If a tile has a property\rthat matches the given properties object, its collision flag will be set. The `collides`\rparameter controls if collision will be enabled (true) or disabled (false). Passing in\r`{ collides: true }` would update the collision flag on any tiles with a \"collides\" property that\rhas a value of true. Any tile that doesn't have \"collides\" set to true will be ignored. You can\ralso use an array of values, e.g. `{ types: [\"stone\", \"lava\", \"sand\" ] }`. If a tile has a\r\"types\" property that matches any of those values, its collision flag will be updated.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "setCollisionByProperty", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "An object with tile properties and corresponding values that should be checked.", "name": "properties" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If true it will enable collision. If false it will clear collision.", "name": "collides" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether or not to recalculate the tile faces after the update.", "name": "recalculateFaces" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Return this Tilemap object, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#setCollisionByProperty", "scope": "instance", "___id": "T000002R042922", "___s": true }, { "comment": "/**\r\n * Sets collision on all tiles in the given layer, except for tiles that have an index specified in\r\n * the given array. The `collides` parameter controls if collision will be enabled (true) or\r\n * disabled (false). Tile indexes not currently in the layer are not affected.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#setCollisionByExclusion\r\n * @since 3.0.0\r\n *\r\n * @param {number[]} indexes - An array of the tile indexes to not be counted for collision.\r\n * @param {boolean} [collides] - If true it will enable collision. If false it will clear collision.\r\n * @param {boolean} [recalculateFaces] - Whether or not to recalculate the tile faces after the update.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Return this Tilemap object, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2150, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets collision on all tiles in the given layer, except for tiles that have an index specified in\rthe given array. The `collides` parameter controls if collision will be enabled (true) or\rdisabled (false). Tile indexes not currently in the layer are not affected.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "setCollisionByExclusion", "since": "3.0.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "An array of the tile indexes to not be counted for collision.", "name": "indexes" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If true it will enable collision. If false it will clear collision.", "name": "collides" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether or not to recalculate the tile faces after the update.", "name": "recalculateFaces" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Return this Tilemap object, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#setCollisionByExclusion", "scope": "instance", "___id": "T000002R042927", "___s": true }, { "comment": "/**\r\n * Sets collision on the tiles within a layer by checking each tiles collision group data\r\n * (typically defined in Tiled within the tileset collision editor). If any objects are found within\r\n * a tiles collision group, the tiles colliding information will be set. The `collides` parameter\r\n * controls if collision will be enabled (true) or disabled (false).\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#setCollisionFromCollisionGroup\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [collides] - If true it will enable collision. If false it will clear collision.\r\n * @param {boolean} [recalculateFaces] - Whether or not to recalculate the tile faces after the update.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Return this Tilemap object, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2181, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets collision on the tiles within a layer by checking each tiles collision group data\r(typically defined in Tiled within the tileset collision editor). If any objects are found within\ra tiles collision group, the tiles colliding information will be set. The `collides` parameter\rcontrols if collision will be enabled (true) or disabled (false).\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "setCollisionFromCollisionGroup", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If true it will enable collision. If false it will clear collision.", "name": "collides" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether or not to recalculate the tile faces after the update.", "name": "recalculateFaces" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Return this Tilemap object, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#setCollisionFromCollisionGroup", "scope": "instance", "___id": "T000002R042932", "___s": true }, { "comment": "/**\r\n * Sets a global collision callback for the given tile index within the layer. This will affect all\r\n * tiles on this layer that have the same index. If a callback is already set for the tile index it\r\n * will be replaced. Set the callback to null to remove it. If you want to set a callback for a tile\r\n * at a specific location on the map then see `setTileLocationCallback`.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#setTileIndexCallback\r\n * @since 3.0.0\r\n *\r\n * @param {(number|number[])} indexes - Either a single tile index, or an array of tile indexes to have a collision callback set for. All values should be integers.\r\n * @param {function} callback - The callback that will be invoked when the tile is collided with.\r\n * @param {object} callbackContext - The context under which the callback is called.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Return this Tilemap object, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets a global collision callback for the given tile index within the layer. This will affect all\rtiles on this layer that have the same index. If a callback is already set for the tile index it\rwill be replaced. Set the callback to null to remove it. If you want to set a callback for a tile\rat a specific location on the map then see `setTileLocationCallback`.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "setTileIndexCallback", "since": "3.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" } ] } ] } }, "description": "Either a single tile index, or an array of tile indexes to have a collision callback set for. All values should be integers.", "name": "indexes" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback that will be invoked when the tile is collided with.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The context under which the callback is called.", "name": "callbackContext" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Return this Tilemap object, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#setTileIndexCallback", "scope": "instance", "___id": "T000002R042937", "___s": true }, { "comment": "/**\r\n * Sets a collision callback for the given rectangular area (in tile coordinates) within the layer.\r\n * If a callback is already set for the tile index it will be replaced. Set the callback to null to\r\n * remove it.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#setTileLocationCallback\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} tileY - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} width - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} height - How many tiles tall from the `tileY` index the area will be.\r\n * @param {function} callback - The callback that will be invoked when the tile is collided with.\r\n * @param {object} [callbackContext] - The context under which the callback is called.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Return this Tilemap object, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2241, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets a collision callback for the given rectangular area (in tile coordinates) within the layer.\rIf a callback is already set for the tile index it will be replaced. Set the callback to null to\rremove it.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "setTileLocationCallback", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback that will be invoked when the tile is collided with.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The context under which the callback is called.", "name": "callbackContext" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Return this Tilemap object, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#setTileLocationCallback", "scope": "instance", "___id": "T000002R042940", "___s": true }, { "comment": "/**\r\n * Sets the current layer to the LayerData associated with `layer`.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#setLayer\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The name of the layer from Tiled, the index of the layer in the map or a TilemapLayer. If not given will default to the maps current layer index.\r\n *\r\n * @return {this} This Tilemap object.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets the current layer to the LayerData associated with `layer`.", "kind": "function", "name": "setLayer", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The name of the layer from Tiled, the index of the layer in the map or a TilemapLayer. If not given will default to the maps current layer index.", "name": "layer" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap object." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#setLayer", "scope": "instance", "___id": "T000002R042943", "___s": true }, { "comment": "/**\r\n * Sets the base tile size for the map. Note: this does not necessarily match the tileWidth and\r\n * tileHeight for all layers. This also updates the base size on all tiles across all layers.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#setBaseTileSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileWidth - The width of the tiles the map uses for calculations.\r\n * @param {number} tileHeight - The height of the tiles the map uses for calculations.\r\n *\r\n * @return {this} This Tilemap object.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2294, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets the base tile size for the map. Note: this does not necessarily match the tileWidth and\rtileHeight for all layers. This also updates the base size on all tiles across all layers.", "kind": "function", "name": "setBaseTileSize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the tiles the map uses for calculations.", "name": "tileWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the tiles the map uses for calculations.", "name": "tileHeight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap object." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#setBaseTileSize", "scope": "instance", "___id": "T000002R042947", "___s": true }, { "comment": "/**\r\n * Sets the tile size for a specific `layer`. Note: this does not necessarily match the maps\r\n * tileWidth and tileHeight for all layers. This will set the tile size for the layer and any\r\n * tiles the layer has.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#setLayerTileSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileWidth - The width of the tiles (in pixels) in the layer.\r\n * @param {number} tileHeight - The height of the tiles (in pixels) in the layer.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The name of the layer from Tiled, the index of the layer in the map or a TilemapLayer. If not given will default to the maps current layer index.\r\n *\r\n * @return {this} This Tilemap object.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets the tile size for a specific `layer`. Note: this does not necessarily match the maps\rtileWidth and tileHeight for all layers. This will set the tile size for the layer and any\rtiles the layer has.", "kind": "function", "name": "setLayerTileSize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the tiles (in pixels) in the layer.", "name": "tileWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the tiles (in pixels) in the layer.", "name": "tileHeight" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The name of the layer from Tiled, the index of the layer in the map or a TilemapLayer. If not given will default to the maps current layer index.", "name": "layer" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap object." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#setLayerTileSize", "scope": "instance", "___id": "T000002R042962", "___s": true }, { "comment": "/**\r\n * Shuffles the tiles in a rectangular region (specified in tile coordinates) within the given\r\n * layer. It will only randomize the tiles in that area, so if they're all the same nothing will\r\n * appear to have changed! This method only modifies tile indexes and does not change collision\r\n * information.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#shuffle\r\n * @since 3.0.0\r\n *\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Return this Tilemap object, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2383, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Shuffles the tiles in a rectangular region (specified in tile coordinates) within the given\rlayer. It will only randomize the tiles in that area, so if they're all the same nothing will\rappear to have changed! This method only modifies tile indexes and does not change collision\rinformation.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "shuffle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Return this Tilemap object, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#shuffle", "scope": "instance", "___id": "T000002R042973", "___s": true }, { "comment": "/**\r\n * Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\r\n * `indexA` and swaps then with `indexB`. This only modifies the index and does not change collision\r\n * information.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#swapByIndex\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileA - First tile index.\r\n * @param {number} tileB - Second tile index.\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Return this Tilemap object, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2413, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\r`indexA` and swaps then with `indexB`. This only modifies the index and does not change collision\rinformation.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "swapByIndex", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "First tile index.", "name": "tileA" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Second tile index.", "name": "tileB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Return this Tilemap object, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#swapByIndex", "scope": "instance", "___id": "T000002R042976", "___s": true }, { "comment": "/**\r\n * Converts from tile X coordinates (tile units) to world X coordinates (pixels), factoring in the\r\n * layers position, scale and scroll.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#tileToWorldX\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?number} Returns a number, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Converts from tile X coordinates (tile units) to world X coordinates (pixels), factoring in the\rlayers position, scale and scroll.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "tileToWorldX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "nullable": true, "description": "Returns a number, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#tileToWorldX", "scope": "instance", "___id": "T000002R042979", "___s": true }, { "comment": "/**\r\n * Converts from tile Y coordinates (tile units) to world Y coordinates (pixels), factoring in the\r\n * layers position, scale and scroll.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#tileToWorldY\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?number} Returns a number, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Converts from tile Y coordinates (tile units) to world Y coordinates (pixels), factoring in the\rlayers position, scale and scroll.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "tileToWorldY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "nullable": true, "description": "Returns a number, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#tileToWorldY", "scope": "instance", "___id": "T000002R042982", "___s": true }, { "comment": "/**\r\n * Converts from tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\r\n * layers position, scale and scroll. This will return a new Vector2 object or update the given\r\n * `point` object.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#tileToWorldXY\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {Phaser.Math.Vector2} [vec2] - A Vector2 to store the coordinates in. If not given a new Vector2 is created.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Math.Vector2} Returns a Vector2, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Converts from tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\rlayers position, scale and scroll. This will return a new Vector2 object or update the given\r`point` object.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "tileToWorldXY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 to store the coordinates in. If not given a new Vector2 is created.", "name": "vec2" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2", "nullable": true } }, "nullable": true, "description": "Returns a Vector2, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#tileToWorldXY", "scope": "instance", "___id": "T000002R042985", "___s": true }, { "comment": "/**\r\n * Returns an array of Vector2s where each entry corresponds to the corner of the requested tile.\r\n *\r\n * The `tileX` and `tileY` parameters are in tile coordinates, not world coordinates.\r\n *\r\n * The corner coordinates are in world space, having factored in TilemapLayer scale, position\r\n * and the camera, if given.\r\n *\r\n * The size of the array will vary based on the orientation of the map. For example an\r\n * orthographic map will return an array of 4 vectors, where-as a hexagonal map will,\r\n * of course, return an array of 6 corner vectors.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#getTileCorners\r\n * @since 3.60.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Math.Vector2[]} Returns an array of Vector2s, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2519, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Returns an array of Vector2s where each entry corresponds to the corner of the requested tile.\r\rThe `tileX` and `tileY` parameters are in tile coordinates, not world coordinates.\r\rThe corner coordinates are in world space, having factored in TilemapLayer scale, position\rand the camera, if given.\r\rThe size of the array will vary based on the orientation of the map. For example an\rorthographic map will return an array of 4 vectors, where-as a hexagonal map will,\rof course, return an array of 6 corner vectors.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "getTileCorners", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ], "nullable": true } }, "nullable": true, "description": "Returns an array of Vector2s, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#getTileCorners", "scope": "instance", "___id": "T000002R042988", "___s": true }, { "comment": "/**\r\n * Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\r\n * specified layer. Each tile will receive a new index. New indexes are drawn from the given\r\n * weightedIndexes array. An example weighted array:\r\n *\r\n * [\r\n * { index: 6, weight: 4 }, // Probability of index 6 is 4 / 8\r\n * { index: 7, weight: 2 }, // Probability of index 7 would be 2 / 8\r\n * { index: 8, weight: 1.5 }, // Probability of index 8 would be 1.5 / 8\r\n * { index: 26, weight: 0.5 } // Probability of index 27 would be 0.5 / 8\r\n * ]\r\n *\r\n * The probability of any index being picked is (the indexs weight) / (sum of all weights). This\r\n * method only modifies tile indexes and does not change collision information.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#weightedRandomize\r\n * @since 3.0.0\r\n *\r\n * @param {object[]} weightedIndexes - An array of objects to randomly draw from during randomization. They should be in the form: { index: 0, weight: 4 } or { index: [0, 1], weight: 4 } if you wish to draw from multiple tile indexes.\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Tilemaps.Tilemap} Return this Tilemap object, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2552, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\rspecified layer. Each tile will receive a new index. New indexes are drawn from the given\rweightedIndexes array. An example weighted array:\r\r[\r { index: 6, weight: 4 }, // Probability of index 6 is 4 / 8\r { index: 7, weight: 2 }, // Probability of index 7 would be 2 / 8\r { index: 8, weight: 1.5 }, // Probability of index 8 would be 1.5 / 8\r { index: 26, weight: 0.5 } // Probability of index 27 would be 0.5 / 8\r]\r\rThe probability of any index being picked is (the indexs weight) / (sum of all weights). This\rmethod only modifies tile indexes and does not change collision information.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "weightedRandomize", "since": "3.0.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } }, "description": "An array of objects to randomly draw from during randomization. They should be in the form: { index: 0, weight: 4 } or { index: [0, 1], weight: 4 } if you wish to draw from multiple tile indexes.", "name": "weightedIndexes" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap", "nullable": true } }, "nullable": true, "description": "Return this Tilemap object, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#weightedRandomize", "scope": "instance", "___id": "T000002R042991", "___s": true }, { "comment": "/**\r\n * Converts from world X coordinates (pixels) to tile X coordinates (tile units), factoring in the\r\n * layers position, scale and scroll.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * You cannot call this method for Isometric or Hexagonal tilemaps as they require\r\n * both `worldX` and `worldY` values to determine the correct tile, instead you\r\n * should use the `worldToTileXY` method.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#worldToTileX\r\n * @since 3.0.0\r\n *\r\n * @param {number} worldX - The x coordinate to be converted, in pixels, not tiles.\r\n * @param {boolean} [snapToFloor] - Whether or not to round the tile coordinate down to the nearest integer.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?number} Returns a number, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Converts from world X coordinates (pixels) to tile X coordinates (tile units), factoring in the\rlayers position, scale and scroll.\r\rIf no layer is specified, the maps current layer is used.\r\rYou cannot call this method for Isometric or Hexagonal tilemaps as they require\rboth `worldX` and `worldY` values to determine the correct tile, instead you\rshould use the `worldToTileXY` method.", "kind": "function", "name": "worldToTileX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to be converted, in pixels, not tiles.", "name": "worldX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether or not to round the tile coordinate down to the nearest integer.", "name": "snapToFloor" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "nullable": true, "description": "Returns a number, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#worldToTileX", "scope": "instance", "___id": "T000002R042994", "___s": true }, { "comment": "/**\r\n * Converts from world Y coordinates (pixels) to tile Y coordinates (tile units), factoring in the\r\n * layers position, scale and scroll.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * You cannot call this method for Isometric or Hexagonal tilemaps as they require\r\n * both `worldX` and `worldY` values to determine the correct tile, instead you\r\n * should use the `worldToTileXY` method.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#worldToTileY\r\n * @since 3.0.0\r\n *\r\n * @param {number} worldY - The y coordinate to be converted, in pixels, not tiles.\r\n * @param {boolean} [snapToFloor] - Whether or not to round the tile coordinate down to the nearest integer.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?number} Returns a number, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2621, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Converts from world Y coordinates (pixels) to tile Y coordinates (tile units), factoring in the\rlayers position, scale and scroll.\r\rIf no layer is specified, the maps current layer is used.\r\rYou cannot call this method for Isometric or Hexagonal tilemaps as they require\rboth `worldX` and `worldY` values to determine the correct tile, instead you\rshould use the `worldToTileXY` method.", "kind": "function", "name": "worldToTileY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to be converted, in pixels, not tiles.", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether or not to round the tile coordinate down to the nearest integer.", "name": "snapToFloor" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "nullable": true, "description": "Returns a number, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#worldToTileY", "scope": "instance", "___id": "T000002R042997", "___s": true }, { "comment": "/**\r\n * Converts from world XY coordinates (pixels) to tile XY coordinates (tile units), factoring in the\r\n * layers position, scale and scroll. This will return a new Vector2 object or update the given\r\n * `point` object.\r\n *\r\n * If no layer is specified, the maps current layer is used.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#worldToTileXY\r\n * @since 3.0.0\r\n *\r\n * @param {number} worldX - The x coordinate to be converted, in pixels, not tiles.\r\n * @param {number} worldY - The y coordinate to be converted, in pixels, not tiles.\r\n * @param {boolean} [snapToFloor] - Whether or not to round the tile coordinate down to the nearest integer.\r\n * @param {Phaser.Math.Vector2} [vec2] - A Vector2 to store the coordinates in. If not given a new Vector2 is created.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n * @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.\r\n *\r\n * @return {?Phaser.Math.Vector2} Returns a vec2, or null if the layer given was invalid.\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Converts from world XY coordinates (pixels) to tile XY coordinates (tile units), factoring in the\rlayers position, scale and scroll. This will return a new Vector2 object or update the given\r`point` object.\r\rIf no layer is specified, the maps current layer is used.", "kind": "function", "name": "worldToTileXY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to be converted, in pixels, not tiles.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to be converted, in pixels, not tiles.", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether or not to round the tile coordinate down to the nearest integer.", "name": "snapToFloor" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 to store the coordinates in. If not given a new Vector2 is created.", "name": "vec2" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" }, { "type": { "names": [ "string", "number", "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } ] } }, "optional": true, "description": "The tile layer to use. If not given the current layer is used.", "name": "layer" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2", "nullable": true } }, "nullable": true, "description": "Returns a vec2, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#worldToTileXY", "scope": "instance", "___id": "T000002R043000", "___s": true }, { "comment": "/**\r\n * Removes all layer data from this Tilemap and nulls the scene reference. This will destroy any\r\n * TilemapLayers that have been created.\r\n *\r\n * @method Phaser.Tilemaps.Tilemap#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tilemap.js", "lineno": 2678, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Removes all layer data from this Tilemap and nulls the scene reference. This will destroy any\rTilemapLayers that have been created.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tilemap", "longname": "Phaser.Tilemaps.Tilemap#destroy", "scope": "instance", "___id": "T000002R043003", "___s": true }, { "comment": "/**\r\n * Creates a Tilemap from the given key or data, or creates a blank Tilemap if no key/data provided.\r\n * When loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing\r\n * from a map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map\r\n * data. For an empty map, you should specify tileWidth, tileHeight, width & height.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#tilemap\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Tilemaps.TilemapConfig} [config] - The config options for the Tilemap.\r\n *\r\n * @return {Phaser.Tilemaps.Tilemap}\r\n */", "meta": { "filename": "TilemapCreator.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Creates a Tilemap from the given key or data, or creates a blank Tilemap if no key/data provided.\rWhen loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing\rfrom a map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map\rdata. For an empty map, you should specify tileWidth, tileHeight, width & height.", "kind": "function", "name": "tilemap", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Tilemaps.TilemapConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.TilemapConfig" } }, "optional": true, "description": "The config options for the Tilemap.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap" } } } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#tilemap", "scope": "instance", "___id": "T000002R043012", "___s": true }, { "comment": "/**\r\n * Creates a Tilemap from the given key or data, or creates a blank Tilemap if no key/data provided.\r\n * When loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing\r\n * from a map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map\r\n * data. For an empty map, you should specify tileWidth, tileHeight, width & height.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#tilemap\r\n * @since 3.0.0\r\n *\r\n * @param {string} [key] - The key in the Phaser cache that corresponds to the loaded tilemap data.\r\n * @param {number} [tileWidth=32] - The width of a tile in pixels. Pass in `null` to leave as the\r\n * default.\r\n * @param {number} [tileHeight=32] - The height of a tile in pixels. Pass in `null` to leave as the\r\n * default.\r\n * @param {number} [width=10] - The width of the map in tiles. Pass in `null` to leave as the\r\n * default.\r\n * @param {number} [height=10] - The height of the map in tiles. Pass in `null` to leave as the\r\n * default.\r\n * @param {number[][]} [data] - Instead of loading from the cache, you can also load directly from\r\n * a 2D array of tile indexes. Pass in `null` for no data.\r\n * @param {boolean} [insertNull=false] - Controls how empty tiles, tiles with an index of -1, in the\r\n * map data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\r\n * location will get a Tile object with an index of -1. If you've a large sparsely populated map and\r\n * the tile data doesn't need to change then setting this value to `true` will help with memory\r\n * consumption. However if your map is small or you need to update the tiles dynamically, then leave\r\n * the default value set.\r\n *\r\n * @return {Phaser.Tilemaps.Tilemap}\r\n */", "meta": { "filename": "TilemapFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Creates a Tilemap from the given key or data, or creates a blank Tilemap if no key/data provided.\rWhen loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing\rfrom a map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map\rdata. For an empty map, you should specify tileWidth, tileHeight, width & height.", "kind": "function", "name": "tilemap", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The key in the Phaser cache that corresponds to the loaded tilemap data.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The width of a tile in pixels. Pass in `null` to leave as the\rdefault.", "name": "tileWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The height of a tile in pixels. Pass in `null` to leave as the\rdefault.", "name": "tileHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The width of the map in tiles. Pass in `null` to leave as the\rdefault.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The height of the map in tiles. Pass in `null` to leave as the\rdefault.", "name": "height" }, { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "Instead of loading from the cache, you can also load directly from\ra 2D array of tile indexes. Pass in `null` for no data.", "name": "data" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Controls how empty tiles, tiles with an index of -1, in the\rmap data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\rlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\rthe tile data doesn't need to change then setting this value to `true` will help with memory\rconsumption. However if your map is small or you need to update the tiles dynamically, then leave\rthe default value set.", "name": "insertNull" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap" } } } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#tilemap", "scope": "instance", "___id": "T000002R043016", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Tilemap Layer is a Game Object that renders LayerData from a Tilemap when used in combination\r\n * with one, or more, Tilesets.\r\n *\r\n * @class TilemapLayer\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.Tilemaps\r\n * @constructor\r\n * @since 3.50.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.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.Pipeline\r\n * @extends Phaser.GameObjects.Components.PostPipeline\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n * @extends Phaser.Physics.Arcade.Components.Collision\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n * @param {Phaser.Tilemaps.Tilemap} tilemap - The Tilemap this layer is a part of.\r\n * @param {number} layerIndex - The index of the LayerData associated with this layer.\r\n * @param {(string|string[]|Phaser.Tilemaps.Tileset|Phaser.Tilemaps.Tileset[])} tileset - The tileset, or an array of tilesets, used to render this layer. Can be a string or a Tileset object.\r\n * @param {number} [x=0] - The world x position where the top left of this layer will be placed.\r\n * @param {number} [y=0] - The world y position where the top left of this layer will be placed.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "classdesc": "A Tilemap Layer is a Game Object that renders LayerData from a Tilemap when used in combination\rwith one, or more, Tilesets.", "kind": "class", "name": "TilemapLayer", "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.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.Pipeline", "Phaser.GameObjects.Components.PostPipeline", "Phaser.GameObjects.Components.ScrollFactor", "Phaser.GameObjects.Components.Transform", "Phaser.GameObjects.Components.Visible", "Phaser.Physics.Arcade.Components.Collision" ], "memberof": "Phaser.Tilemaps", "since": "3.50.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.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap" } }, "description": "The Tilemap this layer is a part of.", "name": "tilemap" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the LayerData associated with this layer.", "name": "layerIndex" }, { "type": { "names": [ "string", "Array.", "Phaser.Tilemaps.Tileset", "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.Tilemaps.Tileset" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tileset", "type": "NameExpression" } ] } ] } }, "description": "The tileset, or an array of tilesets, used to render this layer. Can be a string or a Tileset object.", "name": "tileset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The world x position where the top left of this layer will be placed.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The world y position where the top left of this layer will be placed.", "name": "y" } ], "scope": "static", "longname": "Phaser.Tilemaps.TilemapLayer", "___id": "T000002R043029", "___s": true }, { "comment": "/**\r\n * Used internally by physics system to perform fast type checks.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#isTilemap\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Used internally by physics system to perform fast type checks.", "name": "isTilemap", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#isTilemap", "scope": "instance", "kind": "member", "___id": "T000002R043034", "___s": true }, { "comment": "/**\r\n * The Tilemap that this layer is a part of.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#tilemap\r\n * @type {Phaser.Tilemaps.Tilemap}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The Tilemap that this layer is a part of.", "name": "tilemap", "type": { "names": [ "Phaser.Tilemaps.Tilemap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tilemap" } }, "since": "3.50.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#tilemap", "scope": "instance", "kind": "member", "___id": "T000002R043036", "___s": true }, { "comment": "/**\r\n * The index of the LayerData associated with this layer.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#layerIndex\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The index of the LayerData associated with this layer.", "name": "layerIndex", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#layerIndex", "scope": "instance", "kind": "member", "___id": "T000002R043038", "___s": true }, { "comment": "/**\r\n * The LayerData associated with this layer. LayerData can only be associated with one\r\n * tilemap layer.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#layer\r\n * @type {Phaser.Tilemaps.LayerData}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The LayerData associated with this layer. LayerData can only be associated with one\rtilemap layer.", "name": "layer", "type": { "names": [ "Phaser.Tilemaps.LayerData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.LayerData" } }, "since": "3.50.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#layer", "scope": "instance", "kind": "member", "___id": "T000002R043040", "___s": true }, { "comment": "/**\r\n * An array of `Tileset` objects associated with this layer.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#tileset\r\n * @type {Phaser.Tilemaps.Tileset[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 117, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "An array of `Tileset` objects associated with this layer.", "name": "tileset", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tileset", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#tileset", "scope": "instance", "kind": "member", "___id": "T000002R043043", "___s": true }, { "comment": "/**\r\n * The total number of tiles drawn by the renderer in the last frame.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#tilesDrawn\r\n * @type {number}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 126, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The total number of tiles drawn by the renderer in the last frame.", "name": "tilesDrawn", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#tilesDrawn", "scope": "instance", "kind": "member", "___id": "T000002R043045", "___s": true }, { "comment": "/**\r\n * The total number of tiles in this layer. Updated every frame.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#tilesTotal\r\n * @type {number}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The total number of tiles in this layer. Updated every frame.", "name": "tilesTotal", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#tilesTotal", "scope": "instance", "kind": "member", "___id": "T000002R043047", "___s": true }, { "comment": "/**\r\n * Used internally during rendering. This holds the tiles that are visible within the Camera.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#culledTiles\r\n * @type {Phaser.Tilemaps.Tile[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 146, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Used internally during rendering. This holds the tiles that are visible within the Camera.", "name": "culledTiles", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#culledTiles", "scope": "instance", "kind": "member", "___id": "T000002R043049", "___s": true }, { "comment": "/**\r\n * You can control if the camera should cull tiles on this layer before rendering them or not.\r\n *\r\n * By default the camera will try to cull the tiles in this layer, to avoid over-drawing to the renderer.\r\n *\r\n * However, there are some instances when you may wish to disable this, and toggling this flag allows\r\n * you to do so. Also see `setSkipCull` for a chainable method that does the same thing.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#skipCull\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 155, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "You can control if the camera should cull tiles on this layer before rendering them or not.\r\rBy default the camera will try to cull the tiles in this layer, to avoid over-drawing to the renderer.\r\rHowever, there are some instances when you may wish to disable this, and toggling this flag allows\ryou to do so. Also see `setSkipCull` for a chainable method that does the same thing.", "name": "skipCull", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#skipCull", "scope": "instance", "kind": "member", "___id": "T000002R043051", "___s": true }, { "comment": "/**\r\n * The amount of extra tiles to add into the cull rectangle when calculating its horizontal size.\r\n *\r\n * See the method `setCullPadding` for more details.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#cullPaddingX\r\n * @type {number}\r\n * @default 1\r\n * @since 3.50.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 169, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The amount of extra tiles to add into the cull rectangle when calculating its horizontal size.\r\rSee the method `setCullPadding` for more details.", "name": "cullPaddingX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.50.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#cullPaddingX", "scope": "instance", "kind": "member", "___id": "T000002R043053", "___s": true }, { "comment": "/**\r\n * The amount of extra tiles to add into the cull rectangle when calculating its vertical size.\r\n *\r\n * See the method `setCullPadding` for more details.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#cullPaddingY\r\n * @type {number}\r\n * @default 1\r\n * @since 3.50.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 181, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The amount of extra tiles to add into the cull rectangle when calculating its vertical size.\r\rSee the method `setCullPadding` for more details.", "name": "cullPaddingY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.50.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#cullPaddingY", "scope": "instance", "kind": "member", "___id": "T000002R043055", "___s": true }, { "comment": "/**\r\n * The callback that is invoked when the tiles are culled.\r\n *\r\n * It will call a different function based on the map orientation:\r\n *\r\n * Orthogonal (the default) is `TilemapComponents.CullTiles`\r\n * Isometric is `TilemapComponents.IsometricCullTiles`\r\n * Hexagonal is `TilemapComponents.HexagonalCullTiles`\r\n * Staggered is `TilemapComponents.StaggeredCullTiles`\r\n *\r\n * However, you can override this to call any function you like.\r\n *\r\n * It will be sent 4 arguments:\r\n *\r\n * 1. The Phaser.Tilemaps.LayerData object for this Layer\r\n * 2. The Camera that is culling the layer. You can check its `dirty` property to see if it has changed since the last cull.\r\n * 3. A reference to the `culledTiles` array, which should be used to store the tiles you want rendered.\r\n * 4. The Render Order constant.\r\n *\r\n * See the `TilemapComponents.CullTiles` source code for details on implementing your own culling system.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#cullCallback\r\n * @type {function}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 193, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The callback that is invoked when the tiles are culled.\r\rIt will call a different function based on the map orientation:\r\rOrthogonal (the default) is `TilemapComponents.CullTiles`\rIsometric is `TilemapComponents.IsometricCullTiles`\rHexagonal is `TilemapComponents.HexagonalCullTiles`\rStaggered is `TilemapComponents.StaggeredCullTiles`\r\rHowever, you can override this to call any function you like.\r\rIt will be sent 4 arguments:\r\r1. The Phaser.Tilemaps.LayerData object for this Layer\r2. The Camera that is culling the layer. You can check its `dirty` property to see if it has changed since the last cull.\r3. A reference to the `culledTiles` array, which should be used to store the tiles you want rendered.\r4. The Render Order constant.\r\rSee the `TilemapComponents.CullTiles` source code for details on implementing your own culling system.", "name": "cullCallback", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.50.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#cullCallback", "scope": "instance", "kind": "member", "___id": "T000002R043057", "___s": true }, { "comment": "/**\r\n * An array holding the mapping between the tile indexes and the tileset they belong to.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#gidMap\r\n * @type {Phaser.Tilemaps.Tileset[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 243, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "An array holding the mapping between the tile indexes and the tileset they belong to.", "name": "gidMap", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tileset", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#gidMap", "scope": "instance", "kind": "member", "___id": "T000002R043061", "___s": true }, { "comment": "/**\r\n * The Tilemap Layer Collision Category.\r\n *\r\n * This is exclusively used by the Arcade Physics system.\r\n *\r\n * This can be set to any valid collision bitfield value.\r\n *\r\n * See the `setCollisionCategory` method for more details.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#collisionCategory\r\n * @type {number}\r\n * @since 3.61.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 262, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The Tilemap Layer Collision Category.\r\rThis is exclusively used by the Arcade Physics system.\r\rThis can be set to any valid collision bitfield value.\r\rSee the `setCollisionCategory` method for more details.", "name": "collisionCategory", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.61.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#collisionCategory", "scope": "instance", "kind": "member", "___id": "T000002R043065", "___s": true }, { "comment": "/**\r\n * The Tilemap Layer Collision Mask.\r\n *\r\n * This is exclusively used by the Arcade Physics system.\r\n *\r\n * See the `setCollidesWith` method for more details.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#collisionMask\r\n * @type {number}\r\n * @since 3.61.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 277, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The Tilemap Layer Collision Mask.\r\rThis is exclusively used by the Arcade Physics system.\r\rSee the `setCollidesWith` method for more details.", "name": "collisionMask", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.61.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#collisionMask", "scope": "instance", "kind": "member", "___id": "T000002R043067", "___s": true }, { "comment": "/**\r\n * The horizontal origin of this Tilemap Layer.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#originX\r\n * @type {number}\r\n * @default 0\r\n * @readOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 290, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The horizontal origin of this Tilemap Layer.", "name": "originX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#originX", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Components.Origin#originX", "___id": "T000002R043069", "___s": true }, { "comment": "/**\r\n * The vertical origin of this Tilemap Layer.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#originY\r\n * @type {number}\r\n * @default 0\r\n * @readOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 300, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The vertical origin of this Tilemap Layer.", "name": "originY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#originY", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Components.Origin#originY", "___id": "T000002R043070", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Tilemap Layer.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#displayOriginX\r\n * @type {number}\r\n * @default 0\r\n * @readOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 310, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The horizontal display origin of this Tilemap Layer.", "name": "displayOriginX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#displayOriginX", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Components.Origin#displayOriginX", "___id": "T000002R043071", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Tilemap Layer.\r\n *\r\n * @name Phaser.Tilemaps.TilemapLayer#displayOriginY\r\n * @type {number}\r\n * @default 0\r\n * @readOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 320, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The vertical display origin of this Tilemap Layer.", "name": "displayOriginY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#displayOriginY", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Components.Origin#displayOriginY", "___id": "T000002R043072", "___s": true }, { "comment": "/**\r\n * Sets the rendering (draw) order of the tiles in this layer.\r\n *\r\n * The default is 'right-down', meaning it will order the tiles starting from the top-left,\r\n * drawing to the right and then moving down to the next row.\r\n *\r\n * The draw orders are:\r\n *\r\n * 0 = right-down\r\n * 1 = left-down\r\n * 2 = right-up\r\n * 3 = left-up\r\n *\r\n * Setting the render order does not change the tiles or how they are stored in the layer,\r\n * it purely impacts the order in which they are rendered.\r\n *\r\n * You can provide either an integer (0 to 3), or the string version of the order.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#setRenderOrder\r\n * @since 3.50.0\r\n *\r\n * @param {(number|string)} renderOrder - The render (draw) order value. Either an integer between 0 and 3, or a string: 'right-down', 'left-down', 'right-up' or 'left-up'.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 386, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets the rendering (draw) order of the tiles in this layer.\r\rThe default is 'right-down', meaning it will order the tiles starting from the top-left,\rdrawing to the right and then moving down to the next row.\r\rThe draw orders are:\r\r0 = right-down\r1 = left-down\r2 = right-up\r3 = left-up\r\rSetting the render order does not change the tiles or how they are stored in the layer,\rit purely impacts the order in which they are rendered.\r\rYou can provide either an integer (0 to 3), or the string version of the order.", "kind": "function", "name": "setRenderOrder", "since": "3.50.0", "params": [ { "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The render (draw) order value. Either an integer between 0 and 3, or a string: 'right-down', 'left-down', 'right-up' or 'left-up'.", "name": "renderOrder" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#setRenderOrder", "scope": "instance", "___id": "T000002R043087", "___s": true }, { "comment": "/**\r\n * Calculates interesting faces at the given tile coordinates of the specified layer. Interesting\r\n * faces are used internally for optimizing collisions against tiles. This method is mostly used\r\n * internally to optimize recalculating faces when only one tile has been changed.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#calculateFacesAt\r\n * @since 3.50.0\r\n *\r\n * @param {number} tileX - The x coordinate.\r\n * @param {number} tileY - The y coordinate.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 428, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Calculates interesting faces at the given tile coordinates of the specified layer. Interesting\rfaces are used internally for optimizing collisions against tiles. This method is mostly used\rinternally to optimize recalculating faces when only one tile has been changed.", "kind": "function", "name": "calculateFacesAt", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate.", "name": "tileY" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#calculateFacesAt", "scope": "instance", "___id": "T000002R043092", "___s": true }, { "comment": "/**\r\n * Calculates interesting faces within the rectangular area specified (in tile coordinates) of the\r\n * layer. Interesting faces are used internally for optimizing collisions against tiles. This method\r\n * is mostly used internally.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#calculateFacesWithin\r\n * @since 3.50.0\r\n *\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 448, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Calculates interesting faces within the rectangular area specified (in tile coordinates) of the\rlayer. Interesting faces are used internally for optimizing collisions against tiles. This method\ris mostly used internally.", "kind": "function", "name": "calculateFacesWithin", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#calculateFacesWithin", "scope": "instance", "___id": "T000002R043094", "___s": true }, { "comment": "/**\r\n * Creates a Sprite for every object matching the given tile indexes in the layer. You can\r\n * optionally specify if each tile will be replaced with a new tile after the Sprite has been\r\n * created. This is useful if you want to lay down special tiles in a level that are converted to\r\n * Sprites, but want to replace the tile itself with a floor tile or similar once converted.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#createFromTiles\r\n * @since 3.50.0\r\n *\r\n * @param {(number|array)} indexes - The tile index, or array of indexes, to create Sprites from.\r\n * @param {?(number|array)} replacements - The tile index, or array of indexes, to change a converted\r\n * tile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a\r\n * one-to-one mapping with the indexes array.\r\n * @param {Phaser.Types.GameObjects.Sprite.SpriteConfig} [spriteConfig] - The config object to pass into the Sprite creator (i.e.\r\n * scene.make.sprite).\r\n * @param {Phaser.Scene} [scene] - The Scene to create the Sprites within.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when determining the world XY\r\n *\r\n * @return {Phaser.GameObjects.Sprite[]} An array of the Sprites that were created.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 470, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Creates a Sprite for every object matching the given tile indexes in the layer. You can\roptionally specify if each tile will be replaced with a new tile after the Sprite has been\rcreated. This is useful if you want to lay down special tiles in a level that are converted to\rSprites, but want to replace the tile itself with a floor tile or similar once converted.", "kind": "function", "name": "createFromTiles", "since": "3.50.0", "params": [ { "type": { "names": [ "number", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "array" } ] } }, "description": "The tile index, or array of indexes, to create Sprites from.", "name": "indexes" }, { "type": { "names": [ "number", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "array" } ], "nullable": true } }, "nullable": true, "description": "The tile index, or array of indexes, to change a converted\rtile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a\rone-to-one mapping with the indexes array.", "name": "replacements" }, { "type": { "names": [ "Phaser.Types.GameObjects.Sprite.SpriteConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Sprite.SpriteConfig" } }, "optional": true, "description": "The config object to pass into the Sprite creator (i.e.\rscene.make.sprite).", "name": "spriteConfig" }, { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "optional": true, "description": "The Scene to create the Sprites within.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when determining the world XY", "name": "camera" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Sprite", "type": "NameExpression" } ] } }, "description": "An array of the Sprites that were created." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#createFromTiles", "scope": "instance", "___id": "T000002R043096", "___s": true }, { "comment": "/**\r\n * Returns the tiles in the given layer that are within the cameras viewport.\r\n * This is used internally during rendering.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#cull\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to run the cull check against.\r\n *\r\n * @return {Phaser.Tilemaps.Tile[]} An array of Tile objects to render.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Returns the tiles in the given layer that are within the cameras viewport.\rThis is used internally during rendering.", "kind": "function", "name": "cull", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to run the cull check against.", "name": "camera" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of Tile objects to render." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#cull", "scope": "instance", "___id": "T000002R043098", "___s": true }, { "comment": "/**\r\n * Copies the tiles in the source rectangular area to a new destination (all specified in tile\r\n * coordinates) within the layer. This copies all tile properties & recalculates collision\r\n * information in the destination region.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#copy\r\n * @since 3.50.0\r\n *\r\n * @param {number} srcTileX - The x coordinate of the area to copy from, in tiles, not pixels.\r\n * @param {number} srcTileY - The y coordinate of the area to copy from, in tiles, not pixels.\r\n * @param {number} width - The width of the area to copy, in tiles, not pixels.\r\n * @param {number} height - The height of the area to copy, in tiles, not pixels.\r\n * @param {number} destTileX - The x coordinate of the area to copy to, in tiles, not pixels.\r\n * @param {number} destTileY - The y coordinate of the area to copy to, in tiles, not pixels.\r\n * @param {boolean} [recalculateFaces=true] - `true` if the faces data should be recalculated.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 511, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Copies the tiles in the source rectangular area to a new destination (all specified in tile\rcoordinates) within the layer. This copies all tile properties & recalculates collision\rinformation in the destination region.", "kind": "function", "name": "copy", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the area to copy from, in tiles, not pixels.", "name": "srcTileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the area to copy from, in tiles, not pixels.", "name": "srcTileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the area to copy, in tiles, not pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the area to copy, in tiles, not pixels.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the area to copy to, in tiles, not pixels.", "name": "destTileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the area to copy to, in tiles, not pixels.", "name": "destTileY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#copy", "scope": "instance", "___id": "T000002R043100", "___s": true }, { "comment": "/**\r\n * Sets the tiles in the given rectangular area (in tile coordinates) of the layer with the\r\n * specified index. Tiles will be set to collide if the given index is a colliding index.\r\n * Collision information in the region will be recalculated.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#fill\r\n * @since 3.50.0\r\n *\r\n * @param {number} index - The tile index to fill the area with.\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {boolean} [recalculateFaces=true] - `true` if the faces data should be recalculated.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 536, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets the tiles in the given rectangular area (in tile coordinates) of the layer with the\rspecified index. Tiles will be set to collide if the given index is a colliding index.\rCollision information in the region will be recalculated.", "kind": "function", "name": "fill", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tile index to fill the area with.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#fill", "scope": "instance", "___id": "T000002R043102", "___s": true }, { "comment": "/**\r\n * For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\r\n * filter callback function. Any tiles that pass the filter test (i.e. where the callback returns\r\n * true) will returned as a new array. Similar to Array.prototype.Filter in vanilla JS.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#filterTiles\r\n * @since 3.50.0\r\n *\r\n * @param {function} callback - The callback. Each tile in the given area will be passed to this\r\n * callback as the first and only parameter. The callback should return true for tiles that pass the\r\n * filter.\r\n * @param {object} [context] - The context under which the callback should be run.\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area to filter.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area to filter.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.\r\n *\r\n * @return {Phaser.Tilemaps.Tile[]} An array of Tile objects.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 560, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\rfilter callback function. Any tiles that pass the filter test (i.e. where the callback returns\rtrue) will returned as a new array. Similar to Array.prototype.Filter in vanilla JS.", "kind": "function", "name": "filterTiles", "since": "3.50.0", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback. Each tile in the given area will be passed to this\rcallback as the first and only parameter. The callback should return true for tiles that pass the\rfilter.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The context under which the callback should be run.", "name": "context" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area to filter.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area to filter.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "optional": true, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of Tile objects." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#filterTiles", "scope": "instance", "___id": "T000002R043104", "___s": true }, { "comment": "/**\r\n * Searches the entire map layer for the first tile matching the given index, then returns that Tile\r\n * object. If no match is found, it returns null. The search starts from the top-left tile and\r\n * continues horizontally until it hits the end of the row, then it drops down to the next column.\r\n * If the reverse boolean is true, it scans starting from the bottom-right corner traveling up to\r\n * the top-left.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#findByIndex\r\n * @since 3.50.0\r\n *\r\n * @param {number} index - The tile index value to search for.\r\n * @param {number} [skip=0] - The number of times to skip a matching tile before returning.\r\n * @param {boolean} [reverse=false] - If true it will scan the layer in reverse, starting at the bottom-right. Otherwise it scans from the top-left.\r\n *\r\n * @return {Phaser.Tilemaps.Tile} The first matching Tile object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 585, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Searches the entire map layer for the first tile matching the given index, then returns that Tile\robject. If no match is found, it returns null. The search starts from the top-left tile and\rcontinues horizontally until it hits the end of the row, then it drops down to the next column.\rIf the reverse boolean is true, it scans starting from the bottom-right corner traveling up to\rthe top-left.", "kind": "function", "name": "findByIndex", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tile index value to search for.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of times to skip a matching tile before returning.", "name": "skip" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If true it will scan the layer in reverse, starting at the bottom-right. Otherwise it scans from the top-left.", "name": "reverse" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The first matching Tile object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#findByIndex", "scope": "instance", "___id": "T000002R043106", "___s": true }, { "comment": "/**\r\n * Find the first tile in the given rectangular area (in tile coordinates) of the layer that\r\n * satisfies the provided testing function. I.e. finds the first tile for which `callback` returns\r\n * true. Similar to Array.prototype.find in vanilla JS.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#findTile\r\n * @since 3.50.0\r\n *\r\n * @param {FindTileCallback} callback - The callback. Each tile in the given area will be passed to this callback as the first and only parameter.\r\n * @param {object} [context] - The context under which the callback should be run.\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area to search.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area to search.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.\r\n *\r\n * @return {?Phaser.Tilemaps.Tile} The first Tile found at the given location.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 606, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Find the first tile in the given rectangular area (in tile coordinates) of the layer that\rsatisfies the provided testing function. I.e. finds the first tile for which `callback` returns\rtrue. Similar to Array.prototype.find in vanilla JS.", "kind": "function", "name": "findTile", "since": "3.50.0", "params": [ { "type": { "names": [ "FindTileCallback" ], "parsedType": { "type": "NameExpression", "name": "FindTileCallback" } }, "description": "The callback. Each tile in the given area will be passed to this callback as the first and only parameter.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The context under which the callback should be run.", "name": "context" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area to search.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area to search.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "optional": true, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile", "nullable": true } }, "nullable": true, "description": "The first Tile found at the given location." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#findTile", "scope": "instance", "___id": "T000002R043108", "___s": true }, { "comment": "/**\r\n * For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\r\n * callback. Similar to Array.prototype.forEach in vanilla JS.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#forEachTile\r\n * @since 3.50.0\r\n *\r\n * @param {EachTileCallback} callback - The callback. Each tile in the given area will be passed to this callback as the first and only parameter.\r\n * @param {object} [context] - The context, or scope, under which the callback should be run.\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area to search.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area to search.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 629, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\rcallback. Similar to Array.prototype.forEach in vanilla JS.", "kind": "function", "name": "forEachTile", "since": "3.50.0", "params": [ { "type": { "names": [ "EachTileCallback" ], "parsedType": { "type": "NameExpression", "name": "EachTileCallback" } }, "description": "The callback. Each tile in the given area will be passed to this callback as the first and only parameter.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The context, or scope, under which the callback should be run.", "name": "context" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area to search.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area to search.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "optional": true, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#forEachTile", "scope": "instance", "___id": "T000002R043110", "___s": true }, { "comment": "/**\r\n * Sets an additive tint on each Tile within the given area.\r\n *\r\n * The tint works by taking the pixel color values from the tileset texture, and then\r\n * multiplying it by the color value of the tint.\r\n *\r\n * If no area values are given then all tiles will be tinted to the given color.\r\n *\r\n * To remove a tint call this method with either no parameters, or by passing white `0xffffff` as the tint color.\r\n *\r\n * If a tile already has a tint set then calling this method will override that.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#setTint\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {number} [tint=0xffffff] - The tint color being applied to each tile within the region. Given as a hex value, i.e. `0xff0000` for red. Set to white (`0xffffff`) to reset the tint.\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area to search.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area to search.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 653, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets an additive tint on each Tile within the given area.\r\rThe tint works by taking the pixel color values from the tileset texture, and then\rmultiplying it by the color value of the tint.\r\rIf no area values are given then all tiles will be tinted to the given color.\r\rTo remove a tint call this method with either no parameters, or by passing white `0xffffff` as the tint color.\r\rIf a tile already has a tint set then calling this method will override that.", "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 color being applied to each tile within the region. Given as a hex value, i.e. `0xff0000` for red. Set to white (`0xffffff`) to reset the tint.", "name": "tint" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area to search.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area to search.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "optional": true, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#setTint", "scope": "instance", "___id": "T000002R043112", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on each Tile within the given area.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint.\r\n *\r\n * If no area values are given then all tiles will be tinted to the given color.\r\n *\r\n * To remove a tint call this method with either no parameters, or by passing white `0xffffff` as the tint color.\r\n *\r\n * If a tile already has a tint set then calling this method will override that.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#setTintFill\r\n * @webglOnly\r\n * @since 3.61.0\r\n *\r\n * @param {number} [tint=0xffffff] - The tint color being applied to each tile within the region. Given as a hex value, i.e. `0xff0000` for red. Set to white (`0xffffff`) to reset the tint.\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area to search.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area to search.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 691, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets a fill-based tint on each Tile within the given area.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint.\r\rIf no area values are given then all tiles will be tinted to the given color.\r\rTo remove a tint call this method with either no parameters, or by passing white `0xffffff` as the tint color.\r\rIf a tile already has a tint set then calling this method will override that.", "kind": "function", "name": "setTintFill", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.61.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The tint color being applied to each tile within the region. Given as a hex value, i.e. `0xff0000` for red. Set to white (`0xffffff`) to reset the tint.", "name": "tint" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area to search.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area to search.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "optional": true, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#setTintFill", "scope": "instance", "___id": "T000002R043118", "___s": true }, { "comment": "/**\r\n * Gets a tile at the given tile coordinates from the given layer.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#getTileAt\r\n * @since 3.50.0\r\n *\r\n * @param {number} tileX - X position to get the tile from (given in tile units, not pixels).\r\n * @param {number} tileY - Y position to get the tile from (given in tile units, not pixels).\r\n * @param {boolean} [nonNull=false] - If true getTile won't return null for empty tiles, but a Tile object with an index of -1.\r\n *\r\n * @return {Phaser.Tilemaps.Tile} The Tile at the given coordinates or null if no tile was found or the coordinates were invalid.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 729, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets a tile at the given tile coordinates from the given layer.", "kind": "function", "name": "getTileAt", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X position to get the tile from (given in tile units, not pixels).", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y position to get the tile from (given in tile units, not pixels).", "name": "tileY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If true getTile won't return null for empty tiles, but a Tile object with an index of -1.", "name": "nonNull" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The Tile at the given coordinates or null if no tile was found or the coordinates were invalid." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#getTileAt", "scope": "instance", "___id": "T000002R043124", "___s": true }, { "comment": "/**\r\n * Gets a tile at the given world coordinates from the given layer.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#getTileAtWorldXY\r\n * @since 3.50.0\r\n *\r\n * @param {number} worldX - X position to get the tile from (given in pixels)\r\n * @param {number} worldY - Y position to get the tile from (given in pixels)\r\n * @param {boolean} [nonNull=false] - If true, function won't return null for empty tiles, but a Tile object with an index of -1.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n *\r\n * @return {Phaser.Tilemaps.Tile} The tile at the given coordinates or null if no tile was found or the coordinates were invalid.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 746, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets a tile at the given world coordinates from the given layer.", "kind": "function", "name": "getTileAtWorldXY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X position to get the tile from (given in pixels)", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y position to get the tile from (given in pixels)", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If true, function won't return null for empty tiles, but a Tile object with an index of -1.", "name": "nonNull" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The tile at the given coordinates or null if no tile was found or the coordinates were invalid." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#getTileAtWorldXY", "scope": "instance", "___id": "T000002R043126", "___s": true }, { "comment": "/**\r\n * Gets a tile at the given world coordinates from the given isometric layer.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#getIsoTileAtWorldXY\r\n * @since 3.60.0\r\n *\r\n * @param {number} worldX - X position to get the tile from (given in pixels)\r\n * @param {number} worldY - Y position to get the tile from (given in pixels)\r\n * @param {boolean} [originTop=true] - Which is the active face of the isometric tile? The top (default, true), or the base? (false)\r\n * @param {boolean} [nonNull=false] - If true, function won't return null for empty tiles, but a Tile object with an index of -1.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n *\r\n * @return {Phaser.Tilemaps.Tile} The tile at the given coordinates or null if no tile was found or the coordinates were invalid.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 764, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets a tile at the given world coordinates from the given isometric layer.", "kind": "function", "name": "getIsoTileAtWorldXY", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X position to get the tile from (given in pixels)", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y position to get the tile from (given in pixels)", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Which is the active face of the isometric tile? The top (default, true), or the base? (false)", "name": "originTop" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If true, function won't return null for empty tiles, but a Tile object with an index of -1.", "name": "nonNull" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The tile at the given coordinates or null if no tile was found or the coordinates were invalid." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#getIsoTileAtWorldXY", "scope": "instance", "___id": "T000002R043128", "___s": true }, { "comment": "/**\r\n * Gets the tiles in the given rectangular area (in tile coordinates) of the layer.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#getTilesWithin\r\n * @since 3.50.0\r\n *\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.\r\n *\r\n * @return {Phaser.Tilemaps.Tile[]} An array of Tile objects found within the area.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 789, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the tiles in the given rectangular area (in tile coordinates) of the layer.", "kind": "function", "name": "getTilesWithin", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "optional": true, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of Tile objects found within the area." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#getTilesWithin", "scope": "instance", "___id": "T000002R043132", "___s": true }, { "comment": "/**\r\n * Gets the tiles that overlap with the given shape in the given layer. The shape must be a Circle,\r\n * Line, Rectangle or Triangle. The shape should be in world coordinates.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#getTilesWithinShape\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.Geom.Circle|Phaser.Geom.Line|Phaser.Geom.Rectangle|Phaser.Geom.Triangle)} shape - A shape in world (pixel) coordinates\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when factoring in which tiles to return.\r\n *\r\n * @return {Phaser.Tilemaps.Tile[]} An array of Tile objects found within the shape.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 808, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the tiles that overlap with the given shape in the given layer. The shape must be a Circle,\rLine, Rectangle or Triangle. The shape should be in world coordinates.", "kind": "function", "name": "getTilesWithinShape", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Geom.Circle", "Phaser.Geom.Line", "Phaser.Geom.Rectangle", "Phaser.Geom.Triangle" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Circle" }, { "type": "NameExpression", "name": "Phaser.Geom.Line" }, { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } ] } }, "description": "A shape in world (pixel) coordinates", "name": "shape" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "optional": true, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when factoring in which tiles to return.", "name": "camera" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of Tile objects found within the shape." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#getTilesWithinShape", "scope": "instance", "___id": "T000002R043134", "___s": true }, { "comment": "/**\r\n * Gets the tiles in the given rectangular area (in world coordinates) of the layer.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#getTilesWithinWorldXY\r\n * @since 3.50.0\r\n *\r\n * @param {number} worldX - The world x coordinate for the top-left of the area.\r\n * @param {number} worldY - The world y coordinate for the top-left of the area.\r\n * @param {number} width - The width of the area.\r\n * @param {number} height - The height of the area.\r\n * @param {Phaser.Types.Tilemaps.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when factoring in which tiles to return.\r\n *\r\n * @return {Phaser.Tilemaps.Tile[]} An array of Tile objects found within the area.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 826, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Gets the tiles in the given rectangular area (in world coordinates) of the layer.", "kind": "function", "name": "getTilesWithinWorldXY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The world x coordinate for the top-left of the area.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The world y coordinate for the top-left of the area.", "name": "worldY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the area.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the area.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Tilemaps.FilteringOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.FilteringOptions" } }, "optional": true, "description": "Optional filters to apply when getting the tiles.", "name": "filteringOptions" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when factoring in which tiles to return.", "name": "camera" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } }, "description": "An array of Tile objects found within the area." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#getTilesWithinWorldXY", "scope": "instance", "___id": "T000002R043136", "___s": true }, { "comment": "/**\r\n * Checks if there is a tile at the given location (in tile coordinates) in the given layer. Returns\r\n * false if there is no tile or if the tile at that location has an index of -1.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#hasTileAt\r\n * @since 3.50.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n *\r\n * @return {boolean} `true` if a tile was found at the given location, otherwise `false`.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 846, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Checks if there is a tile at the given location (in tile coordinates) in the given layer. Returns\rfalse if there is no tile or if the tile at that location has an index of -1.", "kind": "function", "name": "hasTileAt", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if a tile was found at the given location, otherwise `false`." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#hasTileAt", "scope": "instance", "___id": "T000002R043138", "___s": true }, { "comment": "/**\r\n * Checks if there is a tile at the given location (in world coordinates) in the given layer. Returns\r\n * false if there is no tile or if the tile at that location has an index of -1.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#hasTileAtWorldXY\r\n * @since 3.50.0\r\n *\r\n * @param {number} worldX - The x coordinate, in pixels.\r\n * @param {number} worldY - The y coordinate, in pixels.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when factoring in which tiles to return.\r\n *\r\n * @return {boolean} `true` if a tile was found at the given location, otherwise `false`.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 863, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Checks if there is a tile at the given location (in world coordinates) in the given layer. Returns\rfalse if there is no tile or if the tile at that location has an index of -1.", "kind": "function", "name": "hasTileAtWorldXY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in pixels.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in pixels.", "name": "worldY" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when factoring in which tiles to return.", "name": "camera" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if a tile was found at the given location, otherwise `false`." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#hasTileAtWorldXY", "scope": "instance", "___id": "T000002R043140", "___s": true }, { "comment": "/**\r\n * Puts a tile at the given tile coordinates in the specified layer. You can pass in either an index\r\n * or a Tile object. If you pass in a Tile, all attributes will be copied over to the specified\r\n * location. If you pass in an index, only the index at the specified location will be changed.\r\n * Collision information will be recalculated at the specified location.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#putTileAt\r\n * @since 3.50.0\r\n *\r\n * @param {(number|Phaser.Tilemaps.Tile)} tile - The index of this tile to set or a Tile object.\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {boolean} [recalculateFaces=true] - `true` if the faces data should be recalculated.\r\n *\r\n * @return {Phaser.Tilemaps.Tile} The Tile object that was inserted at the given coordinates.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 881, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Puts a tile at the given tile coordinates in the specified layer. You can pass in either an index\ror a Tile object. If you pass in a Tile, all attributes will be copied over to the specified\rlocation. If you pass in an index, only the index at the specified location will be changed.\rCollision information will be recalculated at the specified location.", "kind": "function", "name": "putTileAt", "since": "3.50.0", "params": [ { "type": { "names": [ "number", "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } ] } }, "description": "The index of this tile to set or a Tile object.", "name": "tile" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The Tile object that was inserted at the given coordinates." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#putTileAt", "scope": "instance", "___id": "T000002R043142", "___s": true }, { "comment": "/**\r\n * Puts a tile at the given world coordinates (pixels) in the specified layer. You can pass in either\r\n * an index or a Tile object. If you pass in a Tile, all attributes will be copied over to the\r\n * specified location. If you pass in an index, only the index at the specified location will be\r\n * changed. Collision information will be recalculated at the specified location.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#putTileAtWorldXY\r\n * @since 3.50.0\r\n *\r\n * @param {(number|Phaser.Tilemaps.Tile)} tile - The index of this tile to set or a Tile object.\r\n * @param {number} worldX - The x coordinate, in pixels.\r\n * @param {number} worldY - The y coordinate, in pixels.\r\n * @param {boolean} [recalculateFaces] - `true` if the faces data should be recalculated.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n *\r\n * @return {Phaser.Tilemaps.Tile} The Tile object that was inserted at the given coordinates.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 902, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Puts a tile at the given world coordinates (pixels) in the specified layer. You can pass in either\ran index or a Tile object. If you pass in a Tile, all attributes will be copied over to the\rspecified location. If you pass in an index, only the index at the specified location will be\rchanged. Collision information will be recalculated at the specified location.", "kind": "function", "name": "putTileAtWorldXY", "since": "3.50.0", "params": [ { "type": { "names": [ "number", "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } ] } }, "description": "The index of this tile to set or a Tile object.", "name": "tile" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in pixels.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in pixels.", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The Tile object that was inserted at the given coordinates." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#putTileAtWorldXY", "scope": "instance", "___id": "T000002R043144", "___s": true }, { "comment": "/**\r\n * Puts an array of tiles or a 2D array of tiles at the given tile coordinates in the specified\r\n * layer. The array can be composed of either tile indexes or Tile objects. If you pass in a Tile,\r\n * all attributes will be copied over to the specified location. If you pass in an index, only the\r\n * index at the specified location will be changed. Collision information will be recalculated\r\n * within the region tiles were changed.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#putTilesAt\r\n * @since 3.50.0\r\n *\r\n * @param {(number[]|number[][]|Phaser.Tilemaps.Tile[]|Phaser.Tilemaps.Tile[][])} tile - A row (array) or grid (2D array) of Tiles or tile indexes to place.\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {boolean} [recalculateFaces=true] - `true` if the faces data should be recalculated.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 924, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Puts an array of tiles or a 2D array of tiles at the given tile coordinates in the specified\rlayer. The array can be composed of either tile indexes or Tile objects. If you pass in a Tile,\rall attributes will be copied over to the specified location. If you pass in an index, only the\rindex at the specified location will be changed. Collision information will be recalculated\rwithin the region tiles were changed.", "kind": "function", "name": "putTilesAt", "since": "3.50.0", "params": [ { "type": { "names": [ "Array.", "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": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tile", "type": "NameExpression" } ] } ] } ] } }, "description": "A row (array) or grid (2D array) of Tiles or tile indexes to place.", "name": "tile" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#putTilesAt", "scope": "instance", "___id": "T000002R043146", "___s": true }, { "comment": "/**\r\n * Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\r\n * specified layer. Each tile will receive a new index. If an array of indexes is passed in, then\r\n * those will be used for randomly assigning new tile indexes. If an array is not provided, the\r\n * indexes found within the region (excluding -1) will be used for randomly assigning new tile\r\n * indexes. This method only modifies tile indexes and does not change collision information.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#randomize\r\n * @since 3.50.0\r\n *\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {number[]} [indexes] - An array of indexes to randomly draw from during randomization.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 948, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\rspecified layer. Each tile will receive a new index. If an array of indexes is passed in, then\rthose will be used for randomly assigning new tile indexes. If an array is not provided, the\rindexes found within the region (excluding -1) will be used for randomly assigning new tile\rindexes. This method only modifies tile indexes and does not change collision information.", "kind": "function", "name": "randomize", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of indexes to randomly draw from during randomization.", "name": "indexes" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#randomize", "scope": "instance", "___id": "T000002R043148", "___s": true }, { "comment": "/**\r\n * Removes the tile at the given tile coordinates in the specified layer and updates the layers\r\n * collision information.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#removeTileAt\r\n * @since 3.50.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {boolean} [replaceWithNull=true] - If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.\r\n * @param {boolean} [recalculateFaces=true] - `true` if the faces data should be recalculated.\r\n *\r\n * @return {Phaser.Tilemaps.Tile} A Tile object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 973, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Removes the tile at the given tile coordinates in the specified layer and updates the layers\rcollision information.", "kind": "function", "name": "removeTileAt", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.", "name": "replaceWithNull" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "A Tile object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#removeTileAt", "scope": "instance", "___id": "T000002R043150", "___s": true }, { "comment": "/**\r\n * Removes the tile at the given world coordinates in the specified layer and updates the layers\r\n * collision information.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#removeTileAtWorldXY\r\n * @since 3.50.0\r\n *\r\n * @param {number} worldX - The x coordinate, in pixels.\r\n * @param {number} worldY - The y coordinate, in pixels.\r\n * @param {boolean} [replaceWithNull=true] - If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.\r\n * @param {boolean} [recalculateFaces=true] - `true` if the faces data should be recalculated.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n *\r\n * @return {Phaser.Tilemaps.Tile} The Tile object that was removed from the given location.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 992, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Removes the tile at the given world coordinates in the specified layer and updates the layers\rcollision information.", "kind": "function", "name": "removeTileAtWorldXY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in pixels.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in pixels.", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.", "name": "replaceWithNull" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if the faces data should be recalculated.", "name": "recalculateFaces" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tile" } }, "description": "The Tile object that was removed from the given location." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#removeTileAtWorldXY", "scope": "instance", "___id": "T000002R043152", "___s": true }, { "comment": "/**\r\n * Draws a debug representation of the layer to the given Graphics. This is helpful when you want to\r\n * get a quick idea of which of your tiles are colliding and which have interesting faces. The tiles\r\n * are drawn starting at (0, 0) in the Graphics, allowing you to place the debug representation\r\n * wherever you want on the screen.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#renderDebug\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.Graphics} graphics - The target Graphics object to draw upon.\r\n * @param {Phaser.Types.Tilemaps.StyleConfig} [styleConfig] - An object specifying the colors to use for the debug drawing.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1012, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Draws a debug representation of the layer to the given Graphics. This is helpful when you want to\rget a quick idea of which of your tiles are colliding and which have interesting faces. The tiles\rare drawn starting at (0, 0) in the Graphics, allowing you to place the debug representation\rwherever you want on the screen.", "kind": "function", "name": "renderDebug", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The target Graphics object to draw upon.", "name": "graphics" }, { "type": { "names": [ "Phaser.Types.Tilemaps.StyleConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tilemaps.StyleConfig" } }, "optional": true, "description": "An object specifying the colors to use for the debug drawing.", "name": "styleConfig" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#renderDebug", "scope": "instance", "___id": "T000002R043154", "___s": true }, { "comment": "/**\r\n * Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\r\n * `findIndex` and updates their index to match `newIndex`. This only modifies the index and does\r\n * not change collision information.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#replaceByIndex\r\n * @since 3.50.0\r\n *\r\n * @param {number} findIndex - The index of the tile to search for.\r\n * @param {number} newIndex - The index of the tile to replace it with.\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1033, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\r`findIndex` and updates their index to match `newIndex`. This only modifies the index and does\rnot change collision information.", "kind": "function", "name": "replaceByIndex", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the tile to search for.", "name": "findIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the tile to replace it with.", "name": "newIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#replaceByIndex", "scope": "instance", "___id": "T000002R043156", "___s": true }, { "comment": "/**\r\n * You can control if the Cameras should cull tiles before rendering them or not.\r\n *\r\n * By default the camera will try to cull the tiles in this layer, to avoid over-drawing to the renderer.\r\n *\r\n * However, there are some instances when you may wish to disable this.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#setSkipCull\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [value=true] - Set to `true` to stop culling tiles. Set to `false` to enable culling again.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1057, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "You can control if the Cameras should cull tiles before rendering them or not.\r\rBy default the camera will try to cull the tiles in this layer, to avoid over-drawing to the renderer.\r\rHowever, there are some instances when you may wish to disable this.", "kind": "function", "name": "setSkipCull", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Set to `true` to stop culling tiles. Set to `false` to enable culling again.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#setSkipCull", "scope": "instance", "___id": "T000002R043158", "___s": true }, { "comment": "/**\r\n * When a Camera culls the tiles in this layer it does so using its view into the world, building up a\r\n * rectangle inside which the tiles must exist or they will be culled. Sometimes you may need to expand the size\r\n * of this 'cull rectangle', especially if you plan on rotating the Camera viewing the layer. Do so\r\n * by providing the padding values. The values given are in tiles, not pixels. So if the tile width was 32px\r\n * and you set `paddingX` to be 4, it would add 32px x 4 to the cull rectangle (adjusted for scale)\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#setCullPadding\r\n * @since 3.50.0\r\n *\r\n * @param {number} [paddingX=1] - The amount of extra horizontal tiles to add to the cull check padding.\r\n * @param {number} [paddingY=1] - The amount of extra vertical tiles to add to the cull check padding.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1080, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "When a Camera culls the tiles in this layer it does so using its view into the world, building up a\rrectangle inside which the tiles must exist or they will be culled. Sometimes you may need to expand the size\rof this 'cull rectangle', especially if you plan on rotating the Camera viewing the layer. Do so\rby providing the padding values. The values given are in tiles, not pixels. So if the tile width was 32px\rand you set `paddingX` to be 4, it would add 32px x 4 to the cull rectangle (adjusted for scale)", "kind": "function", "name": "setCullPadding", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount of extra horizontal tiles to add to the cull check padding.", "name": "paddingX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount of extra vertical tiles to add to the cull check padding.", "name": "paddingY" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#setCullPadding", "scope": "instance", "___id": "T000002R043162", "___s": true }, { "comment": "/**\r\n * Sets collision on the given tile or tiles within a layer by index. You can pass in either a\r\n * single numeric index or an array of indexes: [2, 3, 15, 20]. The `collides` parameter controls if\r\n * collision will be enabled (true) or disabled (false).\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#setCollision\r\n * @since 3.50.0\r\n *\r\n * @param {(number|array)} indexes - Either a single tile index, or an array of tile indexes.\r\n * @param {boolean} [collides=true] - If true it will enable collision. If false it will clear collision.\r\n * @param {boolean} [recalculateFaces=true] - Whether or not to recalculate the tile faces after the update.\r\n * @param {boolean} [updateLayer=true] - If true, updates the current tiles on the layer. Set to false if no tiles have been placed for significant performance boost.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets collision on the given tile or tiles within a layer by index. You can pass in either a\rsingle numeric index or an array of indexes: [2, 3, 15, 20]. The `collides` parameter controls if\rcollision will be enabled (true) or disabled (false).", "kind": "function", "name": "setCollision", "since": "3.50.0", "params": [ { "type": { "names": [ "number", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "array" } ] } }, "description": "Either a single tile index, or an array of tile indexes.", "name": "indexes" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If true it will enable collision. If false it will clear collision.", "name": "collides" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether or not to recalculate the tile faces after the update.", "name": "recalculateFaces" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If true, updates the current tiles on the layer. Set to false if no tiles have been placed for significant performance boost.", "name": "updateLayer" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#setCollision", "scope": "instance", "___id": "T000002R043168", "___s": true }, { "comment": "/**\r\n * Sets collision on a range of tiles in a layer whose index is between the specified `start` and\r\n * `stop` (inclusive). Calling this with a start value of 10 and a stop value of 14 would set\r\n * collision for tiles 10, 11, 12, 13 and 14. The `collides` parameter controls if collision will be\r\n * enabled (true) or disabled (false).\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#setCollisionBetween\r\n * @since 3.50.0\r\n *\r\n * @param {number} start - The first index of the tile to be set for collision.\r\n * @param {number} stop - The last index of the tile to be set for collision.\r\n * @param {boolean} [collides=true] - If true it will enable collision. If false it will clear collision.\r\n * @param {boolean} [recalculateFaces=true] - Whether or not to recalculate the tile faces after the update.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1128, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets collision on a range of tiles in a layer whose index is between the specified `start` and\r`stop` (inclusive). Calling this with a start value of 10 and a stop value of 14 would set\rcollision for tiles 10, 11, 12, 13 and 14. The `collides` parameter controls if collision will be\renabled (true) or disabled (false).", "kind": "function", "name": "setCollisionBetween", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The first index of the tile to be set for collision.", "name": "start" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The last index of the tile to be set for collision.", "name": "stop" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If true it will enable collision. If false it will clear collision.", "name": "collides" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether or not to recalculate the tile faces after the update.", "name": "recalculateFaces" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#setCollisionBetween", "scope": "instance", "___id": "T000002R043170", "___s": true }, { "comment": "/**\r\n * Sets collision on the tiles within a layer by checking tile properties. If a tile has a property\r\n * that matches the given properties object, its collision flag will be set. The `collides`\r\n * parameter controls if collision will be enabled (true) or disabled (false). Passing in\r\n * `{ collides: true }` would update the collision flag on any tiles with a \"collides\" property that\r\n * has a value of true. Any tile that doesn't have \"collides\" set to true will be ignored. You can\r\n * also use an array of values, e.g. `{ types: [\"stone\", \"lava\", \"sand\" ] }`. If a tile has a\r\n * \"types\" property that matches any of those values, its collision flag will be updated.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#setCollisionByProperty\r\n * @since 3.50.0\r\n *\r\n * @param {object} properties - An object with tile properties and corresponding values that should be checked.\r\n * @param {boolean} [collides=true] - If true it will enable collision. If false it will clear collision.\r\n * @param {boolean} [recalculateFaces=true] - Whether or not to recalculate the tile faces after the update.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1151, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets collision on the tiles within a layer by checking tile properties. If a tile has a property\rthat matches the given properties object, its collision flag will be set. The `collides`\rparameter controls if collision will be enabled (true) or disabled (false). Passing in\r`{ collides: true }` would update the collision flag on any tiles with a \"collides\" property that\rhas a value of true. Any tile that doesn't have \"collides\" set to true will be ignored. You can\ralso use an array of values, e.g. `{ types: [\"stone\", \"lava\", \"sand\" ] }`. If a tile has a\r\"types\" property that matches any of those values, its collision flag will be updated.", "kind": "function", "name": "setCollisionByProperty", "since": "3.50.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "An object with tile properties and corresponding values that should be checked.", "name": "properties" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If true it will enable collision. If false it will clear collision.", "name": "collides" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether or not to recalculate the tile faces after the update.", "name": "recalculateFaces" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#setCollisionByProperty", "scope": "instance", "___id": "T000002R043172", "___s": true }, { "comment": "/**\r\n * Sets collision on all tiles in the given layer, except for tiles that have an index specified in\r\n * the given array. The `collides` parameter controls if collision will be enabled (true) or\r\n * disabled (false). Tile indexes not currently in the layer are not affected.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#setCollisionByExclusion\r\n * @since 3.50.0\r\n *\r\n * @param {number[]} indexes - An array of the tile indexes to not be counted for collision.\r\n * @param {boolean} [collides=true] - If true it will enable collision. If false it will clear collision.\r\n * @param {boolean} [recalculateFaces=true] - Whether or not to recalculate the tile faces after the update.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets collision on all tiles in the given layer, except for tiles that have an index specified in\rthe given array. The `collides` parameter controls if collision will be enabled (true) or\rdisabled (false). Tile indexes not currently in the layer are not affected.", "kind": "function", "name": "setCollisionByExclusion", "since": "3.50.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "An array of the tile indexes to not be counted for collision.", "name": "indexes" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If true it will enable collision. If false it will clear collision.", "name": "collides" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether or not to recalculate the tile faces after the update.", "name": "recalculateFaces" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#setCollisionByExclusion", "scope": "instance", "___id": "T000002R043174", "___s": true }, { "comment": "/**\r\n * Sets collision on the tiles within a layer by checking each tiles collision group data\r\n * (typically defined in Tiled within the tileset collision editor). If any objects are found within\r\n * a tiles collision group, the tile's colliding information will be set. The `collides` parameter\r\n * controls if collision will be enabled (true) or disabled (false).\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#setCollisionFromCollisionGroup\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [collides=true] - If true it will enable collision. If false it will clear collision.\r\n * @param {boolean} [recalculateFaces=true] - Whether or not to recalculate the tile faces after the update.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets collision on the tiles within a layer by checking each tiles collision group data\r(typically defined in Tiled within the tileset collision editor). If any objects are found within\ra tiles collision group, the tile's colliding information will be set. The `collides` parameter\rcontrols if collision will be enabled (true) or disabled (false).", "kind": "function", "name": "setCollisionFromCollisionGroup", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If true it will enable collision. If false it will clear collision.", "name": "collides" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether or not to recalculate the tile faces after the update.", "name": "recalculateFaces" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#setCollisionFromCollisionGroup", "scope": "instance", "___id": "T000002R043176", "___s": true }, { "comment": "/**\r\n * Sets a global collision callback for the given tile index within the layer. This will affect all\r\n * tiles on this layer that have the same index. If a callback is already set for the tile index it\r\n * will be replaced. Set the callback to null to remove it. If you want to set a callback for a tile\r\n * at a specific location on the map then see setTileLocationCallback.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#setTileIndexCallback\r\n * @since 3.50.0\r\n *\r\n * @param {(number|number[])} indexes - Either a single tile index, or an array of tile indexes to have a collision callback set for.\r\n * @param {function} callback - The callback that will be invoked when the tile is collided with.\r\n * @param {object} callbackContext - The context under which the callback is called.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets a global collision callback for the given tile index within the layer. This will affect all\rtiles on this layer that have the same index. If a callback is already set for the tile index it\rwill be replaced. Set the callback to null to remove it. If you want to set a callback for a tile\rat a specific location on the map then see setTileLocationCallback.", "kind": "function", "name": "setTileIndexCallback", "since": "3.50.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" } ] } ] } }, "description": "Either a single tile index, or an array of tile indexes to have a collision callback set for.", "name": "indexes" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback that will be invoked when the tile is collided with.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The context under which the callback is called.", "name": "callbackContext" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#setTileIndexCallback", "scope": "instance", "___id": "T000002R043178", "___s": true }, { "comment": "/**\r\n * Sets a collision callback for the given rectangular area (in tile coordinates) within the layer.\r\n * If a callback is already set for the tile index it will be replaced. Set the callback to null to\r\n * remove it.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#setTileLocationCallback\r\n * @since 3.50.0\r\n *\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n * @param {function} [callback] - The callback that will be invoked when the tile is collided with.\r\n * @param {object} [callbackContext] - The context, or scope, under which the callback is invoked.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1240, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets a collision callback for the given rectangular area (in tile coordinates) within the layer.\rIf a callback is already set for the tile index it will be replaced. Set the callback to null to\rremove it.", "kind": "function", "name": "setTileLocationCallback", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "The callback that will be invoked when the tile is collided with.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The context, or scope, under which the callback is invoked.", "name": "callbackContext" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#setTileLocationCallback", "scope": "instance", "___id": "T000002R043180", "___s": true }, { "comment": "/**\r\n * Shuffles the tiles in a rectangular region (specified in tile coordinates) within the given\r\n * layer. It will only randomize the tiles in that area, so if they're all the same nothing will\r\n * appear to have changed! This method only modifies tile indexes and does not change collision\r\n * information.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#shuffle\r\n * @since 3.50.0\r\n *\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1264, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Shuffles the tiles in a rectangular region (specified in tile coordinates) within the given\rlayer. It will only randomize the tiles in that area, so if they're all the same nothing will\rappear to have changed! This method only modifies tile indexes and does not change collision\rinformation.", "kind": "function", "name": "shuffle", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#shuffle", "scope": "instance", "___id": "T000002R043182", "___s": true }, { "comment": "/**\r\n * Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\r\n * `indexA` and swaps then with `indexB`. This only modifies the index and does not change collision\r\n * information.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#swapByIndex\r\n * @since 3.50.0\r\n *\r\n * @param {number} tileA - First tile index.\r\n * @param {number} tileB - Second tile index.\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1287, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\r`indexA` and swaps then with `indexB`. This only modifies the index and does not change collision\rinformation.", "kind": "function", "name": "swapByIndex", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "First tile index.", "name": "tileA" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Second tile index.", "name": "tileB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#swapByIndex", "scope": "instance", "___id": "T000002R043184", "___s": true }, { "comment": "/**\r\n * Converts from tile X coordinates (tile units) to world X coordinates (pixels), factoring in the\r\n * layers position, scale and scroll.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#tileToWorldX\r\n * @since 3.50.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n *\r\n * @return {number} The Tile X coordinate converted to pixels.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1311, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Converts from tile X coordinates (tile units) to world X coordinates (pixels), factoring in the\rlayers position, scale and scroll.", "kind": "function", "name": "tileToWorldX", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Tile X coordinate converted to pixels." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#tileToWorldX", "scope": "instance", "___id": "T000002R043186", "___s": true }, { "comment": "/**\r\n * Converts from tile Y coordinates (tile units) to world Y coordinates (pixels), factoring in the\r\n * layers position, scale and scroll.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#tileToWorldY\r\n * @since 3.50.0\r\n *\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n *\r\n * @return {number} The Tile Y coordinate converted to pixels.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1328, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Converts from tile Y coordinates (tile units) to world Y coordinates (pixels), factoring in the\rlayers position, scale and scroll.", "kind": "function", "name": "tileToWorldY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Tile Y coordinate converted to pixels." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#tileToWorldY", "scope": "instance", "___id": "T000002R043188", "___s": true }, { "comment": "/**\r\n * Converts from tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\r\n * layers position, scale and scroll. This will return a new Vector2 object or update the given\r\n * `point` object.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#tileToWorldXY\r\n * @since 3.50.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {Phaser.Math.Vector2} [point] - A Vector2 to store the coordinates in. If not given a new Vector2 is created.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 containing the world coordinates of the Tile.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1345, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Converts from tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\rlayers position, scale and scroll. This will return a new Vector2 object or update the given\r`point` object.", "kind": "function", "name": "tileToWorldXY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 to store the coordinates in. If not given a new Vector2 is created.", "name": "point" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 containing the world coordinates of the Tile." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#tileToWorldXY", "scope": "instance", "___id": "T000002R043190", "___s": true }, { "comment": "/**\r\n * Returns an array of Vector2s where each entry corresponds to the corner of the requested tile.\r\n *\r\n * The `tileX` and `tileY` parameters are in tile coordinates, not world coordinates.\r\n *\r\n * The corner coordinates are in world space, having factored in TilemapLayer scale, position\r\n * and the camera, if given.\r\n *\r\n * The size of the array will vary based on the orientation of the map. For example an\r\n * orthographic map will return an array of 4 vectors, where-as a hexagonal map will,\r\n * of course, return an array of 6 corner vectors.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#getTileCorners\r\n * @since 3.60.0\r\n *\r\n * @param {number} tileX - The x coordinate, in tiles, not pixels.\r\n * @param {number} tileY - The y coordinate, in tiles, not pixels.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n *\r\n * @return {?Phaser.Math.Vector2[]} Returns an array of Vector2s, or null if the layer given was invalid.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1365, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Returns an array of Vector2s where each entry corresponds to the corner of the requested tile.\r\rThe `tileX` and `tileY` parameters are in tile coordinates, not world coordinates.\r\rThe corner coordinates are in world space, having factored in TilemapLayer scale, position\rand the camera, if given.\r\rThe size of the array will vary based on the orientation of the map. For example an\rorthographic map will return an array of 4 vectors, where-as a hexagonal map will,\rof course, return an array of 6 corner vectors.", "kind": "function", "name": "getTileCorners", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in tiles, not pixels.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate, in tiles, not pixels.", "name": "tileY" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ], "nullable": true } }, "nullable": true, "description": "Returns an array of Vector2s, or null if the layer given was invalid." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#getTileCorners", "scope": "instance", "___id": "T000002R043192", "___s": true }, { "comment": "/**\r\n * Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\r\n * specified layer. Each tile will receive a new index. New indexes are drawn from the given\r\n * weightedIndexes array. An example weighted array:\r\n *\r\n * [\r\n * { index: 6, weight: 4 }, // Probability of index 6 is 4 / 8\r\n * { index: 7, weight: 2 }, // Probability of index 7 would be 2 / 8\r\n * { index: 8, weight: 1.5 }, // Probability of index 8 would be 1.5 / 8\r\n * { index: 26, weight: 0.5 } // Probability of index 27 would be 0.5 / 8\r\n * ]\r\n *\r\n * The probability of any index being choose is (the index's weight) / (sum of all weights). This\r\n * method only modifies tile indexes and does not change collision information.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#weightedRandomize\r\n * @since 3.50.0\r\n *\r\n * @param {object[]} weightedIndexes - An array of objects to randomly draw from during randomization. They should be in the form: { index: 0, weight: 4 } or { index: [0, 1], weight: 4 } if you wish to draw from multiple tile indexes.\r\n * @param {number} [tileX] - The left most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [tileY] - The top most tile index (in tile coordinates) to use as the origin of the area.\r\n * @param {number} [width] - How many tiles wide from the `tileX` index the area will be.\r\n * @param {number} [height] - How many tiles tall from the `tileY` index the area will be.\r\n *\r\n * @return {this} This Tilemap Layer object.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1391, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\rspecified layer. Each tile will receive a new index. New indexes are drawn from the given\rweightedIndexes array. An example weighted array:\r\r[\r { index: 6, weight: 4 }, // Probability of index 6 is 4 / 8\r { index: 7, weight: 2 }, // Probability of index 7 would be 2 / 8\r { index: 8, weight: 1.5 }, // Probability of index 8 would be 1.5 / 8\r { index: 26, weight: 0.5 } // Probability of index 27 would be 0.5 / 8\r]\r\rThe probability of any index being choose is (the index's weight) / (sum of all weights). This\rmethod only modifies tile indexes and does not change collision information.", "kind": "function", "name": "weightedRandomize", "since": "3.50.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } }, "description": "An array of objects to randomly draw from during randomization. They should be in the form: { index: 0, weight: 4 } or { index: [0, 1], weight: 4 } if you wish to draw from multiple tile indexes.", "name": "weightedIndexes" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The left most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top most tile index (in tile coordinates) to use as the origin of the area.", "name": "tileY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles wide from the `tileX` index the area will be.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How many tiles tall from the `tileY` index the area will be.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tilemap Layer object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#weightedRandomize", "scope": "instance", "___id": "T000002R043194", "___s": true }, { "comment": "/**\r\n * Converts from world X coordinates (pixels) to tile X coordinates (tile units), factoring in the\r\n * layers position, scale and scroll.\r\n *\r\n * You cannot call this method for Isometric or Hexagonal tilemaps as they require\r\n * both `worldX` and `worldY` values to determine the correct tile, instead you\r\n * should use the `worldToTileXY` method.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#worldToTileX\r\n * @since 3.50.0\r\n *\r\n * @param {number} worldX - The x coordinate to be converted, in pixels, not tiles.\r\n * @param {boolean} [snapToFloor] - Whether or not to round the tile coordinate down to the nearest integer.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n *\r\n * @return {number} The tile X coordinate based on the world value.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Converts from world X coordinates (pixels) to tile X coordinates (tile units), factoring in the\rlayers position, scale and scroll.\r\rYou cannot call this method for Isometric or Hexagonal tilemaps as they require\rboth `worldX` and `worldY` values to determine the correct tile, instead you\rshould use the `worldToTileXY` method.", "kind": "function", "name": "worldToTileX", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to be converted, in pixels, not tiles.", "name": "worldX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether or not to round the tile coordinate down to the nearest integer.", "name": "snapToFloor" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tile X coordinate based on the world value." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#worldToTileX", "scope": "instance", "___id": "T000002R043196", "___s": true }, { "comment": "/**\r\n * Converts from world Y coordinates (pixels) to tile Y coordinates (tile units), factoring in the\r\n * layers position, scale and scroll.\r\n *\r\n * You cannot call this method for Isometric or Hexagonal tilemaps as they require\r\n * both `worldX` and `worldY` values to determine the correct tile, instead you\r\n * should use the `worldToTileXY` method.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#worldToTileY\r\n * @since 3.50.0\r\n *\r\n * @param {number} worldY - The y coordinate to be converted, in pixels, not tiles.\r\n * @param {boolean} [snapToFloor] - Whether or not to round the tile coordinate down to the nearest integer.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n *\r\n * @return {number} The tile Y coordinate based on the world value.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1446, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Converts from world Y coordinates (pixels) to tile Y coordinates (tile units), factoring in the\rlayers position, scale and scroll.\r\rYou cannot call this method for Isometric or Hexagonal tilemaps as they require\rboth `worldX` and `worldY` values to determine the correct tile, instead you\rshould use the `worldToTileXY` method.", "kind": "function", "name": "worldToTileY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to be converted, in pixels, not tiles.", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether or not to round the tile coordinate down to the nearest integer.", "name": "snapToFloor" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tile Y coordinate based on the world value." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#worldToTileY", "scope": "instance", "___id": "T000002R043198", "___s": true }, { "comment": "/**\r\n * Converts from world XY coordinates (pixels) to tile XY coordinates (tile units), factoring in the\r\n * layers position, scale and scroll. This will return a new Vector2 object or update the given\r\n * `point` object.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#worldToTileXY\r\n * @since 3.50.0\r\n *\r\n * @param {number} worldX - The x coordinate to be converted, in pixels, not tiles.\r\n * @param {number} worldY - The y coordinate to be converted, in pixels, not tiles.\r\n * @param {boolean} [snapToFloor] - Whether or not to round the tile coordinate down to the nearest integer.\r\n * @param {Phaser.Math.Vector2} [point] - A Vector2 to store the coordinates in. If not given a new Vector2 is created.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 containing the tile coordinates of the world values.\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Converts from world XY coordinates (pixels) to tile XY coordinates (tile units), factoring in the\rlayers position, scale and scroll. This will return a new Vector2 object or update the given\r`point` object.", "kind": "function", "name": "worldToTileXY", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to be converted, in pixels, not tiles.", "name": "worldX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to be converted, in pixels, not tiles.", "name": "worldY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether or not to round the tile coordinate down to the nearest integer.", "name": "snapToFloor" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 to store the coordinates in. If not given a new Vector2 is created.", "name": "point" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when calculating the tile index from the world values.", "name": "camera" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 containing the tile coordinates of the world values." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#worldToTileXY", "scope": "instance", "___id": "T000002R043200", "___s": true }, { "comment": "/**\r\n * Destroys this TilemapLayer and removes its link to the associated LayerData.\r\n *\r\n * @method Phaser.Tilemaps.TilemapLayer#destroy\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [removeFromTilemap=true] - Remove this layer from the parent Tilemap?\r\n */", "meta": { "filename": "TilemapLayer.js", "lineno": 1489, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Destroys this TilemapLayer and removes its link to the associated LayerData.", "kind": "function", "name": "destroy", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Remove this layer from the parent Tilemap?", "name": "removeFromTilemap" } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "longname": "Phaser.Tilemaps.TilemapLayer#destroy", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#destroy", "___id": "T000002R043202", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Tileset is a combination of a single image containing the tiles and a container for data about\r\n * each tile.\r\n *\r\n * @class Tileset\r\n * @memberof Phaser.Tilemaps\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {string} name - The name of the tileset in the map data.\r\n * @param {number} firstgid - The first tile index this tileset contains.\r\n * @param {number} [tileWidth=32] - Width of each tile (in pixels).\r\n * @param {number} [tileHeight=32] - Height of each tile (in pixels).\r\n * @param {number} [tileMargin=0] - The margin around all tiles in the sheet (in pixels).\r\n * @param {number} [tileSpacing=0] - The spacing between each tile in the sheet (in pixels).\r\n * @param {object} [tileProperties={}] - Custom properties defined per tile in the Tileset.\r\n * These typically are custom properties created in Tiled when editing a tileset.\r\n * @param {object} [tileData={}] - Data stored per tile. These typically are created in Tiled when editing a tileset, e.g. from Tiled's tile collision editor or terrain editor.\r\n * @param {object} [tileOffset={x: 0, y: 0}] - Tile texture drawing offset.\r\n */", "meta": { "filename": "Tileset.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "classdesc": "A Tileset is a combination of a single image containing the tiles and a container for data about\reach tile.", "kind": "class", "name": "Tileset", "memberof": "Phaser.Tilemaps", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the tileset in the map data.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The first tile index this tileset contains.", "name": "firstgid" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "Width of each tile (in pixels).", "name": "tileWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "Height of each tile (in pixels).", "name": "tileHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The margin around all tiles in the sheet (in pixels).", "name": "tileMargin" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The spacing between each tile in the sheet (in pixels).", "name": "tileSpacing" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "defaultvalue": "{}", "description": "Custom properties defined per tile in the Tileset.\rThese typically are custom properties created in Tiled when editing a tileset.", "name": "tileProperties" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "defaultvalue": "{}", "description": "Data stored per tile. These typically are created in Tiled when editing a tileset, e.g. from Tiled's tile collision editor or terrain editor.", "name": "tileData" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "defaultvalue": "{x: 0, y: 0}", "description": "Tile texture drawing offset.", "name": "tileOffset" } ], "scope": "static", "longname": "Phaser.Tilemaps.Tileset", "___id": "T000002R043286", "___s": true }, { "comment": "/**\r\n * The name of the Tileset.\r\n *\r\n * @name Phaser.Tilemaps.Tileset#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tileset.js", "lineno": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The name of the Tileset.", "name": "name", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#name", "scope": "instance", "kind": "member", "___id": "T000002R043295", "___s": true }, { "comment": "/**\r\n * The starting index of the first tile index this Tileset contains.\r\n *\r\n * @name Phaser.Tilemaps.Tileset#firstgid\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tileset.js", "lineno": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The starting index of the first tile index this Tileset contains.", "name": "firstgid", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#firstgid", "scope": "instance", "kind": "member", "___id": "T000002R043297", "___s": true }, { "comment": "/**\r\n * The width of each tile (in pixels). Use setTileSize to change.\r\n *\r\n * @name Phaser.Tilemaps.Tileset#tileWidth\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tileset.js", "lineno": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The width of each tile (in pixels). Use setTileSize to change.", "name": "tileWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#tileWidth", "scope": "instance", "kind": "member", "___id": "T000002R043299", "___s": true }, { "comment": "/**\r\n * The height of each tile (in pixels). Use setTileSize to change.\r\n *\r\n * @name Phaser.Tilemaps.Tileset#tileHeight\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tileset.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The height of each tile (in pixels). Use setTileSize to change.", "name": "tileHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#tileHeight", "scope": "instance", "kind": "member", "___id": "T000002R043301", "___s": true }, { "comment": "/**\r\n * The margin around the tiles in the sheet (in pixels). Use `setSpacing` to change.\r\n *\r\n * @name Phaser.Tilemaps.Tileset#tileMargin\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tileset.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The margin around the tiles in the sheet (in pixels). Use `setSpacing` to change.", "name": "tileMargin", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#tileMargin", "scope": "instance", "kind": "member", "___id": "T000002R043303", "___s": true }, { "comment": "/**\r\n * The spacing between each the tile in the sheet (in pixels). Use `setSpacing` to change.\r\n *\r\n * @name Phaser.Tilemaps.Tileset#tileSpacing\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tileset.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The spacing between each the tile in the sheet (in pixels). Use `setSpacing` to change.", "name": "tileSpacing", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#tileSpacing", "scope": "instance", "kind": "member", "___id": "T000002R043305", "___s": true }, { "comment": "/**\r\n * Tileset-specific properties per tile that are typically defined in the Tiled editor in the\r\n * Tileset editor.\r\n *\r\n * @name Phaser.Tilemaps.Tileset#tileProperties\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tileset.js", "lineno": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Tileset-specific properties per tile that are typically defined in the Tiled editor in the\rTileset editor.", "name": "tileProperties", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#tileProperties", "scope": "instance", "kind": "member", "___id": "T000002R043307", "___s": true }, { "comment": "/**\r\n * Tileset-specific data per tile that are typically defined in the Tiled editor, e.g. within\r\n * the Tileset collision editor. This is where collision objects and terrain are stored.\r\n *\r\n * @name Phaser.Tilemaps.Tileset#tileData\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tileset.js", "lineno": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Tileset-specific data per tile that are typically defined in the Tiled editor, e.g. within\rthe Tileset collision editor. This is where collision objects and terrain are stored.", "name": "tileData", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#tileData", "scope": "instance", "kind": "member", "___id": "T000002R043309", "___s": true }, { "comment": "/**\r\n * Controls the drawing offset from the tile origin.\r\n * Defaults to 0x0, no offset.\r\n *\r\n * @name Phaser.Tilemaps.Tileset#tileOffset\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Tileset.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Controls the drawing offset from the tile origin.\rDefaults to 0x0, no offset.", "name": "tileOffset", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.60.0", "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#tileOffset", "scope": "instance", "kind": "member", "___id": "T000002R043311", "___s": true }, { "comment": "/**\r\n * The cached image that contains the individual tiles. Use setImage to set.\r\n *\r\n * @name Phaser.Tilemaps.Tileset#image\r\n * @type {?Phaser.Textures.Texture}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tileset.js", "lineno": 137, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The cached image that contains the individual tiles. Use setImage to set.", "name": "image", "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture", "nullable": true } }, "nullable": true, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#image", "scope": "instance", "kind": "member", "___id": "T000002R043313", "___s": true }, { "comment": "/**\r\n * The gl texture used by the WebGL renderer.\r\n *\r\n * @name Phaser.Tilemaps.Tileset#glTexture\r\n * @type {?WebGLTexture}\r\n * @readonly\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tileset.js", "lineno": 147, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The gl texture used by the WebGL renderer.", "name": "glTexture", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "readonly": true, "since": "3.11.0", "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#glTexture", "scope": "instance", "kind": "member", "___id": "T000002R043315", "___s": true }, { "comment": "/**\r\n * The number of tile rows in the the tileset.\r\n *\r\n * @name Phaser.Tilemaps.Tileset#rows\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tileset.js", "lineno": 157, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The number of tile rows in the the tileset.", "name": "rows", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#rows", "scope": "instance", "kind": "member", "___id": "T000002R043317", "___s": true }, { "comment": "/**\r\n * The number of tile columns in the tileset.\r\n *\r\n * @name Phaser.Tilemaps.Tileset#columns\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tileset.js", "lineno": 167, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The number of tile columns in the tileset.", "name": "columns", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#columns", "scope": "instance", "kind": "member", "___id": "T000002R043319", "___s": true }, { "comment": "/**\r\n * The total number of tiles in the tileset.\r\n *\r\n * @name Phaser.Tilemaps.Tileset#total\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tileset.js", "lineno": 177, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The total number of tiles in the tileset.", "name": "total", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#total", "scope": "instance", "kind": "member", "___id": "T000002R043321", "___s": true }, { "comment": "/**\r\n * The look-up table to specific tile image texture coordinates (UV in pixels). Each element\r\n * contains the coordinates for a tile in an object of the form {x, y}.\r\n *\r\n * @name Phaser.Tilemaps.Tileset#texCoordinates\r\n * @type {object[]}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tileset.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "The look-up table to specific tile image texture coordinates (UV in pixels). Each element\rcontains the coordinates for a tile in an object of the form {x, y}.", "name": "texCoordinates", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#texCoordinates", "scope": "instance", "kind": "member", "___id": "T000002R043323", "___s": true }, { "comment": "/**\r\n * Get a tiles properties that are stored in the Tileset. Returns null if tile index is not\r\n * contained in this Tileset. This is typically defined in Tiled under the Tileset editor.\r\n *\r\n * @method Phaser.Tilemaps.Tileset#getTileProperties\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileIndex - The unique id of the tile across all tilesets in the map.\r\n *\r\n * @return {?(object|undefined)}\r\n */", "meta": { "filename": "Tileset.js", "lineno": 199, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Get a tiles properties that are stored in the Tileset. Returns null if tile index is not\rcontained in this Tileset. This is typically defined in Tiled under the Tileset editor.", "kind": "function", "name": "getTileProperties", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The unique id of the tile across all tilesets in the map.", "name": "tileIndex" } ], "returns": [ { "type": { "names": [ "object", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "UndefinedLiteral" } ], "nullable": true } }, "nullable": true } ], "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#getTileProperties", "scope": "instance", "___id": "T000002R043325", "___s": true }, { "comment": "/**\r\n * Get a tile's data that is stored in the Tileset. Returns null if tile index is not contained\r\n * in this Tileset. This is typically defined in Tiled and will contain both Tileset collision\r\n * info and terrain mapping.\r\n *\r\n * @method Phaser.Tilemaps.Tileset#getTileData\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileIndex - The unique id of the tile across all tilesets in the map.\r\n *\r\n * @return {?object|undefined}\r\n */", "meta": { "filename": "Tileset.js", "lineno": 217, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Get a tile's data that is stored in the Tileset. Returns null if tile index is not contained\rin this Tileset. This is typically defined in Tiled and will contain both Tileset collision\rinfo and terrain mapping.", "kind": "function", "name": "getTileData", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The unique id of the tile across all tilesets in the map.", "name": "tileIndex" } ], "returns": [ { "type": { "names": [ "object", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object", "nullable": true }, { "type": "UndefinedLiteral" } ] } } } ], "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#getTileData", "scope": "instance", "___id": "T000002R043327", "___s": true }, { "comment": "/**\r\n * Get a tile's collision group that is stored in the Tileset. Returns null if tile index is not\r\n * contained in this Tileset. This is typically defined within Tiled's tileset collision editor.\r\n *\r\n * @method Phaser.Tilemaps.Tileset#getTileCollisionGroup\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileIndex - The unique id of the tile across all tilesets in the map.\r\n *\r\n * @return {?object}\r\n */", "meta": { "filename": "Tileset.js", "lineno": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Get a tile's collision group that is stored in the Tileset. Returns null if tile index is not\rcontained in this Tileset. This is typically defined within Tiled's tileset collision editor.", "kind": "function", "name": "getTileCollisionGroup", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The unique id of the tile across all tilesets in the map.", "name": "tileIndex" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "nullable": true } ], "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#getTileCollisionGroup", "scope": "instance", "___id": "T000002R043329", "___s": true }, { "comment": "/**\r\n * Returns true if and only if this Tileset contains the given tile index.\r\n *\r\n * @method Phaser.Tilemaps.Tileset#containsTileIndex\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileIndex - The unique id of the tile across all tilesets in the map.\r\n *\r\n * @return {boolean}\r\n */", "meta": { "filename": "Tileset.js", "lineno": 254, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Returns true if and only if this Tileset contains the given tile index.", "kind": "function", "name": "containsTileIndex", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The unique id of the tile across all tilesets in the map.", "name": "tileIndex" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } } } ], "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#containsTileIndex", "scope": "instance", "___id": "T000002R043332", "___s": true }, { "comment": "/**\r\n * Returns the texture coordinates (UV in pixels) in the Tileset image for the given tile index.\r\n * Returns null if tile index is not contained in this Tileset.\r\n *\r\n * @method Phaser.Tilemaps.Tileset#getTileTextureCoordinates\r\n * @since 3.0.0\r\n *\r\n * @param {number} tileIndex - The unique id of the tile across all tilesets in the map.\r\n *\r\n * @return {?object} Object in the form { x, y } representing the top-left UV coordinate\r\n * within the Tileset image.\r\n */", "meta": { "filename": "Tileset.js", "lineno": 272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Returns the texture coordinates (UV in pixels) in the Tileset image for the given tile index.\rReturns null if tile index is not contained in this Tileset.", "kind": "function", "name": "getTileTextureCoordinates", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The unique id of the tile across all tilesets in the map.", "name": "tileIndex" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "nullable": true, "description": "Object in the form { x, y } representing the top-left UV coordinate\rwithin the Tileset image." } ], "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#getTileTextureCoordinates", "scope": "instance", "___id": "T000002R043334", "___s": true }, { "comment": "/**\r\n * Sets the image associated with this Tileset and updates the tile data (rows, columns, etc.).\r\n *\r\n * @method Phaser.Tilemaps.Tileset#setImage\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Textures.Texture} texture - The image that contains the tiles.\r\n *\r\n * @return {Phaser.Tilemaps.Tileset} This Tileset object.\r\n */", "meta": { "filename": "Tileset.js", "lineno": 291, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets the image associated with this Tileset and updates the tile data (rows, columns, etc.).", "kind": "function", "name": "setImage", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture" } }, "description": "The image that contains the tiles.", "name": "texture" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tileset" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tileset" } }, "description": "This Tileset object." } ], "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#setImage", "scope": "instance", "___id": "T000002R043336", "___s": true }, { "comment": "/**\r\n * Sets the tile width & height and updates the tile data (rows, columns, etc.).\r\n *\r\n * @method Phaser.Tilemaps.Tileset#setTileSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} [tileWidth] - The width of a tile in pixels.\r\n * @param {number} [tileHeight] - The height of a tile in pixels.\r\n *\r\n * @return {Phaser.Tilemaps.Tileset} This Tileset object.\r\n */", "meta": { "filename": "Tileset.js", "lineno": 312, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets the tile width & height and updates the tile data (rows, columns, etc.).", "kind": "function", "name": "setTileSize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of a tile in pixels.", "name": "tileWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of a tile in pixels.", "name": "tileHeight" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tileset" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tileset" } }, "description": "This Tileset object." } ], "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#setTileSize", "scope": "instance", "___id": "T000002R043340", "___s": true }, { "comment": "/**\r\n * Sets the tile margin & spacing and updates the tile data (rows, columns, etc.).\r\n *\r\n * @method Phaser.Tilemaps.Tileset#setSpacing\r\n * @since 3.0.0\r\n *\r\n * @param {number} [margin] - The margin around the tiles in the sheet (in pixels).\r\n * @param {number} [spacing] - The spacing between the tiles in the sheet (in pixels).\r\n *\r\n * @return {Phaser.Tilemaps.Tileset} This Tileset object.\r\n */", "meta": { "filename": "Tileset.js", "lineno": 336, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Sets the tile margin & spacing and updates the tile data (rows, columns, etc.).", "kind": "function", "name": "setSpacing", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The margin around the tiles in the sheet (in pixels).", "name": "margin" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The spacing between the tiles in the sheet (in pixels).", "name": "spacing" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tileset" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tileset" } }, "description": "This Tileset object." } ], "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#setSpacing", "scope": "instance", "___id": "T000002R043344", "___s": true }, { "comment": "/**\r\n * Updates tile texture coordinates and tileset data.\r\n *\r\n * @method Phaser.Tilemaps.Tileset#updateTileData\r\n * @since 3.0.0\r\n *\r\n * @param {number} imageWidth - The (expected) width of the image to slice.\r\n * @param {number} imageHeight - The (expected) height of the image to slice.\r\n *\r\n * @return {Phaser.Tilemaps.Tileset} This Tileset object.\r\n */", "meta": { "filename": "Tileset.js", "lineno": 360, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps", "code": {} }, "description": "Updates tile texture coordinates and tileset data.", "kind": "function", "name": "updateTileData", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The (expected) width of the image to slice.", "name": "imageWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The (expected) height of the image to slice.", "name": "imageHeight" } ], "returns": [ { "type": { "names": [ "Phaser.Tilemaps.Tileset" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.Tileset" } }, "description": "This Tileset object." } ], "memberof": "Phaser.Tilemaps.Tileset", "longname": "Phaser.Tilemaps.Tileset#updateTileData", "scope": "instance", "___id": "T000002R043348", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tilemaps.CreateFromObjectLayerConfig\r\n * @since 3.50.0\r\n *\r\n * @property {number} [id] - A unique Object ID to convert.\r\n * @property {number} [gid] - An Object GID to convert.\r\n * @property {string} [name] - An Object Name to convert.\r\n * @property {string} [type] - An Object Type to convert.\r\n * @property {function} [classType] - A custom class type to convert the objects in to. The default is {@link Phaser.GameObjects.Sprite}. A custom class should resemble Sprite or Image; see {@link Phaser.Types.Tilemaps.CreateFromObjectsClassTypeConstructor}.\r\n * @property {boolean} [ignoreTileset] - By default, gid-based objects copy properties and respect the type of the tile at that gid and treat the object as an override. If this is true, they don't, and use only the fields set on the object itself.\r\n * @property {Phaser.Scene} [scene] - A Scene reference, passed to the Game Objects constructors.\r\n * @property {Phaser.GameObjects.Container} [container] - Optional Container to which the Game Objects are added.\r\n * @property {(string|Phaser.Textures.Texture)} [key] - Optional key of a Texture to be used, as stored in the Texture Manager, or a Texture instance. If omitted, the object's gid's tileset key is used if available.\r\n * @property {(string|number)} [frame] - Optional name or index of the frame within the Texture. If omitted, the tileset index is used, assuming that spritesheet frames exactly match tileset indices & geometries -- if available.\r\n */", "meta": { "filename": "CreateFromObjectLayerConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\typedefs", "code": {} }, "kind": "typedef", "name": "CreateFromObjectLayerConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "A unique Object ID to convert.", "name": "id" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "An Object GID to convert.", "name": "gid" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "An Object Name to convert.", "name": "name" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "An Object Type to convert.", "name": "type" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "A custom class type to convert the objects in to. The default is {@link Phaser.GameObjects.Sprite}. A custom class should resemble Sprite or Image; see {@link Phaser.Types.Tilemaps.CreateFromObjectsClassTypeConstructor}.", "name": "classType" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "By default, gid-based objects copy properties and respect the type of the tile at that gid and treat the object as an override. If this is true, they don't, and use only the fields set on the object itself.", "name": "ignoreTileset" }, { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "optional": true, "description": "A Scene reference, passed to the Game Objects constructors.", "name": "scene" }, { "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "optional": true, "description": "Optional Container to which the Game Objects are added.", "name": "container" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "optional": true, "description": "Optional key of a Texture to be used, as stored in the Texture Manager, or a Texture instance. If omitted, the object's gid's tileset key is used if available.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "Optional name or index of the frame within the Texture. If omitted, the tileset index is used, assuming that spritesheet frames exactly match tileset indices & geometries -- if available.", "name": "frame" } ], "memberof": "Phaser.Types.Tilemaps", "longname": "Phaser.Types.Tilemaps.CreateFromObjectLayerConfig", "scope": "static", "___id": "T000002R043368", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Tilemaps.CreateFromObjectsClassTypeConstructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n */", "meta": { "filename": "CreateFromObjectsClassTypeConstructor.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\typedefs", "code": {} }, "kind": "typedef", "name": "CreateFromObjectsClassTypeConstructor", "type": { "names": [ "function" ] }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object belongs.", "name": "scene" } ], "memberof": "Phaser.Types.Tilemaps", "longname": "Phaser.Types.Tilemaps.CreateFromObjectsClassTypeConstructor", "scope": "static", "___id": "T000002R043369", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tilemaps.DebugStyleOptions\r\n * @since 3.0.0\r\n * \r\n * @property {?Phaser.Display.Color} [styleConfig.tileColor=blue] - Color to use for drawing a filled rectangle at\r\n * non-colliding tile locations. If set to null, non-colliding tiles will not be drawn.\r\n * @property {?Phaser.Display.Color} [styleConfig.collidingTileColor=orange] - Color to use for drawing a filled\r\n * rectangle at colliding tile locations. If set to null, colliding tiles will not be drawn.\r\n * @property {?Phaser.Display.Color} [styleConfig.faceColor=grey] - Color to use for drawing a line at interesting\r\n * tile faces. If set to null, interesting tile faces will not be drawn.\r\n */", "meta": { "filename": "DebugStyleOptions.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\typedefs", "code": {} }, "kind": "typedef", "name": "DebugStyleOptions", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": "blue", "description": "Color to use for drawing a filled rectangle at\rnon-colliding tile locations. If set to null, non-colliding tiles will not be drawn.", "name": "styleConfig.tileColor" }, { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": "orange", "description": "Color to use for drawing a filled\rrectangle at colliding tile locations. If set to null, colliding tiles will not be drawn.", "name": "styleConfig.collidingTileColor" }, { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": "grey", "description": "Color to use for drawing a line at interesting\rtile faces. If set to null, interesting tile faces will not be drawn.", "name": "styleConfig.faceColor" } ], "memberof": "Phaser.Types.Tilemaps", "longname": "Phaser.Types.Tilemaps.DebugStyleOptions", "scope": "static", "___id": "T000002R043370", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tilemaps.FilteringOptions\r\n * @since 3.0.0\r\n * \r\n * @property {boolean} [isNotEmpty=false] - If true, only return tiles that don't have -1 for an index.\r\n * @property {boolean} [isColliding=false] - If true, only return tiles that collide on at least one side.\r\n * @property {boolean} [hasInterestingFace=false] - If true, only return tiles that have at least one interesting face.\r\n */", "meta": { "filename": "FilteringOptions.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\typedefs", "code": {} }, "kind": "typedef", "name": "FilteringOptions", "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": "If true, only return tiles that don't have -1 for an index.", "name": "isNotEmpty" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If true, only return tiles that collide on at least one side.", "name": "isColliding" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If true, only return tiles that have at least one interesting face.", "name": "hasInterestingFace" } ], "memberof": "Phaser.Types.Tilemaps", "longname": "Phaser.Types.Tilemaps.FilteringOptions", "scope": "static", "___id": "T000002R043371", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tilemaps.GIDData\r\n * @since 3.0.0\r\n * \r\n * @property {number} gid - The Tiled GID.\r\n * @property {boolean} flippedHorizontal - Horizontal flip flag.\r\n * @property {boolean} flippedVertical - Vertical flip flag.\r\n * @property {boolean} flippedAntiDiagonal - Diagonal flip flag.\r\n * @property {number} rotation - Amount of rotation.\r\n * @property {boolean} flipped - Is flipped?\r\n */", "meta": { "filename": "GIDData.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\typedefs", "code": {} }, "kind": "typedef", "name": "GIDData", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Tiled GID.", "name": "gid" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Horizontal flip flag.", "name": "flippedHorizontal" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Vertical flip flag.", "name": "flippedVertical" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Diagonal flip flag.", "name": "flippedAntiDiagonal" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Amount of rotation.", "name": "rotation" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is flipped?", "name": "flipped" } ], "memberof": "Phaser.Types.Tilemaps", "longname": "Phaser.Types.Tilemaps.GIDData", "scope": "static", "___id": "T000002R043372", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Tilemaps\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\typedefs", "code": {} }, "kind": "namespace", "name": "Tilemaps", "memberof": "Phaser.Types", "longname": "Phaser.Types.Tilemaps", "scope": "static", "___id": "T000002R043373", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tilemaps.LayerDataConfig\r\n * @since 3.0.0\r\n *\r\n * @property {string} [name] - The name of the layer, if specified in Tiled.\r\n * @property {number} [x=0] - The x offset of where to draw from the top left.\r\n * @property {number} [y=0] - The y offset of where to draw from the top left.\r\n * @property {number} [width=0] - The width of the layer in tiles.\r\n * @property {number} [height=0] - The height of the layer in tiles.\r\n * @property {number} [tileWidth=0] - The pixel width of the tiles.\r\n * @property {number} [tileHeight=0] - The pixel height of the tiles.\r\n * @property {number} [baseTileWidth=0] - The base tile width.\r\n * @property {number} [baseTileHeight=0] - The base tile height.\r\n * @property {number} [widthInPixels=0] - The width in pixels of the entire layer.\r\n * @property {number} [heightInPixels=0] - The height in pixels of the entire layer.\r\n * @property {number} [alpha=1] - The alpha value of the layer.\r\n * @property {boolean} [visible=true] - Is the layer visible or not?\r\n * @property {object[]} [properties] - Layer specific properties (can be specified in Tiled)\r\n * @property {array} [indexes] - Tile ID index map.\r\n * @property {array} [collideIndexes] - Tile Collision ID index map.\r\n * @property {array} [callbacks] - An array of callbacks.\r\n * @property {array} [bodies] - An array of physics bodies.\r\n * @property {array} [data] - An array of the tile data indexes.\r\n * @property {Phaser.Tilemaps.TilemapLayer} [tilemapLayer] - A reference to the Tilemap layer that owns this data.\r\n */", "meta": { "filename": "LayerDataConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\typedefs", "code": {} }, "kind": "typedef", "name": "LayerDataConfig", "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 name of the layer, if specified in Tiled.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x offset of where to draw from the top left.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y offset of where to draw from the top left.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The width of the layer in tiles.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The height of the layer in tiles.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The pixel width of the tiles.", "name": "tileWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The pixel height of the tiles.", "name": "tileHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The base tile width.", "name": "baseTileWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The base tile height.", "name": "baseTileHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The width in pixels of the entire layer.", "name": "widthInPixels" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The height in pixels of the entire layer.", "name": "heightInPixels" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The alpha value of the layer.", "name": "alpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Is the layer visible or not?", "name": "visible" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } }, "optional": true, "description": "Layer specific properties (can be specified in Tiled)", "name": "properties" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Tile ID index map.", "name": "indexes" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Tile Collision ID index map.", "name": "collideIndexes" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "An array of callbacks.", "name": "callbacks" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "An array of physics bodies.", "name": "bodies" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "An array of the tile data indexes.", "name": "data" }, { "type": { "names": [ "Phaser.Tilemaps.TilemapLayer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tilemaps.TilemapLayer" } }, "optional": true, "description": "A reference to the Tilemap layer that owns this data.", "name": "tilemapLayer" } ], "memberof": "Phaser.Types.Tilemaps", "longname": "Phaser.Types.Tilemaps.LayerDataConfig", "scope": "static", "___id": "T000002R043374", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tilemaps.MapDataConfig\r\n * @since 3.0.0\r\n * \r\n * @property {string} [name] - The key in the Phaser cache that corresponds to the loaded tilemap data.\r\n * @property {number} [width=0] - The width of the entire tilemap.\r\n * @property {number} [height=0] - The height of the entire tilemap.\r\n * @property {number} [tileWidth=0] - The width of the tiles.\r\n * @property {number} [tileHeight=0] - The height of the tiles.\r\n * @property {number} [widthInPixels] - The width in pixels of the entire tilemap.\r\n * @property {number} [heightInPixels] - The height in pixels of the entire tilemap.\r\n * @property {number} [format] - The format of the Tilemap, as defined in Tiled.\r\n * @property {(string|Phaser.Tilemaps.Orientation)} [orientation] - The orientation of the map data (i.e. orthogonal, isometric, hexagonal), default 'orthogonal'.\r\n * @property {string} [renderOrder] - Determines the draw order of tilemap. Default is right-down.\r\n * @property {number} [version] - The version of Tiled the map uses.\r\n * @property {number} [properties] - Map specific properties (can be specified in Tiled).\r\n * @property {Phaser.Tilemaps.LayerData[]} [layers] - The layers of the tilemap.\r\n * @property {array} [images] - An array with all the layers configured to the MapData.\r\n * @property {object} [objects] - An array of Tiled Image Layers.\r\n * @property {object} [collision] - An object of Tiled Object Layers.\r\n * @property {Phaser.Tilemaps.Tileset[]} [tilesets] - The tilesets the map uses.\r\n * @property {array} [imageCollections] - The collection of images the map uses(specified in Tiled).\r\n * @property {array} [tiles] - Array of Tile instances.\r\n */", "meta": { "filename": "MapDataConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\typedefs", "code": {} }, "kind": "typedef", "name": "MapDataConfig", "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 in the Phaser cache that corresponds to the loaded tilemap data.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The width of the entire tilemap.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The height of the entire tilemap.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The width of the tiles.", "name": "tileWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The height of the tiles.", "name": "tileHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width in pixels of the entire tilemap.", "name": "widthInPixels" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height in pixels of the entire tilemap.", "name": "heightInPixels" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The format of the Tilemap, as defined in Tiled.", "name": "format" }, { "type": { "names": [ "string", "Phaser.Tilemaps.Orientation" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Tilemaps.Orientation" } ] } }, "optional": true, "description": "The orientation of the map data (i.e. orthogonal, isometric, hexagonal), default 'orthogonal'.", "name": "orientation" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Determines the draw order of tilemap. Default is right-down.", "name": "renderOrder" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The version of Tiled the map uses.", "name": "version" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Map specific properties (can be specified in Tiled).", "name": "properties" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.LayerData", "type": "NameExpression" } ] } }, "optional": true, "description": "The layers of the tilemap.", "name": "layers" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "An array with all the layers configured to the MapData.", "name": "images" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "An array of Tiled Image Layers.", "name": "objects" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "An object of Tiled Object Layers.", "name": "collision" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tilemaps.Tileset", "type": "NameExpression" } ] } }, "optional": true, "description": "The tilesets the map uses.", "name": "tilesets" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "The collection of images the map uses(specified in Tiled).", "name": "imageCollections" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Array of Tile instances.", "name": "tiles" } ], "memberof": "Phaser.Types.Tilemaps", "longname": "Phaser.Types.Tilemaps.MapDataConfig", "scope": "static", "___id": "T000002R043375", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tilemaps.ObjectLayerConfig\r\n * @since 3.0.0\r\n * \r\n * @property {string} [name='object layer'] - The name of the Object Layer.\r\n * @property {number} [opacity=1] - The opacity of the layer, between 0 and 1.\r\n * @property {any} [properties] - The custom properties defined on the Object Layer, keyed by their name.\r\n * @property {any} [propertytypes] - The type of each custom property defined on the Object Layer, keyed by its name.\r\n * @property {string} [type='objectgroup'] - The type of the layer, which should be `objectgroup`.\r\n * @property {boolean} [visible=true] - Whether the layer is shown (`true`) or hidden (`false`).\r\n * @property {any[]} [objects] - An array of all objects on this Object Layer.\r\n */", "meta": { "filename": "ObjectLayerConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\typedefs", "code": {} }, "kind": "typedef", "name": "ObjectLayerConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'object layer'", "description": "The name of the Object Layer.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The opacity of the layer, between 0 and 1.", "name": "opacity" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The custom properties defined on the Object Layer, keyed by their name.", "name": "properties" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The type of each custom property defined on the Object Layer, keyed by its name.", "name": "propertytypes" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'objectgroup'", "description": "The type of the layer, which should be `objectgroup`.", "name": "type" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether the layer is shown (`true`) or hidden (`false`).", "name": "visible" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of all objects on this Object Layer.", "name": "objects" } ], "memberof": "Phaser.Types.Tilemaps", "longname": "Phaser.Types.Tilemaps.ObjectLayerConfig", "scope": "static", "___id": "T000002R043376", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tilemaps.StyleConfig\r\n * @since 3.0.0\r\n * \r\n * @property {?(Phaser.Display.Color|number|null)} [tileColor=blue] - Color to use for drawing a filled rectangle at non-colliding tile locations. If set to null, non-colliding tiles will not be drawn.\r\n * @property {?(Phaser.Display.Color|number|null)} [collidingTileColor=orange] - Color to use for drawing a filled rectangle at colliding tile locations. If set to null, colliding tiles will not be drawn.\r\n * @property {?(Phaser.Display.Color|number|null)} [faceColor=grey] - Color to use for drawing a line at interesting tile faces. If set to null, interesting tile faces will not be drawn.\r\n */", "meta": { "filename": "StyleConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\typedefs", "code": {} }, "kind": "typedef", "name": "StyleConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Display.Color", "number", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Color" }, { "type": "NameExpression", "name": "number" }, { "type": "NullLiteral" } ], "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": "blue", "description": "Color to use for drawing a filled rectangle at non-colliding tile locations. If set to null, non-colliding tiles will not be drawn.", "name": "tileColor" }, { "type": { "names": [ "Phaser.Display.Color", "number", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Color" }, { "type": "NameExpression", "name": "number" }, { "type": "NullLiteral" } ], "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": "orange", "description": "Color to use for drawing a filled rectangle at colliding tile locations. If set to null, colliding tiles will not be drawn.", "name": "collidingTileColor" }, { "type": { "names": [ "Phaser.Display.Color", "number", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Color" }, { "type": "NameExpression", "name": "number" }, { "type": "NullLiteral" } ], "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": "grey", "description": "Color to use for drawing a line at interesting tile faces. If set to null, interesting tile faces will not be drawn.", "name": "faceColor" } ], "memberof": "Phaser.Types.Tilemaps", "longname": "Phaser.Types.Tilemaps.StyleConfig", "scope": "static", "___id": "T000002R043377", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tilemaps.TiledObject\r\n * @since 3.0.0\r\n *\r\n * @property {number} id - The unique object ID.\r\n * @property {string} name - The name this object was assigned in Tiled.\r\n * @property {string} type - The string type of this instance, as assigned in Tiled. Tiled supports inheriting instance types from tilesets; in that case, the type will be set in the tile's data, but will be `''` here; use the `gid` to fetch the tile data or properties.\r\n * @property {boolean} [visible] - The visible state of this object.\r\n * @property {number} [x] - The horizontal position of this object, in pixels, relative to the tilemap.\r\n * @property {number} [y] - The vertical position of this object, in pixels, relative to the tilemap.\r\n * @property {number} [width] - The width of this object, in pixels.\r\n * @property {number} [height] - The height of this object, in pixels.\r\n * @property {number} [rotation] - The rotation of the object in clockwise degrees.\r\n * @property {any} [properties] - Custom properties object.\r\n * @property {number} [gid] - Only set if of type 'tile'.\r\n * @property {boolean} [flippedHorizontal] - Only set if a tile object. The horizontal flip value.\r\n * @property {boolean} [flippedVertical] - Only set if a tile object. The vertical flip value.\r\n * @property {boolean} [flippedAntiDiagonal] - Only set if a tile object. The diagonal flip value.\r\n * @property {Phaser.Types.Math.Vector2Like[]} [polyline] - Only set if a polyline object. An array of objects corresponding to points, where each point has an `x` property and a `y` property.\r\n * @property {Phaser.Types.Math.Vector2Like[]} [polygon] - Only set if a polygon object. An array of objects corresponding to points, where each point has an `x` property and a `y` property.\r\n * @property {any} [text] - Only set if a text object. Contains the text objects properties.\r\n * @property {boolean} [rectangle] - Only set, and set to `true`, if a rectangle object.\r\n * @property {boolean} [ellipse] - Only set, and set to `true`, if a ellipse object.\r\n * @property {boolean} [point] - Only set, and set to `true`, if a point object.\r\n */", "meta": { "filename": "TiledObject.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\typedefs", "code": {} }, "kind": "typedef", "name": "TiledObject", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The unique object ID.", "name": "id" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name this object was assigned in Tiled.", "name": "name" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string type of this instance, as assigned in Tiled. Tiled supports inheriting instance types from tilesets; in that case, the type will be set in the tile's data, but will be `''` here; use the `gid` to fetch the tile data or properties.", "name": "type" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "The visible state of this object.", "name": "visible" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position of this object, in pixels, relative to the tilemap.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The vertical position of this object, in pixels, relative to the tilemap.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of this object, in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of this object, in pixels.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The rotation of the object in clockwise degrees.", "name": "rotation" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Custom properties object.", "name": "properties" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Only set if of type 'tile'.", "name": "gid" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Only set if a tile object. The horizontal flip value.", "name": "flippedHorizontal" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Only set if a tile object. The vertical flip value.", "name": "flippedVertical" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Only set if a tile object. The diagonal flip value.", "name": "flippedAntiDiagonal" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "optional": true, "description": "Only set if a polyline object. An array of objects corresponding to points, where each point has an `x` property and a `y` property.", "name": "polyline" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "optional": true, "description": "Only set if a polygon object. An array of objects corresponding to points, where each point has an `x` property and a `y` property.", "name": "polygon" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Only set if a text object. Contains the text objects properties.", "name": "text" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Only set, and set to `true`, if a rectangle object.", "name": "rectangle" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Only set, and set to `true`, if a ellipse object.", "name": "ellipse" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Only set, and set to `true`, if a point object.", "name": "point" } ], "memberof": "Phaser.Types.Tilemaps", "longname": "Phaser.Types.Tilemaps.TiledObject", "scope": "static", "___id": "T000002R043378", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tilemaps.TilemapConfig\r\n * @since 3.0.0\r\n * \r\n * @property {string} [key] - The key in the Phaser cache that corresponds to the loaded tilemap data.\r\n * @property {number[][]} [data] - Instead of loading from the cache, you can also load directly from a 2D array of tile indexes.\r\n * @property {number} [tileWidth=32] - The width of a tile in pixels.\r\n * @property {number} [tileHeight=32] - The height of a tile in pixels.\r\n * @property {number} [width=10] - The width of the map in tiles.\r\n * @property {number} [height=10] - The height of the map in tiles.\r\n * @property {boolean} [insertNull=false] - Controls how empty tiles, tiles with an index of -1,\r\n * in the map data are handled. If `true`, empty locations will get a value of `null`. If `false`,\r\n * empty location will get a Tile object with an index of -1. If you've a large sparsely populated\r\n * map and the tile data doesn't need to change then setting this value to `true` will help with\r\n * memory consumption. However if your map is small or you need to update the tiles dynamically,\r\n * then leave the default value set.\r\n */", "meta": { "filename": "TilemapConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\typedefs", "code": {} }, "kind": "typedef", "name": "TilemapConfig", "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 in the Phaser cache that corresponds to the loaded tilemap data.", "name": "key" }, { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "Instead of loading from the cache, you can also load directly from a 2D array of tile indexes.", "name": "data" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The width of a tile in pixels.", "name": "tileWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The height of a tile in pixels.", "name": "tileHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The width of the map in tiles.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The height of the map in tiles.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Controls how empty tiles, tiles with an index of -1,\rin the map data are handled. If `true`, empty locations will get a value of `null`. If `false`,\rempty location will get a Tile object with an index of -1. If you've a large sparsely populated\rmap and the tile data doesn't need to change then setting this value to `true` will help with\rmemory consumption. However if your map is small or you need to update the tiles dynamically,\rthen leave the default value set.", "name": "insertNull" } ], "memberof": "Phaser.Types.Tilemaps", "longname": "Phaser.Types.Tilemaps.TilemapConfig", "scope": "static", "___id": "T000002R043379", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Clock is a Scene plugin which creates and updates Timer Events for its Scene.\r\n *\r\n * @class Clock\r\n * @memberof Phaser.Time\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene which owns this Clock.\r\n */", "meta": { "filename": "Clock.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "classdesc": "The Clock is a Scene plugin which creates and updates Timer Events for its Scene.", "kind": "class", "name": "Clock", "memberof": "Phaser.Time", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene which owns this Clock.", "name": "scene" } ], "scope": "static", "longname": "Phaser.Time.Clock", "___id": "T000002R043385", "___s": true }, { "comment": "/**\r\n * The Scene which owns this Clock.\r\n *\r\n * @name Phaser.Time.Clock#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Clock.js", "lineno": 30, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "The Scene which owns this Clock.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Time.Clock", "longname": "Phaser.Time.Clock#scene", "scope": "instance", "kind": "member", "___id": "T000002R043388", "___s": true }, { "comment": "/**\r\n * The Scene Systems object of the Scene which owns this Clock.\r\n *\r\n * @name Phaser.Time.Clock#systems\r\n * @type {Phaser.Scenes.Systems}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Clock.js", "lineno": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "The Scene Systems object of the Scene which owns this Clock.", "name": "systems", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "since": "3.0.0", "memberof": "Phaser.Time.Clock", "longname": "Phaser.Time.Clock#systems", "scope": "instance", "kind": "member", "___id": "T000002R043390", "___s": true }, { "comment": "/**\r\n * The current time of the Clock, in milliseconds.\r\n *\r\n * If accessed externally, this is equivalent to the `time` parameter normally passed to a Scene's `update` method.\r\n *\r\n * @name Phaser.Time.Clock#now\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Clock.js", "lineno": 48, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "The current time of the Clock, in milliseconds.\r\rIf accessed externally, this is equivalent to the `time` parameter normally passed to a Scene's `update` method.", "name": "now", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Time.Clock", "longname": "Phaser.Time.Clock#now", "scope": "instance", "kind": "member", "___id": "T000002R043392", "___s": true }, { "comment": "/**\r\n * The time the Clock (and Scene) started, in milliseconds.\r\n *\r\n * This can be compared to the `time` parameter passed to a Scene's `update` method.\r\n *\r\n * @name Phaser.Time.Clock#startTime\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Clock.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "The time the Clock (and Scene) started, in milliseconds.\r\rThis can be compared to the `time` parameter passed to a Scene's `update` method.", "name": "startTime", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Time.Clock", "longname": "Phaser.Time.Clock#startTime", "scope": "instance", "kind": "member", "___id": "T000002R043394", "___s": true }, { "comment": "/**\r\n * The scale of the Clock's time delta.\r\n *\r\n * The time delta is the time elapsed between two consecutive frames and influences the speed of time for this Clock and anything which uses it, such as its Timer Events. Values higher than 1 increase the speed of time, while values smaller than 1 decrease it. A value of 0 freezes time and is effectively equivalent to pausing the Clock.\r\n *\r\n * @name Phaser.Time.Clock#timeScale\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Clock.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "The scale of the Clock's time delta.\r\rThe time delta is the time elapsed between two consecutive frames and influences the speed of time for this Clock and anything which uses it, such as its Timer Events. Values higher than 1 increase the speed of time, while values smaller than 1 decrease it. A value of 0 freezes time and is effectively equivalent to pausing the Clock.", "name": "timeScale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Time.Clock", "longname": "Phaser.Time.Clock#timeScale", "scope": "instance", "kind": "member", "___id": "T000002R043396", "___s": true }, { "comment": "/**\r\n * Whether the Clock is paused (`true`) or active (`false`).\r\n *\r\n * When paused, the Clock will not update any of its Timer Events, thus freezing time.\r\n *\r\n * @name Phaser.Time.Clock#paused\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Clock.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Whether the Clock is paused (`true`) or active (`false`).\r\rWhen paused, the Clock will not update any of its Timer Events, thus freezing time.", "name": "paused", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Time.Clock", "longname": "Phaser.Time.Clock#paused", "scope": "instance", "kind": "member", "___id": "T000002R043398", "___s": true }, { "comment": "/**\r\n * Creates a Timer Event and adds it to this Clock at the start of the next frame.\r\n *\r\n * You can pass in either a `TimerEventConfig` object, from with a new `TimerEvent` will\r\n * be created, or you can pass in a `TimerEvent` instance.\r\n *\r\n * If passing an instance please make sure that this instance hasn't been used before.\r\n * If it has ever entered a 'completed' state then it will no longer be suitable to\r\n * run again.\r\n *\r\n * Also, if the `TimerEvent` instance is being used by _another_ Clock (in another Scene)\r\n * it will still be updated by that Clock as well, so be careful when using this feature.\r\n *\r\n * @method Phaser.Time.Clock#addEvent\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Time.TimerEvent | Phaser.Types.Time.TimerEventConfig)} config - The configuration for the Timer Event, or an existing Timer Event object.\r\n *\r\n * @return {Phaser.Time.TimerEvent} The Timer Event which was created, or passed in.\r\n */", "meta": { "filename": "Clock.js", "lineno": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Creates a Timer Event and adds it to this Clock at the start of the next frame.\r\rYou can pass in either a `TimerEventConfig` object, from with a new `TimerEvent` will\rbe created, or you can pass in a `TimerEvent` instance.\r\rIf passing an instance please make sure that this instance hasn't been used before.\rIf it has ever entered a 'completed' state then it will no longer be suitable to\rrun again.\r\rAlso, if the `TimerEvent` instance is being used by _another_ Clock (in another Scene)\rit will still be updated by that Clock as well, so be careful when using this feature.", "kind": "function", "name": "addEvent", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Time.TimerEvent", "Phaser.Types.Time.TimerEventConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Time.TimerEvent" }, { "type": "NameExpression", "name": "Phaser.Types.Time.TimerEventConfig" } ] } }, "description": "The configuration for the Timer Event, or an existing Timer Event object.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Time.TimerEvent" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Time.TimerEvent" } }, "description": "The Timer Event which was created, or passed in." } ], "memberof": "Phaser.Time.Clock", "longname": "Phaser.Time.Clock#addEvent", "scope": "instance", "___id": "T000002R043413", "___s": true }, { "comment": "/**\r\n * Creates a Timer Event and adds it to the Clock at the start of the frame.\r\n *\r\n * This is a shortcut for {@link #addEvent} which can be shorter and is compatible with the syntax of the GreenSock Animation Platform (GSAP).\r\n *\r\n * @method Phaser.Time.Clock#delayedCall\r\n * @since 3.0.0\r\n *\r\n * @param {number} delay - The delay of the function call, in milliseconds.\r\n * @param {function} callback - The function to call after the delay expires.\r\n * @param {Array.<*>} [args] - The arguments to call the function with.\r\n * @param {*} [callbackScope] - The scope (`this` object) to call the function with.\r\n *\r\n * @return {Phaser.Time.TimerEvent} The Timer Event which was created.\r\n */", "meta": { "filename": "Clock.js", "lineno": 211, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Creates a Timer Event and adds it to the Clock at the start of the frame.\r\rThis is a shortcut for {@link #addEvent} which can be shorter and is compatible with the syntax of the GreenSock Animation Platform (GSAP).", "kind": "function", "name": "delayedCall", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delay of the function call, in milliseconds.", "name": "delay" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The function to call after the delay expires.", "name": "callback" }, { "type": { "names": [ "Array.<*>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "AllLiteral" } ] } }, "optional": true, "description": "The arguments to call the function with.", "name": "args" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The scope (`this` object) to call the function with.", "name": "callbackScope" } ], "returns": [ { "type": { "names": [ "Phaser.Time.TimerEvent" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Time.TimerEvent" } }, "description": "The Timer Event which was created." } ], "memberof": "Phaser.Time.Clock", "longname": "Phaser.Time.Clock#delayedCall", "scope": "instance", "___id": "T000002R043421", "___s": true }, { "comment": "/**\r\n * Clears and recreates the array of pending Timer Events.\r\n *\r\n * @method Phaser.Time.Clock#clearPendingEvents\r\n * @since 3.0.0\r\n *\r\n * @return {this} - This Clock instance.\r\n */", "meta": { "filename": "Clock.js", "lineno": 231, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Clears and recreates the array of pending Timer Events.", "kind": "function", "name": "clearPendingEvents", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "- This Clock instance." } ], "memberof": "Phaser.Time.Clock", "longname": "Phaser.Time.Clock#clearPendingEvents", "scope": "instance", "___id": "T000002R043427", "___s": true }, { "comment": "/**\r\n * Removes the given Timer Event, or an array of Timer Events, from this Clock.\r\n *\r\n * The events are removed from all internal lists (active, pending and removal),\r\n * freeing the event up to be re-used.\r\n *\r\n * @method Phaser.Time.Clock#removeEvent\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.Time.TimerEvent | Phaser.Time.TimerEvent[])} events - The Timer Event, or an array of Timer Events, to remove from this Clock.\r\n *\r\n * @return {this} - This Clock instance.\r\n */", "meta": { "filename": "Clock.js", "lineno": 246, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Removes the given Timer Event, or an array of Timer Events, from this Clock.\r\rThe events are removed from all internal lists (active, pending and removal),\rfreeing the event up to be re-used.", "kind": "function", "name": "removeEvent", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Time.TimerEvent", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Time.TimerEvent" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Time.TimerEvent", "type": "NameExpression" } ] } ] } }, "description": "The Timer Event, or an array of Timer Events, to remove from this Clock.", "name": "events" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "- This Clock instance." } ], "memberof": "Phaser.Time.Clock", "longname": "Phaser.Time.Clock#removeEvent", "scope": "instance", "___id": "T000002R043430", "___s": true }, { "comment": "/**\r\n * Schedules all active Timer Events for removal at the start of the frame.\r\n *\r\n * @method Phaser.Time.Clock#removeAllEvents\r\n * @since 3.0.0\r\n *\r\n * @return {this} - This Clock instance.\r\n */", "meta": { "filename": "Clock.js", "lineno": 278, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Schedules all active Timer Events for removal at the start of the frame.", "kind": "function", "name": "removeAllEvents", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "- This Clock instance." } ], "memberof": "Phaser.Time.Clock", "longname": "Phaser.Time.Clock#removeAllEvents", "scope": "instance", "___id": "T000002R043435", "___s": true }, { "comment": "/**\r\n * Updates the arrays of active and pending Timer Events. Called at the start of the frame.\r\n *\r\n * @method Phaser.Time.Clock#preUpdate\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": "Clock.js", "lineno": 293, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Updates the arrays of active and pending Timer Events. Called at the start of the frame.", "kind": "function", "name": "preUpdate", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "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.Time.Clock", "longname": "Phaser.Time.Clock#preUpdate", "scope": "instance", "___id": "T000002R043438", "___s": true }, { "comment": "/**\r\n * Updates the Clock's internal time and all of its Timer Events.\r\n *\r\n * @method Phaser.Time.Clock#update\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": "Clock.js", "lineno": 344, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Updates the Clock's internal time and all of its Timer Events.", "kind": "function", "name": "update", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "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.Time.Clock", "longname": "Phaser.Time.Clock#update", "scope": "instance", "___id": "T000002R043451", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Time\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "kind": "namespace", "name": "Time", "memberof": "Phaser", "longname": "Phaser.Time", "scope": "static", "___id": "T000002R043479", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Timeline is a way to schedule events to happen at specific times in the future.\r\n *\r\n * You can think of it as an event sequencer for your game, allowing you to schedule the\r\n * running of callbacks, events and other actions at specific times in the future.\r\n *\r\n * A Timeline is a Scene level system, meaning you can have as many Timelines as you like, each\r\n * belonging to a different Scene. You can also have multiple Timelines running at the same time.\r\n *\r\n * If the Scene is paused, the Timeline will also pause. If the Scene is destroyed, the Timeline\r\n * will be automatically destroyed. However, you can control the Timeline directly, pausing,\r\n * resuming and stopping it at any time.\r\n *\r\n * Create an instance of a Timeline via the Game Object Factory:\r\n *\r\n * ```js\r\n * const timeline = this.add.timeline();\r\n * ```\r\n *\r\n * The Timeline always starts paused. You must call `play` on it to start it running.\r\n *\r\n * You can also pass in a configuration object on creation, or an array of them:\r\n *\r\n * ```js\r\n * const timeline = this.add.timeline({\r\n * at: 1000,\r\n * run: () => {\r\n * this.add.sprite(400, 300, 'logo');\r\n * }\r\n * });\r\n *\r\n * timeline.play();\r\n * ```\r\n *\r\n * In this example we sequence a few different events:\r\n *\r\n * ```js\r\n * const timeline = this.add.timeline([\r\n * {\r\n * at: 1000,\r\n * run: () => { this.logo = this.add.sprite(400, 300, 'logo'); },\r\n * sound: 'TitleMusic'\r\n * },\r\n * {\r\n * at: 2500,\r\n * tween: {\r\n * targets: this.logo,\r\n * y: 600,\r\n * yoyo: true\r\n * },\r\n * sound: 'Explode'\r\n * },\r\n * {\r\n * at: 8000,\r\n * event: 'HURRY_PLAYER',\r\n * target: this.background,\r\n * set: {\r\n * tint: 0xff0000\r\n * }\r\n * }\r\n * ]);\r\n *\r\n * timeline.play();\r\n * ```\r\n *\r\n * There are lots of options available to you via the configuration object. See the\r\n * {@link Phaser.Types.Time.TimelineEventConfig} typedef for more details.\r\n *\r\n * @class Timeline\r\n * @memberof Phaser.Time\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene which owns this Timeline.\r\n * @param {Phaser.Types.Time.TimelineEventConfig|Phaser.Types.Time.TimelineEventConfig[]} config - The configuration object for this Timeline Event, or an array of them.\r\n */", "meta": { "filename": "Timeline.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "classdesc": "A Timeline is a way to schedule events to happen at specific times in the future.\r\rYou can think of it as an event sequencer for your game, allowing you to schedule the\rrunning of callbacks, events and other actions at specific times in the future.\r\rA Timeline is a Scene level system, meaning you can have as many Timelines as you like, each\rbelonging to a different Scene. You can also have multiple Timelines running at the same time.\r\rIf the Scene is paused, the Timeline will also pause. If the Scene is destroyed, the Timeline\rwill be automatically destroyed. However, you can control the Timeline directly, pausing,\rresuming and stopping it at any time.\r\rCreate an instance of a Timeline via the Game Object Factory:\r\r```js\rconst timeline = this.add.timeline();\r```\r\rThe Timeline always starts paused. You must call `play` on it to start it running.\r\rYou can also pass in a configuration object on creation, or an array of them:\r\r```js\rconst timeline = this.add.timeline({\r at: 1000,\r run: () => {\r this.add.sprite(400, 300, 'logo');\r }\r});\r\rtimeline.play();\r```\r\rIn this example we sequence a few different events:\r\r```js\rconst timeline = this.add.timeline([\r {\r at: 1000,\r run: () => { this.logo = this.add.sprite(400, 300, 'logo'); },\r sound: 'TitleMusic'\r },\r {\r at: 2500,\r tween: {\r targets: this.logo,\r y: 600,\r yoyo: true\r },\r sound: 'Explode'\r },\r {\r at: 8000,\r event: 'HURRY_PLAYER',\r target: this.background,\r set: {\r tint: 0xff0000\r }\r }\r]);\r\rtimeline.play();\r```\r\rThere are lots of options available to you via the configuration object. See the\r{@link Phaser.Types.Time.TimelineEventConfig} typedef for more details.", "kind": "class", "name": "Timeline", "memberof": "Phaser.Time", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene which owns this Timeline.", "name": "scene" }, { "type": { "names": [ "Phaser.Types.Time.TimelineEventConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Time.TimelineEventConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Time.TimelineEventConfig", "type": "NameExpression" } ] } ] } }, "description": "The configuration object for this Timeline Event, or an array of them.", "name": "config" } ], "scope": "static", "longname": "Phaser.Time.Timeline", "___id": "T000002R043489", "___s": true }, { "comment": "/**\r\n * The Scene to which this Timeline belongs.\r\n *\r\n * @name Phaser.Time.Timeline#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Timeline.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "The Scene to which this Timeline belongs.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.60.0", "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#scene", "scope": "instance", "kind": "member", "___id": "T000002R043493", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Systems.\r\n *\r\n * @name Phaser.Time.Timeline#systems\r\n * @type {Phaser.Scenes.Systems}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Timeline.js", "lineno": 109, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "A reference to the Scene Systems.", "name": "systems", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "since": "3.60.0", "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#systems", "scope": "instance", "kind": "member", "___id": "T000002R043495", "___s": true }, { "comment": "/**\r\n * The elapsed time counter.\r\n *\r\n * Treat this as read-only.\r\n *\r\n * @name Phaser.Time.Timeline#elapsed\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Timeline.js", "lineno": 118, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "The elapsed time counter.\r\rTreat this as read-only.", "name": "elapsed", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#elapsed", "scope": "instance", "kind": "member", "___id": "T000002R043497", "___s": true }, { "comment": "/**\r\n * Whether the Timeline is running (`true`) or active (`false`).\r\n *\r\n * When paused, the Timeline will not run any of its actions.\r\n *\r\n * By default a Timeline is always paused and should be started by\r\n * calling the `Timeline.play` method.\r\n *\r\n * You can use the `Timeline.pause` and `Timeline.resume` methods to control\r\n * this value in a chainable way.\r\n *\r\n * @name Phaser.Time.Timeline#paused\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Timeline.js", "lineno": 129, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Whether the Timeline is running (`true`) or active (`false`).\r\rWhen paused, the Timeline will not run any of its actions.\r\rBy default a Timeline is always paused and should be started by\rcalling the `Timeline.play` method.\r\rYou can use the `Timeline.pause` and `Timeline.resume` methods to control\rthis value in a chainable way.", "name": "paused", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#paused", "scope": "instance", "kind": "member", "___id": "T000002R043499", "___s": true }, { "comment": "/**\r\n * Whether the Timeline is complete (`true`) or not (`false`).\r\n *\r\n * A Timeline is considered complete when all of its events have been run.\r\n *\r\n * If you wish to restart a Timeline after it has completed, you can do so\r\n * by calling the `Timeline.restart` method.\r\n *\r\n * You can also use the `Timeline.stop` method to stop a running Timeline,\r\n * at any point, without resetting it.\r\n *\r\n * @name Phaser.Time.Timeline#complete\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Timeline.js", "lineno": 147, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Whether the Timeline is complete (`true`) or not (`false`).\r\rA Timeline is considered complete when all of its events have been run.\r\rIf you wish to restart a Timeline after it has completed, you can do so\rby calling the `Timeline.restart` method.\r\rYou can also use the `Timeline.stop` method to stop a running Timeline,\rat any point, without resetting it.", "name": "complete", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#complete", "scope": "instance", "kind": "member", "___id": "T000002R043501", "___s": true }, { "comment": "/**\r\n * The total number of events that have been run.\r\n *\r\n * This value is reset to zero if the Timeline is restarted.\r\n *\r\n * Treat this as read-only.\r\n *\r\n * @name Phaser.Time.Timeline#totalComplete\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Timeline.js", "lineno": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "The total number of events that have been run.\r\rThis value is reset to zero if the Timeline is restarted.\r\rTreat this as read-only.", "name": "totalComplete", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#totalComplete", "scope": "instance", "kind": "member", "___id": "T000002R043503", "___s": true }, { "comment": "/**\r\n * An array of all the Timeline Events.\r\n *\r\n * @name Phaser.Time.Timeline#events\r\n * @type {Phaser.Types.Time.TimelineEvent[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Timeline.js", "lineno": 178, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "An array of all the Timeline Events.", "name": "events", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Time.TimelineEvent", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#events", "scope": "instance", "kind": "member", "___id": "T000002R043505", "___s": true }, { "comment": "/**\r\n * Updates the elapsed time counter, if this Timeline is not paused.\r\n *\r\n * @method Phaser.Time.Timeline#preUpdate\r\n * @since 3.60.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": "Timeline.js", "lineno": 199, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Updates the elapsed time counter, if this Timeline is not paused.", "kind": "function", "name": "preUpdate", "since": "3.60.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.Time.Timeline", "longname": "Phaser.Time.Timeline#preUpdate", "scope": "instance", "___id": "T000002R043508", "___s": true }, { "comment": "/**\r\n * Called automatically by the Scene update step.\r\n *\r\n * Iterates through all of the Timeline Events and checks to see if they should be run.\r\n *\r\n * If they should be run, then the `TimelineEvent.action` callback is invoked.\r\n *\r\n * If the `TimelineEvent.once` property is `true` then the event is removed from the Timeline.\r\n *\r\n * If the `TimelineEvent.event` property is set then the Timeline emits that event.\r\n *\r\n * If the `TimelineEvent.run` property is set then the Timeline invokes that method.\r\n *\r\n * If the `TimelineEvent.target` property is set then the Timeline invokes the `run` method on that target.\r\n *\r\n * @method Phaser.Time.Timeline#update\r\n * @since 3.60.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": "Timeline.js", "lineno": 218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Called automatically by the Scene update step.\r\rIterates through all of the Timeline Events and checks to see if they should be run.\r\rIf they should be run, then the `TimelineEvent.action` callback is invoked.\r\rIf the `TimelineEvent.once` property is `true` then the event is removed from the Timeline.\r\rIf the `TimelineEvent.event` property is set then the Timeline emits that event.\r\rIf the `TimelineEvent.run` property is set then the Timeline invokes that method.\r\rIf the `TimelineEvent.target` property is set then the Timeline invokes the `run` method on that target.", "kind": "function", "name": "update", "since": "3.60.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.Time.Timeline", "longname": "Phaser.Time.Timeline#update", "scope": "instance", "___id": "T000002R043511", "___s": true }, { "comment": "/**\r\n * Starts this Timeline running.\r\n *\r\n * If the Timeline is already running and the `fromStart` parameter is `true`,\r\n * then calling this method will reset the Timeline events as incomplete.\r\n *\r\n * If you wish to resume a paused Timeline, then use the `Timeline.resume` method instead.\r\n *\r\n * @method Phaser.Time.Timeline#play\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [fromStart=true] - Reset this Timeline back to the start before playing.\r\n *\r\n * @return {this} This Timeline instance.\r\n */", "meta": { "filename": "Timeline.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Starts this Timeline running.\r\rIf the Timeline is already running and the `fromStart` parameter is `true`,\rthen calling this method will reset the Timeline events as incomplete.\r\rIf you wish to resume a paused Timeline, then use the `Timeline.resume` method instead.", "kind": "function", "name": "play", "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Reset this Timeline back to the start before playing.", "name": "fromStart" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Timeline instance." } ], "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#play", "scope": "instance", "___id": "T000002R043527", "___s": true }, { "comment": "/**\r\n * Pauses this Timeline.\r\n *\r\n * To resume it again, call the `Timeline.resume` method or set the `Timeline.paused` property to `false`.\r\n *\r\n * If the Timeline is paused while processing the current game step, then it\r\n * will carry on with all events that are due to run during that step and pause\r\n * from the next game step.\r\n *\r\n * @method Phaser.Time.Timeline#pause\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Timeline instance.\r\n */", "meta": { "filename": "Timeline.js", "lineno": 363, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Pauses this Timeline.\r\rTo resume it again, call the `Timeline.resume` method or set the `Timeline.paused` property to `false`.\r\rIf the Timeline is paused while processing the current game step, then it\rwill carry on with all events that are due to run during that step and pause\rfrom the next game step.", "kind": "function", "name": "pause", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Timeline instance." } ], "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#pause", "scope": "instance", "___id": "T000002R043533", "___s": true }, { "comment": "/**\r\n * Resumes this Timeline from a paused state.\r\n *\r\n * The Timeline will carry on from where it left off.\r\n *\r\n * If you need to reset the Timeline to the start, then call the `Timeline.reset` method.\r\n *\r\n * @method Phaser.Time.Timeline#resume\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Timeline instance.\r\n */", "meta": { "filename": "Timeline.js", "lineno": 384, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Resumes this Timeline from a paused state.\r\rThe Timeline will carry on from where it left off.\r\rIf you need to reset the Timeline to the start, then call the `Timeline.reset` method.", "kind": "function", "name": "resume", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Timeline instance." } ], "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#resume", "scope": "instance", "___id": "T000002R043536", "___s": true }, { "comment": "/**\r\n * Stops this Timeline.\r\n *\r\n * This will set the `paused` and `complete` properties to `true`.\r\n *\r\n * If you wish to reset the Timeline to the start, then call the `Timeline.reset` method.\r\n *\r\n * @method Phaser.Time.Timeline#stop\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Timeline instance.\r\n */", "meta": { "filename": "Timeline.js", "lineno": 403, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Stops this Timeline.\r\rThis will set the `paused` and `complete` properties to `true`.\r\rIf you wish to reset the Timeline to the start, then call the `Timeline.reset` method.", "kind": "function", "name": "stop", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Timeline instance." } ], "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#stop", "scope": "instance", "___id": "T000002R043539", "___s": true }, { "comment": "/**\r\n * Resets this Timeline back to the start.\r\n *\r\n * This will set the elapsed time to zero and set all events to be incomplete.\r\n *\r\n * If the Timeline had any events that were set to `once` that have already\r\n * been removed, they will **not** be present again after calling this method.\r\n *\r\n * If the Timeline isn't currently running (i.e. it's paused or complete) then\r\n * calling this method resets those states, the same as calling `Timeline.play(true)`.\r\n *\r\n * @method Phaser.Time.Timeline#reset\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Timeline instance.\r\n */", "meta": { "filename": "Timeline.js", "lineno": 423, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Resets this Timeline back to the start.\r\rThis will set the elapsed time to zero and set all events to be incomplete.\r\rIf the Timeline had any events that were set to `once` that have already\rbeen removed, they will **not** be present again after calling this method.\r\rIf the Timeline isn't currently running (i.e. it's paused or complete) then\rcalling this method resets those states, the same as calling `Timeline.play(true)`.", "kind": "function", "name": "reset", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Timeline instance." } ], "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#reset", "scope": "instance", "___id": "T000002R043543", "___s": true }, { "comment": "/**\r\n * Adds one or more events to this Timeline.\r\n *\r\n * You can pass in a single configuration object, or an array of them:\r\n *\r\n * ```js\r\n * const timeline = this.add.timeline({\r\n * at: 1000,\r\n * run: () => {\r\n * this.add.sprite(400, 300, 'logo');\r\n * }\r\n * });\r\n * ```\r\n *\r\n * @method Phaser.Time.Timeline#add\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Time.TimelineEventConfig|Phaser.Types.Time.TimelineEventConfig[]} config - The configuration object for this Timeline Event, or an array of them.\r\n *\r\n * @return {this} This Timeline instance.\r\n */", "meta": { "filename": "Timeline.js", "lineno": 451, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Adds one or more events to this Timeline.\r\rYou can pass in a single configuration object, or an array of them:\r\r```js\rconst timeline = this.add.timeline({\r at: 1000,\r run: () => {\r this.add.sprite(400, 300, 'logo');\r }\r});\r```", "kind": "function", "name": "add", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.Time.TimelineEventConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Time.TimelineEventConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Time.TimelineEventConfig", "type": "NameExpression" } ] } ] } }, "description": "The configuration object for this Timeline Event, or an array of them.", "name": "config" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Timeline instance." } ], "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#add", "scope": "instance", "___id": "T000002R043548", "___s": true }, { "comment": "/**\r\n * Removes all events from this Timeline, resets the elapsed time to zero\r\n * and pauses the Timeline.\r\n *\r\n * @method Phaser.Time.Timeline#clear\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Timeline instance.\r\n */", "meta": { "filename": "Timeline.js", "lineno": 531, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Removes all events from this Timeline, resets the elapsed time to zero\rand pauses the Timeline.", "kind": "function", "name": "clear", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Timeline instance." } ], "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#clear", "scope": "instance", "___id": "T000002R043573", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Timeline is currently playing.\r\n *\r\n * A Timeline is playing if it is not paused or not complete.\r\n *\r\n * @method Phaser.Time.Timeline#isPlaying\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Timeline is playing, otherwise `false`.\r\n */", "meta": { "filename": "Timeline.js", "lineno": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Returns `true` if this Timeline is currently playing.\r\rA Timeline is playing if it is not paused or not complete.", "kind": "function", "name": "isPlaying", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Timeline is playing, otherwise `false`." } ], "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#isPlaying", "scope": "instance", "___id": "T000002R043578", "___s": true }, { "comment": "/**\r\n * Returns a number between 0 and 1 representing the progress of this Timeline.\r\n *\r\n * A value of 0 means the Timeline has just started, 0.5 means it's half way through,\r\n * and 1 means it's complete.\r\n *\r\n * If the Timeline has no events, or all events have been removed, this will return 1.\r\n *\r\n * If the Timeline is paused, this will return the progress value at the time it was paused.\r\n *\r\n * Note that the value returned is based on the number of events that have been completed,\r\n * not the 'duration' of the events (as this is unknown to the Timeline).\r\n *\r\n * @method Phaser.Time.Timeline#getProgress\r\n * @since 3.60.0\r\n *\r\n * @return {number} A number between 0 and 1 representing the progress of this Timeline.\r\n */", "meta": { "filename": "Timeline.js", "lineno": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Returns a number between 0 and 1 representing the progress of this Timeline.\r\rA value of 0 means the Timeline has just started, 0.5 means it's half way through,\rand 1 means it's complete.\r\rIf the Timeline has no events, or all events have been removed, this will return 1.\r\rIf the Timeline is paused, this will return the progress value at the time it was paused.\r\rNote that the value returned is based on the number of events that have been completed,\rnot the 'duration' of the events (as this is unknown to the Timeline).", "kind": "function", "name": "getProgress", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A number between 0 and 1 representing the progress of this Timeline." } ], "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#getProgress", "scope": "instance", "___id": "T000002R043580", "___s": true }, { "comment": "/**\r\n * Destroys this Timeline.\r\n *\r\n * This will remove all events from the Timeline and stop it from processing.\r\n *\r\n * This method is called automatically when the Scene shuts down, but you may\r\n * also call it directly should you need to destroy the Timeline earlier.\r\n *\r\n * @method Phaser.Time.Timeline#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Timeline.js", "lineno": 589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Destroys this Timeline.\r\rThis will remove all events from the Timeline and stop it from processing.\r\rThis method is called automatically when the Scene shuts down, but you may\ralso call it directly should you need to destroy the Timeline earlier.", "kind": "function", "name": "destroy", "since": "3.60.0", "memberof": "Phaser.Time.Timeline", "longname": "Phaser.Time.Timeline#destroy", "scope": "instance", "___id": "T000002R043583", "___s": true }, { "comment": "/**\r\n * A Timeline is a way to schedule events to happen at specific times in the future.\r\n *\r\n * You can think of it as an event sequencer for your game, allowing you to schedule the\r\n * running of callbacks, events and other actions at specific times in the future.\r\n *\r\n * A Timeline is a Scene level system, meaning you can have as many Timelines as you like, each\r\n * belonging to a different Scene. You can also have multiple Timelines running at the same time.\r\n *\r\n * If the Scene is paused, the Timeline will also pause. If the Scene is destroyed, the Timeline\r\n * will be automatically destroyed. However, you can control the Timeline directly, pausing,\r\n * resuming and stopping it at any time.\r\n *\r\n * Create an instance of a Timeline via the Game Object Factory:\r\n *\r\n * ```js\r\n * const timeline = this.add.timeline();\r\n * ```\r\n *\r\n * The Timeline always starts paused. You must call `play` on it to start it running.\r\n *\r\n * You can also pass in a configuration object on creation, or an array of them:\r\n *\r\n * ```js\r\n * const timeline = this.add.timeline({\r\n * at: 1000,\r\n * run: () => {\r\n * this.add.sprite(400, 300, 'logo');\r\n * }\r\n * });\r\n *\r\n * timeline.play();\r\n * ```\r\n *\r\n * In this example we sequence a few different events:\r\n *\r\n * ```js\r\n * const timeline = this.add.timeline([\r\n * {\r\n * at: 1000,\r\n * run: () => { this.logo = this.add.sprite(400, 300, 'logo'); },\r\n * sound: 'TitleMusic'\r\n * },\r\n * {\r\n * at: 2500,\r\n * tween: {\r\n * targets: this.logo,\r\n * y: 600,\r\n * yoyo: true\r\n * },\r\n * sound: 'Explode'\r\n * },\r\n * {\r\n * at: 8000,\r\n * event: 'HURRY_PLAYER',\r\n * target: this.background,\r\n * set: {\r\n * tint: 0xff0000\r\n * }\r\n * }\r\n * ]);\r\n *\r\n * timeline.play();\r\n * ```\r\n *\r\n * There are lots of options available to you via the configuration object. See the\r\n * {@link Phaser.Types.Time.TimelineEventConfig} typedef for more details.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#timeline\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Time.TimelineEventConfig|Phaser.Types.Time.TimelineEventConfig[]} config - The configuration object for this Timeline Event, or an array of them.\r\n *\r\n * @return {Phaser.Time.Timeline} The Timeline that was created.\r\n */", "meta": { "filename": "Timeline.js", "lineno": 615, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "A Timeline is a way to schedule events to happen at specific times in the future.\r\rYou can think of it as an event sequencer for your game, allowing you to schedule the\rrunning of callbacks, events and other actions at specific times in the future.\r\rA Timeline is a Scene level system, meaning you can have as many Timelines as you like, each\rbelonging to a different Scene. You can also have multiple Timelines running at the same time.\r\rIf the Scene is paused, the Timeline will also pause. If the Scene is destroyed, the Timeline\rwill be automatically destroyed. However, you can control the Timeline directly, pausing,\rresuming and stopping it at any time.\r\rCreate an instance of a Timeline via the Game Object Factory:\r\r```js\rconst timeline = this.add.timeline();\r```\r\rThe Timeline always starts paused. You must call `play` on it to start it running.\r\rYou can also pass in a configuration object on creation, or an array of them:\r\r```js\rconst timeline = this.add.timeline({\r at: 1000,\r run: () => {\r this.add.sprite(400, 300, 'logo');\r }\r});\r\rtimeline.play();\r```\r\rIn this example we sequence a few different events:\r\r```js\rconst timeline = this.add.timeline([\r {\r at: 1000,\r run: () => { this.logo = this.add.sprite(400, 300, 'logo'); },\r sound: 'TitleMusic'\r },\r {\r at: 2500,\r tween: {\r targets: this.logo,\r y: 600,\r yoyo: true\r },\r sound: 'Explode'\r },\r {\r at: 8000,\r event: 'HURRY_PLAYER',\r target: this.background,\r set: {\r tint: 0xff0000\r }\r }\r]);\r\rtimeline.play();\r```\r\rThere are lots of options available to you via the configuration object. See the\r{@link Phaser.Types.Time.TimelineEventConfig} typedef for more details.", "kind": "function", "name": "timeline", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.Time.TimelineEventConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Time.TimelineEventConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Time.TimelineEventConfig", "type": "NameExpression" } ] } ] } }, "description": "The configuration object for this Timeline Event, or an array of them.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Time.Timeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Time.Timeline" } }, "description": "The Timeline that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#timeline", "scope": "instance", "___id": "T000002R043589", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Timer Event represents a delayed function call. It's managed by a Scene's {@link Clock} and will call its function after a set amount of time has passed. The Timer Event can optionally repeat - i.e. call its function multiple times before finishing, or loop indefinitely.\r\n *\r\n * Because it's managed by a Clock, a Timer Event is based on game time, will be affected by its Clock's time scale, and will pause if its Clock pauses.\r\n *\r\n * @class TimerEvent\r\n * @memberof Phaser.Time\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Time.TimerEventConfig} config - The configuration for the Timer Event, including its delay and callback.\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "classdesc": "A Timer Event represents a delayed function call. It's managed by a Scene's {@link Clock} and will call its function after a set amount of time has passed. The Timer Event can optionally repeat - i.e. call its function multiple times before finishing, or loop indefinitely.\r\rBecause it's managed by a Clock, a Timer Event is based on game time, will be affected by its Clock's time scale, and will pause if its Clock pauses.", "kind": "class", "name": "TimerEvent", "memberof": "Phaser.Time", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Time.TimerEventConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Time.TimerEventConfig" } }, "description": "The configuration for the Timer Event, including its delay and callback.", "name": "config" } ], "scope": "static", "longname": "Phaser.Time.TimerEvent", "___id": "T000002R043593", "___s": true }, { "comment": "/**\r\n * The delay in ms at which this TimerEvent fires.\r\n *\r\n * @name Phaser.Time.TimerEvent#delay\r\n * @type {number}\r\n * @default 0\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "The delay in ms at which this TimerEvent fires.", "name": "delay", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#delay", "scope": "instance", "kind": "member", "___id": "T000002R043596", "___s": true }, { "comment": "/**\r\n * The total number of times this TimerEvent will repeat before finishing.\r\n *\r\n * @name Phaser.Time.TimerEvent#repeat\r\n * @type {number}\r\n * @default 0\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 40, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "The total number of times this TimerEvent will repeat before finishing.", "name": "repeat", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#repeat", "scope": "instance", "kind": "member", "___id": "T000002R043598", "___s": true }, { "comment": "/**\r\n * If repeating this contains the current repeat count.\r\n *\r\n * @name Phaser.Time.TimerEvent#repeatCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 51, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "If repeating this contains the current repeat count.", "name": "repeatCount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#repeatCount", "scope": "instance", "kind": "member", "___id": "T000002R043600", "___s": true }, { "comment": "/**\r\n * True if this TimerEvent loops, otherwise false.\r\n *\r\n * @name Phaser.Time.TimerEvent#loop\r\n * @type {boolean}\r\n * @default false\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 61, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "True if this TimerEvent loops, otherwise false.", "name": "loop", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#loop", "scope": "instance", "kind": "member", "___id": "T000002R043602", "___s": true }, { "comment": "/**\r\n * The callback that will be called when the TimerEvent occurs.\r\n *\r\n * @name Phaser.Time.TimerEvent#callback\r\n * @type {function}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "The callback that will be called when the TimerEvent occurs.", "name": "callback", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.0.0", "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#callback", "scope": "instance", "kind": "member", "___id": "T000002R043604", "___s": true }, { "comment": "/**\r\n * The scope in which the callback will be called.\r\n *\r\n * @name Phaser.Time.TimerEvent#callbackScope\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 81, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "The scope in which the callback will be called.", "name": "callbackScope", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#callbackScope", "scope": "instance", "kind": "member", "___id": "T000002R043606", "___s": true }, { "comment": "/**\r\n * Additional arguments to be passed to the callback.\r\n *\r\n * @name Phaser.Time.TimerEvent#args\r\n * @type {array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 90, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Additional arguments to be passed to the callback.", "name": "args", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.0.0", "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#args", "scope": "instance", "kind": "member", "___id": "T000002R043608", "___s": true }, { "comment": "/**\r\n * Scale the time causing this TimerEvent to update.\r\n *\r\n * @name Phaser.Time.TimerEvent#timeScale\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Scale the time causing this TimerEvent to update.", "name": "timeScale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#timeScale", "scope": "instance", "kind": "member", "___id": "T000002R043610", "___s": true }, { "comment": "/**\r\n * Start this many MS into the elapsed (useful if you want a long duration with repeat, but for the first loop to fire quickly)\r\n *\r\n * @name Phaser.Time.TimerEvent#startAt\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 109, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Start this many MS into the elapsed (useful if you want a long duration with repeat, but for the first loop to fire quickly)", "name": "startAt", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#startAt", "scope": "instance", "kind": "member", "___id": "T000002R043612", "___s": true }, { "comment": "/**\r\n * The time in milliseconds which has elapsed since the Timer Event's creation.\r\n *\r\n * This value is local for the Timer Event and is relative to its Clock. As such, it's influenced by the Clock's time scale and paused state, the Timer Event's initial {@link #startAt} property, and the Timer Event's {@link #timeScale} and {@link #paused} state.\r\n *\r\n * @name Phaser.Time.TimerEvent#elapsed\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 119, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "The time in milliseconds which has elapsed since the Timer Event's creation.\r\rThis value is local for the Timer Event and is relative to its Clock. As such, it's influenced by the Clock's time scale and paused state, the Timer Event's initial {@link #startAt} property, and the Timer Event's {@link #timeScale} and {@link #paused} state.", "name": "elapsed", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#elapsed", "scope": "instance", "kind": "member", "___id": "T000002R043614", "___s": true }, { "comment": "/**\r\n * Whether or not this timer is paused.\r\n *\r\n * @name Phaser.Time.TimerEvent#paused\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Whether or not this timer is paused.", "name": "paused", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#paused", "scope": "instance", "kind": "member", "___id": "T000002R043616", "___s": true }, { "comment": "/**\r\n * Whether the Timer Event's function has been called.\r\n *\r\n * When the Timer Event fires, this property will be set to `true` before the callback function is invoked and will be reset immediately afterward if the Timer Event should repeat. The value of this property does not directly influence whether the Timer Event will be removed from its Clock, but can prevent it from firing.\r\n *\r\n * @name Phaser.Time.TimerEvent#hasDispatched\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Whether the Timer Event's function has been called.\r\rWhen the Timer Event fires, this property will be set to `true` before the callback function is invoked and will be reset immediately afterward if the Timer Event should repeat. The value of this property does not directly influence whether the Timer Event will be removed from its Clock, but can prevent it from firing.", "name": "hasDispatched", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#hasDispatched", "scope": "instance", "kind": "member", "___id": "T000002R043618", "___s": true }, { "comment": "/**\r\n * Completely reinitializes the Timer Event, regardless of its current state, according to a configuration object.\r\n *\r\n * @method Phaser.Time.TimerEvent#reset\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Time.TimerEventConfig} config - The new state for the Timer Event.\r\n *\r\n * @return {Phaser.Time.TimerEvent} This TimerEvent object.\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 156, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Completely reinitializes the Timer Event, regardless of its current state, according to a configuration object.", "kind": "function", "name": "reset", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Time.TimerEventConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Time.TimerEventConfig" } }, "description": "The new state for the Timer Event.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Time.TimerEvent" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Time.TimerEvent" } }, "description": "This TimerEvent object." } ], "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#reset", "scope": "instance", "___id": "T000002R043620", "___s": true }, { "comment": "/**\r\n * Gets the progress of the current iteration, not factoring in repeats.\r\n *\r\n * @method Phaser.Time.TimerEvent#getProgress\r\n * @since 3.0.0\r\n *\r\n * @return {number} A number between 0 and 1 representing the current progress.\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 199, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Gets the progress of the current iteration, not factoring in repeats.", "kind": "function", "name": "getProgress", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A number between 0 and 1 representing the current progress." } ], "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#getProgress", "scope": "instance", "___id": "T000002R043634", "___s": true }, { "comment": "/**\r\n * Gets the progress of the timer overall, factoring in repeats.\r\n *\r\n * @method Phaser.Time.TimerEvent#getOverallProgress\r\n * @since 3.0.0\r\n *\r\n * @return {number} The overall progress of the Timer Event, between 0 and 1.\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Gets the progress of the timer overall, factoring in repeats.", "kind": "function", "name": "getOverallProgress", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The overall progress of the Timer Event, between 0 and 1." } ], "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#getOverallProgress", "scope": "instance", "___id": "T000002R043636", "___s": true }, { "comment": "/**\r\n * Returns the number of times this Timer Event will repeat before finishing.\r\n *\r\n * This should not be confused with the number of times the Timer Event will fire before finishing. A return value of 0 doesn't indicate that the Timer Event has finished running - it indicates that it will not repeat after the next time it fires.\r\n *\r\n * @method Phaser.Time.TimerEvent#getRepeatCount\r\n * @since 3.0.0\r\n *\r\n * @return {number} How many times the Timer Event will repeat.\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 235, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Returns the number of times this Timer Event will repeat before finishing.\r\rThis should not be confused with the number of times the Timer Event will fire before finishing. A return value of 0 doesn't indicate that the Timer Event has finished running - it indicates that it will not repeat after the next time it fires.", "kind": "function", "name": "getRepeatCount", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many times the Timer Event will repeat." } ], "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#getRepeatCount", "scope": "instance", "___id": "T000002R043640", "___s": true }, { "comment": "/**\r\n * Returns the local elapsed time for the current iteration of the Timer Event.\r\n *\r\n * @method Phaser.Time.TimerEvent#getElapsed\r\n * @since 3.0.0\r\n *\r\n * @return {number} The local elapsed time in milliseconds.\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 250, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Returns the local elapsed time for the current iteration of the Timer Event.", "kind": "function", "name": "getElapsed", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The local elapsed time in milliseconds." } ], "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#getElapsed", "scope": "instance", "___id": "T000002R043642", "___s": true }, { "comment": "/**\r\n * Returns the local elapsed time for the current iteration of the Timer Event in seconds.\r\n *\r\n * @method Phaser.Time.TimerEvent#getElapsedSeconds\r\n * @since 3.0.0\r\n *\r\n * @return {number} The local elapsed time in seconds.\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 263, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Returns the local elapsed time for the current iteration of the Timer Event in seconds.", "kind": "function", "name": "getElapsedSeconds", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The local elapsed time in seconds." } ], "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#getElapsedSeconds", "scope": "instance", "___id": "T000002R043644", "___s": true }, { "comment": "/**\r\n * Returns the time interval until the next iteration of the Timer Event.\r\n *\r\n * @method Phaser.Time.TimerEvent#getRemaining\r\n * @since 3.50.0\r\n *\r\n * @return {number} The time interval in milliseconds.\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Returns the time interval until the next iteration of the Timer Event.", "kind": "function", "name": "getRemaining", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time interval in milliseconds." } ], "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#getRemaining", "scope": "instance", "___id": "T000002R043646", "___s": true }, { "comment": "/**\r\n * Returns the time interval until the next iteration of the Timer Event in seconds.\r\n *\r\n * @method Phaser.Time.TimerEvent#getRemainingSeconds\r\n * @since 3.50.0\r\n *\r\n * @return {number} The time interval in seconds.\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Returns the time interval until the next iteration of the Timer Event in seconds.", "kind": "function", "name": "getRemainingSeconds", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time interval in seconds." } ], "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#getRemainingSeconds", "scope": "instance", "___id": "T000002R043648", "___s": true }, { "comment": "/**\r\n * Returns the time interval until the last iteration of the Timer Event.\r\n *\r\n * @method Phaser.Time.TimerEvent#getOverallRemaining\r\n * @since 3.50.0\r\n *\r\n * @return {number} The time interval in milliseconds.\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 302, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Returns the time interval until the last iteration of the Timer Event.", "kind": "function", "name": "getOverallRemaining", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time interval in milliseconds." } ], "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#getOverallRemaining", "scope": "instance", "___id": "T000002R043650", "___s": true }, { "comment": "/**\r\n * Returns the time interval until the last iteration of the Timer Event in seconds.\r\n *\r\n * @method Phaser.Time.TimerEvent#getOverallRemainingSeconds\r\n * @since 3.50.0\r\n *\r\n * @return {number} The time interval in seconds.\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 315, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Returns the time interval until the last iteration of the Timer Event in seconds.", "kind": "function", "name": "getOverallRemainingSeconds", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time interval in seconds." } ], "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#getOverallRemainingSeconds", "scope": "instance", "___id": "T000002R043652", "___s": true }, { "comment": "/**\r\n * Forces the Timer Event to immediately expire, thus scheduling its removal in the next frame.\r\n *\r\n * @method Phaser.Time.TimerEvent#remove\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [dispatchCallback=false] - If `true`, the function of the Timer Event will be called before its removal.\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 328, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Forces the Timer Event to immediately expire, thus scheduling its removal in the next frame.", "kind": "function", "name": "remove", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true`, the function of the Timer Event will be called before its removal.", "name": "dispatchCallback" } ], "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#remove", "scope": "instance", "___id": "T000002R043654", "___s": true }, { "comment": "/**\r\n * Destroys all object references in the Timer Event, i.e. its callback, scope, and arguments.\r\n *\r\n * Normally, this method is only called by the Clock when it shuts down. As such, it doesn't stop the Timer Event. If called manually, the Timer Event will still be updated by the Clock, but it won't do anything when it fires.\r\n *\r\n * @method Phaser.Time.TimerEvent#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimerEvent.js", "lineno": 347, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\time", "code": {} }, "description": "Destroys all object references in the Timer Event, i.e. its callback, scope, and arguments.\r\rNormally, this method is only called by the Clock when it shuts down. As such, it doesn't stop the Timer Event. If called manually, the Timer Event will still be updated by the Clock, but it won't do anything when it fires.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Time.TimerEvent", "longname": "Phaser.Time.TimerEvent#destroy", "scope": "instance", "___id": "T000002R043660", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Time\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\time\\typedefs", "code": {} }, "kind": "namespace", "name": "Time", "memberof": "Phaser.Types", "longname": "Phaser.Types.Time", "scope": "static", "___id": "T000002R043666", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Time.TimelineEvent\r\n * @since 3.60.0\r\n *\r\n * @property {boolean} complete - Has this event completed yet?\r\n * @property {boolean} once - Is this a once only event?\r\n * @property {number} time - The time (in elapsed ms) at which this event will fire.\r\n * @property {function} [run=null] - User-land callback which will be called when the Event fires if set.\r\n * @property {Phaser.Types.Tweens.TweenBuilderConfig|Phaser.Types.Tweens.TweenChainBuilderConfig|Phaser.Tweens.Tween|Phaser.Tweens.TweenChain} [tween=null] - Tween configuration object which will be used to create a Tween when the Event fires if set.\r\n * @property {object} [set=null] - Object containing properties to set on the `target` when the Event fires if set.\r\n * @property {string|object} [sound=null] - Sound configuration object which will be used to create a Sound when the Event fires if set.\r\n * @property {*} [target] - The scope (`this` object) with which to invoke the run `callback`.\r\n * @property {string} [event] - Optional event name to emit when the Event fires.\r\n */", "meta": { "filename": "TimelineEvent.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\time\\typedefs", "code": {} }, "kind": "typedef", "name": "TimelineEvent", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Has this event completed yet?", "name": "complete" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this a once only event?", "name": "once" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time (in elapsed ms) at which this event will fire.", "name": "time" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "defaultvalue": null, "description": "User-land callback which will be called when the Event fires if set.", "name": "run" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenBuilderConfig", "Phaser.Types.Tweens.TweenChainBuilderConfig", "Phaser.Tweens.Tween", "Phaser.Tweens.TweenChain" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenBuilderConfig" }, { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenChainBuilderConfig" }, { "type": "NameExpression", "name": "Phaser.Tweens.Tween" }, { "type": "NameExpression", "name": "Phaser.Tweens.TweenChain" } ] } }, "optional": true, "defaultvalue": null, "description": "Tween configuration object which will be used to create a Tween when the Event fires if set.", "name": "tween" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "defaultvalue": null, "description": "Object containing properties to set on the `target` when the Event fires if set.", "name": "set" }, { "type": { "names": [ "string", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "defaultvalue": null, "description": "Sound configuration object which will be used to create a Sound when the Event fires if set.", "name": "sound" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The scope (`this` object) with which to invoke the run `callback`.", "name": "target" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional event name to emit when the Event fires.", "name": "event" } ], "memberof": "Phaser.Types.Time", "longname": "Phaser.Types.Time.TimelineEvent", "scope": "static", "___id": "T000002R043667", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Time.TimelineEventConfig\r\n * @since 3.60.0\r\n *\r\n * @property {number} [at=0] - The time (in ms) at which the Event will fire. The Timeline starts at 0.\r\n * @property {number} [in] - If the Timeline is already running, this is the time (in ms) at which the Event will fire based on its current elapsed value. If set, overrides the `at` property.\r\n * @property {number} [from] - Fire this event 'from' milliseconds after the previous event in the Timeline. If set it overrides the `at` and `in` properties.\r\n * @property {function} [run] - A function which will be called when the Event fires.\r\n * @property {string} [event] - Optional string-based event name to emit when the Event fires. The event is emitted from the Timeline instance.\r\n * @property {*} [target] - The scope (`this` object) with which to invoke the run `callback`, if set.\r\n * @property {boolean} [once=false] - If set, the Event will be removed from the Timeline when it fires.\r\n * @property {boolean} [stop=false] - If set, the Timeline will stop and enter a complete state when this Event fires, even if there are other events after it.\r\n * @property {Phaser.Types.Tweens.TweenBuilderConfig|Phaser.Types.Tweens.TweenChainBuilderConfig|Phaser.Tweens.Tween|Phaser.Tweens.TweenChain} [tween] - A Tween or TweenChain configuration object or instance. If set, the Event will create this Tween when it fires.\r\n * @property {object} [set] - A key-value object of properties to set on the `target` when the Event fires. Ignored if no `target` is given.\r\n * @property {string|object} [sound] - A key from the Sound Manager to play, or a config object for a sound to play when the Event fires. If a config object it must provide two properties: `key` and `config`. The `key` is the key of the sound to play, and the `config` is the config is a Phaser.Types.Sound.SoundConfig object.\r\n */", "meta": { "filename": "TimelineEventConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\time\\typedefs", "code": {} }, "kind": "typedef", "name": "TimelineEventConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The time (in ms) at which the Event will fire. The Timeline starts at 0.", "name": "at" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If the Timeline is already running, this is the time (in ms) at which the Event will fire based on its current elapsed value. If set, overrides the `at` property.", "name": "in" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Fire this event 'from' milliseconds after the previous event in the Timeline. If set it overrides the `at` and `in` properties.", "name": "from" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "A function which will be called when the Event fires.", "name": "run" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional string-based event name to emit when the Event fires. The event is emitted from the Timeline instance.", "name": "event" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The scope (`this` object) with which to invoke the run `callback`, if set.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If set, the Event will be removed from the Timeline when it fires.", "name": "once" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If set, the Timeline will stop and enter a complete state when this Event fires, even if there are other events after it.", "name": "stop" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenBuilderConfig", "Phaser.Types.Tweens.TweenChainBuilderConfig", "Phaser.Tweens.Tween", "Phaser.Tweens.TweenChain" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenBuilderConfig" }, { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenChainBuilderConfig" }, { "type": "NameExpression", "name": "Phaser.Tweens.Tween" }, { "type": "NameExpression", "name": "Phaser.Tweens.TweenChain" } ] } }, "optional": true, "description": "A Tween or TweenChain configuration object or instance. If set, the Event will create this Tween when it fires.", "name": "tween" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "A key-value object of properties to set on the `target` when the Event fires. Ignored if no `target` is given.", "name": "set" }, { "type": { "names": [ "string", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "A key from the Sound Manager to play, or a config object for a sound to play when the Event fires. If a config object it must provide two properties: `key` and `config`. The `key` is the key of the sound to play, and the `config` is the config is a Phaser.Types.Sound.SoundConfig object.", "name": "sound" } ], "memberof": "Phaser.Types.Time", "longname": "Phaser.Types.Time.TimelineEventConfig", "scope": "static", "___id": "T000002R043668", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Time.TimerEventConfig\r\n * @since 3.0.0\r\n *\r\n * @property {number} [delay=0] - The delay after which the Timer Event should fire, in milliseconds.\r\n * @property {number} [repeat=0] - The total number of times the Timer Event will repeat before finishing.\r\n * @property {boolean} [loop=false] - `true` if the Timer Event should repeat indefinitely.\r\n * @property {function} [callback] - The callback which will be called when the Timer Event fires.\r\n * @property {*} [callbackScope] - The scope (`this` object) with which to invoke the `callback`. The default is the Timer Event.\r\n * @property {Array.<*>} [args] - Additional arguments to be passed to the `callback`.\r\n * @property {number} [timeScale=1] - The scale of the elapsed time.\r\n * @property {number} [startAt=0] - The initial elapsed time in milliseconds. Useful if you want a long duration with repeat, but for the first loop to fire quickly.\r\n * @property {boolean} [paused=false] - `true` if the Timer Event should be paused.\r\n */", "meta": { "filename": "TimerEventConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\time\\typedefs", "code": {} }, "kind": "typedef", "name": "TimerEventConfig", "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 delay after which the Timer Event should fire, in milliseconds.", "name": "delay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The total number of times the Timer Event will repeat before finishing.", "name": "repeat" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "`true` if the Timer Event should repeat indefinitely.", "name": "loop" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "The callback which will be called when the Timer Event fires.", "name": "callback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The scope (`this` object) with which to invoke the `callback`. The default is the Timer Event.", "name": "callbackScope" }, { "type": { "names": [ "Array.<*>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "AllLiteral" } ] } }, "optional": true, "description": "Additional arguments to be passed to the `callback`.", "name": "args" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The scale of the elapsed time.", "name": "timeScale" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The initial elapsed time in milliseconds. Useful if you want a long duration with repeat, but for the first loop to fire quickly.", "name": "startAt" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "`true` if the Timer Event should be paused.", "name": "paused" } ], "memberof": "Phaser.Types.Time", "longname": "Phaser.Types.Time.TimerEventConfig", "scope": "static", "___id": "T000002R043669", "___s": true }, { "comment": "/**\r\n * Retrieves the value of the given key from an object.\r\n *\r\n * @function Phaser.Tweens.Builders.GetBoolean\r\n * @since 3.0.0\r\n *\r\n * @param {object} source - The object to retrieve the value from.\r\n * @param {string} key - The key to look for in the `source` object.\r\n * @param {boolean} defaultValue - The default value to return if the `key` doesn't exist or if no `source` object is provided.\r\n *\r\n * @return {boolean} The retrieved value.\r\n */", "meta": { "filename": "GetBoolean.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\builders", "code": {} }, "description": "Retrieves the value of the given key from an object.", "kind": "function", "name": "GetBoolean", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The object to retrieve the value from.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to look for in the `source` object.", "name": "key" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The default value to return if the `key` doesn't exist or if no `source` object is provided.", "name": "defaultValue" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The retrieved value." } ], "memberof": "Phaser.Tweens.Builders", "longname": "Phaser.Tweens.Builders.GetBoolean", "scope": "static", "___id": "T000002R043670", "___s": true }, { "comment": "/**\r\n * This internal function is used to return the correct ease function for a Tween.\r\n *\r\n * It can take a variety of input, including an EaseMap based string, or a custom function.\r\n *\r\n * @function Phaser.Tweens.Builders.GetEaseFunction\r\n * @since 3.0.0\r\n *\r\n * @param {(string|function)} ease - The ease to find. This can be either a string from the EaseMap, or a custom function.\r\n * @param {number[]} [easeParams] - An optional array of ease parameters to go with the ease.\r\n *\r\n * @return {function} The ease function.\r\n */", "meta": { "filename": "GetEaseFunction.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\builders", "code": {} }, "description": "This internal function is used to return the correct ease function for a Tween.\r\rIt can take a variety of input, including an EaseMap based string, or a custom function.", "kind": "function", "name": "GetEaseFunction", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "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" } ], "returns": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The ease function." } ], "memberof": "Phaser.Tweens.Builders", "longname": "Phaser.Tweens.Builders.GetEaseFunction", "scope": "static", "___id": "T000002R043675", "___s": true }, { "comment": "/**\r\n * This internal function is used to return the correct interpolation function for a Tween.\r\n *\r\n * It can take a variety of input, including a string, or a custom function.\r\n *\r\n * @function Phaser.Tweens.Builders.GetInterpolationFunction\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|null)} interpolation - The interpolation function to find. This can be either a string, or a custom function, or null.\r\n *\r\n * @return {?function} The interpolation function to use, or `null`.\r\n */", "meta": { "filename": "GetInterpolationFunction.js", "lineno": 18, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\builders", "code": {} }, "description": "This internal function is used to return the correct interpolation function for a Tween.\r\rIt can take a variety of input, including a string, or a custom function.", "kind": "function", "name": "GetInterpolationFunction", "since": "3.60.0", "params": [ { "type": { "names": [ "string", "function", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NullLiteral" } ] } }, "description": "The interpolation function to find. This can be either a string, or a custom function, or null.", "name": "interpolation" } ], "returns": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [], "nullable": true } }, "nullable": true, "description": "The interpolation function to use, or `null`." } ], "memberof": "Phaser.Tweens.Builders", "longname": "Phaser.Tweens.Builders.GetInterpolationFunction", "scope": "static", "___id": "T000002R043699", "___s": true }, { "comment": "/**\r\n * Internal function used by the Tween Builder to create a function that will return\r\n * the given value from the source.\r\n *\r\n * @function Phaser.Tweens.Builders.GetNewValue\r\n * @since 3.0.0\r\n *\r\n * @param {any} source - The source object to get the value from.\r\n * @param {string} key - The property to get from the source.\r\n * @param {any} defaultValue - A default value to return should the source not have the property set.\r\n *\r\n * @return {function} A function which, when called, will return the property value from the source.\r\n */", "meta": { "filename": "GetNewValue.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\builders", "code": {} }, "description": "Internal function used by the Tween Builder to create a function that will return\rthe given value from the source.", "kind": "function", "name": "GetNewValue", "since": "3.0.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The source object to get the value from.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property to get from the source.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "A default value to return should the source not have the property set.", "name": "defaultValue" } ], "returns": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "A function which, when called, will return the property value from the source." } ], "memberof": "Phaser.Tweens.Builders", "longname": "Phaser.Tweens.Builders.GetNewValue", "scope": "static", "___id": "T000002R043705", "___s": true }, { "comment": "/**\r\n * Internal function used by the Tween Builder to return an array of properties\r\n * that the Tween will be operating on. It takes a tween configuration object\r\n * and then checks that none of the `props` entries start with an underscore, or that\r\n * none of the direct properties are on the Reserved list.\r\n *\r\n * @function Phaser.Tweens.Builders.GetProps\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Tweens.TweenBuilderConfig} config - The configuration object of the Tween to get the properties from.\r\n *\r\n * @return {string[]} An array of all the properties the tween will operate on.\r\n */", "meta": { "filename": "GetProps.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\builders", "code": {} }, "description": "Internal function used by the Tween Builder to return an array of properties\rthat the Tween will be operating on. It takes a tween configuration object\rand then checks that none of the `props` entries start with an underscore, or that\rnone of the direct properties are on the Reserved list.", "kind": "function", "name": "GetProps", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Tweens.TweenBuilderConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenBuilderConfig" } }, "description": "The configuration object of the Tween to get the properties from.", "name": "config" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "An array of all the properties the tween will operate on." } ], "memberof": "Phaser.Tweens.Builders", "longname": "Phaser.Tweens.Builders.GetProps", "scope": "static", "___id": "T000002R043715", "___s": true }, { "comment": "/**\r\n * Extracts an array of targets from a Tween configuration object.\r\n *\r\n * The targets will be looked for in a `targets` property. If it's a function, its return value will be used as the result.\r\n *\r\n * @function Phaser.Tweens.Builders.GetTargets\r\n * @since 3.0.0\r\n *\r\n * @param {object} config - The configuration object to use.\r\n *\r\n * @return {array} An array of targets (may contain only one element), or `null` if no targets were specified.\r\n */", "meta": { "filename": "GetTargets.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\builders", "code": {} }, "description": "Extracts an array of targets from a Tween configuration object.\r\rThe targets will be looked for in a `targets` property. If it's a function, its return value will be used as the result.", "kind": "function", "name": "GetTargets", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The configuration object to use.", "name": "config" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "An array of targets (may contain only one element), or `null` if no targets were specified." } ], "memberof": "Phaser.Tweens.Builders", "longname": "Phaser.Tweens.Builders.GetTargets", "scope": "static", "___id": "T000002R043725", "___s": true }, { "comment": "/**\r\n * Returns `getActive`, `getStart` and `getEnd` functions for a TweenData based on a target property and end value.\r\n *\r\n * `getActive` if not null, is invoked _immediately_ as soon as the TweenData is running, and is set on the target property.\r\n * `getEnd` is invoked once any start delays have expired and returns what the value should tween to.\r\n * `getStart` is invoked when the tween reaches the end and needs to either repeat or yoyo, it returns the value to go back to.\r\n *\r\n * If the end value is a number, it will be treated as an absolute value and the property will be tweened to it.\r\n * A string can be provided to specify a relative end value which consists of an operation\r\n * (`+=` to add to the current value, `-=` to subtract from the current value, `*=` to multiply the current\r\n * value, or `/=` to divide the current value) followed by its operand.\r\n *\r\n * A function can be provided to allow greater control over the end value; it will receive the target\r\n * object being tweened, the name of the property being tweened, and the current value of the property\r\n * as its arguments and must return a value.\r\n *\r\n * If both the starting and the ending values need to be controlled, an object with `getStart` and `getEnd`\r\n * callbacks, which will receive the same arguments, can be provided instead. If an object with a `value`\r\n * property is provided, the property will be used as the effective value under the same rules described here.\r\n *\r\n * @function Phaser.Tweens.Builders.GetValueOp\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The name of the property to modify.\r\n * @param {*} propertyValue - The ending value of the property, as described above.\r\n *\r\n * @return {function} An array of functions, `getActive`, `getStart` and `getEnd`, which return the starting and the ending value of the property based on the provided value.\r\n */", "meta": { "filename": "GetValueOp.js", "lineno": 42, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\builders", "code": {} }, "description": "Returns `getActive`, `getStart` and `getEnd` functions for a TweenData based on a target property and end value.\r\r`getActive` if not null, is invoked _immediately_ as soon as the TweenData is running, and is set on the target property.\r`getEnd` is invoked once any start delays have expired and returns what the value should tween to.\r`getStart` is invoked when the tween reaches the end and needs to either repeat or yoyo, it returns the value to go back to.\r\rIf the end value is a number, it will be treated as an absolute value and the property will be tweened to it.\rA string can be provided to specify a relative end value which consists of an operation\r(`+=` to add to the current value, `-=` to subtract from the current value, `*=` to multiply the current\rvalue, or `/=` to divide the current value) followed by its operand.\r\rA function can be provided to allow greater control over the end value; it will receive the target\robject being tweened, the name of the property being tweened, and the current value of the property\ras its arguments and must return a value.\r\rIf both the starting and the ending values need to be controlled, an object with `getStart` and `getEnd`\rcallbacks, which will receive the same arguments, can be provided instead. If an object with a `value`\rproperty is provided, the property will be used as the effective value under the same rules described here.", "kind": "function", "name": "GetValueOp", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property to modify.", "name": "key" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The ending value of the property, as described above.", "name": "propertyValue" } ], "returns": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "An array of functions, `getActive`, `getStart` and `getEnd`, which return the starting and the ending value of the property based on the provided value." } ], "memberof": "Phaser.Tweens.Builders", "longname": "Phaser.Tweens.Builders.GetValueOp", "scope": "static", "___id": "T000002R043737", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Tweens.Builders\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\builders", "code": {} }, "kind": "namespace", "name": "Builders", "memberof": "Phaser.Tweens", "longname": "Phaser.Tweens.Builders", "scope": "static", "___id": "T000002R043782", "___s": true }, { "comment": "/**\r\n * Creates a new Number Tween.\r\n *\r\n * @function Phaser.Tweens.Builders.NumberTweenBuilder\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Tweens.TweenManager} parent - The owner of the new Tween.\r\n * @param {Phaser.Types.Tweens.NumberTweenBuilderConfig} config - Configuration for the new Tween.\r\n * @param {Phaser.Types.Tweens.TweenConfigDefaults} defaults - Tween configuration defaults.\r\n *\r\n * @return {Phaser.Tweens.Tween} The new tween.\r\n */", "meta": { "filename": "NumberTweenBuilder.js", "lineno": 18, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\builders", "code": {} }, "description": "Creates a new Number Tween.", "kind": "function", "name": "NumberTweenBuilder", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Tweens.TweenManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.TweenManager" } }, "description": "The owner of the new Tween.", "name": "parent" }, { "type": { "names": [ "Phaser.Types.Tweens.NumberTweenBuilderConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.NumberTweenBuilderConfig" } }, "description": "Configuration for the new Tween.", "name": "config" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenConfigDefaults" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenConfigDefaults" } }, "description": "Tween configuration defaults.", "name": "defaults" } ], "returns": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The new tween." } ], "memberof": "Phaser.Tweens.Builders", "longname": "Phaser.Tweens.Builders.NumberTweenBuilder", "scope": "static", "___id": "T000002R043804", "___s": true }, { "comment": "/**\r\n * Creates a Stagger function to be used by a Tween property.\r\n *\r\n * The stagger function will allow you to stagger changes to the value of the property across all targets of the tween.\r\n *\r\n * This is only worth using if the tween has multiple targets.\r\n *\r\n * The following will stagger the delay by 100ms across all targets of the tween, causing them to scale down to 0.2\r\n * over the duration specified:\r\n *\r\n * ```javascript\r\n * this.tweens.add({\r\n * targets: [ ... ],\r\n * scale: 0.2,\r\n * ease: 'linear',\r\n * duration: 1000,\r\n * delay: this.tweens.stagger(100)\r\n * });\r\n * ```\r\n *\r\n * The following will stagger the delay by 500ms across all targets of the tween using a 10 x 6 grid, staggering\r\n * from the center out, using a cubic ease.\r\n *\r\n * ```javascript\r\n * this.tweens.add({\r\n * targets: [ ... ],\r\n * scale: 0.2,\r\n * ease: 'linear',\r\n * duration: 1000,\r\n * delay: this.tweens.stagger(500, { grid: [ 10, 6 ], from: 'center', ease: 'cubic.out' })\r\n * });\r\n * ```\r\n *\r\n * @function Phaser.Tweens.Builders.StaggerBuilder\r\n * @since 3.19.0\r\n *\r\n * @param {(number|number[])} value - The amount to stagger by, or an array containing two elements representing the min and max values to stagger between.\r\n * @param {Phaser.Types.Tweens.StaggerConfig} [config] - A Stagger Configuration object.\r\n *\r\n * @return {function} The stagger function.\r\n */", "meta": { "filename": "StaggerBuilder.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\builders", "code": {} }, "description": "Creates a Stagger function to be used by a Tween property.\r\rThe stagger function will allow you to stagger changes to the value of the property across all targets of the tween.\r\rThis is only worth using if the tween has multiple targets.\r\rThe following will stagger the delay by 100ms across all targets of the tween, causing them to scale down to 0.2\rover the duration specified:\r\r```javascript\rthis.tweens.add({\r targets: [ ... ],\r scale: 0.2,\r ease: 'linear',\r duration: 1000,\r delay: this.tweens.stagger(100)\r});\r```\r\rThe following will stagger the delay by 500ms across all targets of the tween using a 10 x 6 grid, staggering\rfrom the center out, using a cubic ease.\r\r```javascript\rthis.tweens.add({\r targets: [ ... ],\r scale: 0.2,\r ease: 'linear',\r duration: 1000,\r delay: this.tweens.stagger(500, { grid: [ 10, 6 ], from: 'center', ease: 'cubic.out' })\r});\r```", "kind": "function", "name": "StaggerBuilder", "since": "3.19.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" } ] } ] } }, "description": "The amount to stagger by, or an array containing two elements representing the min and max values to stagger between.", "name": "value" }, { "type": { "names": [ "Phaser.Types.Tweens.StaggerConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.StaggerConfig" } }, "optional": true, "description": "A Stagger Configuration object.", "name": "config" } ], "returns": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The stagger function." } ], "memberof": "Phaser.Tweens.Builders", "longname": "Phaser.Tweens.Builders.StaggerBuilder", "scope": "static", "___id": "T000002R043836", "___s": true }, { "comment": "/**\r\n * Creates a new Tween.\r\n *\r\n * @function Phaser.Tweens.Builders.TweenBuilder\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Tweens.TweenManager} parent - The owner of the new Tween.\r\n * @param {Phaser.Types.Tweens.TweenBuilderConfig|object} config - Configuration for the new Tween.\r\n * @param {Phaser.Types.Tweens.TweenConfigDefaults} defaults - Tween configuration defaults.\r\n *\r\n * @return {Phaser.Tweens.Tween} The new tween.\r\n */", "meta": { "filename": "TweenBuilder.js", "lineno": 21, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\builders", "code": {} }, "description": "Creates a new Tween.", "kind": "function", "name": "TweenBuilder", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Tweens.TweenManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.TweenManager" } }, "description": "The owner of the new Tween.", "name": "parent" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenBuilderConfig", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenBuilderConfig" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "Configuration for the new Tween.", "name": "config" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenConfigDefaults" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenConfigDefaults" } }, "description": "Tween configuration defaults.", "name": "defaults" } ], "returns": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The new tween." } ], "memberof": "Phaser.Tweens.Builders", "longname": "Phaser.Tweens.Builders.TweenBuilder", "scope": "static", "___id": "T000002R043915", "___s": true }, { "comment": "/**\r\n * Creates a new Tween Chain instance.\r\n *\r\n * @function Phaser.Tweens.Builders.TweenChainBuilder\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Tweens.TweenManager} parent - The owner of the new Tween.\r\n * @param {Phaser.Types.Tweens.TweenChainBuilderConfig|object} config - Configuration for the new Tween.\r\n *\r\n * @return {Phaser.Tweens.TweenChain} The new Tween Chain.\r\n */", "meta": { "filename": "TweenChainBuilder.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\builders", "code": {} }, "description": "Creates a new Tween Chain instance.", "kind": "function", "name": "TweenChainBuilder", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Tweens.TweenManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.TweenManager" } }, "description": "The owner of the new Tween.", "name": "parent" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenChainBuilderConfig", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenChainBuilderConfig" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "Configuration for the new Tween.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Tweens.TweenChain" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.TweenChain" } }, "description": "The new Tween Chain." } ], "memberof": "Phaser.Tweens.Builders", "longname": "Phaser.Tweens.Builders.TweenChainBuilder", "scope": "static", "___id": "T000002R043970", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Tweens.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Tweens", "longname": "Phaser.Tweens.Events", "scope": "static", "___id": "T000002R043995", "___s": true }, { "comment": "/**\r\n * The Tween Active Event.\r\n *\r\n * This event is dispatched by a Tween when it becomes active within the Tween Manager.\r\n *\r\n * An 'active' Tween is one that is now progressing, although it may not yet be updating\r\n * any target properties, due to settings such as `delay`. If you need an event for when\r\n * the Tween starts actually updating its first property, see `TWEEN_START`.\r\n *\r\n * Listen to it from a Tween instance using `Tween.on('active', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var tween = this.tweens.create({\r\n * targets: image,\r\n * x: 500,\r\n * ease: 'Power1',\r\n * duration: 3000\r\n * });\r\n * tween.on('active', listener);\r\n * this.tweens.existing(tween);\r\n * ```\r\n *\r\n * Note that this event is usually dispatched already by the time you call `this.tweens.add()`, and is\r\n * meant for use with `tweens.create()` and/or `tweens.existing()`.\r\n *\r\n * @event Phaser.Tweens.Events#TWEEN_ACTIVE\r\n * @type {string}\r\n * @since 3.19.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween instance that emitted the event.\r\n * @param {(any|any[])} targets - The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.\r\n */", "meta": { "filename": "TWEEN_ACTIVE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\events", "code": {} }, "description": "The Tween Active Event.\r\rThis event is dispatched by a Tween when it becomes active within the Tween Manager.\r\rAn 'active' Tween is one that is now progressing, although it may not yet be updating\rany target properties, due to settings such as `delay`. If you need an event for when\rthe Tween starts actually updating its first property, see `TWEEN_START`.\r\rListen to it from a Tween instance using `Tween.on('active', listener)`, i.e.:\r\r```javascript\rvar tween = this.tweens.create({\r targets: image,\r x: 500,\r ease: 'Power1',\r duration: 3000\r});\rtween.on('active', listener);\rthis.tweens.existing(tween);\r```\r\rNote that this event is usually dispatched already by the time you call `this.tweens.add()`, and is\rmeant for use with `tweens.create()` and/or `tweens.existing()`.", "kind": "event", "name": "TWEEN_ACTIVE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.19.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween instance that emitted the event.", "name": "tween" }, { "type": { "names": [ "any", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "any" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "description": "The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.", "name": "targets" } ], "memberof": "Phaser.Tweens.Events", "longname": "Phaser.Tweens.Events#event:TWEEN_ACTIVE", "scope": "instance", "___id": "T000002R044007", "___s": true }, { "comment": "/**\r\n * The Tween Complete Event.\r\n *\r\n * This event is dispatched by a Tween when it completes playback entirely, factoring in repeats and loops.\r\n *\r\n * If the Tween has been set to loop or repeat infinitely, this event will not be dispatched\r\n * unless the `Tween.stop` method is called.\r\n *\r\n * If a Tween has a `completeDelay` set, this event will fire after that delay expires.\r\n *\r\n * Listen to it from a Tween instance using `Tween.on('complete', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var tween = this.tweens.add({\r\n * targets: image,\r\n * x: 500,\r\n * ease: 'Power1',\r\n * duration: 3000\r\n * });\r\n * tween.on('complete', listener);\r\n * ```\r\n *\r\n * @event Phaser.Tweens.Events#TWEEN_COMPLETE\r\n * @type {string}\r\n * @since 3.19.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween instance that emitted the event.\r\n * @param {(any|any[])} targets - The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.\r\n */", "meta": { "filename": "TWEEN_COMPLETE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\events", "code": {} }, "description": "The Tween Complete Event.\r\rThis event is dispatched by a Tween when it completes playback entirely, factoring in repeats and loops.\r\rIf the Tween has been set to loop or repeat infinitely, this event will not be dispatched\runless the `Tween.stop` method is called.\r\rIf a Tween has a `completeDelay` set, this event will fire after that delay expires.\r\rListen to it from a Tween instance using `Tween.on('complete', listener)`, i.e.:\r\r```javascript\rvar tween = this.tweens.add({\r targets: image,\r x: 500,\r ease: 'Power1',\r duration: 3000\r});\rtween.on('complete', listener);\r```", "kind": "event", "name": "TWEEN_COMPLETE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.19.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween instance that emitted the event.", "name": "tween" }, { "type": { "names": [ "any", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "any" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "description": "The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.", "name": "targets" } ], "memberof": "Phaser.Tweens.Events", "longname": "Phaser.Tweens.Events#event:TWEEN_COMPLETE", "scope": "instance", "___id": "T000002R044009", "___s": true }, { "comment": "/**\r\n * The Tween Loop Event.\r\n *\r\n * This event is dispatched by a Tween when it loops.\r\n *\r\n * This event will only be dispatched if the Tween has a loop count set.\r\n *\r\n * If a Tween has a `loopDelay` set, this event will fire after that delay expires.\r\n *\r\n * The difference between `loop` and `repeat` is that `repeat` is a property setting,\r\n * where-as `loop` applies to the entire Tween.\r\n *\r\n * Listen to it from a Tween instance using `Tween.on('loop', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var tween = this.tweens.add({\r\n * targets: image,\r\n * x: 500,\r\n * ease: 'Power1',\r\n * duration: 3000,\r\n * loop: 6\r\n * });\r\n * tween.on('loop', listener);\r\n * ```\r\n *\r\n * @event Phaser.Tweens.Events#TWEEN_LOOP\r\n * @type {string}\r\n * @since 3.19.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween instance that emitted the event.\r\n * @param {(any|any[])} targets - The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.\r\n */", "meta": { "filename": "TWEEN_LOOP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\events", "code": {} }, "description": "The Tween Loop Event.\r\rThis event is dispatched by a Tween when it loops.\r\rThis event will only be dispatched if the Tween has a loop count set.\r\rIf a Tween has a `loopDelay` set, this event will fire after that delay expires.\r\rThe difference between `loop` and `repeat` is that `repeat` is a property setting,\rwhere-as `loop` applies to the entire Tween.\r\rListen to it from a Tween instance using `Tween.on('loop', listener)`, i.e.:\r\r```javascript\rvar tween = this.tweens.add({\r targets: image,\r x: 500,\r ease: 'Power1',\r duration: 3000,\r loop: 6\r});\rtween.on('loop', listener);\r```", "kind": "event", "name": "TWEEN_LOOP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.19.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween instance that emitted the event.", "name": "tween" }, { "type": { "names": [ "any", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "any" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "description": "The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.", "name": "targets" } ], "memberof": "Phaser.Tweens.Events", "longname": "Phaser.Tweens.Events#event:TWEEN_LOOP", "scope": "instance", "___id": "T000002R044011", "___s": true }, { "comment": "/**\r\n * The Tween Pause Event.\r\n *\r\n * This event is dispatched by a Tween when it is paused.\r\n *\r\n * Listen to it from a Tween instance using `Tween.on('pause', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var tween = this.tweens.add({\r\n * targets: image,\r\n * ease: 'Power1',\r\n * duration: 3000,\r\n * x: 600\r\n * });\r\n * tween.on('pause', listener);\r\n * // At some point later ...\r\n * tween.pause();\r\n * ```\r\n *\r\n * @event Phaser.Tweens.Events#TWEEN_PAUSE\r\n * @type {string}\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween instance that emitted the event.\r\n */", "meta": { "filename": "TWEEN_PAUSE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\events", "code": {} }, "description": "The Tween Pause Event.\r\rThis event is dispatched by a Tween when it is paused.\r\rListen to it from a Tween instance using `Tween.on('pause', listener)`, i.e.:\r\r```javascript\rvar tween = this.tweens.add({\r targets: image,\r ease: 'Power1',\r duration: 3000,\r x: 600\r});\rtween.on('pause', listener);\r// At some point later ...\rtween.pause();\r```", "kind": "event", "name": "TWEEN_PAUSE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween instance that emitted the event.", "name": "tween" } ], "memberof": "Phaser.Tweens.Events", "longname": "Phaser.Tweens.Events#event:TWEEN_PAUSE", "scope": "instance", "___id": "T000002R044013", "___s": true }, { "comment": "/**\r\n * The Tween Repeat Event.\r\n *\r\n * This event is dispatched by a Tween when one of the properties it is tweening repeats.\r\n *\r\n * This event will only be dispatched if the Tween has a property with a repeat count set.\r\n *\r\n * If a Tween has a `repeatDelay` set, this event will fire after that delay expires.\r\n *\r\n * The difference between `loop` and `repeat` is that `repeat` is a property setting,\r\n * where-as `loop` applies to the entire Tween.\r\n *\r\n * Listen to it from a Tween instance using `Tween.on('repeat', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var tween = this.tweens.add({\r\n * targets: image,\r\n * x: 500,\r\n * ease: 'Power1',\r\n * duration: 3000,\r\n * repeat: 4\r\n * });\r\n * tween.on('repeat', listener);\r\n * ```\r\n *\r\n * @event Phaser.Tweens.Events#TWEEN_REPEAT\r\n * @type {string}\r\n * @since 3.19.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween instance that emitted the event.\r\n * @param {string} key - The property on the target that has just repeated, i.e. `x` or `scaleY`, or whatever property you are tweening.\r\n * @param {any} target - The target object that was repeated. Usually a Game Object, but can be of any type.\r\n * @param {number} current - The current value of the property being set on the target.\r\n * @param {number} previous - The previous value of the property being set on the target.\r\n */", "meta": { "filename": "TWEEN_REPEAT_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\events", "code": {} }, "description": "The Tween Repeat Event.\r\rThis event is dispatched by a Tween when one of the properties it is tweening repeats.\r\rThis event will only be dispatched if the Tween has a property with a repeat count set.\r\rIf a Tween has a `repeatDelay` set, this event will fire after that delay expires.\r\rThe difference between `loop` and `repeat` is that `repeat` is a property setting,\rwhere-as `loop` applies to the entire Tween.\r\rListen to it from a Tween instance using `Tween.on('repeat', listener)`, i.e.:\r\r```javascript\rvar tween = this.tweens.add({\r targets: image,\r x: 500,\r ease: 'Power1',\r duration: 3000,\r repeat: 4\r});\rtween.on('repeat', listener);\r```", "kind": "event", "name": "TWEEN_REPEAT", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.19.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween instance that emitted the event.", "name": "tween" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property on the target that has just repeated, i.e. `x` or `scaleY`, or whatever property you are tweening.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The target object that was repeated. Usually a Game Object, but can be of any type.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current value of the property being set on the target.", "name": "current" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The previous value of the property being set on the target.", "name": "previous" } ], "memberof": "Phaser.Tweens.Events", "longname": "Phaser.Tweens.Events#event:TWEEN_REPEAT", "scope": "instance", "___id": "T000002R044015", "___s": true }, { "comment": "/**\r\n * The Tween Resume Event.\r\n *\r\n * This event is dispatched by a Tween when it is resumed from a paused state.\r\n *\r\n * Listen to it from a Tween instance using `Tween.on('resume', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var tween = this.tweens.add({\r\n * targets: image,\r\n * ease: 'Power1',\r\n * duration: 3000,\r\n * x: 600\r\n * });\r\n * tween.on('resume', listener);\r\n * // At some point later ...\r\n * tween.resume();\r\n * ```\r\n *\r\n * @event Phaser.Tweens.Events#TWEEN_RESUME\r\n * @type {string}\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween instance that emitted the event.\r\n */", "meta": { "filename": "TWEEN_RESUME_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\events", "code": {} }, "description": "The Tween Resume Event.\r\rThis event is dispatched by a Tween when it is resumed from a paused state.\r\rListen to it from a Tween instance using `Tween.on('resume', listener)`, i.e.:\r\r```javascript\rvar tween = this.tweens.add({\r targets: image,\r ease: 'Power1',\r duration: 3000,\r x: 600\r});\rtween.on('resume', listener);\r// At some point later ...\rtween.resume();\r```", "kind": "event", "name": "TWEEN_RESUME", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween instance that emitted the event.", "name": "tween" } ], "memberof": "Phaser.Tweens.Events", "longname": "Phaser.Tweens.Events#event:TWEEN_RESUME", "scope": "instance", "___id": "T000002R044017", "___s": true }, { "comment": "/**\r\n * The Tween Start Event.\r\n *\r\n * This event is dispatched by a Tween when it starts tweening its first property.\r\n *\r\n * A Tween will only emit this event once, as it can only start once.\r\n *\r\n * If a Tween has a `delay` set, this event will fire after that delay expires.\r\n *\r\n * Listen to it from a Tween instance using `Tween.on('start', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var tween = this.tweens.add({\r\n * targets: image,\r\n * x: 500,\r\n * ease: 'Power1',\r\n * duration: 3000\r\n * });\r\n * tween.on('start', listener);\r\n * ```\r\n *\r\n * @event Phaser.Tweens.Events#TWEEN_START\r\n * @type {string}\r\n * @since 3.19.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween instance that emitted the event.\r\n * @param {(any|any[])} targets - The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.\r\n */", "meta": { "filename": "TWEEN_START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\events", "code": {} }, "description": "The Tween Start Event.\r\rThis event is dispatched by a Tween when it starts tweening its first property.\r\rA Tween will only emit this event once, as it can only start once.\r\rIf a Tween has a `delay` set, this event will fire after that delay expires.\r\rListen to it from a Tween instance using `Tween.on('start', listener)`, i.e.:\r\r```javascript\rvar tween = this.tweens.add({\r targets: image,\r x: 500,\r ease: 'Power1',\r duration: 3000\r});\rtween.on('start', listener);\r```", "kind": "event", "name": "TWEEN_START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.19.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween instance that emitted the event.", "name": "tween" }, { "type": { "names": [ "any", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "any" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "description": "The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.", "name": "targets" } ], "memberof": "Phaser.Tweens.Events", "longname": "Phaser.Tweens.Events#event:TWEEN_START", "scope": "instance", "___id": "T000002R044019", "___s": true }, { "comment": "/**\r\n * The Tween Stop Event.\r\n *\r\n * This event is dispatched by a Tween when it is stopped.\r\n *\r\n * Listen to it from a Tween instance using `Tween.on('stop', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var tween = this.tweens.add({\r\n * targets: image,\r\n * x: 500,\r\n * ease: 'Power1',\r\n * duration: 3000\r\n * });\r\n * tween.on('stop', listener);\r\n * ```\r\n *\r\n * @event Phaser.Tweens.Events#TWEEN_STOP\r\n * @type {string}\r\n * @since 3.24.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween instance that emitted the event.\r\n * @param {(any|any[])} targets - The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.\r\n */", "meta": { "filename": "TWEEN_STOP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\events", "code": {} }, "description": "The Tween Stop Event.\r\rThis event is dispatched by a Tween when it is stopped.\r\rListen to it from a Tween instance using `Tween.on('stop', listener)`, i.e.:\r\r```javascript\rvar tween = this.tweens.add({\r targets: image,\r x: 500,\r ease: 'Power1',\r duration: 3000\r});\rtween.on('stop', listener);\r```", "kind": "event", "name": "TWEEN_STOP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.24.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween instance that emitted the event.", "name": "tween" }, { "type": { "names": [ "any", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "any" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "description": "The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.", "name": "targets" } ], "memberof": "Phaser.Tweens.Events", "longname": "Phaser.Tweens.Events#event:TWEEN_STOP", "scope": "instance", "___id": "T000002R044021", "___s": true }, { "comment": "/**\r\n * The Tween Update Event.\r\n *\r\n * This event is dispatched by a Tween every time it updates _any_ of the properties it is tweening.\r\n *\r\n * A Tween that is changing 3 properties of a target will emit this event 3 times per change, once per property.\r\n *\r\n * **Note:** This is a very high frequency event and may be dispatched multiple times, every single frame.\r\n *\r\n * Listen to it from a Tween instance using `Tween.on('update', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var tween = this.tweens.add({\r\n * targets: image,\r\n * x: 500,\r\n * ease: 'Power1',\r\n * duration: 3000,\r\n * });\r\n * tween.on('update', listener);\r\n * ```\r\n *\r\n * @event Phaser.Tweens.Events#TWEEN_UPDATE\r\n * @type {string}\r\n * @since 3.19.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween instance that emitted the event.\r\n * @param {string} key - The property on the target that has just updated, i.e. `x` or `scaleY`, or whatever property you are tweening.\r\n * @param {any} target - The target object that was updated. Usually a Game Object, but can be of any type.\r\n * @param {number} current - The current value of the property that was tweened.\r\n * @param {number} previous - The previous value of the property that was tweened, prior to this update.\r\n */", "meta": { "filename": "TWEEN_UPDATE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\events", "code": {} }, "description": "The Tween Update Event.\r\rThis event is dispatched by a Tween every time it updates _any_ of the properties it is tweening.\r\rA Tween that is changing 3 properties of a target will emit this event 3 times per change, once per property.\r\r**Note:** This is a very high frequency event and may be dispatched multiple times, every single frame.\r\rListen to it from a Tween instance using `Tween.on('update', listener)`, i.e.:\r\r```javascript\rvar tween = this.tweens.add({\r targets: image,\r x: 500,\r ease: 'Power1',\r duration: 3000,\r});\rtween.on('update', listener);\r```", "kind": "event", "name": "TWEEN_UPDATE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.19.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween instance that emitted the event.", "name": "tween" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property on the target that has just updated, i.e. `x` or `scaleY`, or whatever property you are tweening.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The target object that was updated. Usually a Game Object, but can be of any type.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current value of the property that was tweened.", "name": "current" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The previous value of the property that was tweened, prior to this update.", "name": "previous" } ], "memberof": "Phaser.Tweens.Events", "longname": "Phaser.Tweens.Events#event:TWEEN_UPDATE", "scope": "instance", "___id": "T000002R044023", "___s": true }, { "comment": "/**\r\n * The Tween Yoyo Event.\r\n *\r\n * This event is dispatched by a Tween whenever a property it is tweening yoyos.\r\n *\r\n * This event will only be dispatched if the Tween has a property with `yoyo` set.\r\n *\r\n * If the Tween has a `hold` value, this event is dispatched when the hold expires.\r\n *\r\n * This event is dispatched for every property, and for every target, that yoyos.\r\n * For example, if a Tween was updating 2 properties and had 10 targets, this event\r\n * would be dispatched 20 times (twice per target). So be careful how you use it!\r\n *\r\n * Listen to it from a Tween instance using `Tween.on('yoyo', listener)`, i.e.:\r\n *\r\n * ```javascript\r\n * var tween = this.tweens.add({\r\n * targets: image,\r\n * x: 500,\r\n * ease: 'Power1',\r\n * duration: 3000,\r\n * yoyo: true\r\n * });\r\n * tween.on('yoyo', listener);\r\n * ```\r\n *\r\n * @event Phaser.Tweens.Events#TWEEN_YOYO\r\n * @type {string}\r\n * @since 3.19.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween instance that emitted the event.\r\n * @param {string} key - The property on the target that has just yoyo'd, i.e. `x` or `scaleY`, or whatever property you are tweening.\r\n * @param {any} target - The target object that was yoyo'd. Usually a Game Object, but can be of any type.\r\n * @param {number} current - The current value of the property being set on the target.\r\n * @param {number} previous - The previous value of the property being set on the target.\r\n */", "meta": { "filename": "TWEEN_YOYO_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\events", "code": {} }, "description": "The Tween Yoyo Event.\r\rThis event is dispatched by a Tween whenever a property it is tweening yoyos.\r\rThis event will only be dispatched if the Tween has a property with `yoyo` set.\r\rIf the Tween has a `hold` value, this event is dispatched when the hold expires.\r\rThis event is dispatched for every property, and for every target, that yoyos.\rFor example, if a Tween was updating 2 properties and had 10 targets, this event\rwould be dispatched 20 times (twice per target). So be careful how you use it!\r\rListen to it from a Tween instance using `Tween.on('yoyo', listener)`, i.e.:\r\r```javascript\rvar tween = this.tweens.add({\r targets: image,\r x: 500,\r ease: 'Power1',\r duration: 3000,\r yoyo: true\r});\rtween.on('yoyo', listener);\r```", "kind": "event", "name": "TWEEN_YOYO", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.19.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween instance that emitted the event.", "name": "tween" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property on the target that has just yoyo'd, i.e. `x` or `scaleY`, or whatever property you are tweening.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The target object that was yoyo'd. Usually a Game Object, but can be of any type.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current value of the property being set on the target.", "name": "current" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The previous value of the property being set on the target.", "name": "previous" } ], "memberof": "Phaser.Tweens.Events", "longname": "Phaser.Tweens.Events#event:TWEEN_YOYO", "scope": "instance", "___id": "T000002R044025", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Tweens\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "kind": "namespace", "name": "Tweens", "memberof": "Phaser", "longname": "Phaser.Tweens", "scope": "static", "___id": "T000002R044027", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * As the name implies, this is the base Tween class that both the Tween and TweenChain\r\n * inherit from. It contains shared properties and methods common to both types of Tween.\r\n *\r\n * Typically you would never instantiate this class directly, although you could certainly\r\n * use it to create your own variation of Tweens from.\r\n *\r\n * @class BaseTween\r\n * @memberof Phaser.Tweens\r\n * @extends Phaser.Events.EventEmitter\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {(Phaser.Tweens.TweenManager|Phaser.Tweens.TweenChain)} parent - A reference to the Tween Manager, or Tween Chain, that owns this Tween.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "classdesc": "As the name implies, this is the base Tween class that both the Tween and TweenChain\rinherit from. It contains shared properties and methods common to both types of Tween.\r\rTypically you would never instantiate this class directly, although you could certainly\ruse it to create your own variation of Tweens from.", "kind": "class", "name": "BaseTween", "memberof": "Phaser.Tweens", "augments": [ "Phaser.Events.EventEmitter" ], "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Tweens.TweenManager", "Phaser.Tweens.TweenChain" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Tweens.TweenManager" }, { "type": "NameExpression", "name": "Phaser.Tweens.TweenChain" } ] } }, "description": "A reference to the Tween Manager, or Tween Chain, that owns this Tween.", "name": "parent" } ], "scope": "static", "longname": "Phaser.Tweens.BaseTween", "___id": "T000002R044043", "___s": true }, { "comment": "/**\r\n * A reference to the Tween Manager, or Tween Chain, that owns this Tween.\r\n *\r\n * @name Phaser.Tweens.BaseTween#parent\r\n * @type {(Phaser.Tweens.TweenManager|Phaser.Tweens.TweenChain)}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "A reference to the Tween Manager, or Tween Chain, that owns this Tween.", "name": "parent", "type": { "names": [ "Phaser.Tweens.TweenManager", "Phaser.Tweens.TweenChain" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Tweens.TweenManager" }, { "type": "NameExpression", "name": "Phaser.Tweens.TweenChain" } ] } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#parent", "scope": "instance", "kind": "member", "___id": "T000002R044047", "___s": true }, { "comment": "/**\r\n * The main data array. For a Tween, this contains all of the `TweenData` objects, each\r\n * containing a unique property and target that is being tweened.\r\n *\r\n * For a TweenChain, this contains an array of `Tween` instances, which are being played\r\n * through in sequence.\r\n *\r\n * @name Phaser.Tweens.BaseTween#data\r\n * @type {(Phaser.Tweens.TweenData[]|Phaser.Tweens.Tween[])}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The main data array. For a Tween, this contains all of the `TweenData` objects, each\rcontaining a unique property and target that is being tweened.\r\rFor a TweenChain, this contains an array of `Tween` instances, which are being played\rthrough in sequence.", "name": "data", "type": { "names": [ "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tweens.TweenData", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tweens.Tween", "type": "NameExpression" } ] } ] } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#data", "scope": "instance", "kind": "member", "___id": "T000002R044049", "___s": true }, { "comment": "/**\r\n * The cached size of the data array.\r\n *\r\n * @name Phaser.Tweens.BaseTween#totalData\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The cached size of the data array.", "name": "totalData", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#totalData", "scope": "instance", "kind": "member", "___id": "T000002R044051", "___s": true }, { "comment": "/**\r\n * The time in milliseconds before the 'onStart' event fires.\r\n *\r\n * For a Tween, this is the shortest `delay` value across all of the TweenDatas it owns.\r\n * For a TweenChain, it is whatever delay value was given in the configuration.\r\n *\r\n * @name Phaser.Tweens.BaseTween#startDelay\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 69, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The time in milliseconds before the 'onStart' event fires.\r\rFor a Tween, this is the shortest `delay` value across all of the TweenDatas it owns.\rFor a TweenChain, it is whatever delay value was given in the configuration.", "name": "startDelay", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#startDelay", "scope": "instance", "kind": "member", "___id": "T000002R044053", "___s": true }, { "comment": "/**\r\n * Has this Tween started playback yet?\r\n *\r\n * This boolean is toggled when the Tween leaves the 'start delayed' state and begins running.\r\n *\r\n * @name Phaser.Tweens.BaseTween#hasStarted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Has this Tween started playback yet?\r\rThis boolean is toggled when the Tween leaves the 'start delayed' state and begins running.", "name": "hasStarted", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#hasStarted", "scope": "instance", "kind": "member", "___id": "T000002R044055", "___s": true }, { "comment": "/**\r\n * Scales the time applied to this Tween. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on.\r\n *\r\n * The value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.\r\n *\r\n * This value is multiplied by the `TweenManager.timeScale`.\r\n *\r\n * @name Phaser.Tweens.BaseTween#timeScale\r\n * @type {number}\r\n * @default 1\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 94, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Scales the time applied to this Tween. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on.\r\rThe value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.\r\rThis value is multiplied by the `TweenManager.timeScale`.", "name": "timeScale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#timeScale", "scope": "instance", "kind": "member", "___id": "T000002R044057", "___s": true }, { "comment": "/**\r\n * The number of times this Tween will loop.\r\n *\r\n * Can be -1 for an infinite loop, zero for none, or a positive integer.\r\n *\r\n * Typically this is set in the configuration object, but can also be set directly\r\n * as long as this Tween is paused and hasn't started playback.\r\n *\r\n * When enabled it will play through ALL Tweens again.\r\n *\r\n * Use TweenData.repeat to loop a single element.\r\n *\r\n * @name Phaser.Tweens.BaseTween#loop\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The number of times this Tween will loop.\r\rCan be -1 for an infinite loop, zero for none, or a positive integer.\r\rTypically this is set in the configuration object, but can also be set directly\ras long as this Tween is paused and hasn't started playback.\r\rWhen enabled it will play through ALL Tweens again.\r\rUse TweenData.repeat to loop a single element.", "name": "loop", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#loop", "scope": "instance", "kind": "member", "___id": "T000002R044059", "___s": true }, { "comment": "/**\r\n * The time in milliseconds before the Tween loops.\r\n *\r\n * Only used if `loop` is > 0.\r\n *\r\n * @name Phaser.Tweens.BaseTween#loopDelay\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 127, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The time in milliseconds before the Tween loops.\r\rOnly used if `loop` is > 0.", "name": "loopDelay", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#loopDelay", "scope": "instance", "kind": "member", "___id": "T000002R044061", "___s": true }, { "comment": "/**\r\n * Internal counter recording how many loops are left to run.\r\n *\r\n * @name Phaser.Tweens.BaseTween#loopCounter\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal counter recording how many loops are left to run.", "name": "loopCounter", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#loopCounter", "scope": "instance", "kind": "member", "___id": "T000002R044063", "___s": true }, { "comment": "/**\r\n * The time in milliseconds before the 'onComplete' event fires.\r\n *\r\n * This never fires if `loop = -1` as it never completes because it has been\r\n * set to loop forever.\r\n *\r\n * @name Phaser.Tweens.BaseTween#completeDelay\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The time in milliseconds before the 'onComplete' event fires.\r\rThis never fires if `loop = -1` as it never completes because it has been\rset to loop forever.", "name": "completeDelay", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#completeDelay", "scope": "instance", "kind": "member", "___id": "T000002R044065", "___s": true }, { "comment": "/**\r\n * An internal countdown timer (used by loopDelay and completeDelay)\r\n *\r\n * @name Phaser.Tweens.BaseTween#countdown\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 162, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "An internal countdown timer (used by loopDelay and completeDelay)", "name": "countdown", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#countdown", "scope": "instance", "kind": "member", "___id": "T000002R044067", "___s": true }, { "comment": "/**\r\n * The current state of the Tween.\r\n *\r\n * @name Phaser.Tweens.BaseTween#state\r\n * @type {Phaser.Tweens.StateType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 172, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The current state of the Tween.", "name": "state", "type": { "names": [ "Phaser.Tweens.StateType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.StateType" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#state", "scope": "instance", "kind": "member", "___id": "T000002R044069", "___s": true }, { "comment": "/**\r\n * Is the Tween currently paused?\r\n *\r\n * A paused Tween needs to be started with the `play` method, or resumed with the `resume` method.\r\n *\r\n * This property can be toggled at runtime if required.\r\n *\r\n * @name Phaser.Tweens.BaseTween#paused\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 181, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Is the Tween currently paused?\r\rA paused Tween needs to be started with the `play` method, or resumed with the `resume` method.\r\rThis property can be toggled at runtime if required.", "name": "paused", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#paused", "scope": "instance", "kind": "member", "___id": "T000002R044071", "___s": true }, { "comment": "/**\r\n * An object containing the different Tween callback functions.\r\n *\r\n * You can either set these in the Tween config, or by calling the `Tween.setCallback` method.\r\n *\r\n * The types available are:\r\n *\r\n * `onActive` - When the Tween is first created it moves to an 'active' state when added to the Tween Manager. 'Active' does not mean 'playing'.\r\n * `onStart` - When the Tween starts playing after a delayed or paused state. This will happen at the same time as `onActive` if the tween has no delay and isn't paused.\r\n * `onLoop` - When a Tween loops, if it has been set to do so. This happens _after_ the `loopDelay` expires, if set.\r\n * `onComplete` - When the Tween finishes playback fully. Never invoked if the Tween is set to repeat infinitely.\r\n * `onStop` - Invoked only if the `Tween.stop` method is called.\r\n * `onPause` - Invoked only if the `Tween.pause` method is called. Not invoked if the Tween Manager is paused.\r\n * `onResume` - Invoked only if the `Tween.resume` method is called. Not invoked if the Tween Manager is resumed.\r\n *\r\n * The following types are also available and are invoked on a `TweenData` level - that is per-object, per-property, being tweened.\r\n *\r\n * `onYoyo` - When a TweenData starts a yoyo. This happens _after_ the `hold` delay expires, if set.\r\n * `onRepeat` - When a TweenData repeats playback. This happens _after_ the `repeatDelay` expires, if set.\r\n * `onUpdate` - When a TweenData updates a property on a source target during playback.\r\n *\r\n * @name Phaser.Tweens.BaseTween#callbacks\r\n * @type {Phaser.Types.Tweens.TweenCallbacks}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "An object containing the different Tween callback functions.\r\rYou can either set these in the Tween config, or by calling the `Tween.setCallback` method.\r\rThe types available are:\r\r`onActive` - When the Tween is first created it moves to an 'active' state when added to the Tween Manager. 'Active' does not mean 'playing'.\r`onStart` - When the Tween starts playing after a delayed or paused state. This will happen at the same time as `onActive` if the tween has no delay and isn't paused.\r`onLoop` - When a Tween loops, if it has been set to do so. This happens _after_ the `loopDelay` expires, if set.\r`onComplete` - When the Tween finishes playback fully. Never invoked if the Tween is set to repeat infinitely.\r`onStop` - Invoked only if the `Tween.stop` method is called.\r`onPause` - Invoked only if the `Tween.pause` method is called. Not invoked if the Tween Manager is paused.\r`onResume` - Invoked only if the `Tween.resume` method is called. Not invoked if the Tween Manager is resumed.\r\rThe following types are also available and are invoked on a `TweenData` level - that is per-object, per-property, being tweened.\r\r`onYoyo` - When a TweenData starts a yoyo. This happens _after_ the `hold` delay expires, if set.\r`onRepeat` - When a TweenData repeats playback. This happens _after_ the `repeatDelay` expires, if set.\r`onUpdate` - When a TweenData updates a property on a source target during playback.", "name": "callbacks", "type": { "names": [ "Phaser.Types.Tweens.TweenCallbacks" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenCallbacks" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#callbacks", "scope": "instance", "kind": "member", "___id": "T000002R044073", "___s": true }, { "comment": "/**\r\n * The scope (or context) in which all of the callbacks are invoked.\r\n *\r\n * This defaults to be this Tween, but you can override this property\r\n * to set it to whatever object you require.\r\n *\r\n * @name Phaser.Tweens.BaseTween#callbackScope\r\n * @type {any}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 233, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The scope (or context) in which all of the callbacks are invoked.\r\rThis defaults to be this Tween, but you can override this property\rto set it to whatever object you require.", "name": "callbackScope", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#callbackScope", "scope": "instance", "kind": "member", "___id": "T000002R044085", "___s": true }, { "comment": "/**\r\n * Will this Tween persist after playback? A Tween that persists will _not_ be destroyed by the\r\n * Tween Manager, or when calling `Tween.stop`, and can be re-played as required. You can either\r\n * set this property when creating the tween in the tween config, or set it _prior_ to playback.\r\n *\r\n * However, it's up to you to ensure you destroy persistent tweens when you are finished with them,\r\n * or they will retain references you may no longer require and waste memory.\r\n *\r\n * By default, `Tweens` are set to _not_ persist, so they are automatically cleaned-up by\r\n * the Tween Manager. But `TweenChains` _do_ persist by default, unless overridden in their\r\n * config. This is because the type of situations you use a chain for is far more likely to\r\n * need to be replayed again in the future, rather than disposed of.\r\n *\r\n * @name Phaser.Tweens.BaseTween#persist\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Will this Tween persist after playback? A Tween that persists will _not_ be destroyed by the\rTween Manager, or when calling `Tween.stop`, and can be re-played as required. You can either\rset this property when creating the tween in the tween config, or set it _prior_ to playback.\r\rHowever, it's up to you to ensure you destroy persistent tweens when you are finished with them,\ror they will retain references you may no longer require and waste memory.\r\rBy default, `Tweens` are set to _not_ persist, so they are automatically cleaned-up by\rthe Tween Manager. But `TweenChains` _do_ persist by default, unless overridden in their\rconfig. This is because the type of situations you use a chain for is far more likely to\rneed to be replayed again in the future, rather than disposed of.", "name": "persist", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#persist", "scope": "instance", "kind": "member", "___id": "T000002R044087", "___s": true }, { "comment": "/**\r\n * Sets the value of the time scale applied to this Tween. A value of 1 runs in real-time.\r\n * A value of 0.5 runs 50% slower, and so on.\r\n *\r\n * The value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.\r\n *\r\n * This value is multiplied by the `TweenManager.timeScale`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setTimeScale\r\n * @since 3.60.0\r\n *\r\n * @param {number} value - The time scale value to set.\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 265, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets the value of the time scale applied to this Tween. A value of 1 runs in real-time.\rA value of 0.5 runs 50% slower, and so on.\r\rThe value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.\r\rThis value is multiplied by the `TweenManager.timeScale`.", "kind": "function", "name": "setTimeScale", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time scale value to set.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#setTimeScale", "scope": "instance", "___id": "T000002R044089", "___s": true }, { "comment": "/**\r\n * Gets the value of the time scale applied to this Tween. A value of 1 runs in real-time.\r\n * A value of 0.5 runs 50% slower, and so on.\r\n *\r\n * @method Phaser.Tweens.BaseTween#getTimeScale\r\n * @since 3.60.0\r\n *\r\n * @return {number} The value of the time scale applied to this Tween.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 287, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Gets the value of the time scale applied to this Tween. A value of 1 runs in real-time.\rA value of 0.5 runs 50% slower, and so on.", "kind": "function", "name": "getTimeScale", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value of the time scale applied to this Tween." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#getTimeScale", "scope": "instance", "___id": "T000002R044092", "___s": true }, { "comment": "/**\r\n * Checks if this Tween is currently playing.\r\n *\r\n * If this Tween is paused, or not active, this method will return false.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isPlaying\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if the Tween is playing, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Checks if this Tween is currently playing.\r\rIf this Tween is paused, or not active, this method will return false.", "kind": "function", "name": "isPlaying", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Tween is playing, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#isPlaying", "scope": "instance", "___id": "T000002R044094", "___s": true }, { "comment": "/**\r\n * Checks if the Tween is currently paused.\r\n *\r\n * This is the same as inspecting the `BaseTween.paused` property directly.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isPaused\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if the Tween is paused, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Checks if the Tween is currently paused.\r\rThis is the same as inspecting the `BaseTween.paused` property directly.", "kind": "function", "name": "isPaused", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Tween is paused, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#isPaused", "scope": "instance", "___id": "T000002R044096", "___s": true }, { "comment": "/**\r\n * Pauses the Tween immediately. Use `resume` to continue playback.\r\n *\r\n * You can also toggle the `Tween.paused` boolean property, but doing so will not trigger the PAUSE event.\r\n *\r\n * @method Phaser.Tweens.BaseTween#pause\r\n * @fires Phaser.Tweens.Events#TWEEN_PAUSE\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 331, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Pauses the Tween immediately. Use `resume` to continue playback.\r\rYou can also toggle the `Tween.paused` boolean property, but doing so will not trigger the PAUSE event.", "kind": "function", "name": "pause", "fires": [ "Phaser.Tweens.Events#event:TWEEN_PAUSE" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#pause", "scope": "instance", "___id": "T000002R044098", "___s": true }, { "comment": "/**\r\n * Resumes the playback of a previously paused Tween.\r\n *\r\n * You can also toggle the `Tween.paused` boolean property, but doing so will not trigger the RESUME event.\r\n *\r\n * @method Phaser.Tweens.BaseTween#resume\r\n * @fires Phaser.Tweens.Events#TWEEN_RESUME\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 354, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Resumes the playback of a previously paused Tween.\r\rYou can also toggle the `Tween.paused` boolean property, but doing so will not trigger the RESUME event.", "kind": "function", "name": "resume", "fires": [ "Phaser.Tweens.Events#event:TWEEN_RESUME" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#resume", "scope": "instance", "___id": "T000002R044101", "___s": true }, { "comment": "/**\r\n * Internal method that makes this Tween active within the TweenManager\r\n * and emits the onActive event and callback.\r\n *\r\n * @method Phaser.Tweens.BaseTween#makeActive\r\n * @fires Phaser.Tweens.Events#TWEEN_ACTIVE\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 377, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that makes this Tween active within the TweenManager\rand emits the onActive event and callback.", "kind": "function", "name": "makeActive", "fires": [ "Phaser.Tweens.Events#event:TWEEN_ACTIVE" ], "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#makeActive", "scope": "instance", "___id": "T000002R044104", "___s": true }, { "comment": "/**\r\n * Internal method that handles this tween completing and emitting the onComplete event\r\n * and callback.\r\n *\r\n * @method Phaser.Tweens.BaseTween#onCompleteHandler\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that handles this tween completing and emitting the onComplete event\rand callback.", "kind": "function", "name": "onCompleteHandler", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#onCompleteHandler", "scope": "instance", "___id": "T000002R044106", "___s": true }, { "comment": "/**\r\n * Flags the Tween as being complete, whatever stage of progress it is at.\r\n *\r\n * If an `onComplete` callback has been defined it will automatically invoke it, unless a `delay`\r\n * argument is provided, in which case the Tween will delay for that period of time before calling the callback.\r\n *\r\n * If you don't need a delay or don't have an `onComplete` callback then call `Tween.stop` instead.\r\n *\r\n * @method Phaser.Tweens.BaseTween#complete\r\n * @fires Phaser.Tweens.Events#TWEEN_COMPLETE\r\n * @since 3.2.0\r\n *\r\n * @param {number} [delay=0] - The time to wait before invoking the complete callback. If zero it will fire immediately.\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 406, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Flags the Tween as being complete, whatever stage of progress it is at.\r\rIf an `onComplete` callback has been defined it will automatically invoke it, unless a `delay`\rargument is provided, in which case the Tween will delay for that period of time before calling the callback.\r\rIf you don't need a delay or don't have an `onComplete` callback then call `Tween.stop` instead.", "kind": "function", "name": "complete", "fires": [ "Phaser.Tweens.Events#event:TWEEN_COMPLETE" ], "since": "3.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The time to wait before invoking the complete callback. If zero it will fire immediately.", "name": "delay" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#complete", "scope": "instance", "___id": "T000002R044108", "___s": true }, { "comment": "/**\r\n * Flags the Tween as being complete only once the current loop has finished.\r\n *\r\n * This is a useful way to stop an infinitely looping tween once a complete cycle is over,\r\n * rather than abruptly.\r\n *\r\n * If you don't have a loop then call `Tween.stop` instead.\r\n *\r\n * @method Phaser.Tweens.BaseTween#completeAfterLoop\r\n * @fires Phaser.Tweens.Events#TWEEN_COMPLETE\r\n * @since 3.60.0\r\n *\r\n * @param {number} [loops=0] - The number of loops that should finish before this tween completes. Zero means complete just the current loop.\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 440, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Flags the Tween as being complete only once the current loop has finished.\r\rThis is a useful way to stop an infinitely looping tween once a complete cycle is over,\rrather than abruptly.\r\rIf you don't have a loop then call `Tween.stop` instead.", "kind": "function", "name": "completeAfterLoop", "fires": [ "Phaser.Tweens.Events#event:TWEEN_COMPLETE" ], "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of loops that should finish before this tween completes. Zero means complete just the current loop.", "name": "loops" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#completeAfterLoop", "scope": "instance", "___id": "T000002R044112", "___s": true }, { "comment": "/**\r\n * Immediately removes this Tween from the TweenManager and all of its internal arrays,\r\n * no matter what stage it is at. Then sets the tween state to `REMOVED`.\r\n *\r\n * You should dispose of your reference to this tween after calling this method, to\r\n * free it from memory. If you no longer require it, call `Tween.destroy()` on it.\r\n *\r\n * @method Phaser.Tweens.BaseTween#remove\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Immediately removes this Tween from the TweenManager and all of its internal arrays,\rno matter what stage it is at. Then sets the tween state to `REMOVED`.\r\rYou should dispose of your reference to this tween after calling this method, to\rfree it from memory. If you no longer require it, call `Tween.destroy()` on it.", "kind": "function", "name": "remove", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#remove", "scope": "instance", "___id": "T000002R044116", "___s": true }, { "comment": "/**\r\n * Stops the Tween immediately, whatever stage of progress it is at.\r\n *\r\n * If not a part of a Tween Chain it is also flagged for removal by the Tween Manager.\r\n *\r\n * If an `onStop` callback has been defined it will automatically invoke it.\r\n *\r\n * The Tween will be removed during the next game frame, but should be considered 'destroyed' from this point on.\r\n *\r\n * Typically, you cannot play a Tween that has been stopped. If you just wish to pause the tween, not destroy it,\r\n * then call the `pause` method instead and use `resume` to continue playback. If you wish to restart the Tween,\r\n * use the `restart` or `seek` methods.\r\n *\r\n * @method Phaser.Tweens.BaseTween#stop\r\n * @fires Phaser.Tweens.Events#TWEEN_STOP\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 490, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Stops the Tween immediately, whatever stage of progress it is at.\r\rIf not a part of a Tween Chain it is also flagged for removal by the Tween Manager.\r\rIf an `onStop` callback has been defined it will automatically invoke it.\r\rThe Tween will be removed during the next game frame, but should be considered 'destroyed' from this point on.\r\rTypically, you cannot play a Tween that has been stopped. If you just wish to pause the tween, not destroy it,\rthen call the `pause` method instead and use `resume` to continue playback. If you wish to restart the Tween,\ruse the `restart` or `seek` methods.", "kind": "function", "name": "stop", "fires": [ "Phaser.Tweens.Events#event:TWEEN_STOP" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#stop", "scope": "instance", "___id": "T000002R044118", "___s": true }, { "comment": "/**\r\n * Internal method that handles the processing of the loop delay countdown timer and\r\n * the dispatch of related events. Called automatically by `Tween.update`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#updateLoopCountdown\r\n * @since 3.60.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": "BaseTween.js", "lineno": 521, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that handles the processing of the loop delay countdown timer and\rthe dispatch of related events. Called automatically by `Tween.update`.", "kind": "function", "name": "updateLoopCountdown", "since": "3.60.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.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#updateLoopCountdown", "scope": "instance", "___id": "T000002R044120", "___s": true }, { "comment": "/**\r\n * Internal method that handles the processing of the start delay countdown timer and\r\n * the dispatch of related events. Called automatically by `Tween.update`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#updateStartCountdown\r\n * @since 3.60.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": "BaseTween.js", "lineno": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that handles the processing of the start delay countdown timer and\rthe dispatch of related events. Called automatically by `Tween.update`.", "kind": "function", "name": "updateStartCountdown", "since": "3.60.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.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#updateStartCountdown", "scope": "instance", "___id": "T000002R044123", "___s": true }, { "comment": "/**\r\n * Internal method that handles the processing of the complete delay countdown timer and\r\n * the dispatch of related events. Called automatically by `Tween.update`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#updateCompleteDelay\r\n * @since 3.60.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": "BaseTween.js", "lineno": 570, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that handles the processing of the complete delay countdown timer and\rthe dispatch of related events. Called automatically by `Tween.update`.", "kind": "function", "name": "updateCompleteDelay", "since": "3.60.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.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#updateCompleteDelay", "scope": "instance", "___id": "T000002R044128", "___s": true }, { "comment": "/**\r\n * Sets an event based callback to be invoked during playback.\r\n *\r\n * Calling this method will replace a previously set callback for the given type, if any exists.\r\n *\r\n * The types available are:\r\n *\r\n * `onActive` - When the Tween is first created it moves to an 'active' state when added to the Tween Manager. 'Active' does not mean 'playing'.\r\n * `onStart` - When the Tween starts playing after a delayed or paused state. This will happen at the same time as `onActive` if the tween has no delay and isn't paused.\r\n * `onLoop` - When a Tween loops, if it has been set to do so. This happens _after_ the `loopDelay` expires, if set.\r\n * `onComplete` - When the Tween finishes playback fully. Never invoked if the Tween is set to repeat infinitely.\r\n * `onStop` - Invoked only if the `Tween.stop` method is called.\r\n * `onPause` - Invoked only if the `Tween.pause` method is called. Not invoked if the Tween Manager is paused.\r\n * `onResume` - Invoked only if the `Tween.resume` method is called. Not invoked if the Tween Manager is resumed.\r\n *\r\n * The following types are also available and are invoked on a `TweenData` level - that is per-object, per-property, being tweened.\r\n *\r\n * `onYoyo` - When a TweenData starts a yoyo. This happens _after_ the `hold` delay expires, if set.\r\n * `onRepeat` - When a TweenData repeats playback. This happens _after_ the `repeatDelay` expires, if set.\r\n * `onUpdate` - When a TweenData updates a property on a source target during playback.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setCallback\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Tweens.TweenCallbackTypes} type - The type of callback to set. One of: `onActive`, `onComplete`, `onLoop`, `onPause`, `onRepeat`, `onResume`, `onStart`, `onStop`, `onUpdate` or `onYoyo`.\r\n * @param {function} callback - Your callback that will be invoked.\r\n * @param {array} [params] - The parameters to pass to the callback. Pass an empty array if you don't want to define any, but do wish to set the scope.\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets an event based callback to be invoked during playback.\r\rCalling this method will replace a previously set callback for the given type, if any exists.\r\rThe types available are:\r\r`onActive` - When the Tween is first created it moves to an 'active' state when added to the Tween Manager. 'Active' does not mean 'playing'.\r`onStart` - When the Tween starts playing after a delayed or paused state. This will happen at the same time as `onActive` if the tween has no delay and isn't paused.\r`onLoop` - When a Tween loops, if it has been set to do so. This happens _after_ the `loopDelay` expires, if set.\r`onComplete` - When the Tween finishes playback fully. Never invoked if the Tween is set to repeat infinitely.\r`onStop` - Invoked only if the `Tween.stop` method is called.\r`onPause` - Invoked only if the `Tween.pause` method is called. Not invoked if the Tween Manager is paused.\r`onResume` - Invoked only if the `Tween.resume` method is called. Not invoked if the Tween Manager is resumed.\r\rThe following types are also available and are invoked on a `TweenData` level - that is per-object, per-property, being tweened.\r\r`onYoyo` - When a TweenData starts a yoyo. This happens _after_ the `hold` delay expires, if set.\r`onRepeat` - When a TweenData repeats playback. This happens _after_ the `repeatDelay` expires, if set.\r`onUpdate` - When a TweenData updates a property on a source target during playback.", "kind": "function", "name": "setCallback", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.Tweens.TweenCallbackTypes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenCallbackTypes" } }, "description": "The type of callback to set. One of: `onActive`, `onComplete`, `onLoop`, `onPause`, `onRepeat`, `onResume`, `onStart`, `onStop`, `onUpdate` or `onYoyo`.", "name": "type" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "Your callback that will be invoked.", "name": "callback" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "The parameters to pass to the callback. Pass an empty array if you don't want to define any, but do wish to set the scope.", "name": "params" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#setCallback", "scope": "instance", "___id": "T000002R044131", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to PENDING.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setPendingState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 631, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this Tween state to PENDING.", "kind": "function", "name": "setPendingState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#setPendingState", "scope": "instance", "___id": "T000002R044137", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to ACTIVE.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setActiveState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 642, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this Tween state to ACTIVE.", "kind": "function", "name": "setActiveState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#setActiveState", "scope": "instance", "___id": "T000002R044140", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to LOOP_DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setLoopDelayState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 653, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this Tween state to LOOP_DELAY.", "kind": "function", "name": "setLoopDelayState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#setLoopDelayState", "scope": "instance", "___id": "T000002R044143", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to COMPLETE_DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setCompleteDelayState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 664, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this Tween state to COMPLETE_DELAY.", "kind": "function", "name": "setCompleteDelayState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#setCompleteDelayState", "scope": "instance", "___id": "T000002R044146", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to START_DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setStartDelayState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 675, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this Tween state to START_DELAY.", "kind": "function", "name": "setStartDelayState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#setStartDelayState", "scope": "instance", "___id": "T000002R044149", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to PENDING_REMOVE.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setPendingRemoveState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 690, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this Tween state to PENDING_REMOVE.", "kind": "function", "name": "setPendingRemoveState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#setPendingRemoveState", "scope": "instance", "___id": "T000002R044154", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to REMOVED.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setRemovedState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 701, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this Tween state to REMOVED.", "kind": "function", "name": "setRemovedState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#setRemovedState", "scope": "instance", "___id": "T000002R044157", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to FINISHED.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setFinishedState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 712, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this Tween state to FINISHED.", "kind": "function", "name": "setFinishedState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#setFinishedState", "scope": "instance", "___id": "T000002R044160", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to DESTROYED.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setDestroyedState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 723, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this Tween state to DESTROYED.", "kind": "function", "name": "setDestroyedState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#setDestroyedState", "scope": "instance", "___id": "T000002R044163", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of PENDING, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isPending\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of PENDING, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 734, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this Tween has a _current_ state of PENDING, otherwise `false`.", "kind": "function", "name": "isPending", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of PENDING, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#isPending", "scope": "instance", "___id": "T000002R044166", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of ACTIVE, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isActive\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of ACTIVE, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this Tween has a _current_ state of ACTIVE, otherwise `false`.", "kind": "function", "name": "isActive", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of ACTIVE, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#isActive", "scope": "instance", "___id": "T000002R044168", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of LOOP_DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isLoopDelayed\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of LOOP_DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 760, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this Tween has a _current_ state of LOOP_DELAY, otherwise `false`.", "kind": "function", "name": "isLoopDelayed", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of LOOP_DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#isLoopDelayed", "scope": "instance", "___id": "T000002R044170", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of COMPLETE_DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isCompleteDelayed\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of COMPLETE_DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this Tween has a _current_ state of COMPLETE_DELAY, otherwise `false`.", "kind": "function", "name": "isCompleteDelayed", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of COMPLETE_DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#isCompleteDelayed", "scope": "instance", "___id": "T000002R044172", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of START_DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isStartDelayed\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of START_DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 786, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this Tween has a _current_ state of START_DELAY, otherwise `false`.", "kind": "function", "name": "isStartDelayed", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of START_DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#isStartDelayed", "scope": "instance", "___id": "T000002R044174", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of PENDING_REMOVE, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isPendingRemove\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of PENDING_REMOVE, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 799, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this Tween has a _current_ state of PENDING_REMOVE, otherwise `false`.", "kind": "function", "name": "isPendingRemove", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of PENDING_REMOVE, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#isPendingRemove", "scope": "instance", "___id": "T000002R044176", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of REMOVED, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isRemoved\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of REMOVED, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 812, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this Tween has a _current_ state of REMOVED, otherwise `false`.", "kind": "function", "name": "isRemoved", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of REMOVED, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#isRemoved", "scope": "instance", "___id": "T000002R044178", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of FINISHED, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isFinished\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of FINISHED, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 825, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this Tween has a _current_ state of FINISHED, otherwise `false`.", "kind": "function", "name": "isFinished", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of FINISHED, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#isFinished", "scope": "instance", "___id": "T000002R044180", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of DESTROYED, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isDestroyed\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of DESTROYED, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 838, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this Tween has a _current_ state of DESTROYED, otherwise `false`.", "kind": "function", "name": "isDestroyed", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of DESTROYED, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#isDestroyed", "scope": "instance", "___id": "T000002R044182", "___s": true }, { "comment": "/**\r\n * Handles the destroy process of this Tween, clearing out the\r\n * Tween Data and resetting the targets. A Tween that has been\r\n * destroyed cannot ever be played or used again.\r\n *\r\n * @method Phaser.Tweens.BaseTween#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 851, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Handles the destroy process of this Tween, clearing out the\rTween Data and resetting the targets. A Tween that has been\rdestroyed cannot ever be played or used again.", "kind": "function", "name": "destroy", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTween", "longname": "Phaser.Tweens.BaseTween#destroy", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#destroy", "___id": "T000002R044184", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * BaseTweenData is the class that the TweenData and TweenFrameData classes\r\n * extend from. You should not typically instantiate this class directly, but instead\r\n * use it to form your own tween data classes from, should you require it.\r\n *\r\n * Prior to Phaser 3.60 the TweenData was just an object, but was refactored to a class,\r\n * to make it responsible for its own state and updating.\r\n *\r\n * @class BaseTweenData\r\n * @memberof Phaser.Tweens\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - The tween this TweenData instance belongs to.\r\n * @param {number} targetIndex - The target index within the Tween targets array.\r\n * @param {string} key - The property of the target to tween.\r\n * @param {Phaser.Types.Tweens.GetEndCallback} getEnd - What the property will be at the END of the Tween.\r\n * @param {Phaser.Types.Tweens.GetStartCallback} getStart - What the property will be at the START of the Tween.\r\n * @param {?Phaser.Types.Tweens.GetActiveCallback} getActive - If not null, is invoked _immediately_ as soon as the TweenData is running, and is set on the target property.\r\n * @param {function} ease - The ease function this tween uses.\r\n * @param {function} delay - Function that returns the time in milliseconds before tween will start.\r\n * @param {number} duration - The duration of the tween in milliseconds.\r\n * @param {boolean} yoyo - Determines whether the tween should return back to its start value after hold has expired.\r\n * @param {number} hold - Function that returns the time in milliseconds the tween will pause before repeating or returning to its starting value if yoyo is set to true.\r\n * @param {number} repeat - Function that returns the number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.\r\n * @param {number} repeatDelay - Function that returns the time in milliseconds before the repeat will start.\r\n * @param {boolean} flipX - Should toggleFlipX be called when yoyo or repeat happens?\r\n * @param {boolean} flipY - Should toggleFlipY be called when yoyo or repeat happens?\r\n * @param {?function} interpolation - The interpolation function to be used for arrays of data. Defaults to 'null'.\r\n * @param {?number[]} interpolationData - The array of interpolation data to be set. Defaults to 'null'.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "classdesc": "BaseTweenData is the class that the TweenData and TweenFrameData classes\rextend from. You should not typically instantiate this class directly, but instead\ruse it to form your own tween data classes from, should you require it.\r\rPrior to Phaser 3.60 the TweenData was just an object, but was refactored to a class,\rto make it responsible for its own state and updating.", "kind": "class", "name": "BaseTweenData", "memberof": "Phaser.Tweens", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The tween this TweenData instance belongs to.", "name": "tween" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The target index within the Tween targets array.", "name": "targetIndex" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property of the target to tween.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Tweens.GetEndCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetEndCallback" } }, "description": "What the property will be at the END of the Tween.", "name": "getEnd" }, { "type": { "names": [ "Phaser.Types.Tweens.GetStartCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetStartCallback" } }, "description": "What the property will be at the START of the Tween.", "name": "getStart" }, { "type": { "names": [ "Phaser.Types.Tweens.GetActiveCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetActiveCallback", "nullable": true } }, "nullable": true, "description": "If not null, is invoked _immediately_ as soon as the TweenData is running, and is set on the target property.", "name": "getActive" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The ease function this tween uses.", "name": "ease" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "Function that returns the time in milliseconds before tween will start.", "name": "delay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the tween in milliseconds.", "name": "duration" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Determines whether the tween should return back to its start value after hold has expired.", "name": "yoyo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Function that returns the time in milliseconds the tween will pause before repeating or returning to its starting value if yoyo is set to true.", "name": "hold" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Function that returns the number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.", "name": "repeat" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Function that returns the time in milliseconds before the repeat will start.", "name": "repeatDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should toggleFlipX be called when yoyo or repeat happens?", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should toggleFlipY be called when yoyo or repeat happens?", "name": "flipY" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [], "nullable": true } }, "nullable": true, "description": "The interpolation function to be used for arrays of data. Defaults to 'null'.", "name": "interpolation" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ], "nullable": true } }, "nullable": true, "description": "The array of interpolation data to be set. Defaults to 'null'.", "name": "interpolationData" } ], "scope": "static", "longname": "Phaser.Tweens.BaseTweenData", "___id": "T000002R044194", "___s": true }, { "comment": "/**\r\n * A reference to the Tween that this TweenData instance belongs to.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#tween\r\n * @type {Phaser.Tweens.Tween}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "A reference to the Tween that this TweenData instance belongs to.", "name": "tween", "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#tween", "scope": "instance", "kind": "member", "___id": "T000002R044197", "___s": true }, { "comment": "/**\r\n * The index of the target within the Tween `targets` array.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#targetIndex\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The index of the target within the Tween `targets` array.", "name": "targetIndex", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#targetIndex", "scope": "instance", "kind": "member", "___id": "T000002R044199", "___s": true }, { "comment": "/**\r\n * The duration of the tween in milliseconds, excluding any time required\r\n * for yoyo or repeats.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#duration\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The duration of the tween in milliseconds, excluding any time required\rfor yoyo or repeats.", "name": "duration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#duration", "scope": "instance", "kind": "member", "___id": "T000002R044201", "___s": true }, { "comment": "/**\r\n * The total calculated duration, in milliseconds, of this TweenData.\r\n * Factoring in the duration, repeats, delays and yoyos.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#totalDuration\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The total calculated duration, in milliseconds, of this TweenData.\rFactoring in the duration, repeats, delays and yoyos.", "name": "totalDuration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#totalDuration", "scope": "instance", "kind": "member", "___id": "T000002R044203", "___s": true }, { "comment": "/**\r\n * The time, in milliseconds, before this tween will start playing.\r\n *\r\n * This value is generated by the `getDelay` function.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#delay\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 87, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The time, in milliseconds, before this tween will start playing.\r\rThis value is generated by the `getDelay` function.", "name": "delay", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#delay", "scope": "instance", "kind": "member", "___id": "T000002R044205", "___s": true }, { "comment": "/**\r\n * This function returns the value to be used for `TweenData.delay`.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#getDelay\r\n * @type {function}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "This function returns the value to be used for `TweenData.delay`.", "name": "getDelay", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#getDelay", "scope": "instance", "kind": "member", "___id": "T000002R044207", "___s": true }, { "comment": "/**\r\n * Will the Tween ease back to its starting values, after reaching the end\r\n * and any `hold` value that may be set?\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#yoyo\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Will the Tween ease back to its starting values, after reaching the end\rand any `hold` value that may be set?", "name": "yoyo", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#yoyo", "scope": "instance", "kind": "member", "___id": "T000002R044209", "___s": true }, { "comment": "/**\r\n * The time, in milliseconds, before this tween will start a yoyo to repeat.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#hold\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 117, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The time, in milliseconds, before this tween will start a yoyo to repeat.", "name": "hold", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#hold", "scope": "instance", "kind": "member", "___id": "T000002R044211", "___s": true }, { "comment": "/**\r\n * The number of times this tween will repeat.\r\n *\r\n * The tween will always run once regardless of this value,\r\n * so a repeat value of '1' will play the tween twice: I.e. the original\r\n * play-through and then it repeats that once (1).\r\n *\r\n * If this value is set to -1 this tween will repeat forever.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#repeat\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 126, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The number of times this tween will repeat.\r\rThe tween will always run once regardless of this value,\rso a repeat value of '1' will play the tween twice: I.e. the original\rplay-through and then it repeats that once (1).\r\rIf this value is set to -1 this tween will repeat forever.", "name": "repeat", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#repeat", "scope": "instance", "kind": "member", "___id": "T000002R044213", "___s": true }, { "comment": "/**\r\n * The time, in milliseconds, before the repeat will start.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#repeatDelay\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The time, in milliseconds, before the repeat will start.", "name": "repeatDelay", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#repeatDelay", "scope": "instance", "kind": "member", "___id": "T000002R044215", "___s": true }, { "comment": "/**\r\n * How many repeats are left to run?\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#repeatCounter\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "How many repeats are left to run?", "name": "repeatCounter", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#repeatCounter", "scope": "instance", "kind": "member", "___id": "T000002R044217", "___s": true }, { "comment": "/**\r\n * If `true` this Tween will call `toggleFlipX` on the Tween target\r\n * whenever it yoyo's or repeats. It will only be called if the target\r\n * has a function matching this name, like most Phaser GameObjects do.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#flipX\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "If `true` this Tween will call `toggleFlipX` on the Tween target\rwhenever it yoyo's or repeats. It will only be called if the target\rhas a function matching this name, like most Phaser GameObjects do.", "name": "flipX", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#flipX", "scope": "instance", "kind": "member", "___id": "T000002R044219", "___s": true }, { "comment": "/**\r\n * If `true` this Tween will call `toggleFlipY` on the Tween target\r\n * whenever it yoyo's or repeats. It will only be called if the target\r\n * has a function matching this name, like most Phaser GameObjects do.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#flipY\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 170, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "If `true` this Tween will call `toggleFlipY` on the Tween target\rwhenever it yoyo's or repeats. It will only be called if the target\rhas a function matching this name, like most Phaser GameObjects do.", "name": "flipY", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#flipY", "scope": "instance", "kind": "member", "___id": "T000002R044221", "___s": true }, { "comment": "/**\r\n * A value between 0 and 1 holding the progress of this TweenData.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#progress\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 181, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "A value between 0 and 1 holding the progress of this TweenData.", "name": "progress", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#progress", "scope": "instance", "kind": "member", "___id": "T000002R044223", "___s": true }, { "comment": "/**\r\n * The amount of time, in milliseconds, that has elapsed since this\r\n * TweenData was made active.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#elapsed\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 190, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The amount of time, in milliseconds, that has elapsed since this\rTweenData was made active.", "name": "elapsed", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#elapsed", "scope": "instance", "kind": "member", "___id": "T000002R044225", "___s": true }, { "comment": "/**\r\n * The state of this TweenData.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#state\r\n * @type {Phaser.Tweens.StateType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 200, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The state of this TweenData.", "name": "state", "type": { "names": [ "Phaser.Tweens.StateType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.StateType" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#state", "scope": "instance", "kind": "member", "___id": "T000002R044227", "___s": true }, { "comment": "/**\r\n * Is this Tween Data currently waiting for a countdown to elapse, or not?\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#isCountdown\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 209, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Is this Tween Data currently waiting for a countdown to elapse, or not?", "name": "isCountdown", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#isCountdown", "scope": "instance", "kind": "member", "___id": "T000002R044229", "___s": true }, { "comment": "/**\r\n * Returns a reference to the target object belonging to this TweenData.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#getTarget\r\n * @since 3.60.0\r\n *\r\n * @return {object} The target object. Can be any JavaScript object, but is typically a Game Object.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 219, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns a reference to the target object belonging to this TweenData.", "kind": "function", "name": "getTarget", "since": "3.60.0", "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The target object. Can be any JavaScript object, but is typically a Game Object." } ], "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#getTarget", "scope": "instance", "___id": "T000002R044231", "___s": true }, { "comment": "/**\r\n * Sets this TweenData's target object property to be the given value.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setTargetValue\r\n * @since 3.60.0\r\n *\r\n * @param {number} [value] - The value to set on the target. If not given, sets it to the last `current` value.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 232, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this TweenData's target object property to be the given value.", "kind": "function", "name": "setTargetValue", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The value to set on the target. If not given, sets it to the last `current` value.", "name": "value" } ], "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#setTargetValue", "scope": "instance", "___id": "T000002R044233", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to CREATED.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setCreatedState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this TweenData state to CREATED.", "kind": "function", "name": "setCreatedState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#setCreatedState", "scope": "instance", "___id": "T000002R044237", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setDelayState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 259, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this TweenData state to DELAY.", "kind": "function", "name": "setDelayState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#setDelayState", "scope": "instance", "___id": "T000002R044241", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to PENDING_RENDER.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setPendingRenderState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 271, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this TweenData state to PENDING_RENDER.", "kind": "function", "name": "setPendingRenderState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#setPendingRenderState", "scope": "instance", "___id": "T000002R044245", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to PLAYING_FORWARD.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setPlayingForwardState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 283, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this TweenData state to PLAYING_FORWARD.", "kind": "function", "name": "setPlayingForwardState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#setPlayingForwardState", "scope": "instance", "___id": "T000002R044249", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to PLAYING_BACKWARD.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setPlayingBackwardState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this TweenData state to PLAYING_BACKWARD.", "kind": "function", "name": "setPlayingBackwardState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#setPlayingBackwardState", "scope": "instance", "___id": "T000002R044253", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to HOLD_DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setHoldState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this TweenData state to HOLD_DELAY.", "kind": "function", "name": "setHoldState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#setHoldState", "scope": "instance", "___id": "T000002R044257", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to REPEAT_DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setRepeatState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 319, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this TweenData state to REPEAT_DELAY.", "kind": "function", "name": "setRepeatState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#setRepeatState", "scope": "instance", "___id": "T000002R044261", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to COMPLETE.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setCompleteState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 331, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets this TweenData state to COMPLETE.", "kind": "function", "name": "setCompleteState", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#setCompleteState", "scope": "instance", "___id": "T000002R044265", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of CREATED, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isCreated\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of CREATED, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 343, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this TweenData has a _current_ state of CREATED, otherwise `false`.", "kind": "function", "name": "isCreated", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of CREATED, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#isCreated", "scope": "instance", "___id": "T000002R044269", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isDelayed\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this TweenData has a _current_ state of DELAY, otherwise `false`.", "kind": "function", "name": "isDelayed", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#isDelayed", "scope": "instance", "___id": "T000002R044271", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of PENDING_RENDER, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isPendingRender\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of PENDING_RENDER, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 369, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this TweenData has a _current_ state of PENDING_RENDER, otherwise `false`.", "kind": "function", "name": "isPendingRender", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of PENDING_RENDER, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#isPendingRender", "scope": "instance", "___id": "T000002R044273", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of PLAYING_FORWARD, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isPlayingForward\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of PLAYING_FORWARD, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 382, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this TweenData has a _current_ state of PLAYING_FORWARD, otherwise `false`.", "kind": "function", "name": "isPlayingForward", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of PLAYING_FORWARD, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#isPlayingForward", "scope": "instance", "___id": "T000002R044275", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of PLAYING_BACKWARD, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isPlayingBackward\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of PLAYING_BACKWARD, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 395, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this TweenData has a _current_ state of PLAYING_BACKWARD, otherwise `false`.", "kind": "function", "name": "isPlayingBackward", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of PLAYING_BACKWARD, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#isPlayingBackward", "scope": "instance", "___id": "T000002R044277", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of HOLD_DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isHolding\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of HOLD_DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this TweenData has a _current_ state of HOLD_DELAY, otherwise `false`.", "kind": "function", "name": "isHolding", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of HOLD_DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#isHolding", "scope": "instance", "___id": "T000002R044279", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of REPEAT_DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isRepeating\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of REPEAT_DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 421, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this TweenData has a _current_ state of REPEAT_DELAY, otherwise `false`.", "kind": "function", "name": "isRepeating", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of REPEAT_DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#isRepeating", "scope": "instance", "___id": "T000002R044281", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of COMPLETE, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isComplete\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of COMPLETE, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 434, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns `true` if this TweenData has a _current_ state of COMPLETE, otherwise `false`.", "kind": "function", "name": "isComplete", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of COMPLETE, otherwise `false`." } ], "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#isComplete", "scope": "instance", "___id": "T000002R044283", "___s": true }, { "comment": "/**\r\n * Internal method used as part of the playback process that checks if this\r\n * TweenData should yoyo, repeat, or has completed.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setStateFromEnd\r\n * @fires Phaser.Tweens.Events#TWEEN_REPEAT\r\n * @fires Phaser.Tweens.Events#TWEEN_YOYO\r\n * @since 3.60.0\r\n *\r\n * @param {number} diff - Any extra time that needs to be accounted for in the elapsed and progress values.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 447, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method used as part of the playback process that checks if this\rTweenData should yoyo, repeat, or has completed.", "kind": "function", "name": "setStateFromEnd", "fires": [ "Phaser.Tweens.Events#event:TWEEN_REPEAT", "Phaser.Tweens.Events#event:TWEEN_YOYO" ], "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Any extra time that needs to be accounted for in the elapsed and progress values.", "name": "diff" } ], "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#setStateFromEnd", "scope": "instance", "___id": "T000002R044285", "___s": true }, { "comment": "/**\r\n * Internal method used as part of the playback process that checks if this\r\n * TweenData should repeat or has completed.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setStateFromStart\r\n * @fires Phaser.Tweens.Events#TWEEN_REPEAT\r\n * @since 3.60.0\r\n *\r\n * @param {number} diff - Any extra time that needs to be accounted for in the elapsed and progress values.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 474, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method used as part of the playback process that checks if this\rTweenData should repeat or has completed.", "kind": "function", "name": "setStateFromStart", "fires": [ "Phaser.Tweens.Events#event:TWEEN_REPEAT" ], "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Any extra time that needs to be accounted for in the elapsed and progress values.", "name": "diff" } ], "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#setStateFromStart", "scope": "instance", "___id": "T000002R044287", "___s": true }, { "comment": "/**\r\n * Internal method that resets this Tween Data entirely, including the progress and elapsed values.\r\n *\r\n * Called automatically by the parent Tween. Should not be called directly.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#reset\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 496, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that resets this Tween Data entirely, including the progress and elapsed values.\r\rCalled automatically by the parent Tween. Should not be called directly.", "kind": "function", "name": "reset", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#reset", "scope": "instance", "___id": "T000002R044289", "___s": true }, { "comment": "/**\r\n * Internal method that handles repeating or yoyo'ing this TweenData.\r\n *\r\n * Called automatically by `setStateFromStart` and `setStateFromEnd`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#onRepeat\r\n * @fires Phaser.Tweens.Events#TWEEN_REPEAT\r\n * @fires Phaser.Tweens.Events#TWEEN_YOYO\r\n * @since 3.60.0\r\n *\r\n * @param {number} diff - Any extra time that needs to be accounted for in the elapsed and progress values.\r\n * @param {boolean} setStart - Set the TweenData start values?\r\n * @param {boolean} isYoyo - Is this call a Yoyo check?\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 569, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that handles repeating or yoyo'ing this TweenData.\r\rCalled automatically by `setStateFromStart` and `setStateFromEnd`.", "kind": "function", "name": "onRepeat", "fires": [ "Phaser.Tweens.Events#event:TWEEN_REPEAT", "Phaser.Tweens.Events#event:TWEEN_YOYO" ], "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Any extra time that needs to be accounted for in the elapsed and progress values.", "name": "diff" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set the TweenData start values?", "name": "setStart" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this call a Yoyo check?", "name": "isYoyo" } ], "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#onRepeat", "scope": "instance", "___id": "T000002R044310", "___s": true }, { "comment": "/**\r\n * Immediately destroys this TweenData, nulling of all its references.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 652, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Immediately destroys this TweenData, nulling of all its references.", "kind": "function", "name": "destroy", "since": "3.60.0", "memberof": "Phaser.Tweens.BaseTweenData", "longname": "Phaser.Tweens.BaseTweenData#destroy", "scope": "instance", "___id": "T000002R044325", "___s": true }, { "comment": "/**\r\n * Phaser Tween States.\r\n *\r\n * @namespace Phaser.Tweens.States\r\n * @memberof Phaser.Tweens\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Phaser Tween States.", "kind": "namespace", "name": "States", "memberof": "Phaser.Tweens", "since": "3.60.0", "longname": "Phaser.Tweens.States", "scope": "static", "___id": "T000002R044330", "___s": true }, { "comment": "/**\r\n * Phaser Tween state constants.\r\n *\r\n * @typedef {Phaser.Tweens.States} Phaser.Tweens.StateType\r\n * @memberof Phaser.Tweens\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Phaser Tween state constants.", "kind": "typedef", "name": "StateType", "type": { "names": [ "Phaser.Tweens.States" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.States" } }, "memberof": "Phaser.Tweens", "since": "3.60.0", "longname": "Phaser.Tweens.StateType", "scope": "static", "___id": "T000002R044331", "___s": true }, { "comment": "/**\r\n * TweenData state.\r\n *\r\n * @name Phaser.Tweens.States.CREATED\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 25, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "TweenData state.", "name": "CREATED", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.CREATED", "scope": "static", "___id": "T000002R044333", "___s": true }, { "comment": "/**\r\n * TweenData state.\r\n *\r\n * @name Phaser.Tweens.States.DELAY\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 37, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "TweenData state.", "name": "DELAY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.DELAY", "scope": "static", "___id": "T000002R044335", "___s": true }, { "comment": "/**\r\n * TweenData state.\r\n *\r\n * @name Phaser.Tweens.States.PENDING_RENDER\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "TweenData state.", "name": "PENDING_RENDER", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.PENDING_RENDER", "scope": "static", "___id": "T000002R044337", "___s": true }, { "comment": "/**\r\n * TweenData state.\r\n *\r\n * @name Phaser.Tweens.States.PLAYING_FORWARD\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 59, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "TweenData state.", "name": "PLAYING_FORWARD", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.PLAYING_FORWARD", "scope": "static", "___id": "T000002R044339", "___s": true }, { "comment": "/**\r\n * TweenData state.\r\n *\r\n * @name Phaser.Tweens.States.PLAYING_BACKWARD\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 69, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "TweenData state.", "name": "PLAYING_BACKWARD", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.PLAYING_BACKWARD", "scope": "static", "___id": "T000002R044341", "___s": true }, { "comment": "/**\r\n * TweenData state.\r\n *\r\n * @name Phaser.Tweens.States.HOLD_DELAY\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "TweenData state.", "name": "HOLD_DELAY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.HOLD_DELAY", "scope": "static", "___id": "T000002R044343", "___s": true }, { "comment": "/**\r\n * TweenData state.\r\n *\r\n * @name Phaser.Tweens.States.REPEAT_DELAY\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 89, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "TweenData state.", "name": "REPEAT_DELAY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.REPEAT_DELAY", "scope": "static", "___id": "T000002R044345", "___s": true }, { "comment": "/**\r\n * TweenData state.\r\n *\r\n * @name Phaser.Tweens.States.COMPLETE\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 99, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "TweenData state.", "name": "COMPLETE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.COMPLETE", "scope": "static", "___id": "T000002R044347", "___s": true }, { "comment": "/**\r\n * Tween state. The Tween has been created but has not yet been added to the Tween Manager.\r\n *\r\n * @name Phaser.Tweens.States.PENDING\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 111, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Tween state. The Tween has been created but has not yet been added to the Tween Manager.", "name": "PENDING", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.PENDING", "scope": "static", "___id": "T000002R044349", "___s": true }, { "comment": "/**\r\n * Tween state. The Tween is active within the Tween Manager. This means it is either playing,\r\n * or was playing and is currently paused, but in both cases it's still being processed by\r\n * the Tween Manager, so is considered 'active'.\r\n *\r\n * @name Phaser.Tweens.States.ACTIVE\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 121, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Tween state. The Tween is active within the Tween Manager. This means it is either playing,\ror was playing and is currently paused, but in both cases it's still being processed by\rthe Tween Manager, so is considered 'active'.", "name": "ACTIVE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.ACTIVE", "scope": "static", "___id": "T000002R044351", "___s": true }, { "comment": "/**\r\n * Tween state. The Tween is waiting for a loop countdown to elapse.\r\n *\r\n * @name Phaser.Tweens.States.LOOP_DELAY\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 133, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Tween state. The Tween is waiting for a loop countdown to elapse.", "name": "LOOP_DELAY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.LOOP_DELAY", "scope": "static", "___id": "T000002R044353", "___s": true }, { "comment": "/**\r\n * Tween state. The Tween is waiting for a complete delay to elapse.\r\n *\r\n * @name Phaser.Tweens.States.COMPLETE_DELAY\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 143, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Tween state. The Tween is waiting for a complete delay to elapse.", "name": "COMPLETE_DELAY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.COMPLETE_DELAY", "scope": "static", "___id": "T000002R044355", "___s": true }, { "comment": "/**\r\n * Tween state. The Tween is waiting for a starting delay to elapse.\r\n *\r\n * @name Phaser.Tweens.States.START_DELAY\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 153, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Tween state. The Tween is waiting for a starting delay to elapse.", "name": "START_DELAY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.START_DELAY", "scope": "static", "___id": "T000002R044357", "___s": true }, { "comment": "/**\r\n * Tween state. The Tween has finished playback and is waiting to be removed from the Tween Manager.\r\n *\r\n * @name Phaser.Tweens.States.PENDING_REMOVE\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 163, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Tween state. The Tween has finished playback and is waiting to be removed from the Tween Manager.", "name": "PENDING_REMOVE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.PENDING_REMOVE", "scope": "static", "___id": "T000002R044359", "___s": true }, { "comment": "/**\r\n * Tween state. The Tween has been removed from the Tween Manager.\r\n *\r\n * @name Phaser.Tweens.States.REMOVED\r\n * @type {number}\r\n * @const\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 173, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Tween state. The Tween has been removed from the Tween Manager.", "name": "REMOVED", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.0.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.REMOVED", "scope": "static", "___id": "T000002R044361", "___s": true }, { "comment": "/**\r\n * Tween state. The Tween has finished playback but was flagged as 'persistent' during creation,\r\n * so will not be automatically removed by the Tween Manager.\r\n *\r\n * @name Phaser.Tweens.States.FINISHED\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Tween state. The Tween has finished playback but was flagged as 'persistent' during creation,\rso will not be automatically removed by the Tween Manager.", "name": "FINISHED", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.FINISHED", "scope": "static", "___id": "T000002R044363", "___s": true }, { "comment": "/**\r\n * Tween state. The Tween has been destroyed and can no longer be played by a Tween Manager.\r\n *\r\n * @name Phaser.Tweens.States.DESTROYED\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 194, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Tween state. The Tween has been destroyed and can no longer be played by a Tween Manager.", "name": "DESTROYED", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.DESTROYED", "scope": "static", "___id": "T000002R044365", "___s": true }, { "comment": "/**\r\n * A large integer value used for 'infinite' style countdowns.\r\n *\r\n * Similar use-case to Number.MAX_SAFE_INTEGER but we cannot use that because it's not\r\n * supported on IE.\r\n *\r\n * @name Phaser.Tweens.States.MAX\r\n * @type {number}\r\n * @const\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 204, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "A large integer value used for 'infinite' style countdowns.\r\rSimilar use-case to Number.MAX_SAFE_INTEGER but we cannot use that because it's not\rsupported on IE.", "name": "MAX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.60.0", "memberof": "Phaser.Tweens.States", "longname": "Phaser.Tweens.States.MAX", "scope": "static", "___id": "T000002R044367", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tweens.TweenConfigDefaults\r\n * @since 3.0.0\r\n *\r\n * @property {(object|object[])} targets - The object, or an array of objects, to run the tween on.\r\n * @property {number} [delay=0] - The number of milliseconds to delay before the tween will start.\r\n * @property {number} [duration=1000] - The duration of the tween in milliseconds.\r\n * @property {string} [ease='Power0'] - The easing equation to use for the tween.\r\n * @property {array} [easeParams] - Optional easing parameters.\r\n * @property {number} [hold=0] - The number of milliseconds to hold the tween for before yoyo'ing.\r\n * @property {number} [repeat=0] - The number of times to repeat the tween.\r\n * @property {number} [repeatDelay=0] - The number of milliseconds to pause before a tween will repeat.\r\n * @property {boolean} [yoyo=false] - Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take `duration` milliseconds to complete.\r\n * @property {boolean} [flipX=false] - Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipX` property.\r\n * @property {boolean} [flipY=false] - Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipY` property.\r\n * @property {boolean} [persist=false] - Retain the tween within the Tween Manager, even after playback completes?\r\n * @property {function} [interpolation=null] - The interpolation function to use for array-based tween values.\r\n */", "meta": { "filename": "Defaults.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "kind": "typedef", "name": "TweenConfigDefaults", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "object", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } ] } }, "description": "The object, or an array of objects, to run the tween on.", "name": "targets" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of milliseconds to delay before the tween will start.", "name": "delay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration of the tween in milliseconds.", "name": "duration" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'Power0'", "description": "The easing equation to use for the tween.", "name": "ease" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Optional easing parameters.", "name": "easeParams" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of milliseconds to hold the tween for before yoyo'ing.", "name": "hold" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of times to repeat the tween.", "name": "repeat" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of milliseconds to pause before a tween will repeat.", "name": "repeatDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take `duration` milliseconds to complete.", "name": "yoyo" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipX` property.", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipY` property.", "name": "flipY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Retain the tween within the Tween Manager, even after playback completes?", "name": "persist" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "defaultvalue": null, "description": "The interpolation function to use for array-based tween values.", "name": "interpolation" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenConfigDefaults", "scope": "static", "___id": "T000002R044370", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Tween is able to manipulate the properties of one or more objects to any given value, based\r\n * on a duration and type of ease. They are rarely instantiated directly and instead should be\r\n * created via the TweenManager.\r\n *\r\n * Please note that a Tween will not manipulate any property that begins with an underscore.\r\n *\r\n * @class Tween\r\n * @memberof Phaser.Tweens\r\n * @extends Phaser.Tweens.BaseTween\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Tweens.TweenManager} parent - A reference to the Tween Manager that owns this Tween.\r\n * @param {object[]} targets - An array of targets to be tweened.\r\n */", "meta": { "filename": "Tween.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "classdesc": "A Tween is able to manipulate the properties of one or more objects to any given value, based\ron a duration and type of ease. They are rarely instantiated directly and instead should be\rcreated via the TweenManager.\r\rPlease note that a Tween will not manipulate any property that begins with an underscore.", "kind": "class", "name": "Tween", "memberof": "Phaser.Tweens", "augments": [ "Phaser.Tweens.BaseTween" ], "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Tweens.TweenManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.TweenManager" } }, "description": "A reference to the Tween Manager that owns this Tween.", "name": "parent" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } }, "description": "An array of targets to be tweened.", "name": "targets" } ], "scope": "static", "longname": "Phaser.Tweens.Tween", "___id": "T000002R044396", "___s": true }, { "comment": "/**\r\n * An array of references to the target/s this Tween is operating on.\r\n *\r\n * This array should not be manipulated outside of this Tween.\r\n *\r\n * @name Phaser.Tweens.Tween#targets\r\n * @type {object[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tween.js", "lineno": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "An array of references to the target/s this Tween is operating on.\r\rThis array should not be manipulated outside of this Tween.", "name": "targets", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#targets", "scope": "instance", "kind": "member", "___id": "T000002R044400", "___s": true }, { "comment": "/**\r\n * Cached target total.\r\n *\r\n * Used internally and should be treated as read-only.\r\n *\r\n * This is not necessarily the same as the data total.\r\n *\r\n * @name Phaser.Tweens.Tween#totalTargets\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tween.js", "lineno": 55, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Cached target total.\r\rUsed internally and should be treated as read-only.\r\rThis is not necessarily the same as the data total.", "name": "totalTargets", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#totalTargets", "scope": "instance", "kind": "member", "___id": "T000002R044402", "___s": true }, { "comment": "/**\r\n * Is this Tween currently seeking?\r\n *\r\n * This boolean is toggled in the `Tween.seek` method.\r\n *\r\n * When a tween is seeking, by default it will not dispatch any events or callbacks.\r\n *\r\n * @name Phaser.Tweens.Tween#isSeeking\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.19.0\r\n */", "meta": { "filename": "Tween.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Is this Tween currently seeking?\r\rThis boolean is toggled in the `Tween.seek` method.\r\rWhen a tween is seeking, by default it will not dispatch any events or callbacks.", "name": "isSeeking", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.19.0", "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#isSeeking", "scope": "instance", "kind": "member", "___id": "T000002R044404", "___s": true }, { "comment": "/**\r\n * Does this Tween loop or repeat infinitely?\r\n *\r\n * @name Phaser.Tweens.Tween#isInfinite\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Tween.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Does this Tween loop or repeat infinitely?", "name": "isInfinite", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#isInfinite", "scope": "instance", "kind": "member", "___id": "T000002R044406", "___s": true }, { "comment": "/**\r\n * Elapsed time in milliseconds of this run through of the Tween.\r\n *\r\n * @name Phaser.Tweens.Tween#elapsed\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Tween.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Elapsed time in milliseconds of this run through of the Tween.", "name": "elapsed", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#elapsed", "scope": "instance", "kind": "member", "___id": "T000002R044408", "___s": true }, { "comment": "/**\r\n * Total elapsed time in milliseconds of the entire Tween, including looping.\r\n *\r\n * @name Phaser.Tweens.Tween#totalElapsed\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Tween.js", "lineno": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Total elapsed time in milliseconds of the entire Tween, including looping.", "name": "totalElapsed", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#totalElapsed", "scope": "instance", "kind": "member", "___id": "T000002R044410", "___s": true }, { "comment": "/**\r\n * Time in milliseconds for the whole Tween to play through once, excluding loop amounts and loop delays.\r\n *\r\n * This value is set in the `Tween.initTweenData` method and is zero before that point.\r\n *\r\n * @name Phaser.Tweens.Tween#duration\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Tween.js", "lineno": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Time in milliseconds for the whole Tween to play through once, excluding loop amounts and loop delays.\r\rThis value is set in the `Tween.initTweenData` method and is zero before that point.", "name": "duration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#duration", "scope": "instance", "kind": "member", "___id": "T000002R044412", "___s": true }, { "comment": "/**\r\n * Value between 0 and 1. The amount of progress through the Tween, excluding loops.\r\n *\r\n * @name Phaser.Tweens.Tween#progress\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Tween.js", "lineno": 124, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Value between 0 and 1. The amount of progress through the Tween, excluding loops.", "name": "progress", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#progress", "scope": "instance", "kind": "member", "___id": "T000002R044414", "___s": true }, { "comment": "/**\r\n * Time in milliseconds it takes for the Tween to complete a full playthrough (including looping)\r\n *\r\n * For an infinite Tween, this value is a very large integer.\r\n *\r\n * @name Phaser.Tweens.Tween#totalDuration\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Tween.js", "lineno": 134, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Time in milliseconds it takes for the Tween to complete a full playthrough (including looping)\r\rFor an infinite Tween, this value is a very large integer.", "name": "totalDuration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#totalDuration", "scope": "instance", "kind": "member", "___id": "T000002R044416", "___s": true }, { "comment": "/**\r\n * The amount of progress that has been made through the entire Tween, including looping.\r\n *\r\n * A value between 0 and 1.\r\n *\r\n * @name Phaser.Tweens.Tween#totalProgress\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Tween.js", "lineno": 146, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The amount of progress that has been made through the entire Tween, including looping.\r\rA value between 0 and 1.", "name": "totalProgress", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#totalProgress", "scope": "instance", "kind": "member", "___id": "T000002R044418", "___s": true }, { "comment": "/**\r\n * Adds a new TweenData to this Tween. Typically, this method is called\r\n * automatically by the TweenBuilder, however you can also invoke it\r\n * yourself.\r\n *\r\n * @method Phaser.Tweens.Tween#add\r\n * @since 3.60.0\r\n *\r\n * @param {number} targetIndex - The target index within the Tween targets array.\r\n * @param {string} key - The property of the target to tween.\r\n * @param {Phaser.Types.Tweens.GetEndCallback} getEnd - What the property will be at the END of the Tween.\r\n * @param {Phaser.Types.Tweens.GetStartCallback} getStart - What the property will be at the START of the Tween.\r\n * @param {?Phaser.Types.Tweens.GetActiveCallback} getActive - If not null, is invoked _immediately_ as soon as the TweenData is running, and is set on the target property.\r\n * @param {function} ease - The ease function this tween uses.\r\n * @param {function} delay - Function that returns the time in milliseconds before tween will start.\r\n * @param {number} duration - The duration of the tween in milliseconds.\r\n * @param {boolean} yoyo - Determines whether the tween should return back to its start value after hold has expired.\r\n * @param {number} hold - Function that returns the time in milliseconds the tween will pause before repeating or returning to its starting value if yoyo is set to true.\r\n * @param {number} repeat - Function that returns the number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.\r\n * @param {number} repeatDelay - Function that returns the time in milliseconds before the repeat will start.\r\n * @param {boolean} flipX - Should toggleFlipX be called when yoyo or repeat happens?\r\n * @param {boolean} flipY - Should toggleFlipY be called when yoyo or repeat happens?\r\n * @param {?function} interpolation - The interpolation function to be used for arrays of data. Defaults to 'null'.\r\n * @param {?number[]} interpolationData - The array of interpolation data to be set. Defaults to 'null'.\r\n *\r\n * @return {Phaser.Tweens.TweenData} The TweenData instance that was added.\r\n */", "meta": { "filename": "Tween.js", "lineno": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Adds a new TweenData to this Tween. Typically, this method is called\rautomatically by the TweenBuilder, however you can also invoke it\ryourself.", "kind": "function", "name": "add", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The target index within the Tween targets array.", "name": "targetIndex" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property of the target to tween.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Tweens.GetEndCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetEndCallback" } }, "description": "What the property will be at the END of the Tween.", "name": "getEnd" }, { "type": { "names": [ "Phaser.Types.Tweens.GetStartCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetStartCallback" } }, "description": "What the property will be at the START of the Tween.", "name": "getStart" }, { "type": { "names": [ "Phaser.Types.Tweens.GetActiveCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetActiveCallback", "nullable": true } }, "nullable": true, "description": "If not null, is invoked _immediately_ as soon as the TweenData is running, and is set on the target property.", "name": "getActive" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The ease function this tween uses.", "name": "ease" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "Function that returns the time in milliseconds before tween will start.", "name": "delay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the tween in milliseconds.", "name": "duration" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Determines whether the tween should return back to its start value after hold has expired.", "name": "yoyo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Function that returns the time in milliseconds the tween will pause before repeating or returning to its starting value if yoyo is set to true.", "name": "hold" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Function that returns the number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.", "name": "repeat" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Function that returns the time in milliseconds before the repeat will start.", "name": "repeatDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should toggleFlipX be called when yoyo or repeat happens?", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should toggleFlipY be called when yoyo or repeat happens?", "name": "flipY" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [], "nullable": true } }, "nullable": true, "description": "The interpolation function to be used for arrays of data. Defaults to 'null'.", "name": "interpolation" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ], "nullable": true } }, "nullable": true, "description": "The array of interpolation data to be set. Defaults to 'null'.", "name": "interpolationData" } ], "returns": [ { "type": { "names": [ "Phaser.Tweens.TweenData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.TweenData" } }, "description": "The TweenData instance that was added." } ], "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#add", "scope": "instance", "___id": "T000002R044420", "___s": true }, { "comment": "/**\r\n * Adds a new TweenFrameData to this Tween. Typically, this method is called\r\n * automatically by the TweenBuilder, however you can also invoke it\r\n * yourself.\r\n *\r\n * @method Phaser.Tweens.Tween#addFrame\r\n * @since 3.60.0\r\n *\r\n * @param {number} targetIndex - The target index within the Tween targets array.\r\n * @param {string} texture - The texture to set on the target at the end of the tween.\r\n * @param {string|number} frame - The texture frame to set on the target at the end of the tween.\r\n * @param {function} delay - Function that returns the time in milliseconds before tween will start.\r\n * @param {number} duration - The duration of the tween in milliseconds.\r\n * @param {number} hold - Function that returns the time in milliseconds the tween will pause before repeating or returning to its starting value if yoyo is set to true.\r\n * @param {number} repeat - Function that returns the number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.\r\n * @param {number} repeatDelay - Function that returns the time in milliseconds before the repeat will start.\r\n * @param {boolean} flipX - Should toggleFlipX be called when yoyo or repeat happens?\r\n * @param {boolean} flipY - Should toggleFlipY be called when yoyo or repeat happens?\r\n *\r\n * @return {Phaser.Tweens.TweenFrameData} The TweenFrameData instance that was added.\r\n */", "meta": { "filename": "Tween.js", "lineno": 195, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Adds a new TweenFrameData to this Tween. Typically, this method is called\rautomatically by the TweenBuilder, however you can also invoke it\ryourself.", "kind": "function", "name": "addFrame", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The target index within the Tween targets array.", "name": "targetIndex" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The texture to set on the target at the end of the tween.", "name": "texture" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "The texture frame to set on the target at the end of the tween.", "name": "frame" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "Function that returns the time in milliseconds before tween will start.", "name": "delay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the tween in milliseconds.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Function that returns the time in milliseconds the tween will pause before repeating or returning to its starting value if yoyo is set to true.", "name": "hold" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Function that returns the number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.", "name": "repeat" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Function that returns the time in milliseconds before the repeat will start.", "name": "repeatDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should toggleFlipX be called when yoyo or repeat happens?", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should toggleFlipY be called when yoyo or repeat happens?", "name": "flipY" } ], "returns": [ { "type": { "names": [ "Phaser.Tweens.TweenFrameData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.TweenFrameData" } }, "description": "The TweenFrameData instance that was added." } ], "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#addFrame", "scope": "instance", "___id": "T000002R044424", "___s": true }, { "comment": "/**\r\n * Returns the current value of the specified Tween Data.\r\n *\r\n * If this Tween has been destroyed, it will return `null`.\r\n *\r\n * @method Phaser.Tweens.Tween#getValue\r\n * @since 3.0.0\r\n *\r\n * @param {number} [index=0] - The Tween Data to return the value from.\r\n *\r\n * @return {number} The value of the requested Tween Data, or `null` if this Tween has been destroyed.\r\n */", "meta": { "filename": "Tween.js", "lineno": 225, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Returns the current value of the specified Tween Data.\r\rIf this Tween has been destroyed, it will return `null`.", "kind": "function", "name": "getValue", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The Tween Data to return the value from.", "name": "index" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value of the requested Tween Data, or `null` if this Tween has been destroyed." } ], "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#getValue", "scope": "instance", "___id": "T000002R044428", "___s": true }, { "comment": "/**\r\n * See if this Tween is currently acting upon the given target.\r\n *\r\n * @method Phaser.Tweens.Tween#hasTarget\r\n * @since 3.0.0\r\n *\r\n * @param {object} target - The target to check against this Tween.\r\n *\r\n * @return {boolean} `true` if the given target is a target of this Tween, otherwise `false`.\r\n */", "meta": { "filename": "Tween.js", "lineno": 251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "See if this Tween is currently acting upon the given target.", "kind": "function", "name": "hasTarget", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The target to check against this Tween.", "name": "target" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given target is a target of this Tween, otherwise `false`." } ], "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#hasTarget", "scope": "instance", "___id": "T000002R044433", "___s": true }, { "comment": "/**\r\n * Updates the 'end' value of the given property across all matching targets, as long\r\n * as this Tween is currently playing (either forwards or backwards).\r\n *\r\n * Calling this does not adjust the duration of the Tween, or the current progress.\r\n *\r\n * You can optionally tell it to set the 'start' value to be the current value.\r\n *\r\n * If this Tween is in any other state other than playing then calling this method has no effect.\r\n *\r\n * Additionally, if the Tween repeats, is reset, or is seeked, it will revert to the original\r\n * starting and ending values.\r\n *\r\n * @method Phaser.Tweens.Tween#updateTo\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The property to set the new value for. You cannot update the 'texture' property via this method.\r\n * @param {number} value - The new value of the property.\r\n * @param {boolean} [startToCurrent=false] - Should this change set the start value to be the current value?\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "Tween.js", "lineno": 266, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Updates the 'end' value of the given property across all matching targets, as long\ras this Tween is currently playing (either forwards or backwards).\r\rCalling this does not adjust the duration of the Tween, or the current progress.\r\rYou can optionally tell it to set the 'start' value to be the current value.\r\rIf this Tween is in any other state other than playing then calling this method has no effect.\r\rAdditionally, if the Tween repeats, is reset, or is seeked, it will revert to the original\rstarting and ending values.", "kind": "function", "name": "updateTo", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property to set the new value for. You cannot update the 'texture' property via this method.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the property.", "name": "value" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should this change set the start value to be the current value?", "name": "startToCurrent" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#updateTo", "scope": "instance", "___id": "T000002R044435", "___s": true }, { "comment": "/**\r\n * Restarts the Tween from the beginning.\r\n *\r\n * If the Tween has already finished and been destroyed, restarting it will throw an error.\r\n *\r\n * If you wish to restart the Tween from a specific point, use the `Tween.seek` method instead.\r\n *\r\n * @method Phaser.Tweens.Tween#restart\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "Tween.js", "lineno": 313, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Restarts the Tween from the beginning.\r\rIf the Tween has already finished and been destroyed, restarting it will throw an error.\r\rIf you wish to restart the Tween from a specific point, use the `Tween.seek` method instead.", "kind": "function", "name": "restart", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#restart", "scope": "instance", "___id": "T000002R044442", "___s": true }, { "comment": "/**\r\n * Internal method that advances to the next state of the Tween during playback.\r\n *\r\n * @method Phaser.Tweens.Tween#nextState\r\n * @fires Phaser.Tweens.Events#TWEEN_COMPLETE\r\n * @fires Phaser.Tweens.Events#TWEEN_LOOP\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if this Tween has completed, otherwise `false`.\r\n */", "meta": { "filename": "Tween.js", "lineno": 355, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that advances to the next state of the Tween during playback.", "kind": "function", "name": "nextState", "fires": [ "Phaser.Tweens.Events#event:TWEEN_COMPLETE", "Phaser.Tweens.Events#event:TWEEN_LOOP" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has completed, otherwise `false`." } ], "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#nextState", "scope": "instance", "___id": "T000002R044446", "___s": true }, { "comment": "/**\r\n * Internal method that handles this tween completing and starting\r\n * the next tween in the chain, if any.\r\n *\r\n * @method Phaser.Tweens.Tween#onCompleteHandler\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Tween.js", "lineno": 404, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that handles this tween completing and starting\rthe next tween in the chain, if any.", "kind": "function", "name": "onCompleteHandler", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#onCompleteHandler", "scope": "instance", "overrides": "Phaser.Tweens.BaseTween#onCompleteHandler", "___id": "T000002R044452", "___s": true }, { "comment": "/**\r\n * Starts a Tween playing.\r\n *\r\n * You only need to call this method if you have configured the tween to be paused on creation.\r\n *\r\n * If the Tween is already playing, calling this method again will have no effect. If you wish to\r\n * restart the Tween, use `Tween.restart` instead.\r\n *\r\n * Calling this method after the Tween has completed will start the Tween playing again from the beginning.\r\n * This is the same as calling `Tween.seek(0)` and then `Tween.play()`.\r\n *\r\n * @method Phaser.Tweens.Tween#play\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "Tween.js", "lineno": 419, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Starts a Tween playing.\r\rYou only need to call this method if you have configured the tween to be paused on creation.\r\rIf the Tween is already playing, calling this method again will have no effect. If you wish to\rrestart the Tween, use `Tween.restart` instead.\r\rCalling this method after the Tween has completed will start the Tween playing again from the beginning.\rThis is the same as calling `Tween.seek(0)` and then `Tween.play()`.", "kind": "function", "name": "play", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#play", "scope": "instance", "___id": "T000002R044456", "___s": true }, { "comment": "/**\r\n * Seeks to a specific point in the Tween.\r\n *\r\n * The given amount is a value in milliseconds that represents how far into the Tween\r\n * you wish to seek, based on the start of the Tween.\r\n *\r\n * Note that the seek amount takes the entire duration of the Tween into account, including delays, loops and repeats.\r\n * For example, a Tween that lasts for 2 seconds, but that loops 3 times, would have a total duration of 6 seconds,\r\n * so seeking to 3000 ms would seek to the Tweens half-way point based on its _entire_ duration.\r\n *\r\n * Prior to Phaser 3.60 this value was given as a number between 0 and 1 and didn't\r\n * work for Tweens had an infinite repeat. This new method works for all Tweens.\r\n *\r\n * Seeking works by resetting the Tween to its initial values and then iterating through the Tween at `delta`\r\n * jumps per step. The longer the Tween, the longer this can take. If you need more precision you can\r\n * reduce the delta value. If you need a faster seek, you can increase it. When the Tween is\r\n * reset it will refresh the starting and ending values. If these are coming from a dynamic function,\r\n * or a random array, it will be called for each seek.\r\n *\r\n * While seeking the Tween will _not_ emit any of its events or callbacks unless\r\n * the 3rd parameter is set to `true`.\r\n *\r\n * If this Tween is paused, seeking will not change this fact. It will advance the Tween\r\n * to the desired point and then pause it again.\r\n *\r\n * @method Phaser.Tweens.Tween#seek\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - The number of milliseconds to seek into the Tween from the beginning.\r\n * @param {number} [delta=16.6] - The size of each step when seeking through the Tween. A higher value completes faster but at the cost of less precision.\r\n * @param {boolean} [emit=false] - While seeking, should the Tween emit any of its events or callbacks? The default is 'false', i.e. to seek silently.\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "Tween.js", "lineno": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Seeks to a specific point in the Tween.\r\rThe given amount is a value in milliseconds that represents how far into the Tween\ryou wish to seek, based on the start of the Tween.\r\rNote that the seek amount takes the entire duration of the Tween into account, including delays, loops and repeats.\rFor example, a Tween that lasts for 2 seconds, but that loops 3 times, would have a total duration of 6 seconds,\rso seeking to 3000 ms would seek to the Tweens half-way point based on its _entire_ duration.\r\rPrior to Phaser 3.60 this value was given as a number between 0 and 1 and didn't\rwork for Tweens had an infinite repeat. This new method works for all Tweens.\r\rSeeking works by resetting the Tween to its initial values and then iterating through the Tween at `delta`\rjumps per step. The longer the Tween, the longer this can take. If you need more precision you can\rreduce the delta value. If you need a faster seek, you can increase it. When the Tween is\rreset it will refresh the starting and ending values. If these are coming from a dynamic function,\ror a random array, it will be called for each seek.\r\rWhile seeking the Tween will _not_ emit any of its events or callbacks unless\rthe 3rd parameter is set to `true`.\r\rIf this Tween is paused, seeking will not change this fact. It will advance the Tween\rto the desired point and then pause it again.", "kind": "function", "name": "seek", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of milliseconds to seek into the Tween from the beginning.", "name": "amount" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 16.6, "description": "The size of each step when seeking through the Tween. A higher value completes faster but at the cost of less precision.", "name": "delta" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "While seeking, should the Tween emit any of its events or callbacks? The default is 'false', i.e. to seek silently.", "name": "emit" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#seek", "scope": "instance", "___id": "T000002R044459", "___s": true }, { "comment": "/**\r\n * Initialises all of the Tween Data and Tween values.\r\n *\r\n * This is called automatically and should not typically be invoked directly.\r\n *\r\n * @method Phaser.Tweens.Tween#initTweenData\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [isSeeking=false] - Is the Tween Data being reset as part of a seek?\r\n */", "meta": { "filename": "Tween.js", "lineno": 543, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Initialises all of the Tween Data and Tween values.\r\rThis is called automatically and should not typically be invoked directly.", "kind": "function", "name": "initTweenData", "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is the Tween Data being reset as part of a seek?", "name": "isSeeking" } ], "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#initTweenData", "scope": "instance", "___id": "T000002R044472", "___s": true }, { "comment": "/**\r\n * Resets this Tween ready for another play-through.\r\n *\r\n * This is called automatically from the Tween Manager, or from the parent TweenChain,\r\n * and should not typically be invoked directly.\r\n *\r\n * If you wish to restart this Tween, use the `Tween.restart` or `Tween.seek` methods instead.\r\n *\r\n * @method Phaser.Tweens.Tween#reset\r\n * @fires Phaser.Tweens.Events#TWEEN_ACTIVE\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [skipInit=false] - Skip resetting the TweenData and Active State?\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "Tween.js", "lineno": 586, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Resets this Tween ready for another play-through.\r\rThis is called automatically from the Tween Manager, or from the parent TweenChain,\rand should not typically be invoked directly.\r\rIf you wish to restart this Tween, use the `Tween.restart` or `Tween.seek` methods instead.", "kind": "function", "name": "reset", "fires": [ "Phaser.Tweens.Events#event:TWEEN_ACTIVE" ], "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip resetting the TweenData and Active State?", "name": "skipInit" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#reset", "scope": "instance", "___id": "T000002R044486", "___s": true }, { "comment": "/**\r\n * Internal method that advances the Tween based on the time values.\r\n *\r\n * @method Phaser.Tweens.Tween#update\r\n * @fires Phaser.Tweens.Events#TWEEN_COMPLETE\r\n * @fires Phaser.Tweens.Events#TWEEN_LOOP\r\n * @fires Phaser.Tweens.Events#TWEEN_START\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 *\r\n * @return {boolean} Returns `true` if this Tween has finished and should be removed from the Tween Manager, otherwise returns `false`.\r\n */", "meta": { "filename": "Tween.js", "lineno": 630, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that advances the Tween based on the time values.", "kind": "function", "name": "update", "fires": [ "Phaser.Tweens.Events#event:TWEEN_COMPLETE", "Phaser.Tweens.Events#event:TWEEN_LOOP", "Phaser.Tweens.Events#event:TWEEN_START" ], "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "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": "Returns `true` if this Tween has finished and should be removed from the Tween Manager, otherwise returns `false`." } ], "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#update", "scope": "instance", "___id": "T000002R044496", "___s": true }, { "comment": "/**\r\n * Moves this Tween forward by the given amount of milliseconds.\r\n *\r\n * It will only advance through the current loop of the Tween. For example, if the\r\n * Tween is set to repeat or yoyo, it can only fast forward through a single\r\n * section of the sequence. Use `Tween.seek` for more complex playhead control.\r\n *\r\n * If the Tween is paused or has already finished, calling this will have no effect.\r\n *\r\n * @method Phaser.Tweens.Tween#forward\r\n * @since 3.60.0\r\n *\r\n * @param {number} ms - The number of milliseconds to advance this Tween by.\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "Tween.js", "lineno": 724, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Moves this Tween forward by the given amount of milliseconds.\r\rIt will only advance through the current loop of the Tween. For example, if the\rTween is set to repeat or yoyo, it can only fast forward through a single\rsection of the sequence. Use `Tween.seek` for more complex playhead control.\r\rIf the Tween is paused or has already finished, calling this will have no effect.", "kind": "function", "name": "forward", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of milliseconds to advance this Tween by.", "name": "ms" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#forward", "scope": "instance", "___id": "T000002R044512", "___s": true }, { "comment": "/**\r\n * Moves this Tween backward by the given amount of milliseconds.\r\n *\r\n * It will only rewind through the current loop of the Tween. For example, if the\r\n * Tween is set to repeat or yoyo, it can only fast forward through a single\r\n * section of the sequence. Use `Tween.seek` for more complex playhead control.\r\n *\r\n * If the Tween is paused or has already finished, calling this will have no effect.\r\n *\r\n * @method Phaser.Tweens.Tween#rewind\r\n * @since 3.60.0\r\n *\r\n * @param {number} ms - The number of milliseconds to rewind this Tween by.\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "Tween.js", "lineno": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Moves this Tween backward by the given amount of milliseconds.\r\rIt will only rewind through the current loop of the Tween. For example, if the\rTween is set to repeat or yoyo, it can only fast forward through a single\rsection of the sequence. Use `Tween.seek` for more complex playhead control.\r\rIf the Tween is paused or has already finished, calling this will have no effect.", "kind": "function", "name": "rewind", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of milliseconds to rewind this Tween by.", "name": "ms" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#rewind", "scope": "instance", "___id": "T000002R044514", "___s": true }, { "comment": "/**\r\n * Internal method that will emit a Tween based Event and invoke the given callback.\r\n *\r\n * @method Phaser.Tweens.Tween#dispatchEvent\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Tweens.Event} event - The Event to be dispatched.\r\n * @param {Phaser.Types.Tweens.TweenCallbackTypes} [callback] - The name of the callback to be invoked. Can be `null` or `undefined` to skip invocation.\r\n */", "meta": { "filename": "Tween.js", "lineno": 770, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that will emit a Tween based Event and invoke the given callback.", "kind": "function", "name": "dispatchEvent", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.Tweens.Event" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.Event" } }, "description": "The Event to be dispatched.", "name": "event" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenCallbackTypes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenCallbackTypes" } }, "optional": true, "description": "The name of the callback to be invoked. Can be `null` or `undefined` to skip invocation.", "name": "callback" } ], "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#dispatchEvent", "scope": "instance", "___id": "T000002R044516", "___s": true }, { "comment": "/**\r\n * Handles the destroy process of this Tween, clearing out the\r\n * Tween Data and resetting the targets. A Tween that has been\r\n * destroyed cannot ever be played or used again.\r\n *\r\n * @method Phaser.Tweens.Tween#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Tween.js", "lineno": 794, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Handles the destroy process of this Tween, clearing out the\rTween Data and resetting the targets. A Tween that has been\rdestroyed cannot ever be played or used again.", "kind": "function", "name": "destroy", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "longname": "Phaser.Tweens.Tween#destroy", "scope": "instance", "overrides": "Phaser.Tweens.BaseTween#destroy", "___id": "T000002R044519", "___s": true }, { "comment": "/**\r\n * Creates a new Tween object.\r\n *\r\n * Note: This method will only be available if Tweens have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#tween\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Tweens.TweenBuilderConfig|Phaser.Types.Tweens.TweenChainBuilderConfig|Phaser.Tweens.Tween|Phaser.Tweens.TweenChain} config - A Tween Configuration object, or a Tween or TweenChain instance.\r\n *\r\n * @return {Phaser.Tweens.Tween} The Tween that was created.\r\n */", "meta": { "filename": "Tween.js", "lineno": 811, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Creates a new Tween object.\r\rNote: This method will only be available if Tweens have been built into Phaser.", "kind": "function", "name": "tween", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Tweens.TweenBuilderConfig", "Phaser.Types.Tweens.TweenChainBuilderConfig", "Phaser.Tweens.Tween", "Phaser.Tweens.TweenChain" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenBuilderConfig" }, { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenChainBuilderConfig" }, { "type": "NameExpression", "name": "Phaser.Tweens.Tween" }, { "type": "NameExpression", "name": "Phaser.Tweens.TweenChain" } ] } }, "description": "A Tween Configuration object, or a Tween or TweenChain instance.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The Tween that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#tween", "scope": "instance", "___id": "T000002R044522", "___s": true }, { "comment": "/**\r\n * Creates a new Tween object and returns it.\r\n *\r\n * Note: This method will only be available if Tweens have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#tween\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Tweens.TweenBuilderConfig|Phaser.Types.Tweens.TweenChainBuilderConfig|Phaser.Tweens.Tween|Phaser.Tweens.TweenChain} config - A Tween Configuration object, or a Tween or TweenChain instance.\r\n *\r\n * @return {Phaser.Tweens.Tween} The Tween that was created.\r\n */", "meta": { "filename": "Tween.js", "lineno": 828, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Creates a new Tween object and returns it.\r\rNote: This method will only be available if Tweens have been built into Phaser.", "kind": "function", "name": "tween", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Tweens.TweenBuilderConfig", "Phaser.Types.Tweens.TweenChainBuilderConfig", "Phaser.Tweens.Tween", "Phaser.Tweens.TweenChain" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenBuilderConfig" }, { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenChainBuilderConfig" }, { "type": "NameExpression", "name": "Phaser.Tweens.Tween" }, { "type": "NameExpression", "name": "Phaser.Tweens.TweenChain" } ] } }, "description": "A Tween Configuration object, or a Tween or TweenChain instance.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The Tween that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#tween", "scope": "instance", "___id": "T000002R044523", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A TweenChain is a special type of Tween that allows you to create a sequence of Tweens, chained to one-another,\r\n * and add them to the Tween Manager.\r\n *\r\n * The tweens are played in order, from start to finish. You can optionally set the chain\r\n * to repeat as many times as you like. Once the chain has finished playing, or repeating if set,\r\n * all tweens in the chain will be destroyed automatically. To override this, set the 'persist'\r\n * argument to 'true'.\r\n *\r\n * Playback will start immediately unless the _first_ Tween has been configured to be paused.\r\n *\r\n * Please note that Tweens will not manipulate any target property that begins with an underscore.\r\n *\r\n * @class TweenChain\r\n * @memberof Phaser.Tweens\r\n * @extends Phaser.Tweens.BaseTween\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {(Phaser.Tweens.TweenManager|Phaser.Tweens.TweenChain)} parent - A reference to the Tween Manager, or TweenChain, that owns this TweenChain.\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "classdesc": "A TweenChain is a special type of Tween that allows you to create a sequence of Tweens, chained to one-another,\rand add them to the Tween Manager.\r\rThe tweens are played in order, from start to finish. You can optionally set the chain\rto repeat as many times as you like. Once the chain has finished playing, or repeating if set,\rall tweens in the chain will be destroyed automatically. To override this, set the 'persist'\rargument to 'true'.\r\rPlayback will start immediately unless the _first_ Tween has been configured to be paused.\r\rPlease note that Tweens will not manipulate any target property that begins with an underscore.", "kind": "class", "name": "TweenChain", "memberof": "Phaser.Tweens", "augments": [ "Phaser.Tweens.BaseTween" ], "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Tweens.TweenManager", "Phaser.Tweens.TweenChain" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Tweens.TweenManager" }, { "type": "NameExpression", "name": "Phaser.Tweens.TweenChain" } ] } }, "description": "A reference to the Tween Manager, or TweenChain, that owns this TweenChain.", "name": "parent" } ], "scope": "static", "longname": "Phaser.Tweens.TweenChain", "___id": "T000002R044532", "___s": true }, { "comment": "/**\r\n * A reference to the Tween that this TweenChain is currently playing.\r\n *\r\n * @name Phaser.Tweens.TweenChain#currentTween\r\n * @type {Phaser.Tweens.Tween}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "A reference to the Tween that this TweenChain is currently playing.", "name": "currentTween", "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "longname": "Phaser.Tweens.TweenChain#currentTween", "scope": "instance", "kind": "member", "___id": "T000002R044536", "___s": true }, { "comment": "/**\r\n * A reference to the data array index of the currently playing tween.\r\n *\r\n * @name Phaser.Tweens.TweenChain#currentIndex\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 56, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "A reference to the data array index of the currently playing tween.", "name": "currentIndex", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "longname": "Phaser.Tweens.TweenChain#currentIndex", "scope": "instance", "kind": "member", "___id": "T000002R044538", "___s": true }, { "comment": "/**\r\n * Prepares this TweenChain for playback.\r\n *\r\n * Called automatically by the TweenManager. Should not be called directly.\r\n *\r\n * @method Phaser.Tweens.TweenChain#init\r\n * @fires Phaser.Tweens.Events#TWEEN_ACTIVE\r\n * @since 3.60.0\r\n *\r\n * @return {this} This TweenChain instance.\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Prepares this TweenChain for playback.\r\rCalled automatically by the TweenManager. Should not be called directly.", "kind": "function", "name": "init", "fires": [ "Phaser.Tweens.Events#event:TWEEN_ACTIVE" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TweenChain instance." } ], "memberof": "Phaser.Tweens.TweenChain", "longname": "Phaser.Tweens.TweenChain#init", "scope": "instance", "___id": "T000002R044540", "___s": true }, { "comment": "/**\r\n * Create a sequence of Tweens, chained to one-another, and add them to this Tween Manager.\r\n *\r\n * The tweens are played in order, from start to finish. You can optionally set the chain\r\n * to repeat as many times as you like. Once the chain has finished playing, or repeating if set,\r\n * all tweens in the chain will be destroyed automatically. To override this, set the 'persist'\r\n * argument to 'true'.\r\n *\r\n * Playback will start immediately unless the _first_ Tween has been configured to be paused.\r\n *\r\n * Please note that Tweens will not manipulate any target property that begins with an underscore.\r\n *\r\n * @method Phaser.Tweens.TweenChain#add\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Tweens.TweenBuilderConfig[]|object[]} tweens - An array of Tween configuration objects for the Tweens in this chain.\r\n *\r\n * @return {this} This TweenChain instance.\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 97, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Create a sequence of Tweens, chained to one-another, and add them to this Tween Manager.\r\rThe tweens are played in order, from start to finish. You can optionally set the chain\rto repeat as many times as you like. Once the chain has finished playing, or repeating if set,\rall tweens in the chain will be destroyed automatically. To override this, set the 'persist'\rargument to 'true'.\r\rPlayback will start immediately unless the _first_ Tween has been configured to be paused.\r\rPlease note that Tweens will not manipulate any target property that begins with an underscore.", "kind": "function", "name": "add", "since": "3.60.0", "params": [ { "type": { "names": [ "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Tweens.TweenBuilderConfig", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } ] } }, "description": "An array of Tween configuration objects for the Tweens in this chain.", "name": "tweens" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TweenChain instance." } ], "memberof": "Phaser.Tweens.TweenChain", "longname": "Phaser.Tweens.TweenChain#add", "scope": "instance", "___id": "T000002R044543", "___s": true }, { "comment": "/**\r\n * See if any of the tweens in this Tween Chain is currently acting upon the given target.\r\n *\r\n * @method Phaser.Tweens.TweenChain#hasTarget\r\n * @since 3.60.0\r\n *\r\n * @param {object} target - The target to check against this TweenChain.\r\n *\r\n * @return {boolean} `true` if the given target is a target of this TweenChain, otherwise `false`.\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 174, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "See if any of the tweens in this Tween Chain is currently acting upon the given target.", "kind": "function", "name": "hasTarget", "since": "3.60.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The target to check against this TweenChain.", "name": "target" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given target is a target of this TweenChain, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenChain", "longname": "Phaser.Tweens.TweenChain#hasTarget", "scope": "instance", "___id": "T000002R044555", "___s": true }, { "comment": "/**\r\n * Restarts the TweenChain from the beginning.\r\n *\r\n * If this TweenChain was configured to have a loop, or start delay, those\r\n * are reset to their initial values as well. It will also dispatch the\r\n * `onActive` callback and event again.\r\n *\r\n * @method Phaser.Tweens.TweenChain#restart\r\n * @since 3.60.0\r\n *\r\n * @return {this} This TweenChain instance.\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 199, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Restarts the TweenChain from the beginning.\r\rIf this TweenChain was configured to have a loop, or start delay, those\rare reset to their initial values as well. It will also dispatch the\r`onActive` callback and event again.", "kind": "function", "name": "restart", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TweenChain instance." } ], "memberof": "Phaser.Tweens.TweenChain", "longname": "Phaser.Tweens.TweenChain#restart", "scope": "instance", "___id": "T000002R044559", "___s": true }, { "comment": "/**\r\n * Resets the given Tween.\r\n *\r\n * It will seek to position 0 and playback will start on the next frame.\r\n *\r\n * @method Phaser.Tweens.TweenChain#reset\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - The Tween to be reset.\r\n *\r\n * @return {this} This TweenChain instance.\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 232, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Resets the given Tween.\r\rIt will seek to position 0 and playback will start on the next frame.", "kind": "function", "name": "reset", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The Tween to be reset.", "name": "tween" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TweenChain instance." } ], "memberof": "Phaser.Tweens.TweenChain", "longname": "Phaser.Tweens.TweenChain#reset", "scope": "instance", "___id": "T000002R044562", "___s": true }, { "comment": "/**\r\n * Internal method that advances to the next state of the TweenChain playback.\r\n *\r\n * @method Phaser.Tweens.TweenChain#nextState\r\n * @fires Phaser.Tweens.Events#TWEEN_COMPLETE\r\n * @fires Phaser.Tweens.Events#TWEEN_LOOP\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenChain has completed, otherwise `false`.\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 273, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that advances to the next state of the TweenChain playback.", "kind": "function", "name": "nextState", "fires": [ "Phaser.Tweens.Events#event:TWEEN_COMPLETE", "Phaser.Tweens.Events#event:TWEEN_LOOP" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenChain has completed, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenChain", "longname": "Phaser.Tweens.TweenChain#nextState", "scope": "instance", "___id": "T000002R044566", "___s": true }, { "comment": "/**\r\n * Starts this TweenChain playing.\r\n *\r\n * You only need to call this method if you have configured this TweenChain to be paused on creation.\r\n *\r\n * If the TweenChain is already playing, calling this method again will have no effect. If you wish to\r\n * restart the chain, use `TweenChain.restart` instead.\r\n *\r\n * Calling this method after the TweenChain has completed will start the chain playing again from the beginning.\r\n *\r\n * @method Phaser.Tweens.TweenChain#play\r\n * @since 3.60.0\r\n *\r\n * @return {this} This TweenChain instance.\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 320, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Starts this TweenChain playing.\r\rYou only need to call this method if you have configured this TweenChain to be paused on creation.\r\rIf the TweenChain is already playing, calling this method again will have no effect. If you wish to\rrestart the chain, use `TweenChain.restart` instead.\r\rCalling this method after the TweenChain has completed will start the chain playing again from the beginning.", "kind": "function", "name": "play", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TweenChain instance." } ], "memberof": "Phaser.Tweens.TweenChain", "longname": "Phaser.Tweens.TweenChain#play", "scope": "instance", "___id": "T000002R044570", "___s": true }, { "comment": "/**\r\n * Internal method that resets all of the Tweens and the current index pointer.\r\n *\r\n * @method Phaser.Tweens.TweenChain#resetTweens\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 363, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that resets all of the Tweens and the current index pointer.", "kind": "function", "name": "resetTweens", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "longname": "Phaser.Tweens.TweenChain#resetTweens", "scope": "instance", "___id": "T000002R044573", "___s": true }, { "comment": "/**\r\n * Internal method that advances the TweenChain based on the time values.\r\n *\r\n * @method Phaser.Tweens.TweenChain#update\r\n * @fires Phaser.Tweens.Events#TWEEN_COMPLETE\r\n * @fires Phaser.Tweens.Events#TWEEN_LOOP\r\n * @fires Phaser.Tweens.Events#TWEEN_START\r\n * @since 3.60.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 *\r\n * @return {boolean} Returns `true` if this TweenChain has finished and should be removed from the Tween Manager, otherwise returns `false`.\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 383, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that advances the TweenChain based on the time values.", "kind": "function", "name": "update", "fires": [ "Phaser.Tweens.Events#event:TWEEN_COMPLETE", "Phaser.Tweens.Events#event:TWEEN_LOOP", "Phaser.Tweens.Events#event:TWEEN_START" ], "since": "3.60.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" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `true` if this TweenChain has finished and should be removed from the Tween Manager, otherwise returns `false`." } ], "memberof": "Phaser.Tweens.TweenChain", "longname": "Phaser.Tweens.TweenChain#update", "scope": "instance", "___id": "T000002R044580", "___s": true }, { "comment": "/**\r\n * Immediately advances to the next Tween in the chain.\r\n *\r\n * This is typically called internally, but can be used if you need to\r\n * advance playback for some reason.\r\n *\r\n * @method Phaser.Tweens.TweenChain#nextTween\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if there are no more Tweens in the chain, otherwise `false`.\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 451, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Immediately advances to the next Tween in the chain.\r\rThis is typically called internally, but can be used if you need to\radvance playback for some reason.", "kind": "function", "name": "nextTween", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if there are no more Tweens in the chain, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenChain", "longname": "Phaser.Tweens.TweenChain#nextTween", "scope": "instance", "___id": "T000002R044587", "___s": true }, { "comment": "/**\r\n * Sets the current active Tween to the given index, based on its\r\n * entry in the TweenChain data array.\r\n *\r\n * @method Phaser.Tweens.TweenChain#setCurrentTween\r\n * @since 3.60.0\r\n *\r\n * @param {number} index - The index of the Tween to be made current.\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Sets the current active Tween to the given index, based on its\rentry in the TweenChain data array.", "kind": "function", "name": "setCurrentTween", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the Tween to be made current.", "name": "index" } ], "memberof": "Phaser.Tweens.TweenChain", "longname": "Phaser.Tweens.TweenChain#setCurrentTween", "scope": "instance", "___id": "T000002R044589", "___s": true }, { "comment": "/**\r\n * Internal method that will emit a TweenChain based Event and invoke the given callback.\r\n *\r\n * @method Phaser.Tweens.TweenChain#dispatchEvent\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Tweens.Event} event - The Event to be dispatched.\r\n * @param {Phaser.Types.Tweens.TweenCallbackTypes} [callback] - The name of the callback to be invoked. Can be `null` or `undefined` to skip invocation.\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 498, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that will emit a TweenChain based Event and invoke the given callback.", "kind": "function", "name": "dispatchEvent", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.Tweens.Event" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.Event" } }, "description": "The Event to be dispatched.", "name": "event" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenCallbackTypes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenCallbackTypes" } }, "optional": true, "description": "The name of the callback to be invoked. Can be `null` or `undefined` to skip invocation.", "name": "callback" } ], "memberof": "Phaser.Tweens.TweenChain", "longname": "Phaser.Tweens.TweenChain#dispatchEvent", "scope": "instance", "___id": "T000002R044593", "___s": true }, { "comment": "/**\r\n * Immediately destroys this TweenChain, nulling of all its references.\r\n *\r\n * @method Phaser.Tweens.TweenChain#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 519, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Immediately destroys this TweenChain, nulling of all its references.", "kind": "function", "name": "destroy", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "longname": "Phaser.Tweens.TweenChain#destroy", "scope": "instance", "overrides": "Phaser.Tweens.BaseTween#destroy", "___id": "T000002R044596", "___s": true }, { "comment": "/**\r\n * Creates a new TweenChain object and adds it to the Tween Manager.\r\n *\r\n * Note: This method will only be available if Tweens have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#tweenchain\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Tweens.TweenBuilderConfig|object} config - The TweenChain configuration.\r\n *\r\n * @return {Phaser.Tweens.TweenChain} The TweenChain that was created.\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 534, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Creates a new TweenChain object and adds it to the Tween Manager.\r\rNote: This method will only be available if Tweens have been built into Phaser.", "kind": "function", "name": "tweenchain", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.Tweens.TweenBuilderConfig", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenBuilderConfig" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The TweenChain configuration.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Tweens.TweenChain" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.TweenChain" } }, "description": "The TweenChain that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#tweenchain", "scope": "instance", "___id": "T000002R044599", "___s": true }, { "comment": "/**\r\n * Creates a new TweenChain object and returns it, without adding it to the Tween Manager.\r\n *\r\n * Note: This method will only be available if Tweens have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#tweenchain\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Tweens.TweenBuilderConfig|object} config - The TweenChain configuration.\r\n *\r\n * @return {Phaser.Tweens.TweenChain} The TweenChain that was created.\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 551, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Creates a new TweenChain object and returns it, without adding it to the Tween Manager.\r\rNote: This method will only be available if Tweens have been built into Phaser.", "kind": "function", "name": "tweenchain", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.Tweens.TweenBuilderConfig", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenBuilderConfig" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The TweenChain configuration.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Tweens.TweenChain" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.TweenChain" } }, "description": "The TweenChain that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#tweenchain", "scope": "instance", "___id": "T000002R044600", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The TweenData is a class that contains a single target and property that is being tweened.\r\n *\r\n * Tweens create TweenData instances when they are created, with one TweenData instance per\r\n * target, per property. A Tween can own multiple TweenData instances, but a TweenData only\r\n * ever belongs to a single Tween.\r\n *\r\n * You should not typically create these yourself, but rather use the TweenBuilder,\r\n * or the `Tween.add` method.\r\n *\r\n * Prior to Phaser 3.60 the TweenData was just an object, but was refactored to a class,\r\n * to make it responsible for its own state and updating.\r\n *\r\n * @class TweenData\r\n * @memberof Phaser.Tweens\r\n * @extends Phaser.Tweens.BaseTweenData\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - The tween this TweenData instance belongs to.\r\n * @param {number} targetIndex - The target index within the Tween targets array.\r\n * @param {string} key - The property of the target to tween.\r\n * @param {Phaser.Types.Tweens.GetEndCallback} getEnd - What the property will be at the END of the Tween.\r\n * @param {Phaser.Types.Tweens.GetStartCallback} getStart - What the property will be at the START of the Tween.\r\n * @param {?Phaser.Types.Tweens.GetActiveCallback} getActive - If not null, is invoked _immediately_ as soon as the TweenData is running, and is set on the target property.\r\n * @param {function} ease - The ease function this tween uses.\r\n * @param {function} delay - Function that returns the time in milliseconds before tween will start.\r\n * @param {number} duration - The duration of the tween in milliseconds.\r\n * @param {boolean} yoyo - Determines whether the tween should return back to its start value after hold has expired.\r\n * @param {number} hold - Function that returns the time in milliseconds the tween will pause before repeating or returning to its starting value if yoyo is set to true.\r\n * @param {number} repeat - Function that returns the number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.\r\n * @param {number} repeatDelay - Function that returns the time in milliseconds before the repeat will start.\r\n * @param {boolean} flipX - Should toggleFlipX be called when yoyo or repeat happens?\r\n * @param {boolean} flipY - Should toggleFlipY be called when yoyo or repeat happens?\r\n * @param {?function} interpolation - The interpolation function to be used for arrays of data. Defaults to 'null'.\r\n * @param {?number[]} interpolationData - The array of interpolation data to be set. Defaults to 'null'.\r\n */", "meta": { "filename": "TweenData.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "classdesc": "The TweenData is a class that contains a single target and property that is being tweened.\r\rTweens create TweenData instances when they are created, with one TweenData instance per\rtarget, per property. A Tween can own multiple TweenData instances, but a TweenData only\rever belongs to a single Tween.\r\rYou should not typically create these yourself, but rather use the TweenBuilder,\ror the `Tween.add` method.\r\rPrior to Phaser 3.60 the TweenData was just an object, but was refactored to a class,\rto make it responsible for its own state and updating.", "kind": "class", "name": "TweenData", "memberof": "Phaser.Tweens", "augments": [ "Phaser.Tweens.BaseTweenData" ], "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The tween this TweenData instance belongs to.", "name": "tween" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The target index within the Tween targets array.", "name": "targetIndex" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property of the target to tween.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Tweens.GetEndCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetEndCallback" } }, "description": "What the property will be at the END of the Tween.", "name": "getEnd" }, { "type": { "names": [ "Phaser.Types.Tweens.GetStartCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetStartCallback" } }, "description": "What the property will be at the START of the Tween.", "name": "getStart" }, { "type": { "names": [ "Phaser.Types.Tweens.GetActiveCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetActiveCallback", "nullable": true } }, "nullable": true, "description": "If not null, is invoked _immediately_ as soon as the TweenData is running, and is set on the target property.", "name": "getActive" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The ease function this tween uses.", "name": "ease" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "Function that returns the time in milliseconds before tween will start.", "name": "delay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the tween in milliseconds.", "name": "duration" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Determines whether the tween should return back to its start value after hold has expired.", "name": "yoyo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Function that returns the time in milliseconds the tween will pause before repeating or returning to its starting value if yoyo is set to true.", "name": "hold" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Function that returns the number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.", "name": "repeat" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Function that returns the time in milliseconds before the repeat will start.", "name": "repeatDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should toggleFlipX be called when yoyo or repeat happens?", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should toggleFlipY be called when yoyo or repeat happens?", "name": "flipY" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [], "nullable": true } }, "nullable": true, "description": "The interpolation function to be used for arrays of data. Defaults to 'null'.", "name": "interpolation" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ], "nullable": true } }, "nullable": true, "description": "The array of interpolation data to be set. Defaults to 'null'.", "name": "interpolationData" } ], "scope": "static", "longname": "Phaser.Tweens.TweenData", "___id": "T000002R044606", "___s": true }, { "comment": "/**\r\n * The property of the target to be tweened.\r\n *\r\n * @name Phaser.Tweens.TweenData#key\r\n * @type {string}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenData.js", "lineno": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The property of the target to be tweened.", "name": "key", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "longname": "Phaser.Tweens.TweenData#key", "scope": "instance", "kind": "member", "___id": "T000002R044610", "___s": true }, { "comment": "/**\r\n * A function that returns what to set the target property to,\r\n * the moment the TweenData is invoked.\r\n *\r\n * This is called when this TweenData is inititalised or reset.\r\n *\r\n * @name Phaser.Tweens.TweenData#getActiveValue\r\n * @type {?Phaser.Types.Tweens.GetActiveCallback}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenData.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "A function that returns what to set the target property to,\rthe moment the TweenData is invoked.\r\rThis is called when this TweenData is inititalised or reset.", "name": "getActiveValue", "type": { "names": [ "Phaser.Types.Tweens.GetActiveCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetActiveCallback", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "longname": "Phaser.Tweens.TweenData#getActiveValue", "scope": "instance", "kind": "member", "___id": "T000002R044612", "___s": true }, { "comment": "/**\r\n * A function that returns what to set the target property to\r\n * at the end of the tween.\r\n *\r\n * This is called when the tween starts playing, after any initial\r\n * start delay, or if the tween is reset, or is set to repeat.\r\n *\r\n * @name Phaser.Tweens.TweenData#getEndValue\r\n * @type {Phaser.Types.Tweens.GetEndCallback}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenData.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "A function that returns what to set the target property to\rat the end of the tween.\r\rThis is called when the tween starts playing, after any initial\rstart delay, or if the tween is reset, or is set to repeat.", "name": "getEndValue", "type": { "names": [ "Phaser.Types.Tweens.GetEndCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetEndCallback" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "longname": "Phaser.Tweens.TweenData#getEndValue", "scope": "instance", "kind": "member", "___id": "T000002R044614", "___s": true }, { "comment": "/**\r\n * A function that returns what to set the target property to\r\n * at the start of the tween.\r\n *\r\n * This is called when the tween starts playing, after any initial\r\n * start delay, or if the tween is reset, or is set to repeat.\r\n *\r\n * @name Phaser.Tweens.TweenData#getStartValue\r\n * @type {Phaser.Types.Tweens.GetStartCallback}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenData.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "A function that returns what to set the target property to\rat the start of the tween.\r\rThis is called when the tween starts playing, after any initial\rstart delay, or if the tween is reset, or is set to repeat.", "name": "getStartValue", "type": { "names": [ "Phaser.Types.Tweens.GetStartCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetStartCallback" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "longname": "Phaser.Tweens.TweenData#getStartValue", "scope": "instance", "kind": "member", "___id": "T000002R044616", "___s": true }, { "comment": "/**\r\n * The ease function this Tween uses to calculate the target value.\r\n *\r\n * @name Phaser.Tweens.TweenData#ease\r\n * @type {function}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenData.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The ease function this Tween uses to calculate the target value.", "name": "ease", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "longname": "Phaser.Tweens.TweenData#ease", "scope": "instance", "kind": "member", "___id": "T000002R044618", "___s": true }, { "comment": "/**\r\n * The targets starting value, as returned by `getStartValue`.\r\n *\r\n * @name Phaser.Tweens.TweenData#start\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenData.js", "lineno": 117, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The targets starting value, as returned by `getStartValue`.", "name": "start", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "longname": "Phaser.Tweens.TweenData#start", "scope": "instance", "kind": "member", "___id": "T000002R044620", "___s": true }, { "comment": "/**\r\n * The target value from the previous step.\r\n *\r\n * @name Phaser.Tweens.TweenData#previous\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenData.js", "lineno": 126, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The target value from the previous step.", "name": "previous", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "longname": "Phaser.Tweens.TweenData#previous", "scope": "instance", "kind": "member", "___id": "T000002R044622", "___s": true }, { "comment": "/**\r\n * The targets current value, as recorded in the most recent step.\r\n *\r\n * @name Phaser.Tweens.TweenData#current\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenData.js", "lineno": 135, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The targets current value, as recorded in the most recent step.", "name": "current", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "longname": "Phaser.Tweens.TweenData#current", "scope": "instance", "kind": "member", "___id": "T000002R044624", "___s": true }, { "comment": "/**\r\n * The targets ending value, as returned by `getEndValue`.\r\n *\r\n * @name Phaser.Tweens.TweenData#end\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenData.js", "lineno": 144, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The targets ending value, as returned by `getEndValue`.", "name": "end", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "longname": "Phaser.Tweens.TweenData#end", "scope": "instance", "kind": "member", "___id": "T000002R044626", "___s": true }, { "comment": "/**\r\n * The interpolation function to be used for arrays of data.\r\n *\r\n * @name Phaser.Tweens.TweenData#interpolation\r\n * @type {?function}\r\n * @default null\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenData.js", "lineno": 153, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The interpolation function to be used for arrays of data.", "name": "interpolation", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [], "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "longname": "Phaser.Tweens.TweenData#interpolation", "scope": "instance", "kind": "member", "___id": "T000002R044628", "___s": true }, { "comment": "/**\r\n * The array of data to interpolate, if interpolation is being used.\r\n *\r\n * @name Phaser.Tweens.TweenData#interpolationData\r\n * @type {?number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenData.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The array of data to interpolate, if interpolation is being used.", "name": "interpolationData", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ], "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "longname": "Phaser.Tweens.TweenData#interpolationData", "scope": "instance", "kind": "member", "___id": "T000002R044630", "___s": true }, { "comment": "/**\r\n * Internal method that resets this Tween Data entirely, including the progress and elapsed values.\r\n *\r\n * Called automatically by the parent Tween. Should not be called directly.\r\n *\r\n * @method Phaser.Tweens.TweenData#reset\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [isSeeking=false] - Is the Tween Data being reset as part of a Tween seek?\r\n */", "meta": { "filename": "TweenData.js", "lineno": 173, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that resets this Tween Data entirely, including the progress and elapsed values.\r\rCalled automatically by the parent Tween. Should not be called directly.", "kind": "function", "name": "reset", "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is the Tween Data being reset as part of a Tween seek?", "name": "isSeeking" } ], "memberof": "Phaser.Tweens.TweenData", "longname": "Phaser.Tweens.TweenData#reset", "scope": "instance", "overrides": "Phaser.Tweens.BaseTweenData#reset", "___id": "T000002R044632", "___s": true }, { "comment": "/**\r\n * Internal method that advances this TweenData based on the delta value given.\r\n *\r\n * @method Phaser.Tweens.TweenData#update\r\n * @fires Phaser.Tweens.Events#TWEEN_UPDATE\r\n * @fires Phaser.Tweens.Events#TWEEN_REPEAT\r\n * @since 3.60.0\r\n *\r\n * @param {number} delta - The elapsed delta time in ms.\r\n *\r\n * @return {boolean} `true` if this TweenData is still playing, or `false` if it has finished entirely.\r\n */", "meta": { "filename": "TweenData.js", "lineno": 206, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that advances this TweenData based on the delta value given.", "kind": "function", "name": "update", "fires": [ "Phaser.Tweens.Events#event:TWEEN_UPDATE", "Phaser.Tweens.Events#event:TWEEN_REPEAT" ], "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The elapsed delta time in ms.", "name": "delta" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData is still playing, or `false` if it has finished entirely." } ], "memberof": "Phaser.Tweens.TweenData", "longname": "Phaser.Tweens.TweenData#update", "scope": "instance", "___id": "T000002R044642", "___s": true }, { "comment": "/**\r\n * Internal method that will emit a TweenData based Event on the\r\n * parent Tween and also invoke the given callback, if provided.\r\n *\r\n * @method Phaser.Tweens.TweenData#dispatchEvent\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Tweens.Event} event - The Event to be dispatched.\r\n * @param {Phaser.Types.Tweens.TweenCallbackTypes} [callback] - The name of the callback to be invoked. Can be `null` or `undefined` to skip invocation.\r\n */", "meta": { "filename": "TweenData.js", "lineno": 364, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that will emit a TweenData based Event on the\rparent Tween and also invoke the given callback, if provided.", "kind": "function", "name": "dispatchEvent", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.Tweens.Event" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.Event" } }, "description": "The Event to be dispatched.", "name": "event" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenCallbackTypes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenCallbackTypes" } }, "optional": true, "description": "The name of the callback to be invoked. Can be `null` or `undefined` to skip invocation.", "name": "callback" } ], "memberof": "Phaser.Tweens.TweenData", "longname": "Phaser.Tweens.TweenData#dispatchEvent", "scope": "instance", "___id": "T000002R044681", "___s": true }, { "comment": "/**\r\n * Immediately destroys this TweenData, nulling of all its references.\r\n *\r\n * @method Phaser.Tweens.TweenData#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenData.js", "lineno": 397, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Immediately destroys this TweenData, nulling of all its references.", "kind": "function", "name": "destroy", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "longname": "Phaser.Tweens.TweenData#destroy", "scope": "instance", "overrides": "Phaser.Tweens.BaseTweenData#destroy", "___id": "T000002R044689", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The TweenFrameData is a class that contains a single target that will change the texture frame\r\n * at the conclusion of the Tween.\r\n *\r\n * TweenFrameData instances are typically created by the TweenBuilder automatically, when it\r\n * detects the prescence of a 'texture' property as the key being tweened.\r\n *\r\n * A Tween can own multiple TweenFrameData instances, but a TweenFrameData only\r\n * ever belongs to a single Tween.\r\n *\r\n * You should not typically create these yourself, but rather use the TweenBuilder,\r\n * or the `Tween.addFrame` method.\r\n *\r\n * @class TweenFrameData\r\n * @memberof Phaser.Tweens\r\n * @extends Phaser.Tweens.BaseTweenData\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - The tween this TweenData instance belongs to.\r\n * @param {number} targetIndex - The target index within the Tween targets array.\r\n * @param {string} texture - The texture key to set at the end of this tween.\r\n * @param {(string|number)} frame - The texture frame to set at the end of this tween.\r\n * @param {function} delay - Function that returns the time in milliseconds before tween will start.\r\n * @param {number} duration - The duration of the tween in milliseconds.\r\n * @param {number} hold - Function that returns the time in milliseconds the tween will pause before repeating or returning to its starting value if yoyo is set to true.\r\n * @param {number} repeat - Function that returns the number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.\r\n * @param {number} repeatDelay - Function that returns the time in milliseconds before the repeat will start.\r\n * @param {boolean} flipX - Should toggleFlipX be called when yoyo or repeat happens?\r\n * @param {boolean} flipY - Should toggleFlipY be called when yoyo or repeat happens?\r\n */", "meta": { "filename": "TweenFrameData.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "classdesc": "The TweenFrameData is a class that contains a single target that will change the texture frame\rat the conclusion of the Tween.\r\rTweenFrameData instances are typically created by the TweenBuilder automatically, when it\rdetects the prescence of a 'texture' property as the key being tweened.\r\rA Tween can own multiple TweenFrameData instances, but a TweenFrameData only\rever belongs to a single Tween.\r\rYou should not typically create these yourself, but rather use the TweenBuilder,\ror the `Tween.addFrame` method.", "kind": "class", "name": "TweenFrameData", "memberof": "Phaser.Tweens", "augments": [ "Phaser.Tweens.BaseTweenData" ], "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The tween this TweenData instance belongs to.", "name": "tween" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The target index within the Tween targets array.", "name": "targetIndex" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The texture key to set at the end of this tween.", "name": "texture" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "The texture frame to set at the end of this tween.", "name": "frame" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "Function that returns the time in milliseconds before tween will start.", "name": "delay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the tween in milliseconds.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Function that returns the time in milliseconds the tween will pause before repeating or returning to its starting value if yoyo is set to true.", "name": "hold" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Function that returns the number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.", "name": "repeat" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Function that returns the time in milliseconds before the repeat will start.", "name": "repeatDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should toggleFlipX be called when yoyo or repeat happens?", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should toggleFlipY be called when yoyo or repeat happens?", "name": "flipY" } ], "scope": "static", "longname": "Phaser.Tweens.TweenFrameData", "___id": "T000002R044700", "___s": true }, { "comment": "/**\r\n * The property of the target to be tweened.\r\n *\r\n * Always 'texture' for a TweenFrameData object.\r\n *\r\n * @name Phaser.Tweens.TweenFrameData#key\r\n * @type {string}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenFrameData.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The property of the target to be tweened.\r\rAlways 'texture' for a TweenFrameData object.", "name": "key", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "longname": "Phaser.Tweens.TweenFrameData#key", "scope": "instance", "kind": "member", "___id": "T000002R044704", "___s": true }, { "comment": "/**\r\n * The texture to be set at the start of the tween.\r\n *\r\n * @name Phaser.Tweens.TweenFrameData#startTexture\r\n * @type {string}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenFrameData.js", "lineno": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The texture to be set at the start of the tween.", "name": "startTexture", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "longname": "Phaser.Tweens.TweenFrameData#startTexture", "scope": "instance", "kind": "member", "___id": "T000002R044706", "___s": true }, { "comment": "/**\r\n * The texture to be set at the end of the tween.\r\n *\r\n * @name Phaser.Tweens.TweenFrameData#endTexture\r\n * @type {string}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenFrameData.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The texture to be set at the end of the tween.", "name": "endTexture", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "longname": "Phaser.Tweens.TweenFrameData#endTexture", "scope": "instance", "kind": "member", "___id": "T000002R044708", "___s": true }, { "comment": "/**\r\n * The frame to be set at the start of the tween.\r\n *\r\n * @name Phaser.Tweens.TweenFrameData#startFrame\r\n * @type {(string|number)}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenFrameData.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The frame to be set at the start of the tween.", "name": "startFrame", "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "longname": "Phaser.Tweens.TweenFrameData#startFrame", "scope": "instance", "kind": "member", "___id": "T000002R044710", "___s": true }, { "comment": "/**\r\n * The frame to be set at the end of the tween.\r\n *\r\n * @name Phaser.Tweens.TweenFrameData#endFrame\r\n * @type {(string|number)}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenFrameData.js", "lineno": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "The frame to be set at the end of the tween.", "name": "endFrame", "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "longname": "Phaser.Tweens.TweenFrameData#endFrame", "scope": "instance", "kind": "member", "___id": "T000002R044712", "___s": true }, { "comment": "/**\r\n * Will the Tween ease back to its starting values, after reaching the end\r\n * and any `hold` value that may be set?\r\n *\r\n * @name Phaser.Tweens.TweenFrameData#yoyo\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenFrameData.js", "lineno": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Will the Tween ease back to its starting values, after reaching the end\rand any `hold` value that may be set?", "name": "yoyo", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "longname": "Phaser.Tweens.TweenFrameData#yoyo", "scope": "instance", "kind": "member", "overrides": "Phaser.Tweens.BaseTweenData#yoyo", "___id": "T000002R044714", "___s": true }, { "comment": "/**\r\n * Internal method that resets this Tween Data entirely, including the progress and elapsed values.\r\n *\r\n * Called automatically by the parent Tween. Should not be called directly.\r\n *\r\n * @method Phaser.Tweens.TweenFrameData#reset\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [isSeeking=false] - Is the Tween Data being reset as part of a Tween seek?\r\n */", "meta": { "filename": "TweenFrameData.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that resets this Tween Data entirely, including the progress and elapsed values.\r\rCalled automatically by the parent Tween. Should not be called directly.", "kind": "function", "name": "reset", "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is the Tween Data being reset as part of a Tween seek?", "name": "isSeeking" } ], "memberof": "Phaser.Tweens.TweenFrameData", "longname": "Phaser.Tweens.TweenFrameData#reset", "scope": "instance", "overrides": "Phaser.Tweens.BaseTweenData#reset", "___id": "T000002R044716", "___s": true }, { "comment": "/**\r\n * Internal method that advances this TweenData based on the delta value given.\r\n *\r\n * @method Phaser.Tweens.TweenFrameData#update\r\n * @fires Phaser.Tweens.Events#TWEEN_UPDATE\r\n * @fires Phaser.Tweens.Events#TWEEN_REPEAT\r\n * @since 3.60.0\r\n *\r\n * @param {number} delta - The elapsed delta time in ms.\r\n *\r\n * @return {boolean} `true` if this TweenData is still playing, or `false` if it has finished entirely.\r\n */", "meta": { "filename": "TweenFrameData.js", "lineno": 141, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that advances this TweenData based on the delta value given.", "kind": "function", "name": "update", "fires": [ "Phaser.Tweens.Events#event:TWEEN_UPDATE", "Phaser.Tweens.Events#event:TWEEN_REPEAT" ], "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The elapsed delta time in ms.", "name": "delta" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData is still playing, or `false` if it has finished entirely." } ], "memberof": "Phaser.Tweens.TweenFrameData", "longname": "Phaser.Tweens.TweenFrameData#update", "scope": "instance", "___id": "T000002R044721", "___s": true }, { "comment": "/**\r\n * Internal method that will emit a TweenData based Event on the\r\n * parent Tween and also invoke the given callback, if provided.\r\n *\r\n * @method Phaser.Tweens.TweenFrameData#dispatchEvent\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Tweens.Event} event - The Event to be dispatched.\r\n * @param {Phaser.Types.Tweens.TweenCallbackTypes} [callback] - The name of the callback to be invoked. Can be `null` or `undefined` to skip invocation.\r\n */", "meta": { "filename": "TweenFrameData.js", "lineno": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Internal method that will emit a TweenData based Event on the\rparent Tween and also invoke the given callback, if provided.", "kind": "function", "name": "dispatchEvent", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.Tweens.Event" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.Event" } }, "description": "The Event to be dispatched.", "name": "event" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenCallbackTypes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenCallbackTypes" } }, "optional": true, "description": "The name of the callback to be invoked. Can be `null` or `undefined` to skip invocation.", "name": "callback" } ], "memberof": "Phaser.Tweens.TweenFrameData", "longname": "Phaser.Tweens.TweenFrameData#dispatchEvent", "scope": "instance", "___id": "T000002R044744", "___s": true }, { "comment": "/**\r\n * Immediately destroys this TweenData, nulling of all its references.\r\n *\r\n * @method Phaser.Tweens.TweenFrameData#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenFrameData.js", "lineno": 298, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "description": "Immediately destroys this TweenData, nulling of all its references.", "kind": "function", "name": "destroy", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "longname": "Phaser.Tweens.TweenFrameData#destroy", "scope": "instance", "overrides": "Phaser.Tweens.BaseTweenData#destroy", "___id": "T000002R044750", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Tween Manager is a default Scene Plugin which controls and updates Tweens.\r\n *\r\n * A tween is a way to alter one or more properties of a target object over a defined period of time.\r\n *\r\n * Tweens are created by calling the `add` method and passing in the configuration object.\r\n *\r\n * ```js\r\n * const logo = this.add.image(100, 100, 'logo');\r\n *\r\n * this.tweens.add({\r\n * targets: logo,\r\n * x: 600,\r\n * ease: 'Power1',\r\n * duration: 2000\r\n * });\r\n * ```\r\n *\r\n * See the `TweenBuilderConfig` for all of the options you have available.\r\n *\r\n * Playback will start immediately unless the tween has been configured to be paused.\r\n *\r\n * Please note that a Tween will not manipulate any target property that begins with an underscore.\r\n *\r\n * Tweens are designed to be 'fire-and-forget'. They automatically destroy themselves once playback\r\n * is complete, to free-up memory and resources. If you wish to keep a tween after playback, i.e. to\r\n * play it again at a later time, then you should set the `persist` property to `true` in the config.\r\n * However, doing so means it's entirely up to _you_ to destroy the tween when you're finished with it,\r\n * otherwise it will linger in memory forever.\r\n *\r\n * If you wish to chain Tweens together for sequential playback, see the `TweenManager.chain` method.\r\n *\r\n * @class TweenManager\r\n * @memberof Phaser.Tweens\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene which owns this Tween Manager.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "classdesc": "The Tween Manager is a default Scene Plugin which controls and updates Tweens.\r\rA tween is a way to alter one or more properties of a target object over a defined period of time.\r\rTweens are created by calling the `add` method and passing in the configuration object.\r\r```js\rconst logo = this.add.image(100, 100, 'logo');\r\rthis.tweens.add({\r targets: logo,\r x: 600,\r ease: 'Power1',\r duration: 2000\r});\r```\r\rSee the `TweenBuilderConfig` for all of the options you have available.\r\rPlayback will start immediately unless the tween has been configured to be paused.\r\rPlease note that a Tween will not manipulate any target property that begins with an underscore.\r\rTweens are designed to be 'fire-and-forget'. They automatically destroy themselves once playback\ris complete, to free-up memory and resources. If you wish to keep a tween after playback, i.e. to\rplay it again at a later time, then you should set the `persist` property to `true` in the config.\rHowever, doing so means it's entirely up to _you_ to destroy the tween when you're finished with it,\rotherwise it will linger in memory forever.\r\rIf you wish to chain Tweens together for sequential playback, see the `TweenManager.chain` method.", "kind": "class", "name": "TweenManager", "memberof": "Phaser.Tweens", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene which owns this Tween Manager.", "name": "scene" } ], "scope": "static", "longname": "Phaser.Tweens.TweenManager", "___id": "T000002R044768", "___s": true }, { "comment": "/**\r\n * The Scene which owns this Tween Manager.\r\n *\r\n * @name Phaser.Tweens.TweenManager#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "The Scene which owns this Tween Manager.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#scene", "scope": "instance", "kind": "member", "___id": "T000002R044771", "___s": true }, { "comment": "/**\r\n * The Scene Systems Event Emitter.\r\n *\r\n * @name Phaser.Tweens.TweenManager#events\r\n * @type {Phaser.Events.EventEmitter}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "The Scene Systems Event Emitter.", "name": "events", "type": { "names": [ "Phaser.Events.EventEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Events.EventEmitter" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#events", "scope": "instance", "kind": "member", "___id": "T000002R044773", "___s": true }, { "comment": "/**\r\n * The time scale of the Tween Manager.\r\n *\r\n * This value scales the time delta between two frames, thus influencing the speed of time for all Tweens owned by this Tween Manager.\r\n *\r\n * @name Phaser.Tweens.TweenManager#timeScale\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "The time scale of the Tween Manager.\r\rThis value scales the time delta between two frames, thus influencing the speed of time for all Tweens owned by this Tween Manager.", "name": "timeScale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#timeScale", "scope": "instance", "kind": "member", "___id": "T000002R044775", "___s": true }, { "comment": "/**\r\n * This toggles the updating state of this Tween Manager.\r\n *\r\n * Setting `paused` to `true` (or calling the `pauseAll` method) will\r\n * stop this Tween Manager from updating any of its tweens, including\r\n * newly created ones. Set back to `false` to resume playback.\r\n *\r\n * @name Phaser.Tweens.TweenManager#paused\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "This toggles the updating state of this Tween Manager.\r\rSetting `paused` to `true` (or calling the `pauseAll` method) will\rstop this Tween Manager from updating any of its tweens, including\rnewly created ones. Set back to `false` to resume playback.", "name": "paused", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#paused", "scope": "instance", "kind": "member", "___id": "T000002R044777", "___s": true }, { "comment": "/**\r\n * Is this Tween Manager currently processing the tweens as part of\r\n * its 'update' loop? This is set to 'true' at the start of 'update'\r\n * and reset to 'false' at the end of the function. Allows you to trap\r\n * Tween Manager status during tween callbacks.\r\n *\r\n * @name Phaser.Tweens.TweenManager#processing\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 109, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Is this Tween Manager currently processing the tweens as part of\rits 'update' loop? This is set to 'true' at the start of 'update'\rand reset to 'false' at the end of the function. Allows you to trap\rTween Manager status during tween callbacks.", "name": "processing", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#processing", "scope": "instance", "kind": "member", "___id": "T000002R044779", "___s": true }, { "comment": "/**\r\n * An array of Tweens which are actively being processed by the Tween Manager.\r\n *\r\n * @name Phaser.Tweens.TweenManager#tweens\r\n * @type {Phaser.Tweens.Tween[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "An array of Tweens which are actively being processed by the Tween Manager.", "name": "tweens", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tweens.Tween", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#tweens", "scope": "instance", "kind": "member", "___id": "T000002R044781", "___s": true }, { "comment": "/**\r\n * The time the Tween Manager was updated.\r\n *\r\n * @name Phaser.Tweens.TweenManager#time\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "The time the Tween Manager was updated.", "name": "time", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#time", "scope": "instance", "kind": "member", "___id": "T000002R044783", "___s": true }, { "comment": "/**\r\n * The time the Tween Manager was started.\r\n *\r\n * @name Phaser.Tweens.TweenManager#startTime\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "The time the Tween Manager was started.", "name": "startTime", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#startTime", "scope": "instance", "kind": "member", "___id": "T000002R044785", "___s": true }, { "comment": "/**\r\n * The time the Tween Manager should next update.\r\n *\r\n * @name Phaser.Tweens.TweenManager#nextTime\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "The time the Tween Manager should next update.", "name": "nextTime", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#nextTime", "scope": "instance", "kind": "member", "___id": "T000002R044787", "___s": true }, { "comment": "/**\r\n * The time the Tween Manager previously updated.\r\n *\r\n * @name Phaser.Tweens.TweenManager#prevTime\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 158, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "The time the Tween Manager previously updated.", "name": "prevTime", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#prevTime", "scope": "instance", "kind": "member", "___id": "T000002R044789", "___s": true }, { "comment": "/**\r\n * The maximum amount of time, in milliseconds, the browser can\r\n * lag for, before lag smoothing is applied.\r\n *\r\n * See the `TweenManager.setLagSmooth` method for further details.\r\n *\r\n * @name Phaser.Tweens.TweenManager#maxLag\r\n * @type {number}\r\n * @default 500\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 167, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "The maximum amount of time, in milliseconds, the browser can\rlag for, before lag smoothing is applied.\r\rSee the `TweenManager.setLagSmooth` method for further details.", "name": "maxLag", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "500", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#maxLag", "scope": "instance", "kind": "member", "___id": "T000002R044791", "___s": true }, { "comment": "/**\r\n * The amount of time, in milliseconds, that is used to set the\r\n * delta when lag smoothing is applied.\r\n *\r\n * See the `TweenManager.setLagSmooth` method for further details.\r\n *\r\n * @name Phaser.Tweens.TweenManager#lagSkip\r\n * @type {number}\r\n * @default 33\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 180, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "The amount of time, in milliseconds, that is used to set the\rdelta when lag smoothing is applied.\r\rSee the `TweenManager.setLagSmooth` method for further details.", "name": "lagSkip", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "33", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#lagSkip", "scope": "instance", "kind": "member", "___id": "T000002R044793", "___s": true }, { "comment": "/**\r\n * An internal value that holds the fps rate.\r\n *\r\n * @name Phaser.Tweens.TweenManager#gap\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 193, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "An internal value that holds the fps rate.", "name": "gap", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#gap", "scope": "instance", "kind": "member", "___id": "T000002R044795", "___s": true }, { "comment": "/**\r\n * Create a Tween and return it, but does not add it to this Tween Manager.\r\n *\r\n * Please note that a Tween will not manipulate any target property that begins with an underscore.\r\n *\r\n * In order to play this tween, you'll need to add it to a Tween Manager via\r\n * the `TweenManager.existing` method.\r\n *\r\n * You can optionally pass an **array** of Tween Configuration objects to this method and it will create\r\n * one Tween per entry in the array. If an array is given, an array of tweens is returned.\r\n *\r\n * @method Phaser.Tweens.TweenManager#create\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Tweens.TweenBuilderConfig|Phaser.Types.Tweens.TweenBuilderConfig[]|object|object[]} config - A Tween Configuration object. Or an array of Tween Configuration objects.\r\n *\r\n * @return {Phaser.Tweens.Tween|Phaser.Tweens.Tween[]} The created Tween, or an array of Tweens if an array of tween configs was provided.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 241, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Create a Tween and return it, but does not add it to this Tween Manager.\r\rPlease note that a Tween will not manipulate any target property that begins with an underscore.\r\rIn order to play this tween, you'll need to add it to a Tween Manager via\rthe `TweenManager.existing` method.\r\rYou can optionally pass an **array** of Tween Configuration objects to this method and it will create\rone Tween per entry in the array. If an array is given, an array of tweens is returned.", "kind": "function", "name": "create", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Tweens.TweenBuilderConfig", "Array.", "object", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenBuilderConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Tweens.TweenBuilderConfig", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "object" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } ] } }, "description": "A Tween Configuration object. Or an array of Tween Configuration objects.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Tweens.Tween", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Tweens.Tween" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tweens.Tween", "type": "NameExpression" } ] } ] } }, "description": "The created Tween, or an array of Tweens if an array of tween configs was provided." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#create", "scope": "instance", "___id": "T000002R044806", "___s": true }, { "comment": "/**\r\n * Create a Tween and add it to this Tween Manager by passing a Tween Configuration object.\r\n *\r\n * Example, run from within a Scene:\r\n *\r\n * ```js\r\n * const logo = this.add.image(100, 100, 'logo');\r\n *\r\n * this.tweens.add({\r\n * targets: logo,\r\n * x: 600,\r\n * ease: 'Power1',\r\n * duration: 2000\r\n * });\r\n * ```\r\n *\r\n * See the `TweenBuilderConfig` for all of the options you have available.\r\n *\r\n * Playback will start immediately unless the tween has been configured to be paused.\r\n *\r\n * Please note that a Tween will not manipulate any target property that begins with an underscore.\r\n *\r\n * Tweens are designed to be 'fire-and-forget'. They automatically destroy themselves once playback\r\n * is complete, to free-up memory and resources. If you wish to keep a tween after playback, i.e. to\r\n * play it again at a later time, then you should set the `persist` property to `true` in the config.\r\n * However, doing so means it's entirely up to _you_ to destroy the tween when you're finished with it,\r\n * otherwise it will linger in memory forever.\r\n *\r\n * If you wish to chain Tweens together for sequential playback, see the `TweenManager.chain` method.\r\n *\r\n * @method Phaser.Tweens.TweenManager#add\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Tweens.TweenBuilderConfig|Phaser.Types.Tweens.TweenChainBuilderConfig|Phaser.Tweens.Tween|Phaser.Tweens.TweenChain} config - A Tween Configuration object, or a Tween or TweenChain instance.\r\n *\r\n * @return {Phaser.Tweens.Tween} The created Tween.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 290, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Create a Tween and add it to this Tween Manager by passing a Tween Configuration object.\r\rExample, run from within a Scene:\r\r```js\rconst logo = this.add.image(100, 100, 'logo');\r\rthis.tweens.add({\r targets: logo,\r x: 600,\r ease: 'Power1',\r duration: 2000\r});\r```\r\rSee the `TweenBuilderConfig` for all of the options you have available.\r\rPlayback will start immediately unless the tween has been configured to be paused.\r\rPlease note that a Tween will not manipulate any target property that begins with an underscore.\r\rTweens are designed to be 'fire-and-forget'. They automatically destroy themselves once playback\ris complete, to free-up memory and resources. If you wish to keep a tween after playback, i.e. to\rplay it again at a later time, then you should set the `persist` property to `true` in the config.\rHowever, doing so means it's entirely up to _you_ to destroy the tween when you're finished with it,\rotherwise it will linger in memory forever.\r\rIf you wish to chain Tweens together for sequential playback, see the `TweenManager.chain` method.", "kind": "function", "name": "add", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Tweens.TweenBuilderConfig", "Phaser.Types.Tweens.TweenChainBuilderConfig", "Phaser.Tweens.Tween", "Phaser.Tweens.TweenChain" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenBuilderConfig" }, { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenChainBuilderConfig" }, { "type": "NameExpression", "name": "Phaser.Tweens.Tween" }, { "type": "NameExpression", "name": "Phaser.Tweens.TweenChain" } ] } }, "description": "A Tween Configuration object, or a Tween or TweenChain instance.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The created Tween." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#add", "scope": "instance", "___id": "T000002R044812", "___s": true }, { "comment": "/**\r\n * Create multiple Tweens and add them all to this Tween Manager, by passing an array of Tween Configuration objects.\r\n *\r\n * See the `TweenBuilderConfig` for all of the options you have available.\r\n *\r\n * Playback will start immediately unless the tweens have been configured to be paused.\r\n *\r\n * Please note that a Tween will not manipulate any target property that begins with an underscore.\r\n *\r\n * Tweens are designed to be 'fire-and-forget'. They automatically destroy themselves once playback\r\n * is complete, to free-up memory and resources. If you wish to keep a tween after playback, i.e. to\r\n * play it again at a later time, then you should set the `persist` property to `true` in the config.\r\n * However, doing so means it's entirely up to _you_ to destroy the tween when you're finished with it,\r\n * otherwise it will linger in memory forever.\r\n *\r\n * If you wish to chain Tweens together for sequential playback, see the `TweenManager.chain` method.\r\n *\r\n * @method Phaser.Tweens.TweenManager#addMultiple\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Tweens.TweenBuilderConfig[]|object[]} configs - An array of Tween Configuration objects.\r\n *\r\n * @return {Phaser.Tweens.Tween[]} An array of created Tweens.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Create multiple Tweens and add them all to this Tween Manager, by passing an array of Tween Configuration objects.\r\rSee the `TweenBuilderConfig` for all of the options you have available.\r\rPlayback will start immediately unless the tweens have been configured to be paused.\r\rPlease note that a Tween will not manipulate any target property that begins with an underscore.\r\rTweens are designed to be 'fire-and-forget'. They automatically destroy themselves once playback\ris complete, to free-up memory and resources. If you wish to keep a tween after playback, i.e. to\rplay it again at a later time, then you should set the `persist` property to `true` in the config.\rHowever, doing so means it's entirely up to _you_ to destroy the tween when you're finished with it,\rotherwise it will linger in memory forever.\r\rIf you wish to chain Tweens together for sequential playback, see the `TweenManager.chain` method.", "kind": "function", "name": "addMultiple", "since": "3.60.0", "params": [ { "type": { "names": [ "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Tweens.TweenBuilderConfig", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } ] } }, "description": "An array of Tween Configuration objects.", "name": "configs" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tweens.Tween", "type": "NameExpression" } ] } }, "description": "An array of created Tweens." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#addMultiple", "scope": "instance", "___id": "T000002R044818", "___s": true }, { "comment": "/**\r\n * Create a sequence of Tweens, chained to one-another, and add them to this Tween Manager.\r\n *\r\n * The tweens are played in order, from start to finish. You can optionally set the chain\r\n * to repeat as many times as you like. Once the chain has finished playing, or repeating if set,\r\n * all tweens in the chain will be destroyed automatically. To override this, set the `persist`\r\n * argument to 'true'.\r\n *\r\n * Playback will start immediately unless the _first_ Tween has been configured to be paused.\r\n *\r\n * Please note that Tweens will not manipulate any target property that begins with an underscore.\r\n *\r\n * @method Phaser.Tweens.TweenManager#chain\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Tweens.TweenChainBuilderConfig|object} tweens - A Tween Chain configuration object.\r\n *\r\n * @return {Phaser.Tweens.TweenChain} The Tween Chain instance.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Create a sequence of Tweens, chained to one-another, and add them to this Tween Manager.\r\rThe tweens are played in order, from start to finish. You can optionally set the chain\rto repeat as many times as you like. Once the chain has finished playing, or repeating if set,\rall tweens in the chain will be destroyed automatically. To override this, set the `persist`\rargument to 'true'.\r\rPlayback will start immediately unless the _first_ Tween has been configured to be paused.\r\rPlease note that Tweens will not manipulate any target property that begins with an underscore.", "kind": "function", "name": "chain", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.Tweens.TweenChainBuilderConfig", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenChainBuilderConfig" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A Tween Chain configuration object.", "name": "tweens" } ], "returns": [ { "type": { "names": [ "Phaser.Tweens.TweenChain" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.TweenChain" } }, "description": "The Tween Chain instance." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#chain", "scope": "instance", "___id": "T000002R044827", "___s": true }, { "comment": "/**\r\n * Returns an array containing this Tween and all Tweens chained to it,\r\n * in the order in which they will be played.\r\n *\r\n * If there are no chained Tweens an empty array is returned.\r\n *\r\n * @method Phaser.Tweens.TweenManager#getChainedTweens\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - The Tween to return the chain from.\r\n *\r\n * @return {Phaser.Tweens.Tween[]} An array of the chained tweens, or an empty array if there aren't any.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 439, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Returns an array containing this Tween and all Tweens chained to it,\rin the order in which they will be played.\r\rIf there are no chained Tweens an empty array is returned.", "kind": "function", "name": "getChainedTweens", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The Tween to return the chain from.", "name": "tween" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tweens.Tween", "type": "NameExpression" } ] } }, "description": "An array of the chained tweens, or an empty array if there aren't any." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#getChainedTweens", "scope": "instance", "___id": "T000002R044830", "___s": true }, { "comment": "/**\r\n * Check to see if the given Tween instance exists within this Tween Manager.\r\n *\r\n * Will return `true` as long as the Tween is being processed by this Tween Manager.\r\n *\r\n * Will return `false` if not present, or has a state of `REMOVED` or `DESTROYED`.\r\n *\r\n * @method Phaser.Tweens.TweenManager#has\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - The Tween instance to check.\r\n *\r\n * @return {boolean} `true` if the Tween exists within this Tween Manager, otherwise `false`.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 457, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Check to see if the given Tween instance exists within this Tween Manager.\r\rWill return `true` as long as the Tween is being processed by this Tween Manager.\r\rWill return `false` if not present, or has a state of `REMOVED` or `DESTROYED`.", "kind": "function", "name": "has", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The Tween instance to check.", "name": "tween" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Tween exists within this Tween Manager, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#has", "scope": "instance", "___id": "T000002R044832", "___s": true }, { "comment": "/**\r\n * Add an existing Tween to this Tween Manager.\r\n *\r\n * Playback will start immediately unless the tween has been configured to be paused.\r\n *\r\n * @method Phaser.Tweens.TweenManager#existing\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - The Tween to add.\r\n *\r\n * @return {this} This Tween Manager instance.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 476, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Add an existing Tween to this Tween Manager.\r\rPlayback will start immediately unless the tween has been configured to be paused.", "kind": "function", "name": "existing", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The Tween to add.", "name": "tween" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween Manager instance." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#existing", "scope": "instance", "___id": "T000002R044834", "___s": true }, { "comment": "/**\r\n * Create a Number Tween and add it to the active Tween list.\r\n *\r\n * A Number Tween is a special kind of tween that doesn't have a target. Instead,\r\n * it allows you to tween between 2 numeric values. The default values are\r\n * `0` and `1`, but you can change them via the `from` and `to` properties.\r\n *\r\n * You can get the current tweened value via the `Tween.getValue()` method.\r\n *\r\n * Playback will start immediately unless the tween has been configured to be paused.\r\n *\r\n * Please note that a Tween will not manipulate any target property that begins with an underscore.\r\n *\r\n * @method Phaser.Tweens.TweenManager#addCounter\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Tweens.NumberTweenBuilderConfig} config - The configuration object for the Number Tween.\r\n *\r\n * @return {Phaser.Tweens.Tween} The created Number Tween.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 498, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Create a Number Tween and add it to the active Tween list.\r\rA Number Tween is a special kind of tween that doesn't have a target. Instead,\rit allows you to tween between 2 numeric values. The default values are\r`0` and `1`, but you can change them via the `from` and `to` properties.\r\rYou can get the current tweened value via the `Tween.getValue()` method.\r\rPlayback will start immediately unless the tween has been configured to be paused.\r\rPlease note that a Tween will not manipulate any target property that begins with an underscore.", "kind": "function", "name": "addCounter", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Tweens.NumberTweenBuilderConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.NumberTweenBuilderConfig" } }, "description": "The configuration object for the Number Tween.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The created Number Tween." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#addCounter", "scope": "instance", "___id": "T000002R044836", "___s": true }, { "comment": "/**\r\n * Creates a Stagger function to be used by a Tween property.\r\n *\r\n * The stagger function will allow you to stagger changes to the value of the property across all targets of the tween.\r\n *\r\n * This is only worth using if the tween has multiple targets.\r\n *\r\n * The following will stagger the delay by 100ms across all targets of the tween, causing them to scale down to 0.2\r\n * over the duration specified:\r\n *\r\n * ```javascript\r\n * this.tweens.add({\r\n * targets: [ ... ],\r\n * scale: 0.2,\r\n * ease: 'linear',\r\n * duration: 1000,\r\n * delay: this.tweens.stagger(100)\r\n * });\r\n * ```\r\n *\r\n * The following will stagger the delay by 500ms across all targets of the tween using a 10 x 6 grid, staggering\r\n * from the center out, using a cubic ease.\r\n *\r\n * ```javascript\r\n * this.tweens.add({\r\n * targets: [ ... ],\r\n * scale: 0.2,\r\n * ease: 'linear',\r\n * duration: 1000,\r\n * delay: this.tweens.stagger(500, { grid: [ 10, 6 ], from: 'center', ease: 'cubic.out' })\r\n * });\r\n * ```\r\n *\r\n * @method Phaser.Tweens.TweenManager#stagger\r\n * @since 3.19.0\r\n *\r\n * @param {(number|number[])} value - The amount to stagger by, or an array containing two elements representing the min and max values to stagger between.\r\n * @param {Phaser.Types.Tweens.StaggerConfig} config - The configuration object for the Stagger function.\r\n *\r\n * @return {function} The stagger function.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Creates a Stagger function to be used by a Tween property.\r\rThe stagger function will allow you to stagger changes to the value of the property across all targets of the tween.\r\rThis is only worth using if the tween has multiple targets.\r\rThe following will stagger the delay by 100ms across all targets of the tween, causing them to scale down to 0.2\rover the duration specified:\r\r```javascript\rthis.tweens.add({\r targets: [ ... ],\r scale: 0.2,\r ease: 'linear',\r duration: 1000,\r delay: this.tweens.stagger(100)\r});\r```\r\rThe following will stagger the delay by 500ms across all targets of the tween using a 10 x 6 grid, staggering\rfrom the center out, using a cubic ease.\r\r```javascript\rthis.tweens.add({\r targets: [ ... ],\r scale: 0.2,\r ease: 'linear',\r duration: 1000,\r delay: this.tweens.stagger(500, { grid: [ 10, 6 ], from: 'center', ease: 'cubic.out' })\r});\r```", "kind": "function", "name": "stagger", "since": "3.19.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" } ] } ] } }, "description": "The amount to stagger by, or an array containing two elements representing the min and max values to stagger between.", "name": "value" }, { "type": { "names": [ "Phaser.Types.Tweens.StaggerConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.StaggerConfig" } }, "description": "The configuration object for the Stagger function.", "name": "config" } ], "returns": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The stagger function." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#stagger", "scope": "instance", "___id": "T000002R044839", "___s": true }, { "comment": "/**\r\n * Set the limits that are used when a browser encounters lag, or delays that cause the elapsed\r\n * time between two frames to exceed the expected amount. If this occurs, the Tween Manager will\r\n * act as if the 'skip' amount of times has passed, in order to maintain strict tween sequencing.\r\n *\r\n * This is enabled by default with the values 500ms for the lag limit and 33ms for the skip.\r\n *\r\n * You should not set these to low values, as it won't give time for the browser to ever\r\n * catch-up with itself and reclaim sync.\r\n *\r\n * Call this method with no arguments to disable smoothing.\r\n *\r\n * Call it with the arguments `500` and `33` to reset to the defaults.\r\n *\r\n * @method Phaser.Tweens.TweenManager#setLagSmooth\r\n * @since 3.60.0\r\n *\r\n * @param {number} [limit=0] - If the browser exceeds this amount, in milliseconds, it will act as if the 'skip' amount has elapsed instead.\r\n * @param {number} [skip=0] - The amount, in milliseconds, to use as the step delta should the browser lag beyond the 'limit'.\r\n *\r\n * @return {this} This Tween Manager instance.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 573, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Set the limits that are used when a browser encounters lag, or delays that cause the elapsed\rtime between two frames to exceed the expected amount. If this occurs, the Tween Manager will\ract as if the 'skip' amount of times has passed, in order to maintain strict tween sequencing.\r\rThis is enabled by default with the values 500ms for the lag limit and 33ms for the skip.\r\rYou should not set these to low values, as it won't give time for the browser to ever\rcatch-up with itself and reclaim sync.\r\rCall this method with no arguments to disable smoothing.\r\rCall it with the arguments `500` and `33` to reset to the defaults.", "kind": "function", "name": "setLagSmooth", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "If the browser exceeds this amount, in milliseconds, it will act as if the 'skip' amount has elapsed instead.", "name": "limit" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount, in milliseconds, to use as the step delta should the browser lag beyond the 'limit'.", "name": "skip" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween Manager instance." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#setLagSmooth", "scope": "instance", "___id": "T000002R044841", "___s": true }, { "comment": "/**\r\n * Limits the Tween system to run at a particular frame rate.\r\n *\r\n * You should not set this _above_ the frequency of the browser,\r\n * but instead can use it to throttle the frame rate lower, should\r\n * you need to in certain situations.\r\n *\r\n * @method Phaser.Tweens.TweenManager#setFps\r\n * @since 3.60.0\r\n *\r\n * @param {number} [fps=240] - The frame rate to tick at.\r\n *\r\n * @return {this} This Tween Manager instance.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 606, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Limits the Tween system to run at a particular frame rate.\r\rYou should not set this _above_ the frequency of the browser,\rbut instead can use it to throttle the frame rate lower, should\ryou need to in certain situations.", "kind": "function", "name": "setFps", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 240, "description": "The frame rate to tick at.", "name": "fps" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween Manager instance." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#setFps", "scope": "instance", "___id": "T000002R044847", "___s": true }, { "comment": "/**\r\n * Internal method that calculates the delta value, along with the other timing values,\r\n * and returns the new delta.\r\n *\r\n * You should not typically call this method directly.\r\n *\r\n * @method Phaser.Tweens.TweenManager#getDelta\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [tick=false] - Is this a manual tick, or an automated tick?\r\n *\r\n * @return {number} The new delta value.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 630, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Internal method that calculates the delta value, along with the other timing values,\rand returns the new delta.\r\rYou should not typically call this method directly.", "kind": "function", "name": "getDelta", "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is this a manual tick, or an automated tick?", "name": "tick" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new delta value." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#getDelta", "scope": "instance", "___id": "T000002R044852", "___s": true }, { "comment": "/**\r\n * Manually advance the Tween system by one step.\r\n *\r\n * This will update all Tweens even if the Tween Manager is currently\r\n * paused.\r\n *\r\n * @method Phaser.Tweens.TweenManager#tick\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Tween Manager instance.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 672, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Manually advance the Tween system by one step.\r\rThis will update all Tweens even if the Tween Manager is currently\rpaused.", "kind": "function", "name": "tick", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween Manager instance." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#tick", "scope": "instance", "___id": "T000002R044864", "___s": true }, { "comment": "/**\r\n * Internal update handler.\r\n *\r\n * Calls `TweenManager.step` as long as the Tween Manager has not\r\n * been paused.\r\n *\r\n * @method Phaser.Tweens.TweenManager#update\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 690, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Internal update handler.\r\rCalls `TweenManager.step` as long as the Tween Manager has not\rbeen paused.", "kind": "function", "name": "update", "since": "3.0.0", "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#update", "scope": "instance", "___id": "T000002R044866", "___s": true }, { "comment": "/**\r\n * Updates all Tweens belonging to this Tween Manager.\r\n *\r\n * Called automatically by `update` and `tick`.\r\n *\r\n * @method Phaser.Tweens.TweenManager#step\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [tick=false] - Is this a manual tick, or an automated tick?\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 707, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Updates all Tweens belonging to this Tween Manager.\r\rCalled automatically by `update` and `tick`.", "kind": "function", "name": "step", "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is this a manual tick, or an automated tick?", "name": "tick" } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#step", "scope": "instance", "___id": "T000002R044868", "___s": true }, { "comment": "/**\r\n * Removes the given Tween from this Tween Manager, even if it hasn't started\r\n * playback yet. If this method is called while the Tween Manager is processing\r\n * an update loop, then the tween will be flagged for removal at the start of\r\n * the next frame. Otherwise, it is removed immediately.\r\n *\r\n * The removed tween is _not_ destroyed. It is just removed from this Tween Manager.\r\n *\r\n * @method Phaser.Tweens.TweenManager#remove\r\n * @since 3.17.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - The Tween to be removed.\r\n *\r\n * @return {this} This Tween Manager instance.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 775, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Removes the given Tween from this Tween Manager, even if it hasn't started\rplayback yet. If this method is called while the Tween Manager is processing\ran update loop, then the tween will be flagged for removal at the start of\rthe next frame. Otherwise, it is removed immediately.\r\rThe removed tween is _not_ destroyed. It is just removed from this Tween Manager.", "kind": "function", "name": "remove", "since": "3.17.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The Tween to be removed.", "name": "tween" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween Manager instance." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#remove", "scope": "instance", "___id": "T000002R044885", "___s": true }, { "comment": "/**\r\n * Resets the given Tween.\r\n *\r\n * If the Tween does not belong to this Tween Manager, it will first be added.\r\n *\r\n * Then it will seek to position 0 and playback will start on the next frame.\r\n *\r\n * @method Phaser.Tweens.TweenManager#reset\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - The Tween to be reset.\r\n *\r\n * @return {this} This Tween Manager instance.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 808, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Resets the given Tween.\r\rIf the Tween does not belong to this Tween Manager, it will first be added.\r\rThen it will seek to position 0 and playback will start on the next frame.", "kind": "function", "name": "reset", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The Tween to be reset.", "name": "tween" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween Manager instance." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#reset", "scope": "instance", "___id": "T000002R044887", "___s": true }, { "comment": "/**\r\n * Checks if a Tween is active and adds it to the Tween Manager at the start of the frame if it isn't.\r\n *\r\n * @method Phaser.Tweens.TweenManager#makeActive\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - The Tween to check.\r\n *\r\n * @return {this} This Tween Manager instance.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 833, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Checks if a Tween is active and adds it to the Tween Manager at the start of the frame if it isn't.", "kind": "function", "name": "makeActive", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The Tween to check.", "name": "tween" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween Manager instance." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#makeActive", "scope": "instance", "___id": "T000002R044889", "___s": true }, { "comment": "/**\r\n * Passes all Tweens to the given callback.\r\n *\r\n * @method Phaser.Tweens.TweenManager#each\r\n * @since 3.0.0\r\n *\r\n * @param {function} callback - The function to call.\r\n * @param {object} [scope] - The scope (`this` object) to call the function with.\r\n * @param {...*} [args] - The arguments to pass into the function. Its first argument will always be the Tween currently being iterated.\r\n *\r\n * @return {this} This Tween Manager instance.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 852, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Passes all Tweens to the given callback.", "kind": "function", "name": "each", "since": "3.0.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": "The scope (`this` object) to call the function with.", "name": "scope" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "The arguments to pass into the function. Its first argument will always be the Tween currently being iterated.", "name": "args" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween Manager instance." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#each", "scope": "instance", "___id": "T000002R044891", "___s": true }, { "comment": "/**\r\n * Returns an array containing references to all Tweens in this Tween Manager.\r\n *\r\n * It is safe to mutate the returned array. However, acting upon any of the Tweens\r\n * within it, will adjust those stored in this Tween Manager, as they are passed\r\n * by reference and not cloned.\r\n *\r\n * If you wish to get tweens for a specific target, see `getTweensOf`.\r\n *\r\n * @method Phaser.Tweens.TweenManager#getTweens\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Tweens.Tween[]} A new array containing references to all Tweens.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 884, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Returns an array containing references to all Tweens in this Tween Manager.\r\rIt is safe to mutate the returned array. However, acting upon any of the Tweens\rwithin it, will adjust those stored in this Tween Manager, as they are passed\rby reference and not cloned.\r\rIf you wish to get tweens for a specific target, see `getTweensOf`.", "kind": "function", "name": "getTweens", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tweens.Tween", "type": "NameExpression" } ] } }, "description": "A new array containing references to all Tweens." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#getTweens", "scope": "instance", "___id": "T000002R044897", "___s": true }, { "comment": "/**\r\n * Returns an array of all Tweens in the Tween Manager which affect the given target, or array of targets.\r\n *\r\n * It's possible for this method to return tweens that are about to be removed from\r\n * the Tween Manager. You should check the state of the returned tween before acting\r\n * upon it.\r\n *\r\n * @method Phaser.Tweens.TweenManager#getTweensOf\r\n * @since 3.0.0\r\n *\r\n * @param {(object|object[])} target - The target to look for. Provide an array to look for multiple targets.\r\n *\r\n * @return {Phaser.Tweens.Tween[]} A new array containing all Tweens which affect the given target(s).\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 903, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Returns an array of all Tweens in the Tween Manager which affect the given target, or array of targets.\r\rIt's possible for this method to return tweens that are about to be removed from\rthe Tween Manager. You should check the state of the returned tween before acting\rupon it.", "kind": "function", "name": "getTweensOf", "since": "3.0.0", "params": [ { "type": { "names": [ "object", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } ] } }, "description": "The target to look for. Provide an array to look for multiple targets.", "name": "target" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tweens.Tween", "type": "NameExpression" } ] } }, "description": "A new array containing all Tweens which affect the given target(s)." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#getTweensOf", "scope": "instance", "___id": "T000002R044899", "___s": true }, { "comment": "/**\r\n * Returns the scale of the time delta for all Tweens owned by this Tween Manager.\r\n *\r\n * @method Phaser.Tweens.TweenManager#getGlobalTimeScale\r\n * @since 3.0.0\r\n *\r\n * @return {number} The scale of the time delta, usually 1.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 949, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Returns the scale of the time delta for all Tweens owned by this Tween Manager.", "kind": "function", "name": "getGlobalTimeScale", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The scale of the time delta, usually 1." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#getGlobalTimeScale", "scope": "instance", "___id": "T000002R044909", "___s": true }, { "comment": "/**\r\n * Sets a new scale of the time delta for this Tween Manager.\r\n *\r\n * The time delta is the time elapsed between two consecutive frames and influences the speed of time for this Tween Manager and all Tweens it owns. Values higher than 1 increase the speed of time, while values smaller than 1 decrease it. A value of 0 freezes time and is effectively equivalent to pausing all Tweens.\r\n *\r\n * @method Phaser.Tweens.TweenManager#setGlobalTimeScale\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new scale of the time delta, where 1 is the normal speed.\r\n *\r\n * @return {this} This Tween Manager instance.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 962, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Sets a new scale of the time delta for this Tween Manager.\r\rThe time delta is the time elapsed between two consecutive frames and influences the speed of time for this Tween Manager and all Tweens it owns. Values higher than 1 increase the speed of time, while values smaller than 1 decrease it. A value of 0 freezes time and is effectively equivalent to pausing all Tweens.", "kind": "function", "name": "setGlobalTimeScale", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new scale of the time delta, where 1 is the normal speed.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween Manager instance." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#setGlobalTimeScale", "scope": "instance", "___id": "T000002R044911", "___s": true }, { "comment": "/**\r\n * Checks if the given object is being affected by a _playing_ Tween.\r\n *\r\n * If the Tween is paused, this method will return false.\r\n *\r\n * @method Phaser.Tweens.TweenManager#isTweening\r\n * @since 3.0.0\r\n *\r\n * @param {object} target - The object to check if a tween is active for it, or not.\r\n *\r\n * @return {boolean} Returns `true` if a tween is active on the given target, otherwise `false`.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 981, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Checks if the given object is being affected by a _playing_ Tween.\r\rIf the Tween is paused, this method will return false.", "kind": "function", "name": "isTweening", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The object to check if a tween is active for it, or not.", "name": "target" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `true` if a tween is active on the given target, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#isTweening", "scope": "instance", "___id": "T000002R044914", "___s": true }, { "comment": "/**\r\n * Destroys all Tweens in this Tween Manager.\r\n *\r\n * The tweens will erase all references to any targets they hold\r\n * and be stopped immediately.\r\n *\r\n * If this method is called while the Tween Manager is running its\r\n * update process, then the tweens will be removed at the start of\r\n * the next frame. Outside of this, they are removed immediately.\r\n *\r\n * @method Phaser.Tweens.TweenManager#killAll\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Tween Manager instance.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 1011, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Destroys all Tweens in this Tween Manager.\r\rThe tweens will erase all references to any targets they hold\rand be stopped immediately.\r\rIf this method is called while the Tween Manager is running its\rupdate process, then the tweens will be removed at the start of\rthe next frame. Outside of this, they are removed immediately.", "kind": "function", "name": "killAll", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween Manager instance." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#killAll", "scope": "instance", "___id": "T000002R044920", "___s": true }, { "comment": "/**\r\n * Stops all Tweens which affect the given target or array of targets.\r\n *\r\n * The tweens will erase all references to any targets they hold\r\n * and be stopped immediately.\r\n *\r\n * If this method is called while the Tween Manager is running its\r\n * update process, then the tweens will be removed at the start of\r\n * the next frame. Outside of this, they are removed immediately.\r\n *\r\n * @see {@link #getTweensOf}\r\n *\r\n * @method Phaser.Tweens.TweenManager#killTweensOf\r\n * @since 3.0.0\r\n *\r\n * @param {(object|array)} target - The target to kill the tweens of. Provide an array to use multiple targets.\r\n *\r\n * @return {this} This Tween Manager instance.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 1043, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Stops all Tweens which affect the given target or array of targets.\r\rThe tweens will erase all references to any targets they hold\rand be stopped immediately.\r\rIf this method is called while the Tween Manager is running its\rupdate process, then the tweens will be removed at the start of\rthe next frame. Outside of this, they are removed immediately.", "see": [ "{@link #getTweensOf}" ], "kind": "function", "name": "killTweensOf", "since": "3.0.0", "params": [ { "type": { "names": [ "object", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "array" } ] } }, "description": "The target to kill the tweens of. Provide an array to use multiple targets.", "name": "target" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween Manager instance." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#killTweensOf", "scope": "instance", "___id": "T000002R044925", "___s": true }, { "comment": "/**\r\n * Pauses this Tween Manager. No Tweens will update while paused.\r\n *\r\n * This includes tweens created after this method was called.\r\n *\r\n * See `TweenManager#resumeAll` to resume the playback.\r\n *\r\n * As of Phaser 3.60 you can also toggle the boolean property `TweenManager.paused`.\r\n *\r\n * @method Phaser.Tweens.TweenManager#pauseAll\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Tween Manager instance.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 1074, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Pauses this Tween Manager. No Tweens will update while paused.\r\rThis includes tweens created after this method was called.\r\rSee `TweenManager#resumeAll` to resume the playback.\r\rAs of Phaser 3.60 you can also toggle the boolean property `TweenManager.paused`.", "kind": "function", "name": "pauseAll", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween Manager instance." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#pauseAll", "scope": "instance", "___id": "T000002R044929", "___s": true }, { "comment": "/**\r\n * Resumes playback of this Tween Manager.\r\n *\r\n * All active Tweens will continue updating.\r\n *\r\n * See `TweenManager#pauseAll` to pause the playback.\r\n *\r\n * As of Phaser 3.60 you can also toggle the boolean property `TweenManager.paused`.\r\n *\r\n * @method Phaser.Tweens.TweenManager#resumeAll\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Tween Manager instance.\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 1095, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "Resumes playback of this Tween Manager.\r\rAll active Tweens will continue updating.\r\rSee `TweenManager#pauseAll` to pause the playback.\r\rAs of Phaser 3.60 you can also toggle the boolean property `TweenManager.paused`.", "kind": "function", "name": "resumeAll", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween Manager instance." } ], "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#resumeAll", "scope": "instance", "___id": "T000002R044932", "___s": true }, { "comment": "/**\r\n * The Scene that owns this plugin is shutting down.\r\n *\r\n * We need to kill and reset all internal properties as well as stop listening to Scene events.\r\n *\r\n * @method Phaser.Tweens.TweenManager#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 1116, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "The Scene that owns this plugin is shutting down.\r\rWe need to kill and reset all internal properties as well as stop listening to Scene events.", "kind": "function", "name": "shutdown", "since": "3.0.0", "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#shutdown", "scope": "instance", "___id": "T000002R044935", "___s": true }, { "comment": "/**\r\n * The Scene that owns this plugin is being destroyed.\r\n * We need to shutdown and then kill off all external references.\r\n *\r\n * @method Phaser.Tweens.TweenManager#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TweenManager.js", "lineno": 1134, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens", "code": {} }, "description": "The Scene that owns this plugin is being destroyed.\rWe need to shutdown and then kill off all external references.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Tweens.TweenManager", "longname": "Phaser.Tweens.TweenManager#destroy", "scope": "instance", "___id": "T000002R044938", "___s": true }, { "comment": "/**\r\n * @typedef {string} Phaser.Types.Tweens.Event - A Tween Event.\r\n * @since 3.19.0\r\n */", "meta": { "filename": "Event.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "Event", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A Tween Event.", "since": "3.19.0", "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.Event", "scope": "static", "___id": "T000002R044943", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Tweens.GetActiveCallback\r\n * @since 3.19.0\r\n *\r\n * @param {any} target - The tween target.\r\n * @param {string} key - The target property.\r\n * @param {number} value - The current value of the target property.\r\n * @param {number} targetIndex - The index of the target within the Tween.\r\n * @param {number} totalTargets - The total number of targets in this Tween.\r\n * @param {Phaser.Tweens.Tween} tween - The Tween that invoked this callback.\r\n *\r\n * @return {number} - The new value.\r\n */", "meta": { "filename": "GetActiveCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "GetActiveCallback", "type": { "names": [ "function" ] }, "since": "3.19.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The tween target.", "name": "target" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The target property.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current value of the target property.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the target within the Tween.", "name": "targetIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total number of targets in this Tween.", "name": "totalTargets" }, { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The Tween that invoked this callback.", "name": "tween" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "- The new value." } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.GetActiveCallback", "scope": "static", "___id": "T000002R044944", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Tweens.GetEndCallback\r\n * @since 3.18.0\r\n *\r\n * @param {any} target - The tween target.\r\n * @param {string} key - The target property.\r\n * @param {number} value - The current value of the target property.\r\n * @param {number} targetIndex - The index of the target within the Tween.\r\n * @param {number} totalTargets - The total number of targets in this Tween.\r\n * @param {Phaser.Tweens.Tween} tween - The Tween that invoked this callback.\r\n *\r\n * @return {number} - The new value.\r\n */", "meta": { "filename": "GetEndCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "GetEndCallback", "type": { "names": [ "function" ] }, "since": "3.18.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The tween target.", "name": "target" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The target property.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current value of the target property.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the target within the Tween.", "name": "targetIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total number of targets in this Tween.", "name": "totalTargets" }, { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The Tween that invoked this callback.", "name": "tween" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "- The new value." } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.GetEndCallback", "scope": "static", "___id": "T000002R044945", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Tweens.GetStartCallback\r\n * @since 3.18.0\r\n *\r\n * @param {any} target - The tween target.\r\n * @param {string} key - The target property.\r\n * @param {number} value - The current value of the target property.\r\n * @param {number} targetIndex - The index of the target within the Tween.\r\n * @param {number} totalTargets - The total number of targets in this Tween.\r\n * @param {Phaser.Tweens.Tween} tween - The Tween that invoked this callback.\r\n *\r\n * @return {number} - The new value.\r\n */", "meta": { "filename": "GetStartCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "GetStartCallback", "type": { "names": [ "function" ] }, "since": "3.18.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The tween target.", "name": "target" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The target property.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current value of the target property.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the target within the Tween.", "name": "targetIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total number of targets in this Tween.", "name": "totalTargets" }, { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The Tween that invoked this callback.", "name": "tween" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "- The new value." } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.GetStartCallback", "scope": "static", "___id": "T000002R044946", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Tweens\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "namespace", "name": "Tweens", "memberof": "Phaser.Types", "longname": "Phaser.Types.Tweens", "scope": "static", "___id": "T000002R044947", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tweens.NumberTweenBuilderConfig\r\n * @since 3.18.0\r\n *\r\n * @property {number} [from=0] - The start number.\r\n * @property {number} [to=1] - The end number.\r\n * @property {number} [delay=0] - The number of milliseconds to delay before the counter will start.\r\n * @property {number} [duration=1000] - The duration of the counter in milliseconds.\r\n * @property {(string|function)} [ease='Power0'] - The easing equation to use for the counter.\r\n * @property {array} [easeParams] - Optional easing parameters.\r\n * @property {number} [hold=0] - The number of milliseconds to hold the counter for before yoyo'ing.\r\n * @property {number} [repeat=0] - The number of times to repeat the counter.\r\n * @property {number} [repeatDelay=0] - The number of milliseconds to pause before the counter will repeat.\r\n * @property {boolean} [yoyo=false] - Should the counter play forward to the end value and then backwards to the start? The reverse playback will also take `duration` milliseconds to complete.\r\n * @property {string|number|function|object|array} [completeDelay=0] - The time the counter will wait before the onComplete event is dispatched once it has completed, in ms.\r\n * @property {string|number|function|object|array} [loop=0] - The number of times the counter will repeat. (A value of 1 means the counter will play twice, as it repeated once.)\r\n * @property {string|number|function|object|array} [loopDelay=0] - The time the counter will pause before starting either a yoyo or returning to the start for a repeat.\r\n * @property {boolean} [paused=false] - Does the counter start in a paused state (true) or playing (false)?\r\n * @property {any} [callbackScope] - Scope (this) for the callbacks. The default scope is the counter.\r\n * @property {Phaser.Types.Tweens.TweenOnCompleteCallback} [onComplete] - A function to call when the counter completes.\r\n * @property {array} [onCompleteParams] - Additional parameters to pass to `onComplete`.\r\n * @property {Phaser.Types.Tweens.TweenOnLoopCallback} [onLoop] - A function to call each time the counter loops.\r\n * @property {array} [onLoopParams] - Additional parameters to pass to `onLoop`.\r\n * @property {Phaser.Types.Tweens.TweenOnRepeatCallback} [onRepeat] - A function to call each time the counter repeats.\r\n * @property {array} [onRepeatParams] - Additional parameters to pass to `onRepeat`.\r\n * @property {Phaser.Types.Tweens.TweenOnStartCallback} [onStart] - A function to call when the counter starts.\r\n * @property {array} [onStartParams] - Additional parameters to pass to `onStart`.\r\n * @property {Phaser.Types.Tweens.TweenOnStopCallback} [onStop] - A function to call when the counter is stopped.\r\n * @property {array} [onStopParams] - Additional parameters to pass to `onStop`.\r\n * @property {Phaser.Types.Tweens.TweenOnUpdateCallback} [onUpdate] - A function to call each time the counter steps.\r\n * @property {array} [onUpdateParams] - Additional parameters to pass to `onUpdate`.\r\n * @property {Phaser.Types.Tweens.TweenOnYoyoCallback} [onYoyo] - A function to call each time the counter yoyos.\r\n * @property {array} [onYoyoParams] - Additional parameters to pass to `onYoyo`.\r\n * @property {Phaser.Types.Tweens.TweenOnPauseCallback} [onPause] - A function to call when the counter is paused.\r\n * @property {array} [onPauseParams] - Additional parameters to pass to `onPause`.\r\n * @property {Phaser.Types.Tweens.TweenOnResumeCallback} [onResume] - A function to call when the counter is resumed after being paused.\r\n * @property {array} [onResumeParams] - Additional parameters to pass to `onResume`.\r\n * @property {boolean} [persist] - Will the counter be automatically destroyed on completion, or retained for future playback?\r\n * @property {(string|function)} [interpolation] - The interpolation function to use if the `value` given is an array of numbers.\r\n */", "meta": { "filename": "NumberTweenBuilderConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "NumberTweenBuilderConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.18.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The start number.", "name": "from" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The end number.", "name": "to" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of milliseconds to delay before the counter will start.", "name": "delay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration of the counter in milliseconds.", "name": "duration" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "defaultvalue": "'Power0'", "description": "The easing equation to use for the counter.", "name": "ease" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Optional easing parameters.", "name": "easeParams" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of milliseconds to hold the counter for before yoyo'ing.", "name": "hold" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of times to repeat the counter.", "name": "repeat" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of milliseconds to pause before the counter will repeat.", "name": "repeatDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the counter play forward to the end value and then backwards to the start? The reverse playback will also take `duration` milliseconds to complete.", "name": "yoyo" }, { "type": { "names": [ "string", "number", "function", "object", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "array" } ] } }, "optional": true, "defaultvalue": 0, "description": "The time the counter will wait before the onComplete event is dispatched once it has completed, in ms.", "name": "completeDelay" }, { "type": { "names": [ "string", "number", "function", "object", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "array" } ] } }, "optional": true, "defaultvalue": 0, "description": "The number of times the counter will repeat. (A value of 1 means the counter will play twice, as it repeated once.)", "name": "loop" }, { "type": { "names": [ "string", "number", "function", "object", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "array" } ] } }, "optional": true, "defaultvalue": 0, "description": "The time the counter will pause before starting either a yoyo or returning to the start for a repeat.", "name": "loopDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does the counter start in a paused state (true) or playing (false)?", "name": "paused" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Scope (this) for the callbacks. The default scope is the counter.", "name": "callbackScope" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnCompleteCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnCompleteCallback" } }, "optional": true, "description": "A function to call when the counter completes.", "name": "onComplete" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onComplete`.", "name": "onCompleteParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnLoopCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnLoopCallback" } }, "optional": true, "description": "A function to call each time the counter loops.", "name": "onLoop" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onLoop`.", "name": "onLoopParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnRepeatCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnRepeatCallback" } }, "optional": true, "description": "A function to call each time the counter repeats.", "name": "onRepeat" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onRepeat`.", "name": "onRepeatParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnStartCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnStartCallback" } }, "optional": true, "description": "A function to call when the counter starts.", "name": "onStart" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onStart`.", "name": "onStartParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnStopCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnStopCallback" } }, "optional": true, "description": "A function to call when the counter is stopped.", "name": "onStop" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onStop`.", "name": "onStopParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnUpdateCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnUpdateCallback" } }, "optional": true, "description": "A function to call each time the counter steps.", "name": "onUpdate" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onUpdate`.", "name": "onUpdateParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnYoyoCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnYoyoCallback" } }, "optional": true, "description": "A function to call each time the counter yoyos.", "name": "onYoyo" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onYoyo`.", "name": "onYoyoParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnPauseCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnPauseCallback" } }, "optional": true, "description": "A function to call when the counter is paused.", "name": "onPause" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onPause`.", "name": "onPauseParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnResumeCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnResumeCallback" } }, "optional": true, "description": "A function to call when the counter is resumed after being paused.", "name": "onResume" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onResume`.", "name": "onResumeParams" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Will the counter be automatically destroyed on completion, or retained for future playback?", "name": "persist" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "description": "The interpolation function to use if the `value` given is an array of numbers.", "name": "interpolation" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.NumberTweenBuilderConfig", "scope": "static", "___id": "T000002R044948", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tweens.StaggerConfig\r\n * @since 3.19.0\r\n *\r\n * @property {number} [start=0] - The value to start the stagger from. Can be used as a way to offset the stagger while still using a range for the value.\r\n * @property {(string|function)} [ease='Linear'] - An ease to apply across the staggered values. Can either be a string, such as 'sine.inout', or a function.\r\n * @property {(string|number)} [from=0] - The index to start the stagger from. Can be the strings `first`, `last` or `center`, or an integer representing the stagger position.\r\n * @property {number[]} [grid] - Set the stagger to run across a grid by providing an array where element 0 is the width of the grid and element 1 is the height. Combine with the 'from' property to control direction.\r\n *\r\n * @example\r\n * {\r\n * grid: [ 20, 8 ],\r\n * from: 'center',\r\n * ease: 'Power0',\r\n * start: 100\r\n * };\r\n */", "meta": { "filename": "StaggerConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "StaggerConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.19.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The value to start the stagger from. Can be used as a way to offset the stagger while still using a range for the value.", "name": "start" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "defaultvalue": "'Linear'", "description": "An ease to apply across the staggered values. Can either be a string, such as 'sine.inout', or a function.", "name": "ease" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "defaultvalue": 0, "description": "The index to start the stagger from. Can be the strings `first`, `last` or `center`, or an integer representing the stagger position.", "name": "from" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "Set the stagger to run across a grid by providing an array where element 0 is the width of the grid and element 1 is the height. Combine with the 'from' property to control direction.", "name": "grid" } ], "examples": [ "{\r grid: [ 20, 8 ],\r from: 'center',\r ease: 'Power0',\r start: 100\r};" ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.StaggerConfig", "scope": "static", "___id": "T000002R044949", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tweens.TweenBuilderConfig\r\n * @extends object\r\n * @since 3.18.0\r\n *\r\n * @property {any} targets - The object, or an array of objects, to run the tween on.\r\n * @property {(number|function)} [delay=0] - The number of milliseconds to delay before the tween will start.\r\n * @property {number} [duration=1000] - The duration of the tween in milliseconds.\r\n * @property {(string|function)} [ease='Power0'] - The easing equation to use for the tween.\r\n * @property {array} [easeParams] - Optional easing parameters.\r\n * @property {number} [hold=0] - The number of milliseconds to hold the tween for before yoyo'ing.\r\n * @property {number} [repeat=0] - The number of times each property tween repeats.\r\n * @property {number} [repeatDelay=0] - The number of milliseconds to pause before a repeat.\r\n * @property {boolean} [yoyo=false] - Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take `duration` milliseconds to complete.\r\n * @property {boolean} [flipX=false] - Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipX` property.\r\n * @property {boolean} [flipY=false] - Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipY` property.\r\n * @property {string|number|function|object|array} [completeDelay=0] - The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.\r\n * @property {string|number|function|object|array} [loop=0] - The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property in the tween has completed once.\r\n * @property {string|number|function|object|array} [loopDelay=0] - The time the tween will pause before starting either a yoyo or returning to the start for a repeat.\r\n * @property {boolean} [paused=false] - Does the tween start in a paused state (true) or playing (false)?\r\n * @property {Object.} [props] - The properties to tween.\r\n * @property {any} [callbackScope] - The scope (or context) for all of the callbacks. The default scope is the tween.\r\n * @property {Phaser.Types.Tweens.TweenOnCompleteCallback} [onComplete] - A function to call when the tween completes.\r\n * @property {array} [onCompleteParams] - Additional parameters to pass to `onComplete`.\r\n * @property {Phaser.Types.Tweens.TweenOnLoopCallback} [onLoop] - A function to call each time the tween loops.\r\n * @property {array} [onLoopParams] - Additional parameters to pass to `onLoop`.\r\n * @property {Phaser.Types.Tweens.TweenOnRepeatCallback} [onRepeat] - A function to call each time a property tween repeats. Called once per property per target.\r\n * @property {array} [onRepeatParams] - Additional parameters to pass to `onRepeat`.\r\n * @property {Phaser.Types.Tweens.TweenOnStartCallback} [onStart] - A function to call when the tween starts playback, after any delays have expired.\r\n * @property {array} [onStartParams] - Additional parameters to pass to `onStart`.\r\n * @property {Phaser.Types.Tweens.TweenOnStopCallback} [onStop] - A function to call when the tween is stopped.\r\n * @property {array} [onStopParams] - Additional parameters to pass to `onStop`.\r\n * @property {Phaser.Types.Tweens.TweenOnUpdateCallback} [onUpdate] - A function to call each time the tween steps. Called once per property per target.\r\n * @property {array} [onUpdateParams] - Additional parameters to pass to `onUpdate`.\r\n * @property {Phaser.Types.Tweens.TweenOnYoyoCallback} [onYoyo] - A function to call each time a property tween yoyos. Called once per property per target.\r\n * @property {array} [onYoyoParams] - Additional parameters to pass to `onYoyo`.\r\n * @property {Phaser.Types.Tweens.TweenOnActiveCallback} [onActive] - A function to call when the tween becomes active within the Tween Manager.\r\n * @property {array} [onActiveParams] - Additional parameters to pass to `onActive`.\r\n * @property {Phaser.Types.Tweens.TweenOnPauseCallback} [onPause] - A function to call when the tween is paused.\r\n * @property {array} [onPauseParams] - Additional parameters to pass to `onPause`.\r\n * @property {Phaser.Types.Tweens.TweenOnResumeCallback} [onResume] - A function to call when the tween is resumed after being paused.\r\n * @property {array} [onResumeParams] - Additional parameters to pass to `onResume`.\r\n * @property {boolean} [persist] - Will the Tween be automatically destroyed on completion, or retained for future playback?\r\n * @property {(string|function)} [interpolation] - The interpolation function to use if the `value` given is an array of numbers.\r\n *\r\n * @example\r\n * {\r\n * targets: null,\r\n * delay: 0,\r\n * duration: 1000,\r\n * ease: 'Power0',\r\n * easeParams: null,\r\n * hold: 0,\r\n * repeat: 0,\r\n * repeatDelay: 0,\r\n * yoyo: false,\r\n * flipX: false,\r\n * flipY: false\r\n * };\r\n */", "meta": { "filename": "TweenBuilderConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenBuilderConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "object" ], "since": "3.18.0", "properties": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The object, or an array of objects, to run the tween on.", "name": "targets" }, { "type": { "names": [ "number", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "defaultvalue": 0, "description": "The number of milliseconds to delay before the tween will start.", "name": "delay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration of the tween in milliseconds.", "name": "duration" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "defaultvalue": "'Power0'", "description": "The easing equation to use for the tween.", "name": "ease" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Optional easing parameters.", "name": "easeParams" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of milliseconds to hold the tween for before yoyo'ing.", "name": "hold" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of times each property tween repeats.", "name": "repeat" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of milliseconds to pause before a repeat.", "name": "repeatDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take `duration` milliseconds to complete.", "name": "yoyo" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipX` property.", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipY` property.", "name": "flipY" }, { "type": { "names": [ "string", "number", "function", "object", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "array" } ] } }, "optional": true, "defaultvalue": 0, "description": "The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.", "name": "completeDelay" }, { "type": { "names": [ "string", "number", "function", "object", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "array" } ] } }, "optional": true, "defaultvalue": 0, "description": "The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property in the tween has completed once.", "name": "loop" }, { "type": { "names": [ "string", "number", "function", "object", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "array" } ] } }, "optional": true, "defaultvalue": 0, "description": "The time the tween will pause before starting either a yoyo or returning to the start for a repeat.", "name": "loopDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does the tween start in a paused state (true) or playing (false)?", "name": "paused" }, { "type": { "names": [ "Object." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetEndCallback" }, { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenPropConfig" } ] } ] } }, "optional": true, "description": "The properties to tween.", "name": "props" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The scope (or context) for all of the callbacks. The default scope is the tween.", "name": "callbackScope" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnCompleteCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnCompleteCallback" } }, "optional": true, "description": "A function to call when the tween completes.", "name": "onComplete" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onComplete`.", "name": "onCompleteParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnLoopCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnLoopCallback" } }, "optional": true, "description": "A function to call each time the tween loops.", "name": "onLoop" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onLoop`.", "name": "onLoopParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnRepeatCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnRepeatCallback" } }, "optional": true, "description": "A function to call each time a property tween repeats. Called once per property per target.", "name": "onRepeat" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onRepeat`.", "name": "onRepeatParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnStartCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnStartCallback" } }, "optional": true, "description": "A function to call when the tween starts playback, after any delays have expired.", "name": "onStart" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onStart`.", "name": "onStartParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnStopCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnStopCallback" } }, "optional": true, "description": "A function to call when the tween is stopped.", "name": "onStop" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onStop`.", "name": "onStopParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnUpdateCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnUpdateCallback" } }, "optional": true, "description": "A function to call each time the tween steps. Called once per property per target.", "name": "onUpdate" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onUpdate`.", "name": "onUpdateParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnYoyoCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnYoyoCallback" } }, "optional": true, "description": "A function to call each time a property tween yoyos. Called once per property per target.", "name": "onYoyo" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onYoyo`.", "name": "onYoyoParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnActiveCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnActiveCallback" } }, "optional": true, "description": "A function to call when the tween becomes active within the Tween Manager.", "name": "onActive" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onActive`.", "name": "onActiveParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnPauseCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnPauseCallback" } }, "optional": true, "description": "A function to call when the tween is paused.", "name": "onPause" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onPause`.", "name": "onPauseParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnResumeCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnResumeCallback" } }, "optional": true, "description": "A function to call when the tween is resumed after being paused.", "name": "onResume" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onResume`.", "name": "onResumeParams" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Will the Tween be automatically destroyed on completion, or retained for future playback?", "name": "persist" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "description": "The interpolation function to use if the `value` given is an array of numbers.", "name": "interpolation" } ], "examples": [ "{\r targets: null,\r delay: 0,\r duration: 1000,\r ease: 'Power0',\r easeParams: null,\r hold: 0,\r repeat: 0,\r repeatDelay: 0,\r yoyo: false,\r flipX: false,\r flipY: false\r};" ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenBuilderConfig", "scope": "static", "___id": "T000002R044950", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tweens.TweenCallbacks\r\n * @since 3.60.0\r\n *\r\n * @property {Phaser.Types.Tweens.TweenOnActiveCallback} [onActive] - A function to call when the tween becomes active within the Tween Manager.\r\n * @property {Phaser.Types.Tweens.TweenOnStartCallback} [onStart] - A function to call when the tween starts playback, after any delays have expired.\r\n * @property {Phaser.Types.Tweens.TweenOnCompleteCallback} [onComplete] - A function to call when the tween completes.\r\n * @property {Phaser.Types.Tweens.TweenOnLoopCallback} [onLoop] - A function to call each time the tween loops.\r\n * @property {Phaser.Types.Tweens.TweenOnPauseCallback} [onPause] - A function to call each time the tween is paused.\r\n * @property {Phaser.Types.Tweens.TweenOnResumeCallback} [onResume] - A function to call each time the tween is resumed.\r\n * @property {Phaser.Types.Tweens.TweenOnRepeatCallback} [onRepeat] - A function to call each time the tween repeats. Called once per property per target.\r\n * @property {Phaser.Types.Tweens.TweenOnStopCallback} [onStop] - A function to call when the tween is stopped.\r\n * @property {Phaser.Types.Tweens.TweenOnUpdateCallback} [onUpdate] - A function to call each time the tween steps. Called once per property per target.\r\n * @property {Phaser.Types.Tweens.TweenOnYoyoCallback} [onYoyo] - A function to call each time the tween yoyos. Called once per property per target.\r\n */", "meta": { "filename": "TweenCallbacks.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenCallbacks", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "Phaser.Types.Tweens.TweenOnActiveCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnActiveCallback" } }, "optional": true, "description": "A function to call when the tween becomes active within the Tween Manager.", "name": "onActive" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnStartCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnStartCallback" } }, "optional": true, "description": "A function to call when the tween starts playback, after any delays have expired.", "name": "onStart" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnCompleteCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnCompleteCallback" } }, "optional": true, "description": "A function to call when the tween completes.", "name": "onComplete" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnLoopCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnLoopCallback" } }, "optional": true, "description": "A function to call each time the tween loops.", "name": "onLoop" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnPauseCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnPauseCallback" } }, "optional": true, "description": "A function to call each time the tween is paused.", "name": "onPause" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnResumeCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnResumeCallback" } }, "optional": true, "description": "A function to call each time the tween is resumed.", "name": "onResume" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnRepeatCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnRepeatCallback" } }, "optional": true, "description": "A function to call each time the tween repeats. Called once per property per target.", "name": "onRepeat" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnStopCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnStopCallback" } }, "optional": true, "description": "A function to call when the tween is stopped.", "name": "onStop" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnUpdateCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnUpdateCallback" } }, "optional": true, "description": "A function to call each time the tween steps. Called once per property per target.", "name": "onUpdate" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnYoyoCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnYoyoCallback" } }, "optional": true, "description": "A function to call each time the tween yoyos. Called once per property per target.", "name": "onYoyo" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenCallbacks", "scope": "static", "___id": "T000002R044951", "___s": true }, { "comment": "/**\r\n * @typedef {('onActive'|'onComplete'|'onLoop'|'onPause'|'onRepeat'|'onResume'|'onStart'|'onStop'|'onUpdate'|'onYoyo')} Phaser.Types.Tweens.TweenCallbackTypes\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TweenCallbackTypes.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenCallbackTypes", "type": { "names": [ "'onActive'", "'onComplete'", "'onLoop'", "'onPause'", "'onRepeat'", "'onResume'", "'onStart'", "'onStop'", "'onUpdate'", "'onYoyo'" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "'onActive'" }, { "type": "NameExpression", "name": "'onComplete'" }, { "type": "NameExpression", "name": "'onLoop'" }, { "type": "NameExpression", "name": "'onPause'" }, { "type": "NameExpression", "name": "'onRepeat'" }, { "type": "NameExpression", "name": "'onResume'" }, { "type": "NameExpression", "name": "'onStart'" }, { "type": "NameExpression", "name": "'onStop'" }, { "type": "NameExpression", "name": "'onUpdate'" }, { "type": "NameExpression", "name": "'onYoyo'" } ] } }, "since": "3.60.0", "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenCallbackTypes", "scope": "static", "___id": "T000002R044952", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tweens.TweenChainBuilderConfig\r\n * @extends object\r\n * @since 3.60.0\r\n *\r\n * @property {any} targets - The object, or an array of objects, to run the tween on.\r\n * @property {(number|function)} [delay=0] - The number of milliseconds to delay before the tween will start.\r\n * @property {number} [hold=0] - The number of milliseconds to hold the tween for before yoyo'ing.\r\n * @property {number} [repeat=0] - The number of times each property tween repeats.\r\n * @property {number} [repeatDelay=0] - The number of milliseconds to pause before a repeat.\r\n * @property {string|number|function|object|array} [completeDelay=0] - The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.\r\n * @property {string|number|function|object|array} [loop=0] - The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property in the tween has completed once.\r\n * @property {string|number|function|object|array} [loopDelay=0] - The time the tween will pause before starting either a yoyo or returning to the start for a repeat.\r\n * @property {boolean} [paused=false] - Does the tween start in a paused state (true) or playing (false)?\r\n * @property {Phaser.Types.Tweens.TweenBuilderConfig[]} [tweens] - The tweens to chain together.\r\n * @property {any} [callbackScope] - The scope (or context) for all of the callbacks. The default scope is the tween.\r\n * @property {Phaser.Types.Tweens.TweenOnCompleteCallback} [onComplete] - A function to call when the tween completes.\r\n * @property {array} [onCompleteParams] - Additional parameters to pass to `onComplete`.\r\n * @property {Phaser.Types.Tweens.TweenOnLoopCallback} [onLoop] - A function to call each time the tween loops.\r\n * @property {array} [onLoopParams] - Additional parameters to pass to `onLoop`.\r\n * @property {Phaser.Types.Tweens.TweenOnRepeatCallback} [onRepeat] - A function to call each time the tween repeats. Called once per property per target.\r\n * @property {array} [onRepeatParams] - Additional parameters to pass to `onRepeat`.\r\n * @property {Phaser.Types.Tweens.TweenOnStartCallback} [onStart] - A function to call when the tween starts playback, after any delays have expired.\r\n * @property {array} [onStartParams] - Additional parameters to pass to `onStart`.\r\n * @property {Phaser.Types.Tweens.TweenOnStopCallback} [onStop] - A function to call when the tween is stopped.\r\n * @property {array} [onStopParams] - Additional parameters to pass to `onStop`.\r\n * @property {Phaser.Types.Tweens.TweenOnUpdateCallback} [onUpdate] - A function to call each time the tween steps. Called once per property per target.\r\n * @property {array} [onUpdateParams] - Additional parameters to pass to `onUpdate`.\r\n * @property {Phaser.Types.Tweens.TweenOnYoyoCallback} [onYoyo] - A function to call each time the tween yoyos. Called once per property per target.\r\n * @property {array} [onYoyoParams] - Additional parameters to pass to `onYoyo`.\r\n * @property {Phaser.Types.Tweens.TweenOnActiveCallback} [onActive] - A function to call when the tween becomes active within the Tween Manager.\r\n * @property {array} [onActiveParams] - Additional parameters to pass to `onActive`.\r\n * @property {Phaser.Types.Tweens.TweenOnPauseCallback} [onPause] - A function to call when the tween is paused.\r\n * @property {array} [onPauseParams] - Additional parameters to pass to `onPause`.\r\n * @property {Phaser.Types.Tweens.TweenOnResumeCallback} [onResume] - A function to call when the tween is resumed after being paused.\r\n * @property {array} [onResumeParams] - Additional parameters to pass to `onResume`.\r\n * @property {boolean} [persist] - Will the Tween be automatically destroyed on completion, or retained for future playback?\r\n */", "meta": { "filename": "TweenChainBuilderConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenChainBuilderConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "object" ], "since": "3.60.0", "properties": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The object, or an array of objects, to run the tween on.", "name": "targets" }, { "type": { "names": [ "number", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "defaultvalue": 0, "description": "The number of milliseconds to delay before the tween will start.", "name": "delay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of milliseconds to hold the tween for before yoyo'ing.", "name": "hold" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of times each property tween repeats.", "name": "repeat" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of milliseconds to pause before a repeat.", "name": "repeatDelay" }, { "type": { "names": [ "string", "number", "function", "object", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "array" } ] } }, "optional": true, "defaultvalue": 0, "description": "The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.", "name": "completeDelay" }, { "type": { "names": [ "string", "number", "function", "object", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "array" } ] } }, "optional": true, "defaultvalue": 0, "description": "The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property in the tween has completed once.", "name": "loop" }, { "type": { "names": [ "string", "number", "function", "object", "array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "array" } ] } }, "optional": true, "defaultvalue": 0, "description": "The time the tween will pause before starting either a yoyo or returning to the start for a repeat.", "name": "loopDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does the tween start in a paused state (true) or playing (false)?", "name": "paused" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Tweens.TweenBuilderConfig", "type": "NameExpression" } ] } }, "optional": true, "description": "The tweens to chain together.", "name": "tweens" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The scope (or context) for all of the callbacks. The default scope is the tween.", "name": "callbackScope" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnCompleteCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnCompleteCallback" } }, "optional": true, "description": "A function to call when the tween completes.", "name": "onComplete" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onComplete`.", "name": "onCompleteParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnLoopCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnLoopCallback" } }, "optional": true, "description": "A function to call each time the tween loops.", "name": "onLoop" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onLoop`.", "name": "onLoopParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnRepeatCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnRepeatCallback" } }, "optional": true, "description": "A function to call each time the tween repeats. Called once per property per target.", "name": "onRepeat" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onRepeat`.", "name": "onRepeatParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnStartCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnStartCallback" } }, "optional": true, "description": "A function to call when the tween starts playback, after any delays have expired.", "name": "onStart" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onStart`.", "name": "onStartParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnStopCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnStopCallback" } }, "optional": true, "description": "A function to call when the tween is stopped.", "name": "onStop" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onStop`.", "name": "onStopParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnUpdateCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnUpdateCallback" } }, "optional": true, "description": "A function to call each time the tween steps. Called once per property per target.", "name": "onUpdate" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onUpdate`.", "name": "onUpdateParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnYoyoCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnYoyoCallback" } }, "optional": true, "description": "A function to call each time the tween yoyos. Called once per property per target.", "name": "onYoyo" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onYoyo`.", "name": "onYoyoParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnActiveCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnActiveCallback" } }, "optional": true, "description": "A function to call when the tween becomes active within the Tween Manager.", "name": "onActive" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onActive`.", "name": "onActiveParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnPauseCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnPauseCallback" } }, "optional": true, "description": "A function to call when the tween is paused.", "name": "onPause" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onPause`.", "name": "onPauseParams" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenOnResumeCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenOnResumeCallback" } }, "optional": true, "description": "A function to call when the tween is resumed after being paused.", "name": "onResume" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "Additional parameters to pass to `onResume`.", "name": "onResumeParams" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Will the Tween be automatically destroyed on completion, or retained for future playback?", "name": "persist" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenChainBuilderConfig", "scope": "static", "___id": "T000002R044953", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tweens.TweenDataConfig\r\n * @since 3.0.0\r\n *\r\n * @property {any} target - The target to tween.\r\n * @property {number} index - The target index within the Tween targets array.\r\n * @property {string} key - The property of the target being tweened.\r\n * @property {?Phaser.Types.Tweens.GetActiveCallback} getActiveValue - If not null, is invoked _immediately_ as soon as the TweenData is running, and is set on the target property.\r\n * @property {Phaser.Types.Tweens.GetEndCallback} getEndValue - The returned value sets what the property will be at the END of the Tween.\r\n * @property {Phaser.Types.Tweens.GetStartCallback} getStartValue - The returned value sets what the property will be at the START of the Tween.\r\n * @property {function} ease - The ease function this tween uses.\r\n * @property {number} [duration=0] - Duration of the tween in milliseconds, excludes time for yoyo or repeats.\r\n * @property {number} [totalDuration=0] - The total calculated duration of this TweenData (based on duration, repeat, delay and yoyo)\r\n * @property {number} [delay=0] - Time in milliseconds before tween will start.\r\n * @property {boolean} [yoyo=false] - Cause the tween to return back to its start value after hold has expired.\r\n * @property {number} [hold=0] - Time in milliseconds the tween will pause before running the yoyo or starting a repeat.\r\n * @property {number} [repeat=0] - Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.\r\n * @property {number} [repeatDelay=0] - Time in milliseconds before the repeat will start.\r\n * @property {boolean} [flipX=false] - Automatically call toggleFlipX when the TweenData yoyos or repeats\r\n * @property {boolean} [flipY=false] - Automatically call toggleFlipY when the TweenData yoyos or repeats\r\n * @property {number} [progress=0] - Between 0 and 1 showing completion of this TweenData.\r\n * @property {number} [elapsed=0] - Delta counter\r\n * @property {number} [repeatCounter=0] - How many repeats are left to run?\r\n * @property {number} [start=0] - The property value at the start of the ease.\r\n * @property {number} [current=0] - The current propety value.\r\n * @property {number} [previous=0] - The previous property value.\r\n * @property {number} [end=0] - The property value at the end of the ease.\r\n * @property {Phaser.Types.Tweens.TweenDataGenConfig} [gen] - LoadValue generation functions.\r\n * @property {Phaser.Tweens.StateType} [state=0] - TWEEN_CONST.CREATED\r\n */", "meta": { "filename": "TweenDataConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenDataConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The target to tween.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The target index within the Tween targets array.", "name": "index" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property of the target being tweened.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Tweens.GetActiveCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetActiveCallback", "nullable": true } }, "nullable": true, "description": "If not null, is invoked _immediately_ as soon as the TweenData is running, and is set on the target property.", "name": "getActiveValue" }, { "type": { "names": [ "Phaser.Types.Tweens.GetEndCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetEndCallback" } }, "description": "The returned value sets what the property will be at the END of the Tween.", "name": "getEndValue" }, { "type": { "names": [ "Phaser.Types.Tweens.GetStartCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetStartCallback" } }, "description": "The returned value sets what the property will be at the START of the Tween.", "name": "getStartValue" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The ease function this tween uses.", "name": "ease" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Duration of the tween in milliseconds, excludes time for yoyo or repeats.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The total calculated duration of this TweenData (based on duration, repeat, delay and yoyo)", "name": "totalDuration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Time in milliseconds before tween will start.", "name": "delay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Cause the tween to return back to its start value after hold has expired.", "name": "yoyo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Time in milliseconds the tween will pause before running the yoyo or starting a repeat.", "name": "hold" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.", "name": "repeat" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Time in milliseconds before the repeat will start.", "name": "repeatDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Automatically call toggleFlipX when the TweenData yoyos or repeats", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Automatically call toggleFlipY when the TweenData yoyos or repeats", "name": "flipY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Between 0 and 1 showing completion of this TweenData.", "name": "progress" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Delta counter", "name": "elapsed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "How many repeats are left to run?", "name": "repeatCounter" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The property value at the start of the ease.", "name": "start" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The current propety value.", "name": "current" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The previous property value.", "name": "previous" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The property value at the end of the ease.", "name": "end" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenDataGenConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenDataGenConfig" } }, "optional": true, "description": "LoadValue generation functions.", "name": "gen" }, { "type": { "names": [ "Phaser.Tweens.StateType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.StateType" } }, "optional": true, "defaultvalue": 0, "description": "TWEEN_CONST.CREATED", "name": "state" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenDataConfig", "scope": "static", "___id": "T000002R044954", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tweens.TweenDataGenConfig\r\n * @since 3.0.0\r\n *\r\n * @property {function} delay - Time in milliseconds before tween will start.\r\n * @property {function} duration - Duration of the tween in milliseconds, excludes time for yoyo or repeats.\r\n * @property {function} hold - Time in milliseconds the tween will pause before running the yoyo or starting a repeat.\r\n * @property {function} repeat - Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.\r\n * @property {function} repeatDelay - Time in milliseconds before the repeat will start.\r\n */", "meta": { "filename": "TweenDataGenConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenDataGenConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "Time in milliseconds before tween will start.", "name": "delay" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "Duration of the tween in milliseconds, excludes time for yoyo or repeats.", "name": "duration" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "Time in milliseconds the tween will pause before running the yoyo or starting a repeat.", "name": "hold" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.", "name": "repeat" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "Time in milliseconds before the repeat will start.", "name": "repeatDelay" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenDataGenConfig", "scope": "static", "___id": "T000002R044955", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tweens.TweenFrameDataConfig\r\n * @since 3.60.0\r\n *\r\n * @property {any} target - The target to tween.\r\n * @property {number} index - The target index within the Tween targets array.\r\n * @property {string} key - The property of the target being tweened.\r\n * @property {number} [duration=0] - Duration of the tween in milliseconds, excludes time for yoyo or repeats.\r\n * @property {number} [totalDuration=0] - The total calculated duration of this TweenData (based on duration, repeat, delay and yoyo)\r\n * @property {number} [delay=0] - Time in milliseconds before tween will start.\r\n * @property {number} [hold=0] - Time in milliseconds the tween will pause before running the yoyo or starting a repeat.\r\n * @property {number} [repeat=0] - Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.\r\n * @property {number} [repeatDelay=0] - Time in milliseconds before the repeat will start.\r\n * @property {boolean} [flipX=false] - Automatically call toggleFlipX when the TweenData yoyos or repeats\r\n * @property {boolean} [flipY=false] - Automatically call toggleFlipY when the TweenData yoyos or repeats\r\n * @property {number} [progress=0] - Between 0 and 1 showing completion of this TweenData.\r\n * @property {number} [elapsed=0] - Delta counter\r\n * @property {number} [repeatCounter=0] - How many repeats are left to run?\r\n * @property {Phaser.Types.Tweens.TweenDataGenConfig} [gen] - LoadValue generation functions.\r\n * @property {Phaser.Tweens.StateType} [state=0] - TWEEN_CONST.CREATED\r\n */", "meta": { "filename": "TweenFrameDataConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenFrameDataConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The target to tween.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The target index within the Tween targets array.", "name": "index" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property of the target being tweened.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Duration of the tween in milliseconds, excludes time for yoyo or repeats.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The total calculated duration of this TweenData (based on duration, repeat, delay and yoyo)", "name": "totalDuration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Time in milliseconds before tween will start.", "name": "delay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Time in milliseconds the tween will pause before running the yoyo or starting a repeat.", "name": "hold" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.", "name": "repeat" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Time in milliseconds before the repeat will start.", "name": "repeatDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Automatically call toggleFlipX when the TweenData yoyos or repeats", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Automatically call toggleFlipY when the TweenData yoyos or repeats", "name": "flipY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Between 0 and 1 showing completion of this TweenData.", "name": "progress" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Delta counter", "name": "elapsed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "How many repeats are left to run?", "name": "repeatCounter" }, { "type": { "names": [ "Phaser.Types.Tweens.TweenDataGenConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenDataGenConfig" } }, "optional": true, "description": "LoadValue generation functions.", "name": "gen" }, { "type": { "names": [ "Phaser.Tweens.StateType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.StateType" } }, "optional": true, "defaultvalue": 0, "description": "TWEEN_CONST.CREATED", "name": "state" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenFrameDataConfig", "scope": "static", "___id": "T000002R044956", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Tweens.TweenOnActiveCallback\r\n * @since 3.19.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween.\r\n * @param {(any|any[])} targets - The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.\r\n * @param {...any} param - Any value passed in `onActiveParams`.\r\n */", "meta": { "filename": "TweenOnActiveCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenOnActiveCallback", "type": { "names": [ "function" ] }, "since": "3.19.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween.", "name": "tween" }, { "type": { "names": [ "any", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "any" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "description": "The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.", "name": "targets" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "repeatable": true } }, "variable": true, "description": "Any value passed in `onActiveParams`.", "name": "param" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenOnActiveCallback", "scope": "static", "___id": "T000002R044957", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Tweens.TweenOnCompleteCallback\r\n * @since 3.18.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween.\r\n * @param {(any|any[])} targets - The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.\r\n * @param {...any} param - Any value passed in `onCompleteParams`.\r\n */", "meta": { "filename": "TweenOnCompleteCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenOnCompleteCallback", "type": { "names": [ "function" ] }, "since": "3.18.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween.", "name": "tween" }, { "type": { "names": [ "any", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "any" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "description": "The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.", "name": "targets" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "repeatable": true } }, "variable": true, "description": "Any value passed in `onCompleteParams`.", "name": "param" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenOnCompleteCallback", "scope": "static", "___id": "T000002R044958", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Tweens.TweenOnLoopCallback\r\n * @since 3.18.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween.\r\n * @param {(any|any[])} targets - The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.\r\n * @param {...any} param - Any value passed in `onLoopParams`.\r\n */", "meta": { "filename": "TweenOnLoopCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenOnLoopCallback", "type": { "names": [ "function" ] }, "since": "3.18.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween.", "name": "tween" }, { "type": { "names": [ "any", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "any" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "description": "The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.", "name": "targets" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "repeatable": true } }, "variable": true, "description": "Any value passed in `onLoopParams`.", "name": "param" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenOnLoopCallback", "scope": "static", "___id": "T000002R044959", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Tweens.TweenOnPauseCallback\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween.\r\n * @param {(any|any[])} targets - The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.\r\n * @param {...any} param - Any value passed in `onPauseParams`.\r\n */", "meta": { "filename": "TweenOnPauseCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenOnPauseCallback", "type": { "names": [ "function" ] }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween.", "name": "tween" }, { "type": { "names": [ "any", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "any" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "description": "The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.", "name": "targets" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "repeatable": true } }, "variable": true, "description": "Any value passed in `onPauseParams`.", "name": "param" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenOnPauseCallback", "scope": "static", "___id": "T000002R044960", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Tweens.TweenOnRepeatCallback\r\n * @since 3.18.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween.\r\n * @param {any} target - The current target of the Tween. If this Tween has multiple targets, this will be a reference to just the single one being updated prior to this callback.\r\n * @param {string} key - The property that is being updated on the target.\r\n * @param {number} current - The current value of the property being set on the target.\r\n * @param {number} previous - The previous value of the property being set on the target.\r\n * @param {...any} param - Any value passed in `onRepeatParams`.\r\n */", "meta": { "filename": "TweenOnRepeatCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenOnRepeatCallback", "type": { "names": [ "function" ] }, "since": "3.18.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween.", "name": "tween" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The current target of the Tween. If this Tween has multiple targets, this will be a reference to just the single one being updated prior to this callback.", "name": "target" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property that is being updated on the target.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current value of the property being set on the target.", "name": "current" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The previous value of the property being set on the target.", "name": "previous" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "repeatable": true } }, "variable": true, "description": "Any value passed in `onRepeatParams`.", "name": "param" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenOnRepeatCallback", "scope": "static", "___id": "T000002R044961", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Tweens.TweenOnResumeCallback\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween.\r\n * @param {(any|any[])} targets - The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.\r\n * @param {...any} param - Any value passed in `onPauseParams`.\r\n */", "meta": { "filename": "TweenOnResumeCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenOnResumeCallback", "type": { "names": [ "function" ] }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween.", "name": "tween" }, { "type": { "names": [ "any", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "any" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "description": "The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.", "name": "targets" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "repeatable": true } }, "variable": true, "description": "Any value passed in `onPauseParams`.", "name": "param" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenOnResumeCallback", "scope": "static", "___id": "T000002R044962", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Tweens.TweenOnStartCallback\r\n * @since 3.18.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween.\r\n * @param {(any|any[])} targets - The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.\r\n * @param {...any} param - Any value passed in `onStartParams`.\r\n */", "meta": { "filename": "TweenOnStartCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenOnStartCallback", "type": { "names": [ "function" ] }, "since": "3.18.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween.", "name": "tween" }, { "type": { "names": [ "any", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "any" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "description": "The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.", "name": "targets" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "repeatable": true } }, "variable": true, "description": "Any value passed in `onStartParams`.", "name": "param" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenOnStartCallback", "scope": "static", "___id": "T000002R044963", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Tweens.TweenOnStopCallback\r\n * @since 3.24.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween.\r\n * @param {(any|any[])} targets - The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.\r\n * @param {...any} param - Any value passed in `onStopParams`.\r\n */", "meta": { "filename": "TweenOnStopCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenOnStopCallback", "type": { "names": [ "function" ] }, "since": "3.24.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween.", "name": "tween" }, { "type": { "names": [ "any", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "any" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "description": "The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.", "name": "targets" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "repeatable": true } }, "variable": true, "description": "Any value passed in `onStopParams`.", "name": "param" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenOnStopCallback", "scope": "static", "___id": "T000002R044964", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Tweens.TweenOnUpdateCallback\r\n * @since 3.18.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween.\r\n * @param {any} target - The current target of the Tween. If this Tween has multiple targets, this will be a reference to just the single one being updated prior to this callback.\r\n * @param {string} key - The property that is being updated on the target.\r\n * @param {number} current - The current value of the property being set on the target.\r\n * @param {number} previous - The previous value of the property being set on the target.\r\n * @param {...any} param - Any value passed in `onUpdateParams`.\r\n */", "meta": { "filename": "TweenOnUpdateCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenOnUpdateCallback", "type": { "names": [ "function" ] }, "since": "3.18.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween.", "name": "tween" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The current target of the Tween. If this Tween has multiple targets, this will be a reference to just the single one being updated prior to this callback.", "name": "target" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property that is being updated on the target.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current value of the property being set on the target.", "name": "current" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The previous value of the property being set on the target.", "name": "previous" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "repeatable": true } }, "variable": true, "description": "Any value passed in `onUpdateParams`.", "name": "param" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenOnUpdateCallback", "scope": "static", "___id": "T000002R044965", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Tweens.TweenOnYoyoCallback\r\n * @since 3.18.0\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - A reference to the Tween.\r\n * @param {any} target - The current target of the Tween. If this Tween has multiple targets, this will be a reference to just the single one being updated prior to this callback.\r\n * @param {string} key - The property that is being updated on the target.\r\n * @param {number} current - The current value of the property being set on the target.\r\n * @param {number} previous - The previous value of the property being set on the target.\r\n * @param {...any} param - Any value passed in `onYoyoParams`.\r\n */", "meta": { "filename": "TweenOnYoyoCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenOnYoyoCallback", "type": { "names": [ "function" ] }, "since": "3.18.0", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "A reference to the Tween.", "name": "tween" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The current target of the Tween. If this Tween has multiple targets, this will be a reference to just the single one being updated prior to this callback.", "name": "target" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property that is being updated on the target.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current value of the property being set on the target.", "name": "current" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The previous value of the property being set on the target.", "name": "previous" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "repeatable": true } }, "variable": true, "description": "Any value passed in `onYoyoParams`.", "name": "param" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenOnYoyoCallback", "scope": "static", "___id": "T000002R044966", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Tweens.TweenPropConfig\r\n * @since 3.18.0\r\n *\r\n * @property {(number|number[]|string|Phaser.Types.Tweens.GetEndCallback|Phaser.Types.Tweens.TweenPropConfig)} [value] - What the property will be at the END of the Tween.\r\n * @property {Phaser.Types.Tweens.GetActiveCallback} [getActive] - What the property will be set to immediately when this tween becomes active.\r\n * @property {Phaser.Types.Tweens.GetEndCallback} [getEnd] - What the property will be at the END of the Tween.\r\n * @property {Phaser.Types.Tweens.GetStartCallback} [getStart] - What the property will be at the START of the Tween.\r\n * @property {(string|function)} [ease] - The ease function this tween uses.\r\n * @property {number} [delay] - Time in milliseconds before tween will start.\r\n * @property {number} [duration] - Duration of the tween in milliseconds.\r\n * @property {boolean} [yoyo] - Determines whether the tween should return back to its start value after hold has expired.\r\n * @property {number} [hold] - Time in milliseconds the tween will pause before repeating or returning to its starting value if yoyo is set to true.\r\n * @property {number} [repeat] - Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.\r\n * @property {number} [repeatDelay] - Time in milliseconds before the repeat will start.\r\n * @property {boolean} [flipX] - Should toggleFlipX be called when yoyo or repeat happens?\r\n * @property {boolean} [flipY] - Should toggleFlipY be called when yoyo or repeat happens?\r\n * @property {(string|function)} [interpolation] - The interpolation function to use if the `value` given is an array of numbers.\r\n */", "meta": { "filename": "TweenPropConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\typedefs", "code": {} }, "kind": "typedef", "name": "TweenPropConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.18.0", "properties": [ { "type": { "names": [ "number", "Array.", "string", "Phaser.Types.Tweens.GetEndCallback", "Phaser.Types.Tweens.TweenPropConfig" ], "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": "NameExpression", "name": "Phaser.Types.Tweens.GetEndCallback" }, { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenPropConfig" } ] } }, "optional": true, "description": "What the property will be at the END of the Tween.", "name": "value" }, { "type": { "names": [ "Phaser.Types.Tweens.GetActiveCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetActiveCallback" } }, "optional": true, "description": "What the property will be set to immediately when this tween becomes active.", "name": "getActive" }, { "type": { "names": [ "Phaser.Types.Tweens.GetEndCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetEndCallback" } }, "optional": true, "description": "What the property will be at the END of the Tween.", "name": "getEnd" }, { "type": { "names": [ "Phaser.Types.Tweens.GetStartCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.GetStartCallback" } }, "optional": true, "description": "What the property will be at the START of the Tween.", "name": "getStart" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "description": "The ease function this tween uses.", "name": "ease" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Time in milliseconds before tween will start.", "name": "delay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Duration of the tween in milliseconds.", "name": "duration" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Determines whether the tween should return back to its start value after hold has expired.", "name": "yoyo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Time in milliseconds the tween will pause before repeating or returning to its starting value if yoyo is set to true.", "name": "hold" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.", "name": "repeat" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Time in milliseconds before the repeat will start.", "name": "repeatDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Should toggleFlipX be called when yoyo or repeat happens?", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Should toggleFlipY be called when yoyo or repeat happens?", "name": "flipY" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "description": "The interpolation function to use if the `value` given is an array of numbers.", "name": "interpolation" } ], "memberof": "Phaser.Types.Tweens", "longname": "Phaser.Types.Tweens.TweenPropConfig", "scope": "static", "___id": "T000002R044967", "___s": true }, { "comment": "/**\r\n * Adds the given item, or array of items, to the array.\r\n *\r\n * Each item must be unique within the array.\r\n *\r\n * The array is modified in-place and returned.\r\n *\r\n * You can optionally specify a limit to the maximum size of the array. If the quantity of items being\r\n * added will take the array length over this limit, it will stop adding once the limit is reached.\r\n *\r\n * You can optionally specify a callback to be invoked for each item successfully added to the array.\r\n *\r\n * @function Phaser.Utils.Array.Add\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The array to be added to.\r\n * @param {any|any[]} item - The item, or array of items, to add to the array. Each item must be unique within the array.\r\n * @param {number} [limit] - Optional limit which caps the size of the array.\r\n * @param {function} [callback] - A callback to be invoked for each item successfully added to the array.\r\n * @param {object} [context] - The context in which the callback is invoked.\r\n *\r\n * @return {array} The input array.\r\n */", "meta": { "filename": "Add.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Adds the given item, or array of items, to the array.\r\rEach item must be unique within the array.\r\rThe array is modified in-place and returned.\r\rYou can optionally specify a limit to the maximum size of the array. If the quantity of items being\radded will take the array length over this limit, it will stop adding once the limit is reached.\r\rYou can optionally specify a callback to be invoked for each item successfully added to the array.", "kind": "function", "name": "Add", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to be added to.", "name": "array" }, { "type": { "names": [ "any", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "any" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "description": "The item, or array of items, to add to the array. Each item must be unique within the array.", "name": "item" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional limit which caps the size of the array.", "name": "limit" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "A callback to be invoked for each item successfully added to the array.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The context in which the callback is invoked.", "name": "context" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The input array." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.Add", "scope": "static", "___id": "T000002R044968", "___s": true }, { "comment": "/**\r\n * Adds the given item, or array of items, to the array starting at the index specified.\r\n *\r\n * Each item must be unique within the array.\r\n *\r\n * Existing elements in the array are shifted up.\r\n *\r\n * The array is modified in-place and returned.\r\n *\r\n * You can optionally specify a limit to the maximum size of the array. If the quantity of items being\r\n * added will take the array length over this limit, it will stop adding once the limit is reached.\r\n *\r\n * You can optionally specify a callback to be invoked for each item successfully added to the array.\r\n *\r\n * @function Phaser.Utils.Array.AddAt\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The array to be added to.\r\n * @param {any|any[]} item - The item, or array of items, to add to the array.\r\n * @param {number} [index=0] - The index in the array where the item will be inserted.\r\n * @param {number} [limit] - Optional limit which caps the size of the array.\r\n * @param {function} [callback] - A callback to be invoked for each item successfully added to the array.\r\n * @param {object} [context] - The context in which the callback is invoked.\r\n *\r\n * @return {array} The input array.\r\n */", "meta": { "filename": "AddAt.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Adds the given item, or array of items, to the array starting at the index specified.\r\rEach item must be unique within the array.\r\rExisting elements in the array are shifted up.\r\rThe array is modified in-place and returned.\r\rYou can optionally specify a limit to the maximum size of the array. If the quantity of items being\radded will take the array length over this limit, it will stop adding once the limit is reached.\r\rYou can optionally specify a callback to be invoked for each item successfully added to the array.", "kind": "function", "name": "AddAt", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to be added to.", "name": "array" }, { "type": { "names": [ "any", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "any" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "description": "The item, or array of items, to add to the array.", "name": "item" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The index in the array where the item will be inserted.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional limit which caps the size of the array.", "name": "limit" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "A callback to be invoked for each item successfully added to the array.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The context in which the callback is invoked.", "name": "context" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The input array." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.AddAt", "scope": "static", "___id": "T000002R044978", "___s": true }, { "comment": "/**\r\n * Moves the given element to the top of the array.\r\n * The array is modified in-place.\r\n *\r\n * @function Phaser.Utils.Array.BringToTop\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The array.\r\n * @param {*} item - The element to move.\r\n *\r\n * @return {*} The element that was moved.\r\n */", "meta": { "filename": "BringToTop.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Moves the given element to the top of the array.\rThe array is modified in-place.", "kind": "function", "name": "BringToTop", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array.", "name": "array" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The element to move.", "name": "item" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The element that was moved." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.BringToTop", "scope": "static", "___id": "T000002R044989", "___s": true }, { "comment": "/**\r\n * Returns the total number of elements in the array which have a property matching the given value.\r\n *\r\n * @function Phaser.Utils.Array.CountAllMatching\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The array to search.\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 {number} The total number of elements with properties matching the given value.\r\n */", "meta": { "filename": "CountAllMatching.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Returns the total number of elements in the array which have a property matching the given value.", "kind": "function", "name": "CountAllMatching", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to search.", "name": "array" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property to test on each array element.", "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, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total number of elements with properties matching the given value." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.CountAllMatching", "scope": "static", "___id": "T000002R044994", "___s": true }, { "comment": "/**\r\n * Passes each element in the array to the given callback.\r\n *\r\n * @function Phaser.Utils.Array.Each\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The array to search.\r\n * @param {function} callback - A callback to be invoked for each item in the array.\r\n * @param {object} context - The context in which the callback is invoked.\r\n * @param {...*} [args] - Additional arguments that will be passed to the callback, after the current array item.\r\n *\r\n * @return {array} The input array.\r\n */", "meta": { "filename": "Each.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Passes each element in the array to the given callback.", "kind": "function", "name": "Each", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to search.", "name": "array" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "A callback to be invoked for each item in the array.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The context in which the callback is invoked.", "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 current array item.", "name": "args" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The input array." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.Each", "scope": "static", "___id": "T000002R045002", "___s": true }, { "comment": "/**\r\n * Passes each element in the array, between the start and end indexes, to the given callback.\r\n *\r\n * @function Phaser.Utils.Array.EachInRange\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The array to search.\r\n * @param {function} callback - A callback to be invoked for each item in the array.\r\n * @param {object} context - The context in which the callback is invoked.\r\n * @param {number} startIndex - The start index to search from.\r\n * @param {number} endIndex - The end index to search to.\r\n * @param {...*} [args] - Additional arguments that will be passed to the callback, after the child.\r\n *\r\n * @return {array} The input array.\r\n */", "meta": { "filename": "EachInRange.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Passes each element in the array, between the start and end indexes, to the given callback.", "kind": "function", "name": "EachInRange", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to search.", "name": "array" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "A callback to be invoked for each item in the array.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The context in which the callback is invoked.", "name": "context" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The start index to search from.", "name": "startIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The end index to search to.", "name": "endIndex" }, { "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": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The input array." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.EachInRange", "scope": "static", "___id": "T000002R045011", "___s": true }, { "comment": "/**\r\n * Searches a pre-sorted array for the closet value to the given number.\r\n *\r\n * If the `key` argument is given it will assume the array contains objects that all have the required `key` property name,\r\n * and will check for the closest value of those to the given number.\r\n *\r\n * @function Phaser.Utils.Array.FindClosestInSorted\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The value to search for in the array.\r\n * @param {array} array - The array to search, which must be sorted.\r\n * @param {string} [key] - An optional property key. If specified the array elements property will be checked against value.\r\n *\r\n * @return {(number|any)} The nearest value found in the array, or if a `key` was given, the nearest object with the matching property value.\r\n */", "meta": { "filename": "FindClosestInSorted.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Searches a pre-sorted array for the closet value to the given number.\r\rIf the `key` argument is given it will assume the array contains objects that all have the required `key` property name,\rand will check for the closest value of those to the given number.", "kind": "function", "name": "FindClosestInSorted", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to search for in the array.", "name": "value" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to search, which must be sorted.", "name": "array" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "An optional property key. If specified the array elements property will be checked against value.", "name": "key" } ], "returns": [ { "type": { "names": [ "number", "any" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "any" } ] } }, "description": "The nearest value found in the array, or if a `key` was given, the nearest object with the matching property value." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.FindClosestInSorted", "scope": "static", "___id": "T000002R045021", "___s": true }, { "comment": "/**\r\n * Takes an array and flattens it, returning a shallow-copy flattened array.\r\n *\r\n * @function Phaser.Utils.Array.Flatten\r\n * @since 3.60.0\r\n *\r\n * @param {array} array - The array to flatten.\r\n * @param {array} [output] - An array to hold the results in.\r\n *\r\n * @return {array} The flattened output array.\r\n */", "meta": { "filename": "Flatten.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Takes an array and flattens it, returning a shallow-copy flattened array.", "kind": "function", "name": "Flatten", "since": "3.60.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to flatten.", "name": "array" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "An array to hold the results in.", "name": "output" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The flattened output array." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.Flatten", "scope": "static", "___id": "T000002R045032", "___s": true }, { "comment": "/**\r\n * Returns all elements in the array.\r\n *\r\n * You can optionally specify a matching criteria using the `property` and `value` arguments.\r\n *\r\n * For example: `getAll('visible', true)` would return only elements that have their visible property set.\r\n *\r\n * Optionally you can specify a start and end index. For example if the array had 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 elements.\r\n *\r\n * @function Phaser.Utils.Array.GetAll\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The array to search.\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 {array} All matching elements from the array.\r\n */", "meta": { "filename": "GetAll.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Returns all elements in the array.\r\rYou can optionally specify a matching criteria using the `property` and `value` arguments.\r\rFor example: `getAll('visible', true)` would return only elements that have their visible property set.\r\rOptionally you can specify a start and end index. For example if the array had 100 elements,\rand you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\rthe first 50 elements.", "kind": "function", "name": "GetAll", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to search.", "name": "array" }, { "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": "NameExpression", "name": "array" } }, "description": "All matching elements from the array." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.GetAll", "scope": "static", "___id": "T000002R045038", "___s": true }, { "comment": "/**\r\n * Returns the first element in the array.\r\n *\r\n * You can optionally specify a matching criteria using the `property` and `value` arguments.\r\n *\r\n * For example: `getAll('visible', true)` would return the first element that had its `visible` property set.\r\n *\r\n * Optionally you can specify a start and end index. For example if the array had 100 elements,\r\n * and you set `startIndex` to 0 and `endIndex` to 50, it would search only the first 50 elements.\r\n *\r\n * @function Phaser.Utils.Array.GetFirst\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The array to search.\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=0] - An optional start index to search from.\r\n * @param {number} [endIndex=array.length] - An optional end index to search up to (but not included)\r\n *\r\n * @return {object} The first matching element from the array, or `null` if no element could be found in the range given.\r\n */", "meta": { "filename": "GetFirst.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Returns the first element in the array.\r\rYou can optionally specify a matching criteria using the `property` and `value` arguments.\r\rFor example: `getAll('visible', true)` would return the first element that had its `visible` property set.\r\rOptionally you can specify a start and end index. For example if the array had 100 elements,\rand you set `startIndex` to 0 and `endIndex` to 50, it would search only the first 50 elements.", "kind": "function", "name": "GetFirst", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to search.", "name": "array" }, { "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, "defaultvalue": 0, "description": "An optional start index to search from.", "name": "startIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "array.length", "description": "An optional end index to search up to (but not included)", "name": "endIndex" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The first matching element from the array, or `null` if no element could be found in the range given." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.GetFirst", "scope": "static", "___id": "T000002R045047", "___s": true }, { "comment": "/**\r\n * Returns a Random element from the array.\r\n *\r\n * @function Phaser.Utils.Array.GetRandom\r\n * @since 3.0.0\r\n *\r\n * @param {array} array - The array to select the random entry from.\r\n * @param {number} [startIndex=0] - An optional start index.\r\n * @param {number} [length=array.length] - An optional length, the total number of elements (from the startIndex) to choose from.\r\n *\r\n * @return {*} A random element from the array, or `null` if no element could be found in the range given.\r\n */", "meta": { "filename": "GetRandom.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Returns a Random element from the array.", "kind": "function", "name": "GetRandom", "since": "3.0.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to select the random entry from.", "name": "array" }, { "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, "defaultvalue": "array.length", "description": "An optional length, the total number of elements (from the startIndex) to choose from.", "name": "length" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "A random element from the array, or `null` if no element could be found in the range given." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.GetRandom", "scope": "static", "___id": "T000002R045054", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Utils.Array\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "kind": "namespace", "name": "Array", "memberof": "Phaser.Utils", "longname": "Phaser.Utils.Array", "scope": "static", "___id": "T000002R045060", "___s": true }, { "comment": "/**\r\n * Checks if an array can be used as a matrix.\r\n *\r\n * A matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\r\n * have the same length. This is an example matrix:\r\n *\r\n * ```\r\n * [\r\n * [ 1, 1, 1, 1, 1, 1 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 2, 0, 1, 2, 0, 4 ],\r\n * [ 2, 0, 3, 4, 0, 4 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 3, 3, 3, 3, 3, 3 ]\r\n * ]\r\n * ```\r\n *\r\n * @function Phaser.Utils.Array.Matrix.CheckMatrix\r\n * @since 3.0.0\r\n *\r\n * @generic T\r\n * @genericUse {T[][]} - [matrix]\r\n *\r\n * @param {T[][]} [matrix] - The array to check.\r\n *\r\n * @return {boolean} `true` if the given `matrix` array is a valid matrix.\r\n */", "meta": { "filename": "CheckMatrix.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array\\matrix", "code": {} }, "description": "Checks if an array can be used as a matrix.\r\rA matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\rhave the same length. This is an example matrix:\r\r```\r[\r [ 1, 1, 1, 1, 1, 1 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 2, 0, 1, 2, 0, 4 ],\r [ 2, 0, 3, 4, 0, 4 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 3, 3, 3, 3, 3, 3 ]\r]\r```", "kind": "function", "name": "CheckMatrix", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[][]} - [matrix]", "value": "{T[][]} - [matrix]" } ], "params": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The array to check.", "name": "matrix" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given `matrix` array is a valid matrix." } ], "memberof": "Phaser.Utils.Array.Matrix", "longname": "Phaser.Utils.Array.Matrix.CheckMatrix", "scope": "static", "___id": "T000002R045098", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Utils.Array.Matrix\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array\\matrix", "code": {} }, "kind": "namespace", "name": "Matrix", "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.Matrix", "scope": "static", "___id": "T000002R045103", "___s": true }, { "comment": "/**\r\n * Generates a string (which you can pass to console.log) from the given Array Matrix.\r\n *\r\n * A matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\r\n * have the same length. There must be at least two rows. This is an example matrix:\r\n *\r\n * ```\r\n * [\r\n * [ 1, 1, 1, 1, 1, 1 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 2, 0, 1, 2, 0, 4 ],\r\n * [ 2, 0, 3, 4, 0, 4 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 3, 3, 3, 3, 3, 3 ]\r\n * ]\r\n * ```\r\n *\r\n * @function Phaser.Utils.Array.Matrix.MatrixToString\r\n * @since 3.0.0\r\n *\r\n * @generic T\r\n * @genericUse {T[][]} - [matrix]\r\n *\r\n * @param {T[][]} [matrix] - A 2-dimensional array.\r\n *\r\n * @return {string} A string representing the matrix.\r\n */", "meta": { "filename": "MatrixToString.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array\\matrix", "code": {} }, "description": "Generates a string (which you can pass to console.log) from the given Array Matrix.\r\rA matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\rhave the same length. There must be at least two rows. This is an example matrix:\r\r```\r[\r [ 1, 1, 1, 1, 1, 1 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 2, 0, 1, 2, 0, 4 ],\r [ 2, 0, 3, 4, 0, 4 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 3, 3, 3, 3, 3, 3 ]\r]\r```", "kind": "function", "name": "MatrixToString", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[][]} - [matrix]", "value": "{T[][]} - [matrix]" } ], "params": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "A 2-dimensional array.", "name": "matrix" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A string representing the matrix." } ], "memberof": "Phaser.Utils.Array.Matrix", "longname": "Phaser.Utils.Array.Matrix.MatrixToString", "scope": "static", "___id": "T000002R045117", "___s": true }, { "comment": "/**\r\n * Reverses the columns in the given Array Matrix.\r\n *\r\n * A matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\r\n * have the same length. There must be at least two rows. This is an example matrix:\r\n *\r\n * ```\r\n * [\r\n * [ 1, 1, 1, 1, 1, 1 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 2, 0, 1, 2, 0, 4 ],\r\n * [ 2, 0, 3, 4, 0, 4 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 3, 3, 3, 3, 3, 3 ]\r\n * ]\r\n * ```\r\n *\r\n * @function Phaser.Utils.Array.Matrix.ReverseColumns\r\n * @since 3.0.0\r\n *\r\n * @generic T\r\n * @genericUse {T[][]} - [matrix,$return]\r\n *\r\n * @param {T[][]} [matrix] - The array matrix to reverse the columns for.\r\n *\r\n * @return {T[][]} The column reversed matrix.\r\n */", "meta": { "filename": "ReverseColumns.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array\\matrix", "code": {} }, "description": "Reverses the columns in the given Array Matrix.\r\rA matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\rhave the same length. There must be at least two rows. This is an example matrix:\r\r```\r[\r [ 1, 1, 1, 1, 1, 1 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 2, 0, 1, 2, 0, 4 ],\r [ 2, 0, 3, 4, 0, 4 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 3, 3, 3, 3, 3, 3 ]\r]\r```", "kind": "function", "name": "ReverseColumns", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[][]} - [matrix,$return]", "value": "{T[][]} - [matrix,$return]" } ], "params": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The array matrix to reverse the columns for.", "name": "matrix" } ], "returns": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "description": "The column reversed matrix." } ], "memberof": "Phaser.Utils.Array.Matrix", "longname": "Phaser.Utils.Array.Matrix.ReverseColumns", "scope": "static", "___id": "T000002R045132", "___s": true }, { "comment": "/**\r\n * Reverses the rows in the given Array Matrix.\r\n *\r\n * A matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\r\n * have the same length. There must be at least two rows. This is an example matrix:\r\n *\r\n * ```\r\n * [\r\n * [ 1, 1, 1, 1, 1, 1 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 2, 0, 1, 2, 0, 4 ],\r\n * [ 2, 0, 3, 4, 0, 4 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 3, 3, 3, 3, 3, 3 ]\r\n * ]\r\n * ```\r\n *\r\n * @function Phaser.Utils.Array.Matrix.ReverseRows\r\n * @since 3.0.0\r\n *\r\n * @generic T\r\n * @genericUse {T[][]} - [matrix,$return]\r\n *\r\n * @param {T[][]} [matrix] - The array matrix to reverse the rows for.\r\n *\r\n * @return {T[][]} The column reversed matrix.\r\n */", "meta": { "filename": "ReverseRows.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array\\matrix", "code": {} }, "description": "Reverses the rows in the given Array Matrix.\r\rA matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\rhave the same length. There must be at least two rows. This is an example matrix:\r\r```\r[\r [ 1, 1, 1, 1, 1, 1 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 2, 0, 1, 2, 0, 4 ],\r [ 2, 0, 3, 4, 0, 4 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 3, 3, 3, 3, 3, 3 ]\r]\r```", "kind": "function", "name": "ReverseRows", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[][]} - [matrix,$return]", "value": "{T[][]} - [matrix,$return]" } ], "params": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The array matrix to reverse the rows for.", "name": "matrix" } ], "returns": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "description": "The column reversed matrix." } ], "memberof": "Phaser.Utils.Array.Matrix", "longname": "Phaser.Utils.Array.Matrix.ReverseRows", "scope": "static", "___id": "T000002R045135", "___s": true }, { "comment": "/**\r\n * Rotates the array matrix 180 degrees.\r\n *\r\n * A matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\r\n * have the same length. There must be at least two rows. This is an example matrix:\r\n *\r\n * ```\r\n * [\r\n * [ 1, 1, 1, 1, 1, 1 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 2, 0, 1, 2, 0, 4 ],\r\n * [ 2, 0, 3, 4, 0, 4 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 3, 3, 3, 3, 3, 3 ]\r\n * ]\r\n * ```\r\n *\r\n * @function Phaser.Utils.Array.Matrix.Rotate180\r\n * @since 3.0.0\r\n *\r\n * @generic T\r\n * @genericUse {T[][]} - [matrix,$return]\r\n *\r\n * @param {T[][]} [matrix] - The array to rotate.\r\n *\r\n * @return {T[][]} The rotated matrix array. The source matrix should be discard for the returned matrix.\r\n */", "meta": { "filename": "Rotate180.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array\\matrix", "code": {} }, "description": "Rotates the array matrix 180 degrees.\r\rA matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\rhave the same length. There must be at least two rows. This is an example matrix:\r\r```\r[\r [ 1, 1, 1, 1, 1, 1 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 2, 0, 1, 2, 0, 4 ],\r [ 2, 0, 3, 4, 0, 4 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 3, 3, 3, 3, 3, 3 ]\r]\r```", "kind": "function", "name": "Rotate180", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[][]} - [matrix,$return]", "value": "{T[][]} - [matrix,$return]" } ], "params": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The array to rotate.", "name": "matrix" } ], "returns": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "description": "The rotated matrix array. The source matrix should be discard for the returned matrix." } ], "memberof": "Phaser.Utils.Array.Matrix", "longname": "Phaser.Utils.Array.Matrix.Rotate180", "scope": "static", "___id": "T000002R045140", "___s": true }, { "comment": "/**\r\n * Rotates the array matrix to the left (or 90 degrees)\r\n *\r\n * A matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\r\n * have the same length. There must be at least two rows. This is an example matrix:\r\n *\r\n * ```\r\n * [\r\n * [ 1, 1, 1, 1, 1, 1 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 2, 0, 1, 2, 0, 4 ],\r\n * [ 2, 0, 3, 4, 0, 4 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 3, 3, 3, 3, 3, 3 ]\r\n * ]\r\n * ```\r\n *\r\n * @function Phaser.Utils.Array.Matrix.RotateLeft\r\n * @since 3.0.0\r\n *\r\n * @generic T\r\n * @genericUse {T[][]} - [matrix,$return]\r\n *\r\n * @param {T[][]} [matrix] - The array to rotate.\r\n * @param {number} [amount=1] - The number of times to rotate the matrix.\r\n *\r\n * @return {T[][]} The rotated matrix array. The source matrix should be discard for the returned matrix.\r\n */", "meta": { "filename": "RotateLeft.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array\\matrix", "code": {} }, "description": "Rotates the array matrix to the left (or 90 degrees)\r\rA matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\rhave the same length. There must be at least two rows. This is an example matrix:\r\r```\r[\r [ 1, 1, 1, 1, 1, 1 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 2, 0, 1, 2, 0, 4 ],\r [ 2, 0, 3, 4, 0, 4 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 3, 3, 3, 3, 3, 3 ]\r]\r```", "kind": "function", "name": "RotateLeft", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[][]} - [matrix,$return]", "value": "{T[][]} - [matrix,$return]" } ], "params": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The array to rotate.", "name": "matrix" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The number of times to rotate the matrix.", "name": "amount" } ], "returns": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "description": "The rotated matrix array. The source matrix should be discard for the returned matrix." } ], "memberof": "Phaser.Utils.Array.Matrix", "longname": "Phaser.Utils.Array.Matrix.RotateLeft", "scope": "static", "___id": "T000002R045144", "___s": true }, { "comment": "/**\r\n * Rotates the array matrix based on the given rotation value.\r\n *\r\n * The value can be given in degrees: 90, -90, 270, -270 or 180,\r\n * or a string command: `rotateLeft`, `rotateRight` or `rotate180`.\r\n *\r\n * Based on the routine from {@link http://jsfiddle.net/MrPolywhirl/NH42z/}.\r\n *\r\n * A matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\r\n * have the same length. There must be at least two rows. This is an example matrix:\r\n *\r\n * ```\r\n * [\r\n * [ 1, 1, 1, 1, 1, 1 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 2, 0, 1, 2, 0, 4 ],\r\n * [ 2, 0, 3, 4, 0, 4 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 3, 3, 3, 3, 3, 3 ]\r\n * ]\r\n * ```\r\n *\r\n * @function Phaser.Utils.Array.Matrix.RotateMatrix\r\n * @since 3.0.0\r\n *\r\n * @generic T\r\n * @genericUse {T[][]} - [matrix,$return]\r\n *\r\n * @param {T[][]} [matrix] - The array to rotate.\r\n * @param {(number|string)} [direction=90] - The amount to rotate the matrix by.\r\n *\r\n * @return {T[][]} The rotated matrix array. The source matrix should be discard for the returned matrix.\r\n */", "meta": { "filename": "RotateMatrix.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array\\matrix", "code": {} }, "description": "Rotates the array matrix based on the given rotation value.\r\rThe value can be given in degrees: 90, -90, 270, -270 or 180,\ror a string command: `rotateLeft`, `rotateRight` or `rotate180`.\r\rBased on the routine from {@link http://jsfiddle.net/MrPolywhirl/NH42z/}.\r\rA matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\rhave the same length. There must be at least two rows. This is an example matrix:\r\r```\r[\r [ 1, 1, 1, 1, 1, 1 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 2, 0, 1, 2, 0, 4 ],\r [ 2, 0, 3, 4, 0, 4 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 3, 3, 3, 3, 3, 3 ]\r]\r```", "kind": "function", "name": "RotateMatrix", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[][]} - [matrix,$return]", "value": "{T[][]} - [matrix,$return]" } ], "params": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The array to rotate.", "name": "matrix" }, { "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "defaultvalue": 90, "description": "The amount to rotate the matrix by.", "name": "direction" } ], "returns": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "description": "The rotated matrix array. The source matrix should be discard for the returned matrix." } ], "memberof": "Phaser.Utils.Array.Matrix", "longname": "Phaser.Utils.Array.Matrix.RotateMatrix", "scope": "static", "___id": "T000002R045152", "___s": true }, { "comment": "/**\r\n * Rotates the array matrix to the left (or -90 degrees)\r\n *\r\n * A matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\r\n * have the same length. There must be at least two rows. This is an example matrix:\r\n *\r\n * ```\r\n * [\r\n * [ 1, 1, 1, 1, 1, 1 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 2, 0, 1, 2, 0, 4 ],\r\n * [ 2, 0, 3, 4, 0, 4 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 3, 3, 3, 3, 3, 3 ]\r\n * ]\r\n * ```\r\n *\r\n * @function Phaser.Utils.Array.Matrix.RotateRight\r\n * @since 3.0.0\r\n *\r\n * @generic T\r\n * @genericUse {T[][]} - [matrix,$return]\r\n *\r\n * @param {T[][]} [matrix] - The array to rotate.\r\n * @param {number} [amount=1] - The number of times to rotate the matrix.\r\n *\r\n * @return {T[][]} The rotated matrix array. The source matrix should be discard for the returned matrix.\r\n */", "meta": { "filename": "RotateRight.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array\\matrix", "code": {} }, "description": "Rotates the array matrix to the left (or -90 degrees)\r\rA matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\rhave the same length. There must be at least two rows. This is an example matrix:\r\r```\r[\r [ 1, 1, 1, 1, 1, 1 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 2, 0, 1, 2, 0, 4 ],\r [ 2, 0, 3, 4, 0, 4 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 3, 3, 3, 3, 3, 3 ]\r]\r```", "kind": "function", "name": "RotateRight", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[][]} - [matrix,$return]", "value": "{T[][]} - [matrix,$return]" } ], "params": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The array to rotate.", "name": "matrix" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The number of times to rotate the matrix.", "name": "amount" } ], "returns": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "description": "The rotated matrix array. The source matrix should be discard for the returned matrix." } ], "memberof": "Phaser.Utils.Array.Matrix", "longname": "Phaser.Utils.Array.Matrix.RotateRight", "scope": "static", "___id": "T000002R045161", "___s": true }, { "comment": "/**\r\n * Translates the given Array Matrix by shifting each column and row the\r\n * amount specified.\r\n *\r\n * A matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\r\n * have the same length. There must be at least two rows. This is an example matrix:\r\n *\r\n * ```\r\n * [\r\n * [ 1, 1, 1, 1, 1, 1 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 2, 0, 1, 2, 0, 4 ],\r\n * [ 2, 0, 3, 4, 0, 4 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 3, 3, 3, 3, 3, 3 ]\r\n * ]\r\n * ```\r\n *\r\n * @function Phaser.Utils.Array.Matrix.Translate\r\n * @since 3.50.0\r\n *\r\n * @generic T\r\n * @genericUse {T[][]} - [matrix,$return]\r\n *\r\n * @param {T[][]} [matrix] - The array matrix to translate.\r\n * @param {number} [x=0] - The amount to horizontally translate the matrix by.\r\n * @param {number} [y=0] - The amount to vertically translate the matrix by.\r\n *\r\n * @return {T[][]} The translated matrix.\r\n */", "meta": { "filename": "TranslateMatrix.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array\\matrix", "code": {} }, "description": "Translates the given Array Matrix by shifting each column and row the\ramount specified.\r\rA matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\rhave the same length. There must be at least two rows. This is an example matrix:\r\r```\r[\r [ 1, 1, 1, 1, 1, 1 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 2, 0, 1, 2, 0, 4 ],\r [ 2, 0, 3, 4, 0, 4 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 3, 3, 3, 3, 3, 3 ]\r]\r```", "kind": "function", "name": "Translate", "since": "3.50.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[][]} - [matrix,$return]", "value": "{T[][]} - [matrix,$return]" } ], "params": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The array matrix to translate.", "name": "matrix" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to horizontally translate the matrix by.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to vertically translate the matrix by.", "name": "y" } ], "returns": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "description": "The translated matrix." } ], "memberof": "Phaser.Utils.Array.Matrix", "longname": "Phaser.Utils.Array.Matrix.Translate", "scope": "static", "___id": "T000002R045169", "___s": true }, { "comment": "/**\r\n * Transposes the elements of the given matrix (array of arrays).\r\n *\r\n * The transpose of a matrix is a new matrix whose rows are the columns of the original.\r\n *\r\n * A matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\r\n * have the same length. There must be at least two rows. This is an example matrix:\r\n *\r\n * ```\r\n * [\r\n * [ 1, 1, 1, 1, 1, 1 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 2, 0, 1, 2, 0, 4 ],\r\n * [ 2, 0, 3, 4, 0, 4 ],\r\n * [ 2, 0, 0, 0, 0, 4 ],\r\n * [ 3, 3, 3, 3, 3, 3 ]\r\n * ]\r\n * ```\r\n *\r\n * @function Phaser.Utils.Array.Matrix.TransposeMatrix\r\n * @since 3.0.0\r\n *\r\n * @generic T\r\n * @genericUse {T[][]} - [array,$return]\r\n *\r\n * @param {T[][]} [array] - The array matrix to transpose.\r\n *\r\n * @return {T[][]} A new array matrix which is a transposed version of the given array.\r\n */", "meta": { "filename": "TransposeMatrix.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array\\matrix", "code": {} }, "description": "Transposes the elements of the given matrix (array of arrays).\r\rThe transpose of a matrix is a new matrix whose rows are the columns of the original.\r\rA matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows)\rhave the same length. There must be at least two rows. This is an example matrix:\r\r```\r[\r [ 1, 1, 1, 1, 1, 1 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 2, 0, 1, 2, 0, 4 ],\r [ 2, 0, 3, 4, 0, 4 ],\r [ 2, 0, 0, 0, 0, 4 ],\r [ 3, 3, 3, 3, 3, 3 ]\r]\r```", "kind": "function", "name": "TransposeMatrix", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[][]} - [array,$return]", "value": "{T[][]} - [array,$return]" } ], "params": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The array matrix to transpose.", "name": "array" } ], "returns": [ { "type": { "names": [ "Array.>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } ] } }, "description": "A new array matrix which is a transposed version of the given array." } ], "memberof": "Phaser.Utils.Array.Matrix", "longname": "Phaser.Utils.Array.Matrix.TransposeMatrix", "scope": "static", "___id": "T000002R045176", "___s": true }, { "comment": "/**\r\n * Moves the given array element above another one in the array.\r\n * The array is modified in-place.\r\n *\r\n * @function Phaser.Utils.Array.MoveAbove\r\n * @since 3.55.0\r\n *\r\n * @param {array} array - The input array.\r\n * @param {*} item1 - The element to move above base element.\r\n * @param {*} item2 - The base element.\r\n *\r\n *\r\n * @return {array} The input array.\r\n */", "meta": { "filename": "MoveAbove.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Moves the given array element above another one in the array.\rThe array is modified in-place.", "kind": "function", "name": "MoveAbove", "since": "3.55.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The input array.", "name": "array" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The element to move above base element.", "name": "item1" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The base element.", "name": "item2" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The input array." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.MoveAbove", "scope": "static", "___id": "T000002R045186", "___s": true }, { "comment": "/**\r\n * Moves the given array element below another one in the array.\r\n * The array is modified in-place.\r\n *\r\n * @function Phaser.Utils.Array.MoveBelow\r\n * @since 3.55.0\r\n *\r\n * @param {array} array - The input array.\r\n * @param {*} item1 - The element to move below base element.\r\n * @param {*} item2 - The base element.\r\n *\r\n *\r\n * @return {array} The input array.\r\n */", "meta": { "filename": "MoveBelow.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Moves the given array element below another one in the array.\rThe array is modified in-place.", "kind": "function", "name": "MoveBelow", "since": "3.55.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The input array.", "name": "array" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The element to move below base element.", "name": "item1" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The base element.", "name": "item2" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The input array." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.MoveBelow", "scope": "static", "___id": "T000002R045191", "___s": true }, { "comment": "/**\r\n * Moves the given array element down one place in the array.\r\n * The array is modified in-place.\r\n *\r\n * @function Phaser.Utils.Array.MoveDown\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The input array.\r\n * @param {*} item - The element to move down the array.\r\n *\r\n * @return {array} The input array.\r\n */", "meta": { "filename": "MoveDown.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Moves the given array element down one place in the array.\rThe array is modified in-place.", "kind": "function", "name": "MoveDown", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The input array.", "name": "array" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The element to move down the array.", "name": "item" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The input array." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.MoveDown", "scope": "static", "___id": "T000002R045196", "___s": true }, { "comment": "/**\r\n * Moves an element in an array to a new position within the same array.\r\n * The array is modified in-place.\r\n *\r\n * @function Phaser.Utils.Array.MoveTo\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The array.\r\n * @param {*} item - The element to move.\r\n * @param {number} index - The new index that the element will be moved to.\r\n *\r\n * @return {*} The element that was moved.\r\n */", "meta": { "filename": "MoveTo.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Moves an element in an array to a new position within the same array.\rThe array is modified in-place.", "kind": "function", "name": "MoveTo", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array.", "name": "array" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The element to move.", "name": "item" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new index that the element will be moved to.", "name": "index" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The element that was moved." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.MoveTo", "scope": "static", "___id": "T000002R045204", "___s": true }, { "comment": "/**\r\n * Moves the given array element up one place in the array.\r\n * The array is modified in-place.\r\n *\r\n * @function Phaser.Utils.Array.MoveUp\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The input array.\r\n * @param {*} item - The element to move up the array.\r\n *\r\n * @return {array} The input array.\r\n */", "meta": { "filename": "MoveUp.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Moves the given array element up one place in the array.\rThe array is modified in-place.", "kind": "function", "name": "MoveUp", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The input array.", "name": "array" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The element to move up the array.", "name": "item" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The input array." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.MoveUp", "scope": "static", "___id": "T000002R045208", "___s": true }, { "comment": "/**\n * Create an array representing the range of numbers (usually integers), between, and inclusive of,\n * the given `start` and `end` arguments. For example:\n *\n * `var array = Phaser.Utils.Array.NumberArray(2, 4); // array = [2, 3, 4]`\n * `var array = Phaser.Utils.Array.NumberArray(0, 9); // array = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]`\n * `var array = Phaser.Utils.Array.NumberArray(8, 2); // array = [8, 7, 6, 5, 4, 3, 2]`\n *\n * This is equivalent to `Phaser.Utils.Array.NumberArrayStep(start, end, 1)`.\n *\n * You can optionally provide a prefix and / or suffix string. If given the array will contain\n * strings, not integers. For example:\n *\n * `var array = Phaser.Utils.Array.NumberArray(1, 4, 'Level '); // array = [\"Level 1\", \"Level 2\", \"Level 3\", \"Level 4\"]`\n * `var array = Phaser.Utils.Array.NumberArray(5, 7, 'HD-', '.png'); // array = [\"HD-5.png\", \"HD-6.png\", \"HD-7.png\"]`\n *\n * @function Phaser.Utils.Array.NumberArray\n * @since 3.0.0\n *\n * @param {number} start - The minimum value the array starts with.\n * @param {number} end - The maximum value the array contains.\n * @param {string} [prefix] - Optional prefix to place before the number. If provided the array will contain strings, not integers.\n * @param {string} [suffix] - Optional suffix to place after the number. If provided the array will contain strings, not integers.\n *\n * @return {(number[]|string[])} The array of number values, or strings if a prefix or suffix was provided.\n */", "meta": { "filename": "NumberArray.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Create an array representing the range of numbers (usually integers), between, and inclusive of,\nthe given `start` and `end` arguments. For example:\n\n`var array = Phaser.Utils.Array.NumberArray(2, 4); // array = [2, 3, 4]`\n`var array = Phaser.Utils.Array.NumberArray(0, 9); // array = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]`\n`var array = Phaser.Utils.Array.NumberArray(8, 2); // array = [8, 7, 6, 5, 4, 3, 2]`\n\nThis is equivalent to `Phaser.Utils.Array.NumberArrayStep(start, end, 1)`.\n\nYou can optionally provide a prefix and / or suffix string. If given the array will contain\nstrings, not integers. For example:\n\n`var array = Phaser.Utils.Array.NumberArray(1, 4, 'Level '); // array = [\"Level 1\", \"Level 2\", \"Level 3\", \"Level 4\"]`\n`var array = Phaser.Utils.Array.NumberArray(5, 7, 'HD-', '.png'); // array = [\"HD-5.png\", \"HD-6.png\", \"HD-7.png\"]`", "kind": "function", "name": "NumberArray", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum value the array starts with.", "name": "start" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum value the array contains.", "name": "end" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional prefix to place before the number. If provided the array will contain strings, not integers.", "name": "prefix" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional suffix to place after the number. If provided the array will contain strings, not integers.", "name": "suffix" } ], "returns": [ { "type": { "names": [ "Array.", "Array." ], "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": "The array of number values, or strings if a prefix or suffix was provided." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.NumberArray", "scope": "static", "___id": "T000002R045216", "___s": true }, { "comment": "/**\r\n * Create an array of numbers (positive and/or negative) progressing from `start`\r\n * up to but not including `end` by advancing by `step`.\r\n *\r\n * If `start` is less than `end` a zero-length range is created unless a negative `step` is specified.\r\n *\r\n * Certain values for `start` and `end` (eg. NaN/undefined/null) are currently coerced to 0;\r\n * for forward compatibility make sure to pass in actual numbers.\r\n *\r\n * @example\r\n * NumberArrayStep(4);\r\n * // => [0, 1, 2, 3]\r\n *\r\n * NumberArrayStep(1, 5);\r\n * // => [1, 2, 3, 4]\r\n *\r\n * NumberArrayStep(0, 20, 5);\r\n * // => [0, 5, 10, 15]\r\n *\r\n * NumberArrayStep(0, -4, -1);\r\n * // => [0, -1, -2, -3]\r\n *\r\n * NumberArrayStep(1, 4, 0);\r\n * // => [1, 1, 1]\r\n *\r\n * NumberArrayStep(0);\r\n * // => []\r\n *\r\n * @function Phaser.Utils.Array.NumberArrayStep\r\n * @since 3.0.0\r\n *\r\n * @param {number} [start=0] - The start of the range.\r\n * @param {number} [end=null] - The end of the range.\r\n * @param {number} [step=1] - The value to increment or decrement by.\r\n *\r\n * @return {number[]} The array of number values.\r\n */", "meta": { "filename": "NumberArrayStep.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Create an array of numbers (positive and/or negative) progressing from `start`\rup to but not including `end` by advancing by `step`.\r\rIf `start` is less than `end` a zero-length range is created unless a negative `step` is specified.\r\rCertain values for `start` and `end` (eg. NaN/undefined/null) are currently coerced to 0;\rfor forward compatibility make sure to pass in actual numbers.", "examples": [ "NumberArrayStep(4);\r// => [0, 1, 2, 3]\r\rNumberArrayStep(1, 5);\r// => [1, 2, 3, 4]\r\rNumberArrayStep(0, 20, 5);\r// => [0, 5, 10, 15]\r\rNumberArrayStep(0, -4, -1);\r// => [0, -1, -2, -3]\r\rNumberArrayStep(1, 4, 0);\r// => [1, 1, 1]\r\rNumberArrayStep(0);\r// => []" ], "kind": "function", "name": "NumberArrayStep", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The start of the range.", "name": "start" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": null, "description": "The end of the range.", "name": "end" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The value to increment or decrement by.", "name": "step" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The array of number values." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.NumberArrayStep", "scope": "static", "___id": "T000002R045228", "___s": true }, { "comment": "/**\r\n * A [Floyd-Rivest](https://en.wikipedia.org/wiki/Floyd%E2%80%93Rivest_algorithm) quick selection algorithm.\r\n *\r\n * Rearranges the array items so that all items in the [left, k] range are smaller than all items in [k, right];\r\n * The k-th element will have the (k - left + 1)th smallest value in [left, right].\r\n *\r\n * The array is modified in-place.\r\n *\r\n * Based on code by [Vladimir Agafonkin](https://www.npmjs.com/~mourner)\r\n *\r\n * @function Phaser.Utils.Array.QuickSelect\r\n * @since 3.0.0\r\n *\r\n * @param {array} arr - The array to sort.\r\n * @param {number} k - The k-th element index.\r\n * @param {number} [left=0] - The index of the left part of the range.\r\n * @param {number} [right] - The index of the right part of the range.\r\n * @param {function} [compare] - An optional comparison function. Is passed two elements and should return 0, 1 or -1.\r\n */", "meta": { "filename": "QuickSelect.js", "lineno": 25, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "A [Floyd-Rivest](https://en.wikipedia.org/wiki/Floyd%E2%80%93Rivest_algorithm) quick selection algorithm.\r\rRearranges the array items so that all items in the [left, k] range are smaller than all items in [k, right];\rThe k-th element will have the (k - left + 1)th smallest value in [left, right].\r\rThe array is modified in-place.\r\rBased on code by [Vladimir Agafonkin](https://www.npmjs.com/~mourner)", "kind": "function", "name": "QuickSelect", "since": "3.0.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to sort.", "name": "arr" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The k-th element index.", "name": "k" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The index of the left part of the range.", "name": "left" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The index of the right part of the range.", "name": "right" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "An optional comparison function. Is passed two elements and should return 0, 1 or -1.", "name": "compare" } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.QuickSelect", "scope": "static", "___id": "T000002R045245", "___s": true }, { "comment": "/**\r\n * Creates an array populated with a range of values, based on the given arguments and configuration object.\r\n *\r\n * Range ([a,b,c], [1,2,3]) =\r\n * a1, a2, a3, b1, b2, b3, c1, c2, c3\r\n *\r\n * Range ([a,b], [1,2,3], qty = 3) =\r\n * a1, a1, a1, a2, a2, a2, a3, a3, a3, b1, b1, b1, b2, b2, b2, b3, b3, b3\r\n *\r\n * Range ([a,b,c], [1,2,3], repeat x1) =\r\n * a1, a2, a3, b1, b2, b3, c1, c2, c3, a1, a2, a3, b1, b2, b3, c1, c2, c3\r\n *\r\n * Range ([a,b], [1,2], repeat -1 = endless, max = 14) =\r\n * Maybe if max is set then repeat goes to -1 automatically?\r\n * a1, a2, b1, b2, a1, a2, b1, b2, a1, a2, b1, b2, a1, a2 (capped at 14 elements)\r\n *\r\n * Range ([a], [1,2,3,4,5], random = true) =\r\n * a4, a1, a5, a2, a3\r\n *\r\n * Range ([a, b], [1,2,3], random = true) =\r\n * b3, a2, a1, b1, a3, b2\r\n *\r\n * Range ([a, b, c], [1,2,3], randomB = true) =\r\n * a3, a1, a2, b2, b3, b1, c1, c3, c2\r\n *\r\n * Range ([a], [1,2,3,4,5], yoyo = true) =\r\n * a1, a2, a3, a4, a5, a5, a4, a3, a2, a1\r\n *\r\n * Range ([a, b], [1,2,3], yoyo = true) =\r\n * a1, a2, a3, b1, b2, b3, b3, b2, b1, a3, a2, a1\r\n *\r\n * @function Phaser.Utils.Array.Range\r\n * @since 3.0.0\r\n *\r\n * @param {array} a - The first array of range elements.\r\n * @param {array} b - The second array of range elements.\r\n * @param {object} [options] - A range configuration object. Can contain: repeat, random, randomB, yoyo, max, qty.\r\n *\r\n * @return {array} An array of arranged elements.\r\n */", "meta": { "filename": "Range.js", "lineno": 28, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Creates an array populated with a range of values, based on the given arguments and configuration object.\r\rRange ([a,b,c], [1,2,3]) =\ra1, a2, a3, b1, b2, b3, c1, c2, c3\r\rRange ([a,b], [1,2,3], qty = 3) =\ra1, a1, a1, a2, a2, a2, a3, a3, a3, b1, b1, b1, b2, b2, b2, b3, b3, b3\r\rRange ([a,b,c], [1,2,3], repeat x1) =\ra1, a2, a3, b1, b2, b3, c1, c2, c3, a1, a2, a3, b1, b2, b3, c1, c2, c3\r\rRange ([a,b], [1,2], repeat -1 = endless, max = 14) =\rMaybe if max is set then repeat goes to -1 automatically?\ra1, a2, b1, b2, a1, a2, b1, b2, a1, a2, b1, b2, a1, a2 (capped at 14 elements)\r\rRange ([a], [1,2,3,4,5], random = true) =\ra4, a1, a5, a2, a3\r\rRange ([a, b], [1,2,3], random = true) =\rb3, a2, a1, b1, a3, b2\r\rRange ([a, b, c], [1,2,3], randomB = true) =\ra3, a1, a2, b2, b3, b1, c1, c3, c2\r\rRange ([a], [1,2,3,4,5], yoyo = true) =\ra1, a2, a3, a4, a5, a5, a4, a3, a2, a1\r\rRange ([a, b], [1,2,3], yoyo = true) =\ra1, a2, a3, b1, b2, b3, b3, b2, b1, a3, a2, a1", "kind": "function", "name": "Range", "since": "3.0.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The first array of range elements.", "name": "a" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The second array of range elements.", "name": "b" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "A range configuration object. Can contain: repeat, random, randomB, yoyo, max, qty.", "name": "options" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "An array of arranged elements." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.Range", "scope": "static", "___id": "T000002R045272", "___s": true }, { "comment": "/**\r\n * Removes the given item, or array of items, from the array.\r\n *\r\n * The array is modified in-place.\r\n *\r\n * You can optionally specify a callback to be invoked for each item successfully removed from the array.\r\n *\r\n * @function Phaser.Utils.Array.Remove\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The array to be modified.\r\n * @param {*|Array.<*>} item - The item, or array of items, to be removed from the array.\r\n * @param {function} [callback] - A callback to be invoked for each item successfully removed from the array.\r\n * @param {object} [context] - The context in which the callback is invoked.\r\n *\r\n * @return {*|Array.<*>} The item, or array of items, that were successfully removed from the array.\r\n */", "meta": { "filename": "Remove.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Removes the given item, or array of items, from the array.\r\rThe array is modified in-place.\r\rYou can optionally specify a callback to be invoked for each item successfully removed from the array.", "kind": "function", "name": "Remove", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to be modified.", "name": "array" }, { "type": { "names": [ "*", "Array.<*>" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "AllLiteral" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "AllLiteral" } ] } ] } }, "description": "The item, or array of items, to be removed from the array.", "name": "item" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "A callback to be invoked for each item successfully removed from the array.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The context in which the callback is invoked.", "name": "context" } ], "returns": [ { "type": { "names": [ "*", "Array.<*>" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "AllLiteral" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "AllLiteral" } ] } ] } }, "description": "The item, or array of items, that were successfully removed from the array." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.Remove", "scope": "static", "___id": "T000002R045291", "___s": true }, { "comment": "/**\r\n * Removes the item from the given position in the array.\r\n *\r\n * The array is modified in-place.\r\n *\r\n * You can optionally specify a callback to be invoked for the item if it is successfully removed from the array.\r\n *\r\n * @function Phaser.Utils.Array.RemoveAt\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The array to be modified.\r\n * @param {number} index - The array index to remove the item from. The index must be in bounds or it will throw an error.\r\n * @param {function} [callback] - A callback to be invoked for the item removed from the array.\r\n * @param {object} [context] - The context in which the callback is invoked.\r\n *\r\n * @return {*} The item that was removed.\r\n */", "meta": { "filename": "RemoveAt.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Removes the item from the given position in the array.\r\rThe array is modified in-place.\r\rYou can optionally specify a callback to be invoked for the item if it is successfully removed from the array.", "kind": "function", "name": "RemoveAt", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to be modified.", "name": "array" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The array index to remove the item from. The index must be in bounds or it will throw an error.", "name": "index" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "A callback to be invoked for the item removed from the array.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The context in which the callback is invoked.", "name": "context" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item that was removed." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.RemoveAt", "scope": "static", "___id": "T000002R045302", "___s": true }, { "comment": "/**\r\n * Removes the item within the given range in the array.\r\n *\r\n * The array is modified in-place.\r\n *\r\n * You can optionally specify a callback to be invoked for the item/s successfully removed from the array.\r\n *\r\n * @function Phaser.Utils.Array.RemoveBetween\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The array to be modified.\r\n * @param {number} startIndex - The start index to remove from.\r\n * @param {number} endIndex - The end index to remove to.\r\n * @param {function} [callback] - A callback to be invoked for the item removed from the array.\r\n * @param {object} [context] - The context in which the callback is invoked.\r\n *\r\n * @return {Array.<*>} An array of items that were removed.\r\n */", "meta": { "filename": "RemoveBetween.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Removes the item within the given range in the array.\r\rThe array is modified in-place.\r\rYou can optionally specify a callback to be invoked for the item/s successfully removed from the array.", "kind": "function", "name": "RemoveBetween", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to be modified.", "name": "array" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The start index to remove from.", "name": "startIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The end index to remove to.", "name": "endIndex" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "A callback to be invoked for the item removed from the array.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "The context in which the callback is invoked.", "name": "context" } ], "returns": [ { "type": { "names": [ "Array.<*>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "AllLiteral" } ] } }, "description": "An array of items that were removed." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.RemoveBetween", "scope": "static", "___id": "T000002R045308", "___s": true }, { "comment": "/**\r\n * Removes a random object from the given array and returns it.\r\n * Will return null if there are no array items that fall within the specified range or if there is no item for the randomly chosen index.\r\n *\r\n * @function Phaser.Utils.Array.RemoveRandomElement\r\n * @since 3.0.0\r\n *\r\n * @param {array} array - The array to removed a random element from.\r\n * @param {number} [start=0] - The array index to start the search from.\r\n * @param {number} [length=array.length] - Optional restriction on the number of elements to randomly select from.\r\n *\r\n * @return {object} The random element that was removed, or `null` if there were no array elements that fell within the given range.\r\n */", "meta": { "filename": "RemoveRandomElement.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Removes a random object from the given array and returns it.\rWill return null if there are no array items that fall within the specified range or if there is no item for the randomly chosen index.", "kind": "function", "name": "RemoveRandomElement", "since": "3.0.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to removed a random element from.", "name": "array" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The array index to start the search from.", "name": "start" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "array.length", "description": "Optional restriction on the number of elements to randomly select from.", "name": "length" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The random element that was removed, or `null` if there were no array elements that fell within the given range." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.RemoveRandomElement", "scope": "static", "___id": "T000002R045319", "___s": true }, { "comment": "/**\r\n * Replaces an element of the array with the new element.\r\n * The new element cannot already be a member of the array.\r\n * The array is modified in-place.\r\n *\r\n * @function Phaser.Utils.Array.Replace\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The array to search within.\r\n * @param {*} oldChild - The element in the array that will be replaced.\r\n * @param {*} newChild - The element to be inserted into the array at the position of `oldChild`.\r\n *\r\n * @return {boolean} Returns true if the oldChild was successfully replaced, otherwise returns false.\r\n */", "meta": { "filename": "Replace.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Replaces an element of the array with the new element.\rThe new element cannot already be a member of the array.\rThe array is modified in-place.", "kind": "function", "name": "Replace", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to search within.", "name": "array" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The element in the array that will be replaced.", "name": "oldChild" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The element to be inserted into the array at the position of `oldChild`.", "name": "newChild" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns true if the oldChild was successfully replaced, otherwise returns false." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.Replace", "scope": "static", "___id": "T000002R045325", "___s": true }, { "comment": "/**\r\n * Moves the element at the start of the array to the end, shifting all items in the process.\r\n * The \"rotation\" happens to the left.\r\n *\r\n * @function Phaser.Utils.Array.RotateLeft\r\n * @since 3.0.0\r\n *\r\n * @param {array} array - The array to shift to the left. This array is modified in place.\r\n * @param {number} [total=1] - The number of times to shift the array.\r\n *\r\n * @return {*} The most recently shifted element.\r\n */", "meta": { "filename": "RotateLeft.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Moves the element at the start of the array to the end, shifting all items in the process.\rThe \"rotation\" happens to the left.", "kind": "function", "name": "RotateLeft", "since": "3.0.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to shift to the left. This array is modified in place.", "name": "array" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The number of times to shift the array.", "name": "total" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The most recently shifted element." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.RotateLeft", "scope": "static", "___id": "T000002R045331", "___s": true }, { "comment": "/**\r\n * Moves the element at the end of the array to the start, shifting all items in the process.\r\n * The \"rotation\" happens to the right.\r\n *\r\n * @function Phaser.Utils.Array.RotateRight\r\n * @since 3.0.0\r\n *\r\n * @param {array} array - The array to shift to the right. This array is modified in place.\r\n * @param {number} [total=1] - The number of times to shift the array.\r\n *\r\n * @return {*} The most recently shifted element.\r\n */", "meta": { "filename": "RotateRight.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Moves the element at the end of the array to the start, shifting all items in the process.\rThe \"rotation\" happens to the right.", "kind": "function", "name": "RotateRight", "since": "3.0.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to shift to the right. This array is modified in place.", "name": "array" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The number of times to shift the array.", "name": "total" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The most recently shifted element." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.RotateRight", "scope": "static", "___id": "T000002R045338", "___s": true }, { "comment": "/**\r\n * Tests if the start and end indexes are a safe range for the given array.\r\n *\r\n * @function Phaser.Utils.Array.SafeRange\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The array to check.\r\n * @param {number} startIndex - The start index.\r\n * @param {number} endIndex - The end index.\r\n * @param {boolean} [throwError=true] - Throw an error if the range is out of bounds.\r\n *\r\n * @return {boolean} True if the range is safe, otherwise false.\r\n */", "meta": { "filename": "SafeRange.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Tests if the start and end indexes are a safe range for the given array.", "kind": "function", "name": "SafeRange", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to check.", "name": "array" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The start index.", "name": "startIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The end index.", "name": "endIndex" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Throw an error if the range is out of bounds.", "name": "throwError" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the range is safe, otherwise false." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.SafeRange", "scope": "static", "___id": "T000002R045345", "___s": true }, { "comment": "/**\r\n * Moves the given element to the bottom of the array.\r\n * The array is modified in-place.\r\n *\r\n * @function Phaser.Utils.Array.SendToBack\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The array.\r\n * @param {*} item - The element to move.\r\n *\r\n * @return {*} The element that was moved.\r\n */", "meta": { "filename": "SendToBack.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Moves the given element to the bottom of the array.\rThe array is modified in-place.", "kind": "function", "name": "SendToBack", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array.", "name": "array" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The element to move.", "name": "item" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The element that was moved." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.SendToBack", "scope": "static", "___id": "T000002R045349", "___s": true }, { "comment": "/**\r\n * Scans the array for elements with the given property. If found, the property is set to the `value`.\r\n *\r\n * For example: `SetAll('visible', true)` would set all elements that have a `visible` property to `false`.\r\n *\r\n * Optionally you can specify a start and end index. For example if the array had 100 elements,\r\n * and you set `startIndex` to 0 and `endIndex` to 50, it would update only the first 50 elements.\r\n *\r\n * @function Phaser.Utils.Array.SetAll\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The array to search.\r\n * @param {string} property - The property to test for on each array element.\r\n * @param {*} value - The value to set the property to.\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 {array} The input array.\r\n */", "meta": { "filename": "SetAll.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Scans the array for elements with the given property. If found, the property is set to the `value`.\r\rFor example: `SetAll('visible', true)` would set all elements that have a `visible` property to `false`.\r\rOptionally you can specify a start and end index. For example if the array had 100 elements,\rand you set `startIndex` to 0 and `endIndex` to 50, it would update only the first 50 elements.", "kind": "function", "name": "SetAll", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to search.", "name": "array" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property to test for on each array element.", "name": "property" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value to set the property to.", "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": "NameExpression", "name": "array" } }, "description": "The input array." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.SetAll", "scope": "static", "___id": "T000002R045354", "___s": true }, { "comment": "/**\r\n * Shuffles the contents of the given array using the Fisher-Yates implementation.\r\n *\r\n * The original array is modified directly and returned.\r\n *\r\n * @function Phaser.Utils.Array.Shuffle\r\n * @since 3.0.0\r\n *\r\n * @generic T\r\n * @genericUse {T[]} - [array,$return]\r\n *\r\n * @param {T[]} array - The array to shuffle. This array is modified in place.\r\n *\r\n * @return {T[]} The shuffled array.\r\n */", "meta": { "filename": "Shuffle.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Shuffles the contents of the given array using the Fisher-Yates implementation.\r\rThe original array is modified directly and returned.", "kind": "function", "name": "Shuffle", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "T", "value": "T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [array,$return]", "value": "{T[]} - [array,$return]" } ], "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } }, "description": "The array to shuffle. This array is modified in place.", "name": "array" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "T", "type": "NameExpression" } ] } }, "description": "The shuffled array." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.Shuffle", "scope": "static", "___id": "T000002R045362", "___s": true }, { "comment": "/**\n * Takes the given array and runs a numeric sort on it, ignoring any non-digits that\n * may be in the entries.\n *\n * You should only run this on arrays containing strings.\n *\n * @function Phaser.Utils.Array.SortByDigits\n * @since 3.50.0\n *\n * @param {string[]} array - The input array of strings.\n *\n * @return {string[]} The sorted input array.\n */", "meta": { "filename": "SortByDigits.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Takes the given array and runs a numeric sort on it, ignoring any non-digits that\nmay be in the entries.\n\nYou should only run this on arrays containing strings.", "kind": "function", "name": "SortByDigits", "since": "3.50.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "The input array of strings.", "name": "array" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "The sorted input array." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.SortByDigits", "scope": "static", "___id": "T000002R045370", "___s": true }, { "comment": "/**\r\n * Removes a single item from an array and returns it without creating gc, like the native splice does.\r\n * Based on code by Mike Reinstein.\r\n *\r\n * @function Phaser.Utils.Array.SpliceOne\r\n * @since 3.0.0\r\n *\r\n * @param {array} array - The array to splice from.\r\n * @param {number} index - The index of the item which should be spliced.\r\n *\r\n * @return {*} The item which was spliced (removed).\r\n */", "meta": { "filename": "SpliceOne.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Removes a single item from an array and returns it without creating gc, like the native splice does.\rBased on code by Mike Reinstein.", "kind": "function", "name": "SpliceOne", "since": "3.0.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array to splice from.", "name": "array" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the item which should be spliced.", "name": "index" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The item which was spliced (removed)." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.SpliceOne", "scope": "static", "___id": "T000002R045374", "___s": true }, { "comment": "/**\r\n * An in-place stable array sort, because `Array#sort()` is not guaranteed stable.\r\n *\r\n * This is an implementation of merge sort, without recursion.\r\n *\r\n * Function based on the Two-Screen/stable sort 0.1.8 from https://github.com/Two-Screen/stable\r\n *\r\n * @function Phaser.Utils.Array.StableSort\r\n * @since 3.0.0\r\n *\r\n * @param {array} array - The input array to be sorted.\r\n * @param {function} [compare] - The comparison function.\r\n *\r\n * @return {array} The sorted result.\r\n */", "meta": { "filename": "StableSort.js", "lineno": 142, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "An in-place stable array sort, because `Array#sort()` is not guaranteed stable.\r\rThis is an implementation of merge sort, without recursion.\r\rFunction based on the Two-Screen/stable sort 0.1.8 from https://github.com/Two-Screen/stable", "kind": "function", "name": "StableSort", "since": "3.0.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The input array to be sorted.", "name": "array" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "The comparison function.", "name": "compare" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The sorted result." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.StableSort", "scope": "static", "___id": "T000002R045413", "___s": true }, { "comment": "/**\r\n * Swaps the position of two elements in the given array.\r\n * The elements must exist in the same array.\r\n * The array is modified in-place.\r\n *\r\n * @function Phaser.Utils.Array.Swap\r\n * @since 3.4.0\r\n *\r\n * @param {array} array - The input array.\r\n * @param {*} item1 - The first element to swap.\r\n * @param {*} item2 - The second element to swap.\r\n *\r\n * @return {array} The input array.\r\n */", "meta": { "filename": "Swap.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\array", "code": {} }, "description": "Swaps the position of two elements in the given array.\rThe elements must exist in the same array.\rThe array is modified in-place.", "kind": "function", "name": "Swap", "since": "3.4.0", "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The input array.", "name": "array" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The first element to swap.", "name": "item1" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The second element to swap.", "name": "item2" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The input array." } ], "memberof": "Phaser.Utils.Array", "longname": "Phaser.Utils.Array.Swap", "scope": "static", "___id": "T000002R045418", "___s": true }, { "comment": "/**\r\n * Converts an ArrayBuffer into a base64 string.\r\n *\r\n * The resulting string can optionally be a data uri if the `mediaType` argument is provided.\r\n *\r\n * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs for more details.\r\n *\r\n * @function Phaser.Utils.Base64.ArrayBufferToBase64\r\n * @since 3.18.0\r\n *\r\n * @param {ArrayBuffer} arrayBuffer - The Array Buffer to encode.\r\n * @param {string} [mediaType] - An optional media type, i.e. `audio/ogg` or `image/jpeg`. If included the resulting string will be a data URI.\r\n *\r\n * @return {string} The base64 encoded Array Buffer.\r\n */", "meta": { "filename": "ArrayBufferToBase64.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\base64", "code": {} }, "description": "Converts an ArrayBuffer into a base64 string.\r\rThe resulting string can optionally be a data uri if the `mediaType` argument is provided.\r\rSee https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs for more details.", "kind": "function", "name": "ArrayBufferToBase64", "since": "3.18.0", "params": [ { "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "description": "The Array Buffer to encode.", "name": "arrayBuffer" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "An optional media type, i.e. `audio/ogg` or `image/jpeg`. If included the resulting string will be a data URI.", "name": "mediaType" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The base64 encoded Array Buffer." } ], "memberof": "Phaser.Utils.Base64", "longname": "Phaser.Utils.Base64.ArrayBufferToBase64", "scope": "static", "___id": "T000002R045426", "___s": true }, { "comment": "/**\r\n * Converts a base64 string, either with or without a data uri, into an Array Buffer.\r\n *\r\n * @function Phaser.Utils.Base64.Base64ToArrayBuffer\r\n * @since 3.18.0\r\n *\r\n * @param {string} base64 - The base64 string to be decoded. Can optionally contain a data URI header, which will be stripped out prior to decoding.\r\n *\r\n * @return {ArrayBuffer} An ArrayBuffer decoded from the base64 data.\r\n */", "meta": { "filename": "Base64ToArrayBuffer.js", "lineno": 18, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\base64", "code": {} }, "description": "Converts a base64 string, either with or without a data uri, into an Array Buffer.", "kind": "function", "name": "Base64ToArrayBuffer", "since": "3.18.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The base64 string to be decoded. Can optionally contain a data URI header, which will be stripped out prior to decoding.", "name": "base64" } ], "returns": [ { "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "description": "An ArrayBuffer decoded from the base64 data." } ], "memberof": "Phaser.Utils.Base64", "longname": "Phaser.Utils.Base64.Base64ToArrayBuffer", "scope": "static", "___id": "T000002R045444", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Utils.Base64\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\base64", "code": {} }, "kind": "namespace", "name": "Base64", "memberof": "Phaser.Utils", "longname": "Phaser.Utils.Base64", "scope": "static", "___id": "T000002R045466", "___s": true }, { "comment": "/**\r\n * Creates a new class with the given descriptor.\r\n * The constructor, defined by the name `initialize`,\r\n * is an optional function. If unspecified, an anonymous\r\n * function will be used which calls the parent class (if\r\n * one exists).\r\n *\r\n * You can also use `Extends` and `Mixins` to provide subclassing\r\n * and inheritance.\r\n *\r\n * @class Phaser.Class\r\n * @constructor\r\n * @param {Object} definition a dictionary of functions for the class\r\n * @example\r\n *\r\n * var MyClass = new Phaser.Class({\r\n *\r\n * initialize: function() {\r\n * this.foo = 2.0;\r\n * },\r\n *\r\n * bar: function() {\r\n * return this.foo + 5;\r\n * }\r\n * });\r\n */", "meta": { "range": [ 4755, 6569 ], "filename": "Class.js", "lineno": 173, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils", "code": { "id": "astnode100383544", "name": "Class", "type": "FunctionDeclaration", "paramnames": [ "definition" ] }, "vars": { "definition": "Class~definition", "initialize": "Class~initialize", "Extends": "Class~Extends", "base": "Class~base", "": null, "initialize.prototype": "Class~initialize.prototype", "initialize.prototype.constructor": "Class~initialize#constructor", "mixins": "Class~mixins" } }, "description": "Creates a new class with the given descriptor.\rThe constructor, defined by the name `initialize`,\ris an optional function. If unspecified, an anonymous\rfunction will be used which calls the parent class (if\rone exists).\r\rYou can also use `Extends` and `Mixins` to provide subclassing\rand inheritance.", "kind": "class", "classdesc": "Phaser.Class", "params": [ { "type": { "names": [ "Object" ], "parsedType": { "type": "NameExpression", "name": "Object" } }, "description": "a dictionary of functions for the class", "name": "definition" } ], "examples": [ "var MyClass = new Phaser.Class({\r\r initialize: function() {\r this.foo = 2.0;\r },\r\r bar: function() {\r return this.foo + 5;\r }\r });" ], "name": "Class", "longname": "Class", "scope": "global", "___id": "T000002R045489", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Utils\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils", "code": {} }, "kind": "namespace", "name": "Utils", "memberof": "Phaser", "longname": "Phaser.Utils", "scope": "static", "___id": "T000002R045507", "___s": true }, { "comment": "/**\r\n * A NOOP (No Operation) callback function.\r\n *\r\n * Used internally by Phaser when it's more expensive to determine if a callback exists\r\n * than it is to just invoke an empty function.\r\n *\r\n * @function Phaser.Utils.NOOP\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NOOP.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils", "code": {} }, "description": "A NOOP (No Operation) callback function.\r\rUsed internally by Phaser when it's more expensive to determine if a callback exists\rthan it is to just invoke an empty function.", "kind": "function", "name": "NOOP", "since": "3.0.0", "memberof": "Phaser.Utils", "longname": "Phaser.Utils.NOOP", "scope": "static", "___id": "T000002R045515", "___s": true }, { "comment": "/**\r\n * A NULL OP callback function.\r\n *\r\n * This function always returns `null`.\r\n *\r\n * Used internally by Phaser when it's more expensive to determine if a callback exists\r\n * than it is to just invoke an empty function.\r\n *\r\n * @function Phaser.Utils.NULL\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NULL.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils", "code": {} }, "description": "A NULL OP callback function.\r\rThis function always returns `null`.\r\rUsed internally by Phaser when it's more expensive to determine if a callback exists\rthan it is to just invoke an empty function.", "kind": "function", "name": "NULL", "since": "3.60.0", "memberof": "Phaser.Utils", "longname": "Phaser.Utils.NULL", "scope": "static", "___id": "T000002R045518", "___s": true }, { "comment": "/**\r\n * Shallow Object Clone. Will not clone nested objects.\r\n *\r\n * @function Phaser.Utils.Objects.Clone\r\n * @since 3.0.0\r\n *\r\n * @param {object} obj - The object to clone.\r\n *\r\n * @return {object} A new object with the same properties as the input object.\r\n */", "meta": { "filename": "Clone.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\object", "code": {} }, "description": "Shallow Object Clone. Will not clone nested objects.", "kind": "function", "name": "Clone", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The object to clone.", "name": "obj" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "A new object with the same properties as the input object." } ], "memberof": "Phaser.Utils.Objects", "longname": "Phaser.Utils.Objects.Clone", "scope": "static", "___id": "T000002R045521", "___s": true }, { "comment": "/**\r\n * Deep Copy the given object or array.\r\n *\r\n * @function Phaser.Utils.Objects.DeepCopy\r\n * @since 3.50.0\r\n *\r\n * @param {object} obj - The object to deep copy.\r\n *\r\n * @return {object} A deep copy of the original object.\r\n */", "meta": { "filename": "DeepCopy.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\object", "code": {} }, "description": "Deep Copy the given object or array.", "kind": "function", "name": "DeepCopy", "since": "3.50.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The object to deep copy.", "name": "obj" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "A deep copy of the original object." } ], "memberof": "Phaser.Utils.Objects", "longname": "Phaser.Utils.Objects.DeepCopy", "scope": "static", "___id": "T000002R045528", "___s": true }, { "comment": "/**\r\n * This is a slightly modified version of http://api.jquery.com/jQuery.extend/\r\n *\r\n * @function Phaser.Utils.Objects.Extend\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - The objects that will be mixed.\r\n *\r\n * @return {object} The extended object.\r\n */", "meta": { "filename": "Extend.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\object", "code": {} }, "description": "This is a slightly modified version of http://api.jquery.com/jQuery.extend/", "kind": "function", "name": "Extend", "since": "3.0.0", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "The objects that will be mixed.", "name": "args" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The extended object." } ], "memberof": "Phaser.Utils.Objects", "longname": "Phaser.Utils.Objects.Extend", "scope": "static", "___id": "T000002R045538", "___s": true }, { "comment": "/**\r\n * Retrieves a value from an object. Allows for more advanced selection options, including:\r\n *\r\n * Allowed types:\r\n *\r\n * Explicit:\r\n * {\r\n * x: 4\r\n * }\r\n *\r\n * From function\r\n * {\r\n * x: function ()\r\n * }\r\n *\r\n * Randomly pick one element from the array\r\n * {\r\n * x: [a, b, c, d, e, f]\r\n * }\r\n *\r\n * Random integer between min and max:\r\n * {\r\n * x: { randInt: [min, max] }\r\n * }\r\n *\r\n * Random float between min and max:\r\n * {\r\n * x: { randFloat: [min, max] }\r\n * }\r\n *\r\n *\r\n * @function Phaser.Utils.Objects.GetAdvancedValue\r\n * @since 3.0.0\r\n *\r\n * @param {object} source - The object to retrieve the value from.\r\n * @param {string} key - The name of the property to retrieve from the object. If a property is nested, the names of its preceding properties should be separated by a dot (`.`) - `banner.hideBanner` would return the value of the `hideBanner` property from the object stored in the `banner` property of the `source` object.\r\n * @param {*} defaultValue - The value to return if the `key` isn't found in the `source` object.\r\n *\r\n * @return {*} The value of the requested key.\r\n */", "meta": { "filename": "GetAdvancedValue.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\object", "code": {} }, "description": "Retrieves a value from an object. Allows for more advanced selection options, including:\r\rAllowed types:\r\rExplicit:\r{\r x: 4\r}\r\rFrom function\r{\r x: function ()\r}\r\rRandomly pick one element from the array\r{\r x: [a, b, c, d, e, f]\r}\r\rRandom integer between min and max:\r{\r x: { randInt: [min, max] }\r}\r\rRandom float between min and max:\r{\r x: { randFloat: [min, max] }\r}", "kind": "function", "name": "GetAdvancedValue", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The object to retrieve the value from.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property to retrieve from the object. If a property is nested, the names of its preceding properties should be separated by a dot (`.`) - `banner.hideBanner` would return the value of the `hideBanner` property from the object stored in the `banner` property of the `source` object.", "name": "key" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value to return if the `key` isn't found in the `source` object.", "name": "defaultValue" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value of the requested key." } ], "memberof": "Phaser.Utils.Objects", "longname": "Phaser.Utils.Objects.GetAdvancedValue", "scope": "static", "___id": "T000002R045566", "___s": true }, { "comment": "/**\r\n * Finds the key within the top level of the {@link source} object, or returns {@link defaultValue}\r\n *\r\n * @function Phaser.Utils.Objects.GetFastValue\r\n * @since 3.0.0\r\n *\r\n * @param {object} source - The object to search\r\n * @param {string} key - The key for the property on source. Must exist at the top level of the source object (no periods)\r\n * @param {*} [defaultValue] - The default value to use if the key does not exist.\r\n *\r\n * @return {*} The value if found; otherwise, defaultValue (null if none provided)\r\n */", "meta": { "filename": "GetFastValue.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\object", "code": {} }, "description": "Finds the key within the top level of the {@link source} object, or returns {@link defaultValue}", "kind": "function", "name": "GetFastValue", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The object to search", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key for the property on source. Must exist at the top level of the source object (no periods)", "name": "key" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The default value to use if the key does not exist.", "name": "defaultValue" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value if found; otherwise, defaultValue (null if none provided)" } ], "memberof": "Phaser.Utils.Objects", "longname": "Phaser.Utils.Objects.GetFastValue", "scope": "static", "___id": "T000002R045570", "___s": true }, { "comment": "/**\r\n * Retrieves and clamps a numerical value from an object.\r\n *\r\n * @function Phaser.Utils.Objects.GetMinMaxValue\r\n * @since 3.0.0\r\n *\r\n * @param {object} source - The object to retrieve the value from.\r\n * @param {string} key - The name of the property to retrieve from the object. If a property is nested, the names of its preceding properties should be separated by a dot (`.`).\r\n * @param {number} min - The minimum value which can be returned.\r\n * @param {number} max - The maximum value which can be returned.\r\n * @param {number} defaultValue - The value to return if the property doesn't exist. It's also constrained to the given bounds.\r\n *\r\n * @return {number} The clamped value from the `source` object.\r\n */", "meta": { "filename": "GetMinMaxValue.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\object", "code": {} }, "description": "Retrieves and clamps a numerical value from an object.", "kind": "function", "name": "GetMinMaxValue", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The object to retrieve the value from.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property to retrieve from the object. If a property is nested, the names of its preceding properties should be separated by a dot (`.`).", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum value which can be returned.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum value which can be returned.", "name": "max" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to return if the property doesn't exist. It's also constrained to the given bounds.", "name": "defaultValue" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The clamped value from the `source` object." } ], "memberof": "Phaser.Utils.Objects", "longname": "Phaser.Utils.Objects.GetMinMaxValue", "scope": "static", "___id": "T000002R045576", "___s": true }, { "comment": "/**\r\n * Retrieves a value from an object, or an alternative object, falling to a back-up default value if not found.\r\n *\r\n * The key is a string, which can be split based on the use of the period character.\r\n *\r\n * For example:\r\n *\r\n * ```javascript\r\n * const source = {\r\n * lives: 3,\r\n * render: {\r\n * screen: {\r\n * width: 1024\r\n * }\r\n * }\r\n * }\r\n *\r\n * const lives = GetValue(source, 'lives', 1);\r\n * const width = GetValue(source, 'render.screen.width', 800);\r\n * const height = GetValue(source, 'render.screen.height', 600);\r\n * ```\r\n *\r\n * In the code above, `lives` will be 3 because it's defined at the top level of `source`.\r\n * The `width` value will be 1024 because it can be found inside the `render.screen` object.\r\n * The `height` value will be 600, the default value, because it is missing from the `render.screen` object.\r\n *\r\n * @function Phaser.Utils.Objects.GetValue\r\n * @since 3.0.0\r\n *\r\n * @param {object} source - The primary object to try to retrieve the value from. If not found in here, `altSource` is checked.\r\n * @param {string} key - The name of the property to retrieve from the object. If a property is nested, the names of its preceding properties should be separated by a dot (`.`) - `banner.hideBanner` would return the value of the `hideBanner` property from the object stored in the `banner` property of the `source` object.\r\n * @param {*} defaultValue - The value to return if the `key` isn't found in the `source` object.\r\n * @param {object} [altSource] - An alternative object to retrieve the value from. If the property exists in `source` then `altSource` will not be used.\r\n *\r\n * @return {*} The value of the requested key.\r\n */", "meta": { "filename": "GetValue.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\object", "code": {} }, "description": "Retrieves a value from an object, or an alternative object, falling to a back-up default value if not found.\r\rThe key is a string, which can be split based on the use of the period character.\r\rFor example:\r\r```javascript\rconst source = {\r lives: 3,\r render: {\r screen: {\r width: 1024\r }\r }\r}\r\rconst lives = GetValue(source, 'lives', 1);\rconst width = GetValue(source, 'render.screen.width', 800);\rconst height = GetValue(source, 'render.screen.height', 600);\r```\r\rIn the code above, `lives` will be 3 because it's defined at the top level of `source`.\rThe `width` value will be 1024 because it can be found inside the `render.screen` object.\rThe `height` value will be 600, the default value, because it is missing from the `render.screen` object.", "kind": "function", "name": "GetValue", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The primary object to try to retrieve the value from. If not found in here, `altSource` is checked.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property to retrieve from the object. If a property is nested, the names of its preceding properties should be separated by a dot (`.`) - `banner.hideBanner` would return the value of the `hideBanner` property from the object stored in the `banner` property of the `source` object.", "name": "key" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value to return if the `key` isn't found in the `source` object.", "name": "defaultValue" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "An alternative object to retrieve the value from. If the property exists in `source` then `altSource` will not be used.", "name": "altSource" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value of the requested key." } ], "memberof": "Phaser.Utils.Objects", "longname": "Phaser.Utils.Objects.GetValue", "scope": "static", "___id": "T000002R045581", "___s": true }, { "comment": "/**\r\n * Verifies that an object contains all requested keys\r\n *\r\n * @function Phaser.Utils.Objects.HasAll\r\n * @since 3.0.0\r\n *\r\n * @param {object} source - an object on which to check for key existence\r\n * @param {string[]} keys - an array of keys to ensure the source object contains\r\n *\r\n * @return {boolean} true if the source object contains all keys, false otherwise.\r\n */", "meta": { "filename": "HasAll.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\object", "code": {} }, "description": "Verifies that an object contains all requested keys", "kind": "function", "name": "HasAll", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "an object on which to check for key existence", "name": "source" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "an array of keys to ensure the source object contains", "name": "keys" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "true if the source object contains all keys, false otherwise." } ], "memberof": "Phaser.Utils.Objects", "longname": "Phaser.Utils.Objects.HasAll", "scope": "static", "___id": "T000002R045598", "___s": true }, { "comment": "/**\r\n * Verifies that an object contains at least one of the requested keys\r\n *\r\n * @function Phaser.Utils.Objects.HasAny\r\n * @since 3.0.0\r\n *\r\n * @param {object} source - an object on which to check for key existence\r\n * @param {string[]} keys - an array of keys to search the object for\r\n *\r\n * @return {boolean} true if the source object contains at least one of the keys, false otherwise\r\n */", "meta": { "filename": "HasAny.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\object", "code": {} }, "description": "Verifies that an object contains at least one of the requested keys", "kind": "function", "name": "HasAny", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "an object on which to check for key existence", "name": "source" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "an array of keys to search the object for", "name": "keys" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "true if the source object contains at least one of the keys, false otherwise" } ], "memberof": "Phaser.Utils.Objects", "longname": "Phaser.Utils.Objects.HasAny", "scope": "static", "___id": "T000002R045602", "___s": true }, { "comment": "/**\r\n * Determine whether the source object has a property with the specified key.\r\n *\r\n * @function Phaser.Utils.Objects.HasValue\r\n * @since 3.0.0\r\n *\r\n * @param {object} source - The source object to be checked.\r\n * @param {string} key - The property to check for within the object\r\n *\r\n * @return {boolean} `true` if the provided `key` exists on the `source` object, otherwise `false`.\r\n */", "meta": { "filename": "HasValue.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\object", "code": {} }, "description": "Determine whether the source object has a property with the specified key.", "kind": "function", "name": "HasValue", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The source object to be checked.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property to check for within the object", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the provided `key` exists on the `source` object, otherwise `false`." } ], "memberof": "Phaser.Utils.Objects", "longname": "Phaser.Utils.Objects.HasValue", "scope": "static", "___id": "T000002R045606", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Utils.Objects\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\object", "code": {} }, "kind": "namespace", "name": "Objects", "memberof": "Phaser.Utils", "longname": "Phaser.Utils.Objects", "scope": "static", "___id": "T000002R045609", "___s": true }, { "comment": "/**\r\n * This is a slightly modified version of jQuery.isPlainObject.\r\n * A plain object is an object whose internal class property is [object Object].\r\n *\r\n * @function Phaser.Utils.Objects.IsPlainObject\r\n * @since 3.0.0\r\n *\r\n * @param {object} obj - The object to inspect.\r\n *\r\n * @return {boolean} `true` if the object is plain, otherwise `false`.\r\n */", "meta": { "filename": "IsPlainObject.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\object", "code": {} }, "description": "This is a slightly modified version of jQuery.isPlainObject.\rA plain object is an object whose internal class property is [object Object].", "kind": "function", "name": "IsPlainObject", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The object to inspect.", "name": "obj" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the object is plain, otherwise `false`." } ], "memberof": "Phaser.Utils.Objects", "longname": "Phaser.Utils.Objects.IsPlainObject", "scope": "static", "___id": "T000002R045626", "___s": true }, { "comment": "/**\r\n * Creates a new Object using all values from obj1 and obj2.\r\n * If a value exists in both obj1 and obj2, the value in obj1 is used.\r\n *\r\n * This is only a shallow copy. Deeply nested objects are not cloned, so be sure to only use this\r\n * function on shallow objects.\r\n *\r\n * @function Phaser.Utils.Objects.Merge\r\n * @since 3.0.0\r\n *\r\n * @param {object} obj1 - The first object.\r\n * @param {object} obj2 - The second object.\r\n *\r\n * @return {object} A new object containing the union of obj1's and obj2's properties.\r\n */", "meta": { "filename": "Merge.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\object", "code": {} }, "description": "Creates a new Object using all values from obj1 and obj2.\rIf a value exists in both obj1 and obj2, the value in obj1 is used.\r\rThis is only a shallow copy. Deeply nested objects are not cloned, so be sure to only use this\rfunction on shallow objects.", "kind": "function", "name": "Merge", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The first object.", "name": "obj1" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The second object.", "name": "obj2" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "A new object containing the union of obj1's and obj2's properties." } ], "memberof": "Phaser.Utils.Objects", "longname": "Phaser.Utils.Objects.Merge", "scope": "static", "___id": "T000002R045630", "___s": true }, { "comment": "/**\r\n * Creates a new Object using all values from obj1.\r\n *\r\n * Then scans obj2. If a property is found in obj2 that *also* exists in obj1, the value from obj2 is used, otherwise the property is skipped.\r\n *\r\n * @function Phaser.Utils.Objects.MergeRight\r\n * @since 3.0.0\r\n *\r\n * @param {object} obj1 - The first object to merge.\r\n * @param {object} obj2 - The second object to merge. Keys from this object which also exist in `obj1` will be copied to `obj1`.\r\n *\r\n * @return {object} The merged object. `obj1` and `obj2` are not modified.\r\n */", "meta": { "filename": "MergeRight.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\object", "code": {} }, "description": "Creates a new Object using all values from obj1.\r\rThen scans obj2. If a property is found in obj2 that *also* exists in obj1, the value from obj2 is used, otherwise the property is skipped.", "kind": "function", "name": "MergeRight", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The first object to merge.", "name": "obj1" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The second object to merge. Keys from this object which also exist in `obj1` will be copied to `obj1`.", "name": "obj2" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The merged object. `obj1` and `obj2` are not modified." } ], "memberof": "Phaser.Utils.Objects", "longname": "Phaser.Utils.Objects.MergeRight", "scope": "static", "___id": "T000002R045637", "___s": true }, { "comment": "/**\r\n * Returns a new object that only contains the `keys` that were found on the object provided.\r\n * If no `keys` are found, an empty object is returned.\r\n *\r\n * @function Phaser.Utils.Objects.Pick\r\n * @since 3.18.0\r\n *\r\n * @param {object} object - The object to pick the provided keys from.\r\n * @param {array} keys - An array of properties to retrieve from the provided object.\r\n *\r\n * @return {object} A new object that only contains the `keys` that were found on the provided object. If no `keys` were found, an empty object will be returned.\r\n */", "meta": { "filename": "Pick.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\object", "code": {} }, "description": "Returns a new object that only contains the `keys` that were found on the object provided.\rIf no `keys` are found, an empty object is returned.", "kind": "function", "name": "Pick", "since": "3.18.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The object to pick the provided keys from.", "name": "object" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "An array of properties to retrieve from the provided object.", "name": "keys" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "A new object that only contains the `keys` that were found on the provided object. If no `keys` were found, an empty object will be returned." } ], "memberof": "Phaser.Utils.Objects", "longname": "Phaser.Utils.Objects.Pick", "scope": "static", "___id": "T000002R045644", "___s": true }, { "comment": "/**\r\n * Sets a value in an object, allowing for dot notation to control the depth of the property.\r\n *\r\n * For example:\r\n *\r\n * ```javascript\r\n * var data = {\r\n * world: {\r\n * position: {\r\n * x: 200,\r\n * y: 100\r\n * }\r\n * }\r\n * };\r\n *\r\n * SetValue(data, 'world.position.y', 300);\r\n *\r\n * console.log(data.world.position.y); // 300\r\n * ```\r\n *\r\n * @function Phaser.Utils.Objects.SetValue\r\n * @since 3.17.0\r\n *\r\n * @param {object} source - The object to set the value in.\r\n * @param {string} key - The name of the property in the object. If a property is nested, the names of its preceding properties should be separated by a dot (`.`)\r\n * @param {any} value - The value to set into the property, if found in the source object.\r\n *\r\n * @return {boolean} `true` if the property key was valid and the value was set, otherwise `false`.\r\n */", "meta": { "filename": "SetValue.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\object", "code": {} }, "description": "Sets a value in an object, allowing for dot notation to control the depth of the property.\r\rFor example:\r\r```javascript\rvar data = {\r world: {\r position: {\r x: 200,\r y: 100\r }\r }\r};\r\rSetValue(data, 'world.position.y', 300);\r\rconsole.log(data.world.position.y); // 300\r```", "kind": "function", "name": "SetValue", "since": "3.17.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The object to set the value in.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property in the object. If a property is nested, the names of its preceding properties should be separated by a dot (`.`)", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The value to set into the property, if found in the source object.", "name": "value" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the property key was valid and the value was set, otherwise `false`." } ], "memberof": "Phaser.Utils.Objects", "longname": "Phaser.Utils.Objects.SetValue", "scope": "static", "___id": "T000002R045651", "___s": true }, { "comment": "/**\r\n * Takes a string and replaces instances of markers with values in the given array.\r\n * The markers take the form of `%1`, `%2`, etc. I.e.:\r\n *\r\n * `Format(\"The %1 is worth %2 gold\", [ 'Sword', 500 ])`\r\n *\r\n * @function Phaser.Utils.String.Format\r\n * @since 3.0.0\r\n *\r\n * @param {string} string - The string containing the replacement markers.\r\n * @param {array} values - An array containing values that will replace the markers. If no value exists an empty string is inserted instead.\r\n *\r\n * @return {string} The string containing replaced values.\r\n */", "meta": { "filename": "Format.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\string", "code": {} }, "description": "Takes a string and replaces instances of markers with values in the given array.\rThe markers take the form of `%1`, `%2`, etc. I.e.:\r\r`Format(\"The %1 is worth %2 gold\", [ 'Sword', 500 ])`", "kind": "function", "name": "Format", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string containing the replacement markers.", "name": "string" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "An array containing values that will replace the markers. If no value exists an empty string is inserted instead.", "name": "values" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string containing replaced values." } ], "memberof": "Phaser.Utils.String", "longname": "Phaser.Utils.String.Format", "scope": "static", "___id": "T000002R045662", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Utils.String\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\string", "code": {} }, "kind": "namespace", "name": "String", "memberof": "Phaser.Utils", "longname": "Phaser.Utils.String", "scope": "static", "___id": "T000002R045665", "___s": true }, { "comment": "/**\r\n * Takes the given string and pads it out, to the length required, using the character\r\n * specified. For example if you need a string to be 6 characters long, you can call:\r\n *\r\n * `pad('bob', 6, '-', 2)`\r\n *\r\n * This would return: `bob---` as it has padded it out to 6 characters, using the `-` on the right.\r\n *\r\n * You can also use it to pad numbers (they are always returned as strings):\r\n *\r\n * `pad(512, 6, '0', 1)`\r\n *\r\n * Would return: `000512` with the string padded to the left.\r\n *\r\n * If you don't specify a direction it'll pad to both sides:\r\n *\r\n * `pad('c64', 7, '*')`\r\n *\r\n * Would return: `**c64**`\r\n *\r\n * @function Phaser.Utils.String.Pad\r\n * @since 3.0.0\r\n *\r\n * @param {string|number|object} str - The target string. `toString()` will be called on the string, which means you can also pass in common data types like numbers.\r\n * @param {number} [len=0] - The number of characters to be added.\r\n * @param {string} [pad=\" \"] - The string to pad it out with (defaults to a space).\r\n * @param {number} [dir=3] - The direction dir = 1 (left), 2 (right), 3 (both).\r\n *\r\n * @return {string} The padded string.\r\n */", "meta": { "filename": "Pad.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\string", "code": {} }, "description": "Takes the given string and pads it out, to the length required, using the character\rspecified. For example if you need a string to be 6 characters long, you can call:\r\r`pad('bob', 6, '-', 2)`\r\rThis would return: `bob---` as it has padded it out to 6 characters, using the `-` on the right.\r\rYou can also use it to pad numbers (they are always returned as strings):\r\r`pad(512, 6, '0', 1)`\r\rWould return: `000512` with the string padded to the left.\r\rIf you don't specify a direction it'll pad to both sides:\r\r`pad('c64', 7, '*')`\r\rWould return: `**c64**`", "kind": "function", "name": "Pad", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "number", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The target string. `toString()` will be called on the string, which means you can also pass in common data types like numbers.", "name": "str" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of characters to be added.", "name": "len" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "\" \"", "description": "The string to pad it out with (defaults to a space).", "name": "pad" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 3, "description": "The direction dir = 1 (left), 2 (right), 3 (both).", "name": "dir" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The padded string." } ], "memberof": "Phaser.Utils.String", "longname": "Phaser.Utils.String.Pad", "scope": "static", "___id": "T000002R045673", "___s": true }, { "comment": "/**\r\n * Takes a string and removes the character at the given index.\r\n *\r\n * @function Phaser.Utils.String.RemoveAt\r\n * @since 3.50.0\r\n *\r\n * @param {string} string - The string to be worked on.\r\n * @param {number} index - The index of the character to be removed.\r\n *\r\n * @return {string} The modified string.\r\n */", "meta": { "filename": "RemoveAt.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\string", "code": {} }, "description": "Takes a string and removes the character at the given index.", "kind": "function", "name": "RemoveAt", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string to be worked on.", "name": "string" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the character to be removed.", "name": "index" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The modified string." } ], "memberof": "Phaser.Utils.String", "longname": "Phaser.Utils.String.RemoveAt", "scope": "static", "___id": "T000002R045687", "___s": true }, { "comment": "/**\r\n * Takes the given string and reverses it, returning the reversed string.\r\n * For example if given the string `Atari 520ST` it would return `TS025 iratA`.\r\n *\r\n * @function Phaser.Utils.String.Reverse\r\n * @since 3.0.0\r\n *\r\n * @param {string} string - The string to be reversed.\r\n *\r\n * @return {string} The reversed string.\r\n */", "meta": { "filename": "Reverse.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\string", "code": {} }, "description": "Takes the given string and reverses it, returning the reversed string.\rFor example if given the string `Atari 520ST` it would return `TS025 iratA`.", "kind": "function", "name": "Reverse", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string to be reversed.", "name": "string" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The reversed string." } ], "memberof": "Phaser.Utils.String", "longname": "Phaser.Utils.String.Reverse", "scope": "static", "___id": "T000002R045690", "___s": true }, { "comment": "/**\r\n * Capitalizes the first letter of a string if there is one.\r\n * @example\r\n * UppercaseFirst('abc');\r\n * // returns 'Abc'\r\n * @example\r\n * UppercaseFirst('the happy family');\r\n * // returns 'The happy family'\r\n * @example\r\n * UppercaseFirst('');\r\n * // returns ''\r\n *\r\n * @function Phaser.Utils.String.UppercaseFirst\r\n * @since 3.0.0\r\n *\r\n * @param {string} str - The string to capitalize.\r\n *\r\n * @return {string} A new string, same as the first, but with the first letter capitalized.\r\n */", "meta": { "filename": "UppercaseFirst.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\string", "code": {} }, "description": "Capitalizes the first letter of a string if there is one.", "examples": [ "UppercaseFirst('abc');\r// returns 'Abc'", "UppercaseFirst('the happy family');\r// returns 'The happy family'", "UppercaseFirst('');\r// returns ''" ], "kind": "function", "name": "UppercaseFirst", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string to capitalize.", "name": "str" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A new string, same as the first, but with the first letter capitalized." } ], "memberof": "Phaser.Utils.String", "longname": "Phaser.Utils.String.UppercaseFirst", "scope": "static", "___id": "T000002R045693", "___s": true }, { "comment": "/**\r\n * Creates and returns an RFC4122 version 4 compliant UUID.\r\n *\r\n * The string is in the form: `xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx` where each `x` is replaced with a random\r\n * hexadecimal digit from 0 to f, and `y` is replaced with a random hexadecimal digit from 8 to b.\r\n *\r\n * @function Phaser.Utils.String.UUID\r\n * @since 3.12.0\r\n *\r\n * @return {string} The UUID string.\r\n */", "meta": { "filename": "UUID.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\utils\\string", "code": {} }, "description": "Creates and returns an RFC4122 version 4 compliant UUID.\r\rThe string is in the form: `xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx` where each `x` is replaced with a random\rhexadecimal digit from 0 to f, and `y` is replaced with a random hexadecimal digit from 8 to b.", "kind": "function", "name": "UUID", "since": "3.12.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The UUID string." } ], "memberof": "Phaser.Utils.String", "longname": "Phaser.Utils.String.UUID", "scope": "static", "___id": "T000002R045696", "___s": true }, { "comment": "/**\r\n * @typedef {object} AdInstance\r\n *\r\n * @property {any} instance - Represents an instance of an ad.\r\n * @property {string} placementID - The Audience Network placement ID of this ad instance.\r\n * @property {boolean} shown - Has this ad already been shown in-game?\r\n * @property {boolean} video - Is this a video ad?\r\n */", "meta": { "filename": "AdInstance.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "kind": "typedef", "name": "AdInstance", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "Represents an instance of an ad.", "name": "instance" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The Audience Network placement ID of this ad instance.", "name": "placementID" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Has this ad already been shown in-game?", "name": "shown" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this a video ad?", "name": "video" } ], "longname": "AdInstance", "scope": "global", "___id": "T000002R045701", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Facebook Instant Games Plugin for Phaser 3 provides a seamless bridge between Phaser\r\n * and the Facebook Instant Games API version 6.2.\r\n * \r\n * You can access this plugin via the `facebook` property in a Scene, i.e:\r\n * \r\n * ```javascript\r\n * this.facebook.getPlatform();\r\n * ```\r\n * \r\n * If this is unavailable please check to make sure you're using a build of Phaser that has\r\n * this plugin within it. You can quickly check this by looking at the dev tools console\r\n * header - the Phaser version number will have `-FB` after it if this plugin is loaded.\r\n *\r\n * If you are building your own version of Phaser then use this Webpack DefinePlugin flag:\r\n * \r\n * `\"typeof PLUGIN_FBINSTANT\": JSON.stringify(true)`\r\n * \r\n * You will find that every Instant Games API method has a mapping in this plugin.\r\n * For a full list please consult either the plugin documentation, or the 6.2 SDK documentation\r\n * at https://developers.facebook.com/docs/games/instant-games/sdk/fbinstant6.2\r\n * \r\n * Internally this plugin uses its own Data Manager to handle seamless user data updates and provides\r\n * handy functions for advertisement displaying, opening share dialogs, logging, leaderboards, purchase API requests,\r\n * loader integration and more.\r\n * \r\n * To get started with Facebook Instant Games you will need to register on Facebook and create a new Instant\r\n * Game app that has its own unique app ID. Facebook have also provided a dashboard interface for setting up\r\n * various features for your game, including leaderboards, ad requests and the payments API. There are lots\r\n * of guides on the Facebook Developers portal to assist with setting these\r\n * various systems up: https://developers.facebook.com/docs/games/instant-games/guides\r\n * \r\n * For more details follow the Quick Start guide here: https://developers.facebook.com/docs/games/instant-games\r\n *\r\n * @class FacebookInstantGamesPlugin\r\n * @memberOf Phaser\r\n * @constructor\r\n * @extends Phaser.Events.EventEmitter\r\n * @since 3.13.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser.Game instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "classdesc": "The Facebook Instant Games Plugin for Phaser 3 provides a seamless bridge between Phaser\rand the Facebook Instant Games API version 6.2.\r\rYou can access this plugin via the `facebook` property in a Scene, i.e:\r\r```javascript\rthis.facebook.getPlatform();\r```\r\rIf this is unavailable please check to make sure you're using a build of Phaser that has\rthis plugin within it. You can quickly check this by looking at the dev tools console\rheader - the Phaser version number will have `-FB` after it if this plugin is loaded.\r\rIf you are building your own version of Phaser then use this Webpack DefinePlugin flag:\r\r`\"typeof PLUGIN_FBINSTANT\": JSON.stringify(true)`\r\rYou will find that every Instant Games API method has a mapping in this plugin.\rFor a full list please consult either the plugin documentation, or the 6.2 SDK documentation\rat https://developers.facebook.com/docs/games/instant-games/sdk/fbinstant6.2\r\rInternally this plugin uses its own Data Manager to handle seamless user data updates and provides\rhandy functions for advertisement displaying, opening share dialogs, logging, leaderboards, purchase API requests,\rloader integration and more.\r\rTo get started with Facebook Instant Games you will need to register on Facebook and create a new Instant\rGame app that has its own unique app ID. Facebook have also provided a dashboard interface for setting up\rvarious features for your game, including leaderboards, ad requests and the payments API. There are lots\rof guides on the Facebook Developers portal to assist with setting these\rvarious systems up: https://developers.facebook.com/docs/games/instant-games/guides\r\rFor more details follow the Quick Start guide here: https://developers.facebook.com/docs/games/instant-games", "kind": "class", "name": "FacebookInstantGamesPlugin", "memberof": "Phaser", "augments": [ "Phaser.Events.EventEmitter" ], "since": "3.13.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "A reference to the Phaser.Game instance.", "name": "game" } ], "scope": "static", "longname": "Phaser.FacebookInstantGamesPlugin", "___id": "T000002R045715", "___s": true }, { "comment": "/**\r\n * A reference to the Phaser.Game instance.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#game\r\n * @type {Phaser.Game}\r\n * @readOnly\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "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.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#game", "scope": "instance", "kind": "member", "___id": "T000002R045719", "___s": true }, { "comment": "/**\r\n * A Data Manager instance.\r\n * It allows you to store, query and retrieve any key/value data you may need to store.\r\n * It's also used internally by the plugin to store FBIG API data.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#data\r\n * @type {Phaser.Data.DataManager}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "A Data Manager instance.\rIt allows you to store, query and retrieve any key/value data you may need to store.\rIt's also used internally by the plugin to store FBIG API data.", "name": "data", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#data", "scope": "instance", "kind": "member", "___id": "T000002R045721", "___s": true }, { "comment": "/**\r\n * Has the Facebook Instant Games API loaded yet?\r\n * This is set automatically during the boot process.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#hasLoaded\r\n * @type {boolean}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 94, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Has the Facebook Instant Games API loaded yet?\rThis is set automatically during the boot process.", "name": "hasLoaded", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#hasLoaded", "scope": "instance", "kind": "member", "___id": "T000002R045723", "___s": true }, { "comment": "/**\r\n * Is the Data Manager currently locked?\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#dataLocked\r\n * @type {boolean}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Is the Data Manager currently locked?", "name": "dataLocked", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#dataLocked", "scope": "instance", "kind": "member", "___id": "T000002R045725", "___s": true }, { "comment": "/**\r\n * A list of the Facebook Instant Games APIs that are available,\r\n * based on the given platform, context and user privacy settings.\r\n * This value is populated automatically during boot.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#supportedAPIs\r\n * @type {string[]}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "A list of the Facebook Instant Games APIs that are available,\rbased on the given platform, context and user privacy settings.\rThis value is populated automatically during boot.", "name": "supportedAPIs", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#supportedAPIs", "scope": "instance", "kind": "member", "___id": "T000002R045727", "___s": true }, { "comment": "/**\r\n * Holds the entry point that the game was launched from.\r\n * This value is populated automatically during boot.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#entryPoint\r\n * @type {string}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 124, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Holds the entry point that the game was launched from.\rThis value is populated automatically during boot.", "name": "entryPoint", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#entryPoint", "scope": "instance", "kind": "member", "___id": "T000002R045729", "___s": true }, { "comment": "/**\r\n * An object that contains any data associated with the entry point that the game was launched from.\r\n * The contents of the object are developer-defined, and can occur from entry points on different platforms.\r\n * This will return null for older mobile clients, as well as when there is no data associated with the particular entry point.\r\n * This value is populated automatically during boot.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#entryPointData\r\n * @type {any}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 134, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "An object that contains any data associated with the entry point that the game was launched from.\rThe contents of the object are developer-defined, and can occur from entry points on different platforms.\rThis will return null for older mobile clients, as well as when there is no data associated with the particular entry point.\rThis value is populated automatically during boot.", "name": "entryPointData", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#entryPointData", "scope": "instance", "kind": "member", "___id": "T000002R045731", "___s": true }, { "comment": "/**\r\n * A unique identifier for the current game context. This represents a specific context\r\n * that the game is being played in (for example, a particular messenger conversation or facebook post).\r\n * The identifier will be null if game is being played in a solo context.\r\n * This value is populated automatically during boot.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#contextID\r\n * @type {string}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 146, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "A unique identifier for the current game context. This represents a specific context\rthat the game is being played in (for example, a particular messenger conversation or facebook post).\rThe identifier will be null if game is being played in a solo context.\rThis value is populated automatically during boot.", "name": "contextID", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#contextID", "scope": "instance", "kind": "member", "___id": "T000002R045733", "___s": true }, { "comment": "/**\r\n * The current context in which your game is running. This can be either `null` or\r\n * one of:\r\n * \r\n * `POST` - The game is running inside of a Facebook post.\r\n * `THREAD` - The game is running inside a Facebook Messenger thread.\r\n * `GROUP` - The game is running inside a Facebook Group.\r\n * `SOLO` - This is the default context, the player is the only participant.\r\n * \r\n * This value is populated automatically during boot.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#contextType\r\n * @type {?string}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 158, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "The current context in which your game is running. This can be either `null` or\rone of:\r\r`POST` - The game is running inside of a Facebook post.\r`THREAD` - The game is running inside a Facebook Messenger thread.\r`GROUP` - The game is running inside a Facebook Group.\r`SOLO` - This is the default context, the player is the only participant.\r\rThis value is populated automatically during boot.", "name": "contextType", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#contextType", "scope": "instance", "kind": "member", "___id": "T000002R045735", "___s": true }, { "comment": "/**\r\n * The current locale.\r\n * See https://origincache.facebook.com/developers/resources/?id=FacebookLocales.xml for a complete list of supported locale values.\r\n * Use this to determine what languages the current game should be localized with.\r\n * This value is populated automatically during boot.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#locale\r\n * @type {?string}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "The current locale.\rSee https://origincache.facebook.com/developers/resources/?id=FacebookLocales.xml for a complete list of supported locale values.\rUse this to determine what languages the current game should be localized with.\rThis value is populated automatically during boot.", "name": "locale", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#locale", "scope": "instance", "kind": "member", "___id": "T000002R045737", "___s": true }, { "comment": "/**\r\n * The platform on which the game is currently running, i.e. `IOS`.\r\n * This value is populated automatically during boot.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#platform\r\n * @type {?string}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "The platform on which the game is currently running, i.e. `IOS`.\rThis value is populated automatically during boot.", "name": "platform", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#platform", "scope": "instance", "kind": "member", "___id": "T000002R045739", "___s": true }, { "comment": "/**\r\n * The string representation of the Facebook Instant Games SDK version being used.\r\n * This value is populated automatically during boot.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#version\r\n * @type {?string}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "The string representation of the Facebook Instant Games SDK version being used.\rThis value is populated automatically during boot.", "name": "version", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#version", "scope": "instance", "kind": "member", "___id": "T000002R045741", "___s": true }, { "comment": "/**\r\n * Holds the id of the player. This is a string based ID, the same as `FBInstant.player.getID()`.\r\n * This value is populated automatically during boot if the API is supported.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#playerID\r\n * @type {?string}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Holds the id of the player. This is a string based ID, the same as `FBInstant.player.getID()`.\rThis value is populated automatically during boot if the API is supported.", "name": "playerID", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#playerID", "scope": "instance", "kind": "member", "___id": "T000002R045743", "___s": true }, { "comment": "/**\r\n * The player's localized display name.\r\n * This value is populated automatically during boot if the API is supported.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#playerName\r\n * @type {?string}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 217, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "The player's localized display name.\rThis value is populated automatically during boot if the API is supported.", "name": "playerName", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#playerName", "scope": "instance", "kind": "member", "___id": "T000002R045745", "___s": true }, { "comment": "/**\r\n * A url to the player's public profile photo. The photo will always be a square, and with dimensions\r\n * of at least 200x200. When rendering it in the game, the exact dimensions should never be assumed to be constant.\r\n * It's recommended to always scale the image to a desired size before rendering.\r\n * This value is populated automatically during boot if the API is supported.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#playerPhotoURL\r\n * @type {?string}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 227, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "A url to the player's public profile photo. The photo will always be a square, and with dimensions\rof at least 200x200. When rendering it in the game, the exact dimensions should never be assumed to be constant.\rIt's recommended to always scale the image to a desired size before rendering.\rThis value is populated automatically during boot if the API is supported.", "name": "playerPhotoURL", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#playerPhotoURL", "scope": "instance", "kind": "member", "___id": "T000002R045747", "___s": true }, { "comment": "/**\r\n * Whether a player can subscribe to the game bot or not.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#playerCanSubscribeBot\r\n * @type {boolean}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 239, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Whether a player can subscribe to the game bot or not.", "name": "playerCanSubscribeBot", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#playerCanSubscribeBot", "scope": "instance", "kind": "member", "___id": "T000002R045749", "___s": true }, { "comment": "/**\r\n * Does the current platform and context allow for use of the payments API?\r\n * Currently this is only available on Facebook.com and Android 6+.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#paymentsReady\r\n * @type {boolean}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 248, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Does the current platform and context allow for use of the payments API?\rCurrently this is only available on Facebook.com and Android 6+.", "name": "paymentsReady", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#paymentsReady", "scope": "instance", "kind": "member", "___id": "T000002R045751", "___s": true }, { "comment": "/**\r\n * The set of products that are registered to the game.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#catalog\r\n * @type {Product[]}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 258, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "The set of products that are registered to the game.", "name": "catalog", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Product", "type": "NameExpression" } ] } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#catalog", "scope": "instance", "kind": "member", "___id": "T000002R045753", "___s": true }, { "comment": "/**\r\n * Contains all of the player's unconsumed purchases.\r\n * The game must fetch the current player's purchases as soon as the client indicates that it is ready to perform payments-related operations,\r\n * i.e. at game start. The game can then process and consume any purchases that are waiting to be consumed.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#purchases\r\n * @type {Purchase[]}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 267, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Contains all of the player's unconsumed purchases.\rThe game must fetch the current player's purchases as soon as the client indicates that it is ready to perform payments-related operations,\ri.e. at game start. The game can then process and consume any purchases that are waiting to be consumed.", "name": "purchases", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Purchase", "type": "NameExpression" } ] } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#purchases", "scope": "instance", "kind": "member", "___id": "T000002R045755", "___s": true }, { "comment": "/**\r\n * Contains all of the leaderboard data, as populated by the `getLeaderboard()` method.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#leaderboards\r\n * @type {Phaser.FacebookInstantGamesLeaderboard[]}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 278, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Contains all of the leaderboard data, as populated by the `getLeaderboard()` method.", "name": "leaderboards", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.FacebookInstantGamesLeaderboard", "type": "NameExpression" } ] } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#leaderboards", "scope": "instance", "kind": "member", "___id": "T000002R045757", "___s": true }, { "comment": "/**\r\n * Contains AdInstance objects, as created by the `preloadAds()` method.\r\n *\r\n * @name Phaser.FacebookInstantGamesPlugin#ads\r\n * @type {AdInstance[]}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 287, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Contains AdInstance objects, as created by the `preloadAds()` method.", "name": "ads", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "AdInstance", "type": "NameExpression" } ] } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#ads", "scope": "instance", "kind": "member", "___id": "T000002R045759", "___s": true }, { "comment": "/**\r\n * Call this method from your `Scene.preload` in order to sync the load progress\r\n * of the Phaser Loader with the Facebook Instant Games loader display, i.e.:\r\n * \r\n * ```javascript\r\n * this.facebook.showLoadProgress(this);\r\n * this.facebook.once('startgame', this.startGame, this);\r\n * ```\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#showLoadProgress\r\n * @since 3.13.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene for which you want to show loader progress for.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Call this method from your `Scene.preload` in order to sync the load progress\rof the Phaser Loader with the Facebook Instant Games loader display, i.e.:\r\r```javascript\rthis.facebook.showLoadProgress(this);\rthis.facebook.once('startgame', this.startGame, this);\r```", "kind": "function", "name": "showLoadProgress", "since": "3.13.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene for which you want to show loader progress for.", "name": "scene" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#showLoadProgress", "scope": "instance", "___id": "T000002R045771", "___s": true }, { "comment": "/**\r\n * This method is called automatically when the game has finished loading,\r\n * if you used the `showLoadProgress` method. If your game doesn't need to\r\n * load any assets, or you're managing the load yourself, then call this\r\n * method directly to start the API running.\r\n * \r\n * When the API has finished starting this plugin will emit a `startgame` event\r\n * which you should listen for.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#gameStarted\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 398, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "This method is called automatically when the game has finished loading,\rif you used the `showLoadProgress` method. If your game doesn't need to\rload any assets, or you're managing the load yourself, then call this\rmethod directly to start the API running.\r\rWhen the API has finished starting this plugin will emit a `startgame` event\rwhich you should listen for.", "kind": "function", "name": "gameStarted", "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#gameStarted", "scope": "instance", "___id": "T000002R045774", "___s": true }, { "comment": "/**\r\n * Checks to see if a given Facebook Instant Games API is available or not.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#checkAPI\r\n * @since 3.13.0\r\n * \r\n * @param {string} api - The API to check for, i.e. `player.getID`.\r\n * \r\n * @return {boolean} `true` if the API is supported, otherwise `false`.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Checks to see if a given Facebook Instant Games API is available or not.", "kind": "function", "name": "checkAPI", "since": "3.13.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The API to check for, i.e. `player.getID`.", "name": "api" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the API is supported, otherwise `false`." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#checkAPI", "scope": "instance", "___id": "T000002R045789", "___s": true }, { "comment": "/**\r\n * Returns the unique identifier for the current game context. This represents a specific context\r\n * that the game is being played in (for example, a particular messenger conversation or facebook post).\r\n * The identifier will be null if game is being played in a solo context.\r\n * \r\n * It is only populated if `contextGetID` is in the list of supported APIs.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#getID\r\n * @since 3.13.0\r\n * \r\n * @return {string} The context ID.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 516, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Returns the unique identifier for the current game context. This represents a specific context\rthat the game is being played in (for example, a particular messenger conversation or facebook post).\rThe identifier will be null if game is being played in a solo context.\r\rIt is only populated if `contextGetID` is in the list of supported APIs.", "kind": "function", "name": "getID", "since": "3.13.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The context ID." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#getID", "scope": "instance", "___id": "T000002R045791", "___s": true }, { "comment": "/**\r\n * Returns the current context in which your game is running. This can be either `null` or one of:\r\n * \r\n * `POST` - The game is running inside of a Facebook post.\r\n * `THREAD` - The game is running inside a Facebook Messenger thread.\r\n * `GROUP` - The game is running inside a Facebook Group.\r\n * `SOLO` - This is the default context, the player is the only participant.\r\n * \r\n * It is only populated if `contextGetType` is in the list of supported APIs.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#getType\r\n * @since 3.13.0\r\n * \r\n * @return {?string} The context type.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 538, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Returns the current context in which your game is running. This can be either `null` or one of:\r\r`POST` - The game is running inside of a Facebook post.\r`THREAD` - The game is running inside a Facebook Messenger thread.\r`GROUP` - The game is running inside a Facebook Group.\r`SOLO` - This is the default context, the player is the only participant.\r\rIt is only populated if `contextGetType` is in the list of supported APIs.", "kind": "function", "name": "getType", "since": "3.13.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "description": "The context type." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#getType", "scope": "instance", "___id": "T000002R045794", "___s": true }, { "comment": "/**\r\n * Returns the current locale.\r\n * See https://origincache.facebook.com/developers/resources/?id=FacebookLocales.xml for a complete list of supported locale values.\r\n * Use this to determine what languages the current game should be localized with.\r\n * It is only populated if `getLocale` is in the list of supported APIs.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#getLocale\r\n * @since 3.13.0\r\n * \r\n * @return {?string} The current locale.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 563, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Returns the current locale.\rSee https://origincache.facebook.com/developers/resources/?id=FacebookLocales.xml for a complete list of supported locale values.\rUse this to determine what languages the current game should be localized with.\rIt is only populated if `getLocale` is in the list of supported APIs.", "kind": "function", "name": "getLocale", "since": "3.13.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "description": "The current locale." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#getLocale", "scope": "instance", "___id": "T000002R045797", "___s": true }, { "comment": "/**\r\n * Returns the platform on which the game is currently running, i.e. `IOS`.\r\n * It is only populated if `getPlatform` is in the list of supported APIs.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#getPlatform\r\n * @since 3.13.0\r\n * \r\n * @return {?string} The current platform.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 584, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Returns the platform on which the game is currently running, i.e. `IOS`.\rIt is only populated if `getPlatform` is in the list of supported APIs.", "kind": "function", "name": "getPlatform", "since": "3.13.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "description": "The current platform." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#getPlatform", "scope": "instance", "___id": "T000002R045800", "___s": true }, { "comment": "/**\r\n * Returns the string representation of the Facebook Instant Games SDK version being used.\r\n * It is only populated if `getSDKVersion` is in the list of supported APIs.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#getSDKVersion\r\n * @since 3.13.0\r\n * \r\n * @return {?string} The sdk version.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 603, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Returns the string representation of the Facebook Instant Games SDK version being used.\rIt is only populated if `getSDKVersion` is in the list of supported APIs.", "kind": "function", "name": "getSDKVersion", "since": "3.13.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "description": "The sdk version." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#getSDKVersion", "scope": "instance", "___id": "T000002R045803", "___s": true }, { "comment": "/**\r\n * Returns the id of the player. This is a string based ID, the same as `FBInstant.player.getID()`.\r\n * It is only populated if `playerGetID` is in the list of supported APIs.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#getPlayerID\r\n * @since 3.13.0\r\n * \r\n * @return {?string} The player ID.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Returns the id of the player. This is a string based ID, the same as `FBInstant.player.getID()`.\rIt is only populated if `playerGetID` is in the list of supported APIs.", "kind": "function", "name": "getPlayerID", "since": "3.13.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "description": "The player ID." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#getPlayerID", "scope": "instance", "___id": "T000002R045806", "___s": true }, { "comment": "/**\r\n * Returns the player's localized display name.\r\n * It is only populated if `playerGetName` is in the list of supported APIs.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#getPlayerName\r\n * @since 3.13.0\r\n * \r\n * @return {?string} The player's localized display name.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 641, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Returns the player's localized display name.\rIt is only populated if `playerGetName` is in the list of supported APIs.", "kind": "function", "name": "getPlayerName", "since": "3.13.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "description": "The player's localized display name." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#getPlayerName", "scope": "instance", "___id": "T000002R045809", "___s": true }, { "comment": "/**\r\n * Returns the url to the player's public profile photo. The photo will always be a square, and with dimensions\r\n * of at least 200x200. When rendering it in the game, the exact dimensions should never be assumed to be constant.\r\n * It's recommended to always scale the image to a desired size before rendering.\r\n * It is only populated if `playerGetPhoto` is in the list of supported APIs.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#getPlayerPhotoURL\r\n * @since 3.13.0\r\n * \r\n * @return {?string} The player's photo url.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 660, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Returns the url to the player's public profile photo. The photo will always be a square, and with dimensions\rof at least 200x200. When rendering it in the game, the exact dimensions should never be assumed to be constant.\rIt's recommended to always scale the image to a desired size before rendering.\rIt is only populated if `playerGetPhoto` is in the list of supported APIs.", "kind": "function", "name": "getPlayerPhotoURL", "since": "3.13.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "description": "The player's photo url." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#getPlayerPhotoURL", "scope": "instance", "___id": "T000002R045812", "___s": true }, { "comment": "/**\r\n * Load the player's photo and store it in the Texture Manager, ready for use in-game.\r\n * \r\n * This method works by using a Scene Loader instance and then asking the Loader to\r\n * retrieve the image.\r\n * \r\n * When complete the plugin will emit a `photocomplete` event, along with the key of the photo.\r\n * \r\n * ```javascript\r\n * this.facebook.loadPlayerPhoto(this, 'player').once('photocomplete', function (key) {\r\n * this.add.image(x, y, 'player');\r\n * }, this);\r\n * ```\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#loadPlayerPhoto\r\n * @since 3.13.0\r\n * \r\n * @param {Phaser.Scene} scene - The Scene that will be responsible for loading this photo.\r\n * @param {string} key - The key to use when storing the photo in the Texture Manager.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 681, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Load the player's photo and store it in the Texture Manager, ready for use in-game.\r\rThis method works by using a Scene Loader instance and then asking the Loader to\rretrieve the image.\r\rWhen complete the plugin will emit a `photocomplete` event, along with the key of the photo.\r\r```javascript\rthis.facebook.loadPlayerPhoto(this, 'player').once('photocomplete', function (key) {\r this.add.image(x, y, 'player');\r}, this);\r```", "kind": "function", "name": "loadPlayerPhoto", "since": "3.13.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene that will be responsible for loading this photo.", "name": "scene" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to use when storing the photo in the Texture Manager.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#loadPlayerPhoto", "scope": "instance", "___id": "T000002R045815", "___s": true }, { "comment": "/**\r\n * Checks if the current player can subscribe to the game bot.\r\n * \r\n * It makes an async call to the API, so the result isn't available immediately.\r\n * \r\n * If they can subscribe, the `playerCanSubscribeBot` property is set to `true`\r\n * and this plugin will emit the `cansubscribebot` event.\r\n * \r\n * If they cannot, i.e. it's not in the list of supported APIs, or the request\r\n * was rejected, it will emit a `cansubscribebotfail` event instead.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#canSubscribeBot\r\n * @since 3.13.0\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 723, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Checks if the current player can subscribe to the game bot.\r\rIt makes an async call to the API, so the result isn't available immediately.\r\rIf they can subscribe, the `playerCanSubscribeBot` property is set to `true`\rand this plugin will emit the `cansubscribebot` event.\r\rIf they cannot, i.e. it's not in the list of supported APIs, or the request\rwas rejected, it will emit a `cansubscribebotfail` event instead.", "kind": "function", "name": "canSubscribeBot", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#canSubscribeBot", "scope": "instance", "___id": "T000002R045817", "___s": true }, { "comment": "/**\r\n * Subscribes the current player to the game bot.\r\n * \r\n * It makes an async call to the API, so the result isn't available immediately.\r\n * \r\n * If they are successfully subscribed this plugin will emit the `subscribebot` event.\r\n * \r\n * If they cannot, i.e. it's not in the list of supported APIs, or the request\r\n * was rejected, it will emit a `subscribebotfail` event instead.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#subscribeBot\r\n * @since 3.13.0\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 764, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Subscribes the current player to the game bot.\r\rIt makes an async call to the API, so the result isn't available immediately.\r\rIf they are successfully subscribed this plugin will emit the `subscribebot` event.\r\rIf they cannot, i.e. it's not in the list of supported APIs, or the request\rwas rejected, it will emit a `subscribebotfail` event instead.", "kind": "function", "name": "subscribeBot", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#subscribeBot", "scope": "instance", "___id": "T000002R045821", "___s": true }, { "comment": "/**\r\n * Gets the associated data from the player based on the given key, or array of keys.\r\n * \r\n * The data is requested in an async call, so the result isn't available immediately.\r\n * \r\n * When the call completes the data is set into this plugins Data Manager and the\r\n * `getdata` event will be emitted.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#getData\r\n * @since 3.13.0\r\n * \r\n * @param {(string|string[])} keys - The key/s of the data to retrieve.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 802, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Gets the associated data from the player based on the given key, or array of keys.\r\rThe data is requested in an async call, so the result isn't available immediately.\r\rWhen the call completes the data is set into this plugins Data Manager and the\r`getdata` event will be emitted.", "kind": "function", "name": "getData", "since": "3.13.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/s of the data to retrieve.", "name": "keys" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#getData", "scope": "instance", "___id": "T000002R045824", "___s": true }, { "comment": "/**\r\n * Set data to be saved to the designated cloud storage of the current player. The game can store up to 1MB of data for each unique player.\r\n * \r\n * The data save is requested in an async call, so the result isn't available immediately.\r\n * \r\n * Data managed via this plugins Data Manager instance is automatically synced with Facebook. However, you can call this\r\n * method directly if you need to replace the data object directly.\r\n * \r\n * When the APIs `setDataAsync` call resolves it will emit the `savedata` event from this plugin. If the call fails for some\r\n * reason it will emit `savedatafail` instead.\r\n * \r\n * The call resolving does not necessarily mean that the input has already been persisted. Rather, it means that the data was valid and\r\n * has been scheduled to be saved. It also guarantees that all values that were set are now available in `getData`.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#saveData\r\n * @since 3.13.0\r\n * \r\n * @param {object} data - An object containing a set of key-value pairs that should be persisted to cloud storage.\r\n * The object must contain only serializable values - any non-serializable values will cause the entire modification to be rejected.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 848, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Set data to be saved to the designated cloud storage of the current player. The game can store up to 1MB of data for each unique player.\r\rThe data save is requested in an async call, so the result isn't available immediately.\r\rData managed via this plugins Data Manager instance is automatically synced with Facebook. However, you can call this\rmethod directly if you need to replace the data object directly.\r\rWhen the APIs `setDataAsync` call resolves it will emit the `savedata` event from this plugin. If the call fails for some\rreason it will emit `savedatafail` instead.\r\rThe call resolving does not necessarily mean that the input has already been persisted. Rather, it means that the data was valid and\rhas been scheduled to be saved. It also guarantees that all values that were set are now available in `getData`.", "kind": "function", "name": "saveData", "since": "3.13.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "An object containing a set of key-value pairs that should be persisted to cloud storage.\rThe object must contain only serializable values - any non-serializable values will cause the entire modification to be rejected.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#saveData", "scope": "instance", "___id": "T000002R045831", "___s": true }, { "comment": "/**\r\n * Immediately flushes any changes to the player data to the designated cloud storage.\r\n * This function is expensive, and should primarily be used for critical changes where persistence needs to be immediate\r\n * and known by the game. Non-critical changes should rely on the platform to persist them in the background.\r\n * NOTE: Calls to player.setDataAsync will be rejected while this function's result is pending.\r\n * \r\n * Data managed via this plugins Data Manager instance is automatically synced with Facebook. However, you can call this\r\n * method directly if you need to flush the data directly.\r\n * \r\n * When the APIs `flushDataAsync` call resolves it will emit the `flushdata` event from this plugin. If the call fails for some\r\n * reason it will emit `flushdatafail` instead.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#flushData\r\n * @since 3.13.0\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 891, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Immediately flushes any changes to the player data to the designated cloud storage.\rThis function is expensive, and should primarily be used for critical changes where persistence needs to be immediate\rand known by the game. Non-critical changes should rely on the platform to persist them in the background.\rNOTE: Calls to player.setDataAsync will be rejected while this function's result is pending.\r\rData managed via this plugins Data Manager instance is automatically synced with Facebook. However, you can call this\rmethod directly if you need to flush the data directly.\r\rWhen the APIs `flushDataAsync` call resolves it will emit the `flushdata` event from this plugin. If the call fails for some\rreason it will emit `flushdatafail` instead.", "kind": "function", "name": "flushData", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#flushData", "scope": "instance", "___id": "T000002R045834", "___s": true }, { "comment": "/**\r\n * Retrieve stats from the designated cloud storage of the current player.\r\n * \r\n * The data is requested in an async call, so the result isn't available immediately.\r\n * \r\n * When the call completes the `getstats` event will be emitted along with the data object returned.\r\n * \r\n * If the call fails, i.e. it's not in the list of supported APIs, or the request was rejected,\r\n * it will emit a `getstatsfail` event instead.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#getStats\r\n * @since 3.13.0\r\n * \r\n * @param {string[]} [keys] - An optional array of unique keys to retrieve stats for. If the function is called without it, it will fetch all stats.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 929, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Retrieve stats from the designated cloud storage of the current player.\r\rThe data is requested in an async call, so the result isn't available immediately.\r\rWhen the call completes the `getstats` event will be emitted along with the data object returned.\r\rIf the call fails, i.e. it's not in the list of supported APIs, or the request was rejected,\rit will emit a `getstatsfail` event instead.", "kind": "function", "name": "getStats", "since": "3.13.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of unique keys to retrieve stats for. If the function is called without it, it will fetch all stats.", "name": "keys" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#getStats", "scope": "instance", "___id": "T000002R045837", "___s": true }, { "comment": "/**\r\n * Save the stats of the current player to the designated cloud storage.\r\n * \r\n * Stats in the Facebook Instant Games API are purely numerical values paired with a string-based key. Only numbers can be saved as stats,\r\n * all other data types will be ignored.\r\n * \r\n * The data is requested in an async call, so the result isn't available immediately.\r\n * \r\n * When the call completes the `savestats` event will be emitted along with the data object returned.\r\n * \r\n * If the call fails, i.e. it's not in the list of supported APIs, or the request was rejected,\r\n * it will emit a `savestatsfail` event instead.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#saveStats\r\n * @since 3.13.0\r\n * \r\n * @param {object} data - An object containing a set of key-value pairs that should be persisted to cloud storage as stats. Note that only numerical values are stored.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 967, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Save the stats of the current player to the designated cloud storage.\r\rStats in the Facebook Instant Games API are purely numerical values paired with a string-based key. Only numbers can be saved as stats,\rall other data types will be ignored.\r\rThe data is requested in an async call, so the result isn't available immediately.\r\rWhen the call completes the `savestats` event will be emitted along with the data object returned.\r\rIf the call fails, i.e. it's not in the list of supported APIs, or the request was rejected,\rit will emit a `savestatsfail` event instead.", "kind": "function", "name": "saveStats", "since": "3.13.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "An object containing a set of key-value pairs that should be persisted to cloud storage as stats. Note that only numerical values are stored.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#saveStats", "scope": "instance", "___id": "T000002R045840", "___s": true }, { "comment": "/**\r\n * Increment the stats of the current player and save them to the designated cloud storage.\r\n * \r\n * Stats in the Facebook Instant Games API are purely numerical values paired with a string-based key. Only numbers can be saved as stats,\r\n * all other data types will be ignored.\r\n * \r\n * The data object provided for this call should contain offsets for how much to modify the stats by:\r\n * \r\n * ```javascript\r\n * this.facebook.incStats({\r\n * level: 1,\r\n * zombiesSlain: 17,\r\n * rank: -1\r\n * });\r\n * ```\r\n * \r\n * The data is requested in an async call, so the result isn't available immediately.\r\n * \r\n * When the call completes the `incstats` event will be emitted along with the data object returned.\r\n * \r\n * If the call fails, i.e. it's not in the list of supported APIs, or the request was rejected,\r\n * it will emit a `incstatsfail` event instead.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#incStats\r\n * @since 3.13.0\r\n * \r\n * @param {object} data - An object containing a set of key-value pairs indicating how much to increment each stat in cloud storage. Note that only numerical values are processed.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1018, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Increment the stats of the current player and save them to the designated cloud storage.\r\rStats in the Facebook Instant Games API are purely numerical values paired with a string-based key. Only numbers can be saved as stats,\rall other data types will be ignored.\r\rThe data object provided for this call should contain offsets for how much to modify the stats by:\r\r```javascript\rthis.facebook.incStats({\r level: 1,\r zombiesSlain: 17,\r rank: -1\r});\r```\r\rThe data is requested in an async call, so the result isn't available immediately.\r\rWhen the call completes the `incstats` event will be emitted along with the data object returned.\r\rIf the call fails, i.e. it's not in the list of supported APIs, or the request was rejected,\rit will emit a `incstatsfail` event instead.", "kind": "function", "name": "incStats", "since": "3.13.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "An object containing a set of key-value pairs indicating how much to increment each stat in cloud storage. Note that only numerical values are processed.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#incStats", "scope": "instance", "___id": "T000002R045846", "___s": true }, { "comment": "/**\r\n * Sets the data associated with the individual gameplay session for the current context.\r\n * \r\n * This function should be called whenever the game would like to update the current session data.\r\n * \r\n * This session data may be used to populate a variety of payloads, such as game play webhooks.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#saveSession\r\n * @since 3.13.0\r\n * \r\n * @param {object} data - An arbitrary data object, which must be less than or equal to 1000 characters when stringified.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Sets the data associated with the individual gameplay session for the current context.\r\rThis function should be called whenever the game would like to update the current session data.\r\rThis session data may be used to populate a variety of payloads, such as game play webhooks.", "kind": "function", "name": "saveSession", "since": "3.13.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "An arbitrary data object, which must be less than or equal to 1000 characters when stringified.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#saveSession", "scope": "instance", "___id": "T000002R045852", "___s": true }, { "comment": "/**\r\n * This invokes a dialog to let the user share specified content, either as a message in Messenger or as a post on the user's timeline.\r\n * \r\n * A blob of data can be attached to the share which every game session launched from the share will be able to access via the `this.entryPointData` property.\r\n * \r\n * This data must be less than or equal to 1000 characters when stringified.\r\n * \r\n * When this method is called you should consider your game paused. Listen out for the `resume` event from this plugin to know when the dialog has been closed.\r\n * \r\n * The user may choose to cancel the share action and close the dialog. The resulting `resume` event will be dispatched regardless if the user actually shared the content or not.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#openShare\r\n * @since 3.13.0\r\n * \r\n * @param {string} text - A text message to be shared.\r\n * @param {string} key - The key of the texture to use as the share image.\r\n * @param {string} [frame] - The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.\r\n * @param {object} [sessionData] - A blob of data to attach to the share.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1114, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "This invokes a dialog to let the user share specified content, either as a message in Messenger or as a post on the user's timeline.\r\rA blob of data can be attached to the share which every game session launched from the share will be able to access via the `this.entryPointData` property.\r\rThis data must be less than or equal to 1000 characters when stringified.\r\rWhen this method is called you should consider your game paused. Listen out for the `resume` event from this plugin to know when the dialog has been closed.\r\rThe user may choose to cancel the share action and close the dialog. The resulting `resume` event will be dispatched regardless if the user actually shared the content or not.", "kind": "function", "name": "openShare", "since": "3.13.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A text message to be shared.", "name": "text" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the texture to use as the share image.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.", "name": "frame" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "A blob of data to attach to the share.", "name": "sessionData" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#openShare", "scope": "instance", "___id": "T000002R045855", "___s": true }, { "comment": "/**\r\n * This invokes a dialog to let the user invite a friend to play this game, either as a message in Messenger or as a post on the user's timeline.\r\n * \r\n * A blob of data can be attached to the share which every game session launched from the share will be able to access via the `this.entryPointData` property.\r\n * \r\n * This data must be less than or equal to 1000 characters when stringified.\r\n * \r\n * When this method is called you should consider your game paused. Listen out for the `resume` event from this plugin to know when the dialog has been closed.\r\n * \r\n * The user may choose to cancel the share action and close the dialog. The resulting `resume` event will be dispatched regardless if the user actually shared the content or not.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#openInvite\r\n * @since 3.13.0\r\n * \r\n * @param {string} text - A text message to be shared.\r\n * @param {string} key - The key of the texture to use as the share image.\r\n * @param {string} [frame] - The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.\r\n * @param {object} [sessionData] - A blob of data to attach to the share.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "This invokes a dialog to let the user invite a friend to play this game, either as a message in Messenger or as a post on the user's timeline.\r\rA blob of data can be attached to the share which every game session launched from the share will be able to access via the `this.entryPointData` property.\r\rThis data must be less than or equal to 1000 characters when stringified.\r\rWhen this method is called you should consider your game paused. Listen out for the `resume` event from this plugin to know when the dialog has been closed.\r\rThe user may choose to cancel the share action and close the dialog. The resulting `resume` event will be dispatched regardless if the user actually shared the content or not.", "kind": "function", "name": "openInvite", "since": "3.13.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A text message to be shared.", "name": "text" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the texture to use as the share image.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.", "name": "frame" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "A blob of data to attach to the share.", "name": "sessionData" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#openInvite", "scope": "instance", "___id": "T000002R045857", "___s": true }, { "comment": "/**\r\n * This invokes a dialog to let the user share specified content, either as a message in Messenger or as a post on the user's timeline.\r\n * \r\n * A blob of data can be attached to the share which every game session launched from the share will be able to access via the `this.entryPointData` property.\r\n * \r\n * This data must be less than or equal to 1000 characters when stringified.\r\n * \r\n * When this method is called you should consider your game paused. Listen out for the `resume` event from this plugin to know when the dialog has been closed.\r\n * \r\n * The user may choose to cancel the share action and close the dialog. The resulting `resume` event will be dispatched regardless if the user actually shared the content or not.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#openRequest\r\n * @since 3.13.0\r\n * \r\n * @param {string} text - A text message to be shared.\r\n * @param {string} key - The key of the texture to use as the share image.\r\n * @param {string} [frame] - The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.\r\n * @param {object} [sessionData] - A blob of data to attach to the share.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "This invokes a dialog to let the user share specified content, either as a message in Messenger or as a post on the user's timeline.\r\rA blob of data can be attached to the share which every game session launched from the share will be able to access via the `this.entryPointData` property.\r\rThis data must be less than or equal to 1000 characters when stringified.\r\rWhen this method is called you should consider your game paused. Listen out for the `resume` event from this plugin to know when the dialog has been closed.\r\rThe user may choose to cancel the share action and close the dialog. The resulting `resume` event will be dispatched regardless if the user actually shared the content or not.", "kind": "function", "name": "openRequest", "since": "3.13.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A text message to be shared.", "name": "text" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the texture to use as the share image.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.", "name": "frame" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "A blob of data to attach to the share.", "name": "sessionData" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#openRequest", "scope": "instance", "___id": "T000002R045859", "___s": true }, { "comment": "/**\r\n * This invokes a dialog to let the user share specified content, either as a message in Messenger or as a post on the user's timeline.\r\n * \r\n * A blob of data can be attached to the share which every game session launched from the share will be able to access via the `this.entryPointData` property.\r\n * \r\n * This data must be less than or equal to 1000 characters when stringified.\r\n * \r\n * When this method is called you should consider your game paused. Listen out for the `resume` event from this plugin to know when the dialog has been closed.\r\n * \r\n * The user may choose to cancel the share action and close the dialog. The resulting `resume` event will be dispatched regardless if the user actually shared the content or not.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#openChallenge\r\n * @since 3.13.0\r\n * \r\n * @param {string} text - A text message to be shared.\r\n * @param {string} key - The key of the texture to use as the share image.\r\n * @param {string} [frame] - The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.\r\n * @param {object} [sessionData] - A blob of data to attach to the share.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1192, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "This invokes a dialog to let the user share specified content, either as a message in Messenger or as a post on the user's timeline.\r\rA blob of data can be attached to the share which every game session launched from the share will be able to access via the `this.entryPointData` property.\r\rThis data must be less than or equal to 1000 characters when stringified.\r\rWhen this method is called you should consider your game paused. Listen out for the `resume` event from this plugin to know when the dialog has been closed.\r\rThe user may choose to cancel the share action and close the dialog. The resulting `resume` event will be dispatched regardless if the user actually shared the content or not.", "kind": "function", "name": "openChallenge", "since": "3.13.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A text message to be shared.", "name": "text" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the texture to use as the share image.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.", "name": "frame" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "A blob of data to attach to the share.", "name": "sessionData" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#openChallenge", "scope": "instance", "___id": "T000002R045861", "___s": true }, { "comment": "/**\r\n * This function determines whether the number of participants in the current game context is between a given minimum and maximum, inclusive.\r\n * If one of the bounds is null only the other bound will be checked against.\r\n * It will always return the original result for the first call made in a context in a given game play session.\r\n * Subsequent calls, regardless of arguments, will return the answer to the original query until a context change occurs and the query result is reset.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#isSizeBetween\r\n * @since 3.13.0\r\n * \r\n * @param {integer} [min] - The minimum bound of the context size query.\r\n * @param {integer} [max] - The maximum bound of the context size query.\r\n * \r\n * @return {object} The Context Size Response object in the format: `{answer: boolean, minSize: number?, maxSize: number?}`.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "This function determines whether the number of participants in the current game context is between a given minimum and maximum, inclusive.\rIf one of the bounds is null only the other bound will be checked against.\rIt will always return the original result for the first call made in a context in a given game play session.\rSubsequent calls, regardless of arguments, will return the answer to the original query until a context change occurs and the query result is reset.", "kind": "function", "name": "isSizeBetween", "since": "3.13.0", "params": [ { "type": { "names": [ "integer" ], "parsedType": { "type": "NameExpression", "name": "integer" } }, "optional": true, "description": "The minimum bound of the context size query.", "name": "min" }, { "type": { "names": [ "integer" ], "parsedType": { "type": "NameExpression", "name": "integer" } }, "optional": true, "description": "The maximum bound of the context size query.", "name": "max" } ], "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The Context Size Response object in the format: `{answer: boolean, minSize: number?, maxSize: number?}`." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#isSizeBetween", "scope": "instance", "___id": "T000002R045873", "___s": true }, { "comment": "/**\r\n * Request a switch into a specific context. If the player does not have permission to enter that context,\r\n * or if the player does not provide permission for the game to enter that context, this will emit a `switchfail` event.\r\n * \r\n * Otherwise, the plugin will emit the `switch` event when the game has switched into the specified context.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#switchContext\r\n * @since 3.13.0\r\n * \r\n * @param {string} contextID - The ID of the desired context.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1293, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Request a switch into a specific context. If the player does not have permission to enter that context,\ror if the player does not provide permission for the game to enter that context, this will emit a `switchfail` event.\r\rOtherwise, the plugin will emit the `switch` event when the game has switched into the specified context.", "kind": "function", "name": "switchContext", "since": "3.13.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The ID of the desired context.", "name": "contextID" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#switchContext", "scope": "instance", "___id": "T000002R045875", "___s": true }, { "comment": "/**\r\n * A filter that may be applied to a Context Choose operation.\r\n * \r\n * 'NEW_CONTEXT_ONLY' - Prefer to only surface contexts the game has not been played in before.\r\n * 'INCLUDE_EXISTING_CHALLENGES' - Include the \"Existing Challenges\" section, which surfaces actively played-in contexts that the player is a part of.\r\n * 'NEW_PLAYERS_ONLY' - In sections containing individuals, prefer people who have not played the game.\r\n * \r\n * @typedef {string} ContextFilter\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "A filter that may be applied to a Context Choose operation.\r\r'NEW_CONTEXT_ONLY' - Prefer to only surface contexts the game has not been played in before.\r'INCLUDE_EXISTING_CHALLENGES' - Include the \"Existing Challenges\" section, which surfaces actively played-in contexts that the player is a part of.\r'NEW_PLAYERS_ONLY' - In sections containing individuals, prefer people who have not played the game.", "kind": "typedef", "name": "ContextFilter", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "longname": "ContextFilter", "scope": "global", "___id": "T000002R045879", "___s": true }, { "comment": "/**\r\n * A configuration object that may be applied to a Context Choose operation.\r\n * \r\n * @typedef {object} ChooseContextConfig\r\n * @property {ContextFilter[]} [filters] - The set of filters to apply to the context suggestions: 'NEW_CONTEXT_ONLY', 'INCLUDE_EXISTING_CHALLENGES' or 'NEW_PLAYERS_ONLY'.\r\n * @property {number} [maxSize] - The maximum number of participants that a suggested context should ideally have.\r\n * @property {number} [minSize] - The minimum number of participants that a suggested context should ideally have.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1342, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "A configuration object that may be applied to a Context Choose operation.", "kind": "typedef", "name": "ChooseContextConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "ContextFilter", "type": "NameExpression" } ] } }, "optional": true, "description": "The set of filters to apply to the context suggestions: 'NEW_CONTEXT_ONLY', 'INCLUDE_EXISTING_CHALLENGES' or 'NEW_PLAYERS_ONLY'.", "name": "filters" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The maximum number of participants that a suggested context should ideally have.", "name": "maxSize" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The minimum number of participants that a suggested context should ideally have.", "name": "minSize" } ], "longname": "ChooseContextConfig", "scope": "global", "___id": "T000002R045880", "___s": true }, { "comment": "/**\r\n * Opens a context selection dialog for the player. If the player selects an available context,\r\n * the client will attempt to switch into that context, and emit the `choose` event if successful.\r\n * Otherwise, if the player exits the menu or the client fails to switch into the new context, the `choosefail` event will be emitted.\r\n * \r\n * @method Phaser.FacebookInstantGamesPlugin#chooseContext\r\n * @since 3.13.0\r\n * \r\n * @param {ChooseContextConfig} [options] - An object specifying conditions on the contexts that should be offered.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1351, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Opens a context selection dialog for the player. If the player selects an available context,\rthe client will attempt to switch into that context, and emit the `choose` event if successful.\rOtherwise, if the player exits the menu or the client fails to switch into the new context, the `choosefail` event will be emitted.", "kind": "function", "name": "chooseContext", "since": "3.13.0", "params": [ { "type": { "names": [ "ChooseContextConfig" ], "parsedType": { "type": "NameExpression", "name": "ChooseContextConfig" } }, "optional": true, "description": "An object specifying conditions on the contexts that should be offered.", "name": "options" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#chooseContext", "scope": "instance", "___id": "T000002R045881", "___s": true }, { "comment": "/**\r\n * Attempts to create or switch into a context between a specified player and the current player.\r\n * This plugin will emit the `create` event once the context switch is completed.\r\n * If the API call fails, such as if the player listed is not a Connected Player of the current player or if the\r\n * player does not provide permission to enter the new context, then the plugin will emit a 'createfail' event.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#createContext\r\n * @since 3.13.0\r\n * \r\n * @param {string} playerID - ID of the player.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1385, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Attempts to create or switch into a context between a specified player and the current player.\rThis plugin will emit the `create` event once the context switch is completed.\rIf the API call fails, such as if the player listed is not a Connected Player of the current player or if the\rplayer does not provide permission to enter the new context, then the plugin will emit a 'createfail' event.", "kind": "function", "name": "createContext", "since": "3.13.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "ID of the player.", "name": "playerID" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#createContext", "scope": "instance", "___id": "T000002R045885", "___s": true }, { "comment": "/**\r\n * Fetches an array of ConnectedPlayer objects containing information about active players\r\n * (people who played the game in the last 90 days) that are connected to the current player.\r\n * \r\n * It makes an async call to the API, so the result isn't available immediately.\r\n * \r\n * If they are successfully subscribed this plugin will emit the `players` event along\r\n * with the player data.\r\n * \r\n * If they cannot, i.e. it's not in the list of supported APIs, or the request\r\n * was rejected, it will emit a `playersfail` event instead.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#getPlayers\r\n * @since 3.13.0\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1420, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Fetches an array of ConnectedPlayer objects containing information about active players\r(people who played the game in the last 90 days) that are connected to the current player.\r\rIt makes an async call to the API, so the result isn't available immediately.\r\rIf they are successfully subscribed this plugin will emit the `players` event along\rwith the player data.\r\rIf they cannot, i.e. it's not in the list of supported APIs, or the request\rwas rejected, it will emit a `playersfail` event instead.", "kind": "function", "name": "getPlayers", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#getPlayers", "scope": "instance", "___id": "T000002R045889", "___s": true }, { "comment": "/**\r\n * Fetches the game's product catalog.\r\n * \r\n * It makes an async call to the API, so the result isn't available immediately.\r\n * \r\n * If they are successfully subscribed this plugin will emit the `getcatalog` event along\r\n * with the catalog data.\r\n * \r\n * If they cannot, i.e. it's not in the list of supported APIs, or the request\r\n * was rejected, it will emit a `getcatalogfail` event instead.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#getCatalog\r\n * @since 3.13.0\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1458, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Fetches the game's product catalog.\r\rIt makes an async call to the API, so the result isn't available immediately.\r\rIf they are successfully subscribed this plugin will emit the `getcatalog` event along\rwith the catalog data.\r\rIf they cannot, i.e. it's not in the list of supported APIs, or the request\rwas rejected, it will emit a `getcatalogfail` event instead.", "kind": "function", "name": "getCatalog", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#getCatalog", "scope": "instance", "___id": "T000002R045892", "___s": true }, { "comment": "/**\r\n * Fetches a single Product from the game's product catalog.\r\n * \r\n * The product catalog must have been populated using `getCatalog` prior to calling this method.\r\n * \r\n * Use this to look-up product details based on a purchase list.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#getProduct\r\n * @since 3.17.0\r\n * \r\n * @param {string} productID - The Product ID of the item to get from the catalog.\r\n * \r\n * @return {?Product} The Product from the catalog, or `null` if it couldn't be found or the catalog isn't populated.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1503, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Fetches a single Product from the game's product catalog.\r\rThe product catalog must have been populated using `getCatalog` prior to calling this method.\r\rUse this to look-up product details based on a purchase list.", "kind": "function", "name": "getProduct", "since": "3.17.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The Product ID of the item to get from the catalog.", "name": "productID" } ], "returns": [ { "type": { "names": [ "Product" ], "parsedType": { "type": "NameExpression", "name": "Product", "nullable": true } }, "nullable": true, "description": "The Product from the catalog, or `null` if it couldn't be found or the catalog isn't populated." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#getProduct", "scope": "instance", "___id": "T000002R045897", "___s": true }, { "comment": "/**\r\n * Begins the purchase flow for a specific product.\r\n * \r\n * It makes an async call to the API, so the result isn't available immediately.\r\n * \r\n * If they are successfully subscribed this plugin will emit the `purchase` event along\r\n * with the purchase data.\r\n * \r\n * If they cannot, i.e. it's not in the list of supported APIs, or the request\r\n * was rejected, it will emit a `purchasefail` event instead.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#purchase\r\n * @since 3.13.0\r\n * \r\n * @param {string} productID - The identifier of the product to purchase.\r\n * @param {string} [developerPayload] - An optional developer-specified payload, to be included in the returned purchase's signed request.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1530, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Begins the purchase flow for a specific product.\r\rIt makes an async call to the API, so the result isn't available immediately.\r\rIf they are successfully subscribed this plugin will emit the `purchase` event along\rwith the purchase data.\r\rIf they cannot, i.e. it's not in the list of supported APIs, or the request\rwas rejected, it will emit a `purchasefail` event instead.", "kind": "function", "name": "purchase", "since": "3.13.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The identifier of the product to purchase.", "name": "productID" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "An optional developer-specified payload, to be included in the returned purchase's signed request.", "name": "developerPayload" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#purchase", "scope": "instance", "___id": "T000002R045900", "___s": true }, { "comment": "/**\r\n * Fetches all of the player's unconsumed purchases. The game must fetch the current player's purchases\r\n * as soon as the client indicates that it is ready to perform payments-related operations,\r\n * i.e. at game start. The game can then process and consume any purchases that are waiting to be consumed.\r\n * \r\n * It makes an async call to the API, so the result isn't available immediately.\r\n * \r\n * If they are successfully subscribed this plugin will emit the `getpurchases` event along\r\n * with the purchase data.\r\n * \r\n * If they cannot, i.e. it's not in the list of supported APIs, or the request\r\n * was rejected, it will emit a `getpurchasesfail` event instead.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#getPurchases\r\n * @since 3.13.0\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Fetches all of the player's unconsumed purchases. The game must fetch the current player's purchases\ras soon as the client indicates that it is ready to perform payments-related operations,\ri.e. at game start. The game can then process and consume any purchases that are waiting to be consumed.\r\rIt makes an async call to the API, so the result isn't available immediately.\r\rIf they are successfully subscribed this plugin will emit the `getpurchases` event along\rwith the purchase data.\r\rIf they cannot, i.e. it's not in the list of supported APIs, or the request\rwas rejected, it will emit a `getpurchasesfail` event instead.", "kind": "function", "name": "getPurchases", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#getPurchases", "scope": "instance", "___id": "T000002R045907", "___s": true }, { "comment": "/**\r\n * Consumes a specific purchase belonging to the current player. Before provisioning a product's effects to the player,\r\n * the game should request the consumption of the purchased product. Once the purchase is successfully consumed,\r\n * the game should immediately provide the player with the effects of their purchase.\r\n * \r\n * It makes an async call to the API, so the result isn't available immediately.\r\n * \r\n * If they are successfully subscribed this plugin will emit the `consumepurchase` event along\r\n * with the purchase data.\r\n * \r\n * If they cannot, i.e. it's not in the list of supported APIs, or the request\r\n * was rejected, it will emit a `consumepurchasefail` event instead.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#consumePurchase\r\n * @since 3.17.0\r\n * \r\n * @param {string} purchaseToken - The purchase token of the purchase that should be consumed.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1626, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Consumes a specific purchase belonging to the current player. Before provisioning a product's effects to the player,\rthe game should request the consumption of the purchased product. Once the purchase is successfully consumed,\rthe game should immediately provide the player with the effects of their purchase.\r\rIt makes an async call to the API, so the result isn't available immediately.\r\rIf they are successfully subscribed this plugin will emit the `consumepurchase` event along\rwith the purchase data.\r\rIf they cannot, i.e. it's not in the list of supported APIs, or the request\rwas rejected, it will emit a `consumepurchasefail` event instead.", "kind": "function", "name": "consumePurchase", "since": "3.17.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The purchase token of the purchase that should be consumed.", "name": "purchaseToken" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#consumePurchase", "scope": "instance", "___id": "T000002R045912", "___s": true }, { "comment": "/**\r\n * Informs Facebook of a custom update that occurred in the game.\r\n * This will temporarily yield control to Facebook and Facebook will decide what to do based on what the update is.\r\n * Once Facebook returns control to the game the plugin will emit an `update` or `updatefail` event.\r\n * \r\n * It makes an async call to the API, so the result isn't available immediately.\r\n * \r\n * The `text` parameter is an update payload with the following structure:\r\n * \r\n * ```\r\n * text: {\r\n * default: 'X just invaded Y\\'s village!',\r\n * localizations: {\r\n * ar_AR: 'X \\u0641\\u0642\\u0637 \\u063A\\u0632\\u062A ' +\r\n * '\\u0642\\u0631\\u064A\\u0629 Y!',\r\n * en_US: 'X just invaded Y\\'s village!',\r\n * es_LA: '\\u00A1X acaba de invadir el pueblo de Y!',\r\n * }\r\n * }\r\n * ```\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#update\r\n * @since 3.13.0\r\n * \r\n * @param {string} cta - The call to action text.\r\n * @param {object} text - The text object.\r\n * @param {string} key - The key of the texture to use as the share image.\r\n * @param {?(string|integer)} frame - The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.\r\n * @param {string} template - The update template key.\r\n * @param {object} updateData - The update data object payload.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1667, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Informs Facebook of a custom update that occurred in the game.\rThis will temporarily yield control to Facebook and Facebook will decide what to do based on what the update is.\rOnce Facebook returns control to the game the plugin will emit an `update` or `updatefail` event.\r\rIt makes an async call to the API, so the result isn't available immediately.\r\rThe `text` parameter is an update payload with the following structure:\r\r```\rtext: {\r default: 'X just invaded Y\\'s village!',\r localizations: {\r ar_AR: 'X \\u0641\\u0642\\u0637 \\u063A\\u0632\\u062A ' +\r '\\u0642\\u0631\\u064A\\u0629 Y!',\r en_US: 'X just invaded Y\\'s village!',\r es_LA: '\\u00A1X acaba de invadir el pueblo de Y!',\r }\r}\r```", "kind": "function", "name": "update", "since": "3.13.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The call to action text.", "name": "cta" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The text object.", "name": "text" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the texture to use as the share image.", "name": "key" }, { "type": { "names": [ "string", "integer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "integer" } ], "nullable": true } }, "nullable": true, "description": "The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.", "name": "frame" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The update template key.", "name": "template" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The update data object payload.", "name": "updateData" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#update", "scope": "instance", "___id": "T000002R045915", "___s": true }, { "comment": "/**\r\n * Informs Facebook of a leaderboard update that occurred in the game.\r\n * This will temporarily yield control to Facebook and Facebook will decide what to do based on what the update is.\r\n * Once Facebook returns control to the game the plugin will emit an `update` or `updatefail` event.\r\n * \r\n * It makes an async call to the API, so the result isn't available immediately.\r\n * \r\n * The `text` parameter is an update payload with the following structure:\r\n * \r\n * ```\r\n * text: {\r\n * default: 'X just invaded Y\\'s village!',\r\n * localizations: {\r\n * ar_AR: 'X \\u0641\\u0642\\u0637 \\u063A\\u0632\\u062A ' +\r\n * '\\u0642\\u0631\\u064A\\u0629 Y!',\r\n * en_US: 'X just invaded Y\\'s village!',\r\n * es_LA: '\\u00A1X acaba de invadir el pueblo de Y!',\r\n * }\r\n * }\r\n * ```\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#updateLeaderboard\r\n * @since 3.13.0\r\n * \r\n * @param {string} cta - The call to action text.\r\n * @param {object} text - The text object.\r\n * @param {string} key - The key of the texture to use as the share image.\r\n * @param {?(string|integer)} frame - The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.\r\n * @param {string} template - The update template key.\r\n * @param {object} updateData - The update data object payload.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1705, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Informs Facebook of a leaderboard update that occurred in the game.\rThis will temporarily yield control to Facebook and Facebook will decide what to do based on what the update is.\rOnce Facebook returns control to the game the plugin will emit an `update` or `updatefail` event.\r\rIt makes an async call to the API, so the result isn't available immediately.\r\rThe `text` parameter is an update payload with the following structure:\r\r```\rtext: {\r default: 'X just invaded Y\\'s village!',\r localizations: {\r ar_AR: 'X \\u0641\\u0642\\u0637 \\u063A\\u0632\\u062A ' +\r '\\u0642\\u0631\\u064A\\u0629 Y!',\r en_US: 'X just invaded Y\\'s village!',\r es_LA: '\\u00A1X acaba de invadir el pueblo de Y!',\r }\r}\r```", "kind": "function", "name": "updateLeaderboard", "since": "3.13.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The call to action text.", "name": "cta" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The text object.", "name": "text" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the texture to use as the share image.", "name": "key" }, { "type": { "names": [ "string", "integer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "integer" } ], "nullable": true } }, "nullable": true, "description": "The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.", "name": "frame" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The update template key.", "name": "template" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The update data object payload.", "name": "updateData" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#updateLeaderboard", "scope": "instance", "___id": "T000002R045917", "___s": true }, { "comment": "/**\r\n * Request that the client switch to a different Instant Game.\r\n * \r\n * It makes an async call to the API, so the result isn't available immediately.\r\n * \r\n * If the game switches successfully this plugin will emit the `switchgame` event and the client will load the new game.\r\n * \r\n * If they cannot, i.e. it's not in the list of supported APIs, or the request\r\n * was rejected, it will emit a `switchgamefail` event instead.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#switchGame\r\n * @since 3.13.0\r\n * \r\n * @param {string} appID - The Application ID of the Instant Game to switch to. The application must be an Instant Game, and must belong to the same business as the current game.\r\n * @param {object} [data] - An optional data payload. This will be set as the entrypoint data for the game being switched to. Must be less than or equal to 1000 characters when stringified.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Request that the client switch to a different Instant Game.\r\rIt makes an async call to the API, so the result isn't available immediately.\r\rIf the game switches successfully this plugin will emit the `switchgame` event and the client will load the new game.\r\rIf they cannot, i.e. it's not in the list of supported APIs, or the request\rwas rejected, it will emit a `switchgamefail` event instead.", "kind": "function", "name": "switchGame", "since": "3.13.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The Application ID of the Instant Game to switch to. The application must be an Instant Game, and must belong to the same business as the current game.", "name": "appID" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "An optional data payload. This will be set as the entrypoint data for the game being switched to. Must be less than or equal to 1000 characters when stringified.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#switchGame", "scope": "instance", "___id": "T000002R045936", "___s": true }, { "comment": "/**\r\n * Prompts the user to create a shortcut to the game if they are eligible to.\r\n * Can only be called once per session.\r\n * \r\n * It makes an async call to the API, so the result isn't available immediately.\r\n * \r\n * If the user choose to create a shortcut this plugin will emit the `shortcutcreated` event.\r\n * \r\n * If they cannot, i.e. it's not in the list of supported APIs, or the request\r\n * was rejected, it will emit a `shortcutcreatedfail` event instead.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#createShortcut\r\n * @since 3.13.0\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1856, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Prompts the user to create a shortcut to the game if they are eligible to.\rCan only be called once per session.\r\rIt makes an async call to the API, so the result isn't available immediately.\r\rIf the user choose to create a shortcut this plugin will emit the `shortcutcreated` event.\r\rIf they cannot, i.e. it's not in the list of supported APIs, or the request\rwas rejected, it will emit a `shortcutcreatedfail` event instead.", "kind": "function", "name": "createShortcut", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#createShortcut", "scope": "instance", "___id": "T000002R045940", "___s": true }, { "comment": "/**\r\n * Quits the game.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#quit\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1894, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Quits the game.", "kind": "function", "name": "quit", "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#quit", "scope": "instance", "___id": "T000002R045943", "___s": true }, { "comment": "/**\r\n * Log an app event with FB Analytics.\r\n * \r\n * See https://developers.facebook.com/docs/javascript/reference/v2.8#app_events for more details about FB Analytics.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#log\r\n * @since 3.13.0\r\n * \r\n * @param {string} name - Name of the event. Must be 2 to 40 characters, and can only contain '_', '-', ' ', and alphanumeric characters.\r\n * @param {number} [value] - An optional numeric value that FB Analytics can calculate a sum with.\r\n * @param {object} [params] - An optional object that can contain up to 25 key-value pairs to be logged with the event. Keys must be 2 to 40 characters, and can only contain '_', '-', ' ', and alphanumeric characters. Values must be less than 100 characters in length.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1905, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Log an app event with FB Analytics.\r\rSee https://developers.facebook.com/docs/javascript/reference/v2.8#app_events for more details about FB Analytics.", "kind": "function", "name": "log", "since": "3.13.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Name of the event. Must be 2 to 40 characters, and can only contain '_', '-', ' ', and alphanumeric characters.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "An optional numeric value that FB Analytics can calculate a sum with.", "name": "value" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "An optional object that can contain up to 25 key-value pairs to be logged with the event. Keys must be 2 to 40 characters, and can only contain '_', '-', ' ', and alphanumeric characters. Values must be less than 100 characters in length.", "name": "params" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#log", "scope": "instance", "___id": "T000002R045945", "___s": true }, { "comment": "/**\r\n * Attempt to create an instance of an interstitial ad.\r\n * \r\n * If the instance is created successfully then the ad is preloaded ready for display in-game via the method `showAd()`.\r\n * \r\n * If the ad loads it will emit the `adloaded` event, passing the AdInstance as the only parameter.\r\n * \r\n * If the ad cannot be displayed because there was no inventory to fill it, it will emit the `adsnofill` event.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#preloadAds\r\n * @since 3.13.0\r\n * \r\n * @param {(string|string[])} placementID - The ad placement ID, or an array of IDs, as created in your Audience Network settings within Facebook.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 1936, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Attempt to create an instance of an interstitial ad.\r\rIf the instance is created successfully then the ad is preloaded ready for display in-game via the method `showAd()`.\r\rIf the ad loads it will emit the `adloaded` event, passing the AdInstance as the only parameter.\r\rIf the ad cannot be displayed because there was no inventory to fill it, it will emit the `adsnofill` event.", "kind": "function", "name": "preloadAds", "since": "3.13.0", "params": [ { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "description": "The ad placement ID, or an array of IDs, as created in your Audience Network settings within Facebook.", "name": "placementID" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#preloadAds", "scope": "instance", "___id": "T000002R045948", "___s": true }, { "comment": "/**\r\n * Attempt to create an instance of an rewarded video ad.\r\n * \r\n * If the instance is created successfully then the ad is preloaded ready for display in-game via the method `showVideo()`.\r\n * \r\n * If the ad loads it will emit the `adloaded` event, passing the AdInstance as the only parameter.\r\n * \r\n * If the ad cannot be displayed because there was no inventory to fill it, it will emit the `adsnofill` event.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#preloadVideoAds\r\n * @since 3.13.0\r\n * \r\n * @param {(string|string[])} placementID - The ad placement ID, or an array of IDs, as created in your Audience Network settings within Facebook.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 2022, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Attempt to create an instance of an rewarded video ad.\r\rIf the instance is created successfully then the ad is preloaded ready for display in-game via the method `showVideo()`.\r\rIf the ad loads it will emit the `adloaded` event, passing the AdInstance as the only parameter.\r\rIf the ad cannot be displayed because there was no inventory to fill it, it will emit the `adsnofill` event.", "kind": "function", "name": "preloadVideoAds", "since": "3.13.0", "params": [ { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "description": "The ad placement ID, or an array of IDs, as created in your Audience Network settings within Facebook.", "name": "placementID" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#preloadVideoAds", "scope": "instance", "___id": "T000002R045960", "___s": true }, { "comment": "/**\r\n * Displays a previously loaded interstitial ad.\r\n * \r\n * If the ad is successfully displayed this plugin will emit the `adfinished` event, with the AdInstance object as its parameter.\r\n * \r\n * If the ad cannot be displayed, it will emit the `adsnotloaded` event.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#showAd\r\n * @since 3.13.0\r\n * \r\n * @param {string} placementID - The ad placement ID to display.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 2108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Displays a previously loaded interstitial ad.\r\rIf the ad is successfully displayed this plugin will emit the `adfinished` event, with the AdInstance object as its parameter.\r\rIf the ad cannot be displayed, it will emit the `adsnotloaded` event.", "kind": "function", "name": "showAd", "since": "3.13.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The ad placement ID to display.", "name": "placementID" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#showAd", "scope": "instance", "___id": "T000002R045972", "___s": true }, { "comment": "/**\r\n * Displays a previously loaded interstitial video ad.\r\n * \r\n * If the ad is successfully displayed this plugin will emit the `adfinished` event, with the AdInstance object as its parameter.\r\n * \r\n * If the ad cannot be displayed, it will emit the `adsnotloaded` event.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#showVideo\r\n * @since 3.13.0\r\n * \r\n * @param {string} placementID - The ad placement ID to display.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 2159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Displays a previously loaded interstitial video ad.\r\rIf the ad is successfully displayed this plugin will emit the `adfinished` event, with the AdInstance object as its parameter.\r\rIf the ad cannot be displayed, it will emit the `adsnotloaded` event.", "kind": "function", "name": "showVideo", "since": "3.13.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The ad placement ID to display.", "name": "placementID" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#showVideo", "scope": "instance", "___id": "T000002R045978", "___s": true }, { "comment": "/**\r\n * Attempts to match the current player with other users looking for people to play with.\r\n * If successful, a new Messenger group thread will be created containing the matched players and the player will\r\n * be context switched to that thread. This plugin will also dispatch the `matchplayer` event, containing the new context ID and Type.\r\n * \r\n * The default minimum and maximum number of players in one matched thread are 2 and 20 respectively,\r\n * depending on how many players are trying to get matched around the same time.\r\n * \r\n * The values can be changed in `fbapp-config.json`. See the Bundle Config documentation for documentation about `fbapp-config.json`.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#matchPlayer\r\n * @since 3.13.0\r\n * \r\n * @param {string} [matchTag] - Optional extra information about the player used to group them with similar players. Players will only be grouped with other players with exactly the same tag. The tag must only include letters, numbers, and underscores and be 100 characters or less in length.\r\n * @param {boolean} [switchImmediately=false] - Optional extra parameter that specifies whether the player should be immediately switched to the new context when a match is found. By default this will be false which will mean the player needs explicitly press play after being matched to switch to the new context.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 2210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Attempts to match the current player with other users looking for people to play with.\rIf successful, a new Messenger group thread will be created containing the matched players and the player will\rbe context switched to that thread. This plugin will also dispatch the `matchplayer` event, containing the new context ID and Type.\r\rThe default minimum and maximum number of players in one matched thread are 2 and 20 respectively,\rdepending on how many players are trying to get matched around the same time.\r\rThe values can be changed in `fbapp-config.json`. See the Bundle Config documentation for documentation about `fbapp-config.json`.", "kind": "function", "name": "matchPlayer", "since": "3.13.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional extra information about the player used to group them with similar players. Players will only be grouped with other players with exactly the same tag. The tag must only include letters, numbers, and underscores and be 100 characters or less in length.", "name": "matchTag" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Optional extra parameter that specifies whether the player should be immediately switched to the new context when a match is found. By default this will be false which will mean the player needs explicitly press play after being matched to switch to the new context.", "name": "switchImmediately" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#matchPlayer", "scope": "instance", "___id": "T000002R045984", "___s": true }, { "comment": "/**\r\n * Fetch a specific leaderboard belonging to this Instant Game.\r\n * \r\n * The data is requested in an async call, so the result isn't available immediately.\r\n * \r\n * When the call completes the `getleaderboard` event will be emitted along with a Leaderboard object instance.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#getLeaderboard\r\n * @since 3.13.0\r\n * \r\n * @param {string} name - The name of the leaderboard. Each leaderboard for an Instant Game must have its own distinct name.\r\n * \r\n * @return {this} This Facebook Instant Games Plugin instance.\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 2251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Fetch a specific leaderboard belonging to this Instant Game.\r\rThe data is requested in an async call, so the result isn't available immediately.\r\rWhen the call completes the `getleaderboard` event will be emitted along with a Leaderboard object instance.", "kind": "function", "name": "getLeaderboard", "since": "3.13.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the leaderboard. Each leaderboard for an Instant Game must have its own distinct name.", "name": "name" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Facebook Instant Games Plugin instance." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#getLeaderboard", "scope": "instance", "___id": "T000002R045989", "___s": true }, { "comment": "/**\r\n * Quits the Facebook API and then destroys this plugin.\r\n *\r\n * @method Phaser.FacebookInstantGamesPlugin#destroy\r\n * @since 3.13.0\r\n */", "meta": { "filename": "FacebookInstantGamesPlugin.js", "lineno": 2290, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Quits the Facebook API and then destroys this plugin.", "kind": "function", "name": "destroy", "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "longname": "Phaser.FacebookInstantGamesPlugin#destroy", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#destroy", "___id": "T000002R045994", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * This class represents one single Leaderboard that belongs to a Facebook Instant Game.\r\n * \r\n * You do not need to instantiate this class directly, it will be created when you use the\r\n * `getLeaderboard()` method of the main plugin.\r\n *\r\n * @class FacebookInstantGamesLeaderboard\r\n * @memberOf Phaser\r\n * @constructor\r\n * @extends Phaser.Events.EventEmitter\r\n * @since 3.13.0\r\n * \r\n * @param {Phaser.FacebookInstantGamesPlugin} plugin - A reference to the Facebook Instant Games Plugin.\r\n * @param {any} data - An Instant Game leaderboard instance.\r\n */", "meta": { "filename": "Leaderboard.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "classdesc": "This class represents one single Leaderboard that belongs to a Facebook Instant Game.\r\rYou do not need to instantiate this class directly, it will be created when you use the\r`getLeaderboard()` method of the main plugin.", "kind": "class", "name": "FacebookInstantGamesLeaderboard", "memberof": "Phaser", "augments": [ "Phaser.Events.EventEmitter" ], "since": "3.13.0", "params": [ { "type": { "names": [ "Phaser.FacebookInstantGamesPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FacebookInstantGamesPlugin" } }, "description": "A reference to the Facebook Instant Games Plugin.", "name": "plugin" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "An Instant Game leaderboard instance.", "name": "data" } ], "scope": "static", "longname": "Phaser.FacebookInstantGamesLeaderboard", "___id": "T000002R046005", "___s": true }, { "comment": "/**\r\n * A reference to the Facebook Instant Games Plugin.\r\n *\r\n * @name Phaser.FacebookInstantGamesLeaderboard#plugin\r\n * @type {Phaser.FacebookInstantGamesPlugin}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Leaderboard.js", "lineno": 37, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "A reference to the Facebook Instant Games Plugin.", "name": "plugin", "type": { "names": [ "Phaser.FacebookInstantGamesPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FacebookInstantGamesPlugin" } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesLeaderboard", "longname": "Phaser.FacebookInstantGamesLeaderboard#plugin", "scope": "instance", "kind": "member", "___id": "T000002R046009", "___s": true }, { "comment": "/**\r\n * An Instant Game leaderboard instance.\r\n *\r\n * @name Phaser.FacebookInstantGamesLeaderboard#ref\r\n * @type {any}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Leaderboard.js", "lineno": 46, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "An Instant Game leaderboard instance.", "name": "ref", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesLeaderboard", "longname": "Phaser.FacebookInstantGamesLeaderboard#ref", "scope": "instance", "kind": "member", "___id": "T000002R046011", "___s": true }, { "comment": "/**\r\n * The name of the leaderboard.\r\n *\r\n * @name Phaser.FacebookInstantGamesLeaderboard#name\r\n * @type {string}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Leaderboard.js", "lineno": 55, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "The name of the leaderboard.", "name": "name", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesLeaderboard", "longname": "Phaser.FacebookInstantGamesLeaderboard#name", "scope": "instance", "kind": "member", "___id": "T000002R046013", "___s": true }, { "comment": "/**\r\n * The ID of the context that the leaderboard is associated with, or null if the leaderboard is not tied to a particular context.\r\n *\r\n * @name Phaser.FacebookInstantGamesLeaderboard#contextID\r\n * @type {string}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Leaderboard.js", "lineno": 64, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "The ID of the context that the leaderboard is associated with, or null if the leaderboard is not tied to a particular context.", "name": "contextID", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesLeaderboard", "longname": "Phaser.FacebookInstantGamesLeaderboard#contextID", "scope": "instance", "kind": "member", "___id": "T000002R046015", "___s": true }, { "comment": "/**\r\n * The total number of player entries in the leaderboard.\r\n * This value defaults to zero. Populate it via the `getEntryCount()` method.\r\n *\r\n * @name Phaser.FacebookInstantGamesLeaderboard#entryCount\r\n * @type {integer}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Leaderboard.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "The total number of player entries in the leaderboard.\rThis value defaults to zero. Populate it via the `getEntryCount()` method.", "name": "entryCount", "type": { "names": [ "integer" ], "parsedType": { "type": "NameExpression", "name": "integer" } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesLeaderboard", "longname": "Phaser.FacebookInstantGamesLeaderboard#entryCount", "scope": "instance", "kind": "member", "___id": "T000002R046017", "___s": true }, { "comment": "/**\r\n * The players score object.\r\n * This value defaults to `null`. Populate it via the `getPlayerScore()` method.\r\n *\r\n * @name Phaser.FacebookInstantGamesLeaderboard#playerScore\r\n * @type {LeaderboardScore}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Leaderboard.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "The players score object.\rThis value defaults to `null`. Populate it via the `getPlayerScore()` method.", "name": "playerScore", "type": { "names": [ "LeaderboardScore" ], "parsedType": { "type": "NameExpression", "name": "LeaderboardScore" } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesLeaderboard", "longname": "Phaser.FacebookInstantGamesLeaderboard#playerScore", "scope": "instance", "kind": "member", "___id": "T000002R046019", "___s": true }, { "comment": "/**\r\n * The scores in the Leaderboard from the currently requested range.\r\n * This value defaults to an empty array. Populate it via the `getScores()` method.\r\n * The contents of this array are reset each time `getScores()` is called.\r\n *\r\n * @name Phaser.FacebookInstantGamesLeaderboard#scores\r\n * @type {LeaderboardScore[]}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Leaderboard.js", "lineno": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "The scores in the Leaderboard from the currently requested range.\rThis value defaults to an empty array. Populate it via the `getScores()` method.\rThe contents of this array are reset each time `getScores()` is called.", "name": "scores", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "LeaderboardScore", "type": "NameExpression" } ] } }, "since": "3.13.0", "memberof": "Phaser.FacebookInstantGamesLeaderboard", "longname": "Phaser.FacebookInstantGamesLeaderboard#scores", "scope": "instance", "kind": "member", "___id": "T000002R046021", "___s": true }, { "comment": "/**\r\n * Fetches the total number of player entries in the leaderboard.\r\n * \r\n * The data is requested in an async call, so the result isn't available immediately.\r\n * \r\n * When the call completes this Leaderboard will emit the `getentrycount` event along with the count and name of the Leaderboard.\r\n *\r\n * @method Phaser.FacebookInstantGamesLeaderboard#getEntryCount\r\n * @since 3.13.0\r\n * \r\n * @return {this} This Leaderboard instance.\r\n */", "meta": { "filename": "Leaderboard.js", "lineno": 107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Fetches the total number of player entries in the leaderboard.\r\rThe data is requested in an async call, so the result isn't available immediately.\r\rWhen the call completes this Leaderboard will emit the `getentrycount` event along with the count and name of the Leaderboard.", "kind": "function", "name": "getEntryCount", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Leaderboard instance." } ], "memberof": "Phaser.FacebookInstantGamesLeaderboard", "longname": "Phaser.FacebookInstantGamesLeaderboard#getEntryCount", "scope": "instance", "___id": "T000002R046023", "___s": true }, { "comment": "/**\r\n * Updates the player's score. If the player has an existing score, the old score will only be replaced if the new score is better than it.\r\n * NOTE: If the leaderboard is associated with a specific context, the game must be in that context to set a score for the player.\r\n * \r\n * The data is requested in an async call, so the result isn't available immediately.\r\n * \r\n * When the call completes this Leaderboard will emit the `setscore` event along with the LeaderboardScore object and the name of the Leaderboard.\r\n * \r\n * If the save fails the event will send `null` as the score value.\r\n *\r\n * @method Phaser.FacebookInstantGamesLeaderboard#setScore\r\n * @since 3.13.0\r\n * \r\n * @param {integer} score - The new score for the player. Must be a 64-bit integer number.\r\n * @param {(string|any)} [data] - Metadata to associate with the stored score. Must be less than 2KB in size. If an object is given it will be passed to `JSON.stringify`.\r\n * \r\n * @return {this} This Leaderboard instance.\r\n */", "meta": { "filename": "Leaderboard.js", "lineno": 137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Updates the player's score. If the player has an existing score, the old score will only be replaced if the new score is better than it.\rNOTE: If the leaderboard is associated with a specific context, the game must be in that context to set a score for the player.\r\rThe data is requested in an async call, so the result isn't available immediately.\r\rWhen the call completes this Leaderboard will emit the `setscore` event along with the LeaderboardScore object and the name of the Leaderboard.\r\rIf the save fails the event will send `null` as the score value.", "kind": "function", "name": "setScore", "since": "3.13.0", "params": [ { "type": { "names": [ "integer" ], "parsedType": { "type": "NameExpression", "name": "integer" } }, "description": "The new score for the player. Must be a 64-bit integer number.", "name": "score" }, { "type": { "names": [ "string", "any" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "any" } ] } }, "optional": true, "description": "Metadata to associate with the stored score. Must be less than 2KB in size. If an object is given it will be passed to `JSON.stringify`.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Leaderboard instance." } ], "memberof": "Phaser.FacebookInstantGamesLeaderboard", "longname": "Phaser.FacebookInstantGamesLeaderboard#setScore", "scope": "instance", "___id": "T000002R046027", "___s": true }, { "comment": "/**\r\n * Gets the players leaderboard entry and stores it in the `playerScore` property.\r\n * \r\n * The data is requested in an async call, so the result isn't available immediately.\r\n * \r\n * When the call completes this Leaderboard will emit the `getplayerscore` event along with the score and the name of the Leaderboard.\r\n * \r\n * If the player has not yet saved a score, the event will send `null` as the score value, and `playerScore` will be set to `null` as well.\r\n *\r\n * @method Phaser.FacebookInstantGamesLeaderboard#getPlayerScore\r\n * @since 3.13.0\r\n * \r\n * @return {this} This Leaderboard instance.\r\n */", "meta": { "filename": "Leaderboard.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Gets the players leaderboard entry and stores it in the `playerScore` property.\r\rThe data is requested in an async call, so the result isn't available immediately.\r\rWhen the call completes this Leaderboard will emit the `getplayerscore` event along with the score and the name of the Leaderboard.\r\rIf the player has not yet saved a score, the event will send `null` as the score value, and `playerScore` will be set to `null` as well.", "kind": "function", "name": "getPlayerScore", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Leaderboard instance." } ], "memberof": "Phaser.FacebookInstantGamesLeaderboard", "longname": "Phaser.FacebookInstantGamesLeaderboard#getPlayerScore", "scope": "instance", "___id": "T000002R046034", "___s": true }, { "comment": "/**\r\n * Retrieves a set of leaderboard entries, ordered by score ranking in the leaderboard.\r\n * \r\n * The data is requested in an async call, so the result isn't available immediately.\r\n * \r\n * When the call completes this Leaderboard will emit the `getscores` event along with an array of LeaderboardScore entries and the name of the Leaderboard.\r\n *\r\n * @method Phaser.FacebookInstantGamesLeaderboard#getScores\r\n * @since 3.13.0\r\n * \r\n * @param {integer} [count=10] - The number of entries to attempt to fetch from the leaderboard. Currently, up to a maximum of 100 entries may be fetched per query.\r\n * @param {integer} [offset=0] - The offset from the top of the leaderboard that entries will be fetched from.\r\n * \r\n * @return {this} This Leaderboard instance.\r\n */", "meta": { "filename": "Leaderboard.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Retrieves a set of leaderboard entries, ordered by score ranking in the leaderboard.\r\rThe data is requested in an async call, so the result isn't available immediately.\r\rWhen the call completes this Leaderboard will emit the `getscores` event along with an array of LeaderboardScore entries and the name of the Leaderboard.", "kind": "function", "name": "getScores", "since": "3.13.0", "params": [ { "type": { "names": [ "integer" ], "parsedType": { "type": "NameExpression", "name": "integer" } }, "optional": true, "defaultvalue": 10, "description": "The number of entries to attempt to fetch from the leaderboard. Currently, up to a maximum of 100 entries may be fetched per query.", "name": "count" }, { "type": { "names": [ "integer" ], "parsedType": { "type": "NameExpression", "name": "integer" } }, "optional": true, "defaultvalue": 0, "description": "The offset from the top of the leaderboard that entries will be fetched from.", "name": "offset" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Leaderboard instance." } ], "memberof": "Phaser.FacebookInstantGamesLeaderboard", "longname": "Phaser.FacebookInstantGamesLeaderboard#getScores", "scope": "instance", "___id": "T000002R046039", "___s": true }, { "comment": "/**\r\n * Retrieves a set of leaderboard entries, based on the current player's connected players (including the current player), ordered by local rank within the set of connected players.\r\n * \r\n * The data is requested in an async call, so the result isn't available immediately.\r\n * \r\n * When the call completes this Leaderboard will emit the `getconnectedscores` event along with an array of LeaderboardScore entries and the name of the Leaderboard.\r\n *\r\n * @method Phaser.FacebookInstantGamesLeaderboard#getConnectedScores\r\n * @since 3.16.0\r\n * \r\n * @return {this} This Leaderboard instance.\r\n */", "meta": { "filename": "Leaderboard.js", "lineno": 271, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "description": "Retrieves a set of leaderboard entries, based on the current player's connected players (including the current player), ordered by local rank within the set of connected players.\r\rThe data is requested in an async call, so the result isn't available immediately.\r\rWhen the call completes this Leaderboard will emit the `getconnectedscores` event along with an array of LeaderboardScore entries and the name of the Leaderboard.", "kind": "function", "name": "getConnectedScores", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Leaderboard instance." } ], "memberof": "Phaser.FacebookInstantGamesLeaderboard", "longname": "Phaser.FacebookInstantGamesLeaderboard#getConnectedScores", "scope": "instance", "___id": "T000002R046045", "___s": true }, { "comment": "/**\r\n * @typedef {object} LeaderboardScore\r\n *\r\n * @property {integer} score - An integer score value.\r\n * @property {string} scoreFormatted - The score value, formatted with the score format associated with the leaderboard.\r\n * @property {integer} timestamp - The Unix timestamp of when the leaderboard entry was last updated.\r\n * @property {integer} rank - The entry's leaderboard ranking.\r\n * @property {string} data - The developer-specified payload associated with the score, or null if one was not set.\r\n * @property {string} playerName - The player's localized display name.\r\n * @property {string} playerPhotoURL - A url to the player's public profile photo.\r\n * @property {string} playerID - The game's unique identifier for the player.\r\n */", "meta": { "filename": "LeaderboardScore.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "kind": "typedef", "name": "LeaderboardScore", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "integer" ], "parsedType": { "type": "NameExpression", "name": "integer" } }, "description": "An integer score value.", "name": "score" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The score value, formatted with the score format associated with the leaderboard.", "name": "scoreFormatted" }, { "type": { "names": [ "integer" ], "parsedType": { "type": "NameExpression", "name": "integer" } }, "description": "The Unix timestamp of when the leaderboard entry was last updated.", "name": "timestamp" }, { "type": { "names": [ "integer" ], "parsedType": { "type": "NameExpression", "name": "integer" } }, "description": "The entry's leaderboard ranking.", "name": "rank" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The developer-specified payload associated with the score, or null if one was not set.", "name": "data" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The player's localized display name.", "name": "playerName" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A url to the player's public profile photo.", "name": "playerPhotoURL" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The game's unique identifier for the player.", "name": "playerID" } ], "longname": "LeaderboardScore", "scope": "global", "___id": "T000002R046050", "___s": true }, { "comment": "/**\r\n * @typedef {object} Product\r\n *\r\n * @property {string} [title] - The title of the product.\r\n * @property {string} [productID] - The product's game-specified identifier.\r\n * @property {string} [description] - The product description.\r\n * @property {string} [imageURI] - A link to the product's associated image.\r\n * @property {string} [price] - The price of the product.\r\n * @property {string} [priceCurrencyCode] - The currency code for the product.\r\n */", "meta": { "filename": "Product.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "kind": "typedef", "name": "Product", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The title of the product.", "name": "title" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The product's game-specified identifier.", "name": "productID" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The product description.", "name": "description" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "A link to the product's associated image.", "name": "imageURI" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The price of the product.", "name": "price" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The currency code for the product.", "name": "priceCurrencyCode" } ], "longname": "Product", "scope": "global", "___id": "T000002R046062", "___s": true }, { "comment": "/**\r\n * @typedef {object} Purchase\r\n *\r\n * @property {string} [developerPayload] - A developer-specified string, provided during the purchase of the product.\r\n * @property {string} [paymentID] - The identifier for the purchase transaction.\r\n * @property {string} [productID] - The product's game-specified identifier.\r\n * @property {string} [purchaseTime] - Unix timestamp of when the purchase occurred.\r\n * @property {string} [purchaseToken] - A token representing the purchase that may be used to consume the purchase.\r\n * @property {string} [signedRequest] - Server-signed encoding of the purchase request.\r\n */", "meta": { "filename": "Purchase.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\plugins\\fbinstant\\src", "code": {} }, "kind": "typedef", "name": "Purchase", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "A developer-specified string, provided during the purchase of the product.", "name": "developerPayload" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The identifier for the purchase transaction.", "name": "paymentID" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The product's game-specified identifier.", "name": "productID" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Unix timestamp of when the purchase occurred.", "name": "purchaseTime" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "A token representing the purchase that may be used to consume the purchase.", "name": "purchaseToken" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Server-signed encoding of the purchase request.", "name": "signedRequest" } ], "longname": "Purchase", "scope": "global", "___id": "T000002R046072", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Animations.AnimationManager#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R046082", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Animations.AnimationManager#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Animations.AnimationManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R046083", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Animations.AnimationManager#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Animations.AnimationManager", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R046084", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Animations.AnimationManager#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Animations.AnimationManager", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R046085", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Animations.AnimationManager#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Animations.AnimationManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R046086", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Animations.AnimationManager#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Animations.AnimationManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R046087", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Animations.AnimationManager#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Animations.AnimationManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R046088", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Animations.AnimationManager#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Animations.AnimationManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R046089", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Animations.AnimationManager#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Animations.AnimationManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R046090", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Animations.AnimationManager#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Animations.AnimationManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R046091", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Animations.AnimationManager#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Animations.AnimationManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R046092", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Cameras.Scene2D.BaseCamera#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R046093", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Cameras.Scene2D.BaseCamera#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Cameras.Scene2D.BaseCamera", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R046094", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Cameras.Scene2D.BaseCamera#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R046095", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Cameras.Scene2D.BaseCamera#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R046096", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Cameras.Scene2D.BaseCamera#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R046097", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Cameras.Scene2D.BaseCamera#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R046098", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Cameras.Scene2D.BaseCamera#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R046099", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Cameras.Scene2D.BaseCamera#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R046100", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Cameras.Scene2D.BaseCamera#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R046101", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Cameras.Scene2D.BaseCamera#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R046102", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Cameras.Scene2D.BaseCamera#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R046103", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.Cameras.Scene2D.BaseCamera#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "___id": "T000002R046109", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.Cameras.Scene2D.BaseCamera#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "___id": "T000002R046110", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.Cameras.Scene2D.BaseCamera#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "___id": "T000002R046111", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.Cameras.Scene2D.BaseCamera#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "___id": "T000002R046112", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.Cameras.Scene2D.BaseCamera#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "___id": "T000002R046113", "___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": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "scene", "longname": "Phaser.Cameras.Scene2D.Camera#scene", "kind": "member", "description": "A reference to the Scene this camera belongs to.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#scene", "inherited": true, "___id": "T000002R046115", "___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": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "sceneManager", "longname": "Phaser.Cameras.Scene2D.Camera#sceneManager", "kind": "member", "description": "A reference to the Game Scene Manager.", "type": { "names": [ "Phaser.Scenes.SceneManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.SceneManager" } }, "since": "3.12.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#sceneManager", "inherited": true, "___id": "T000002R046116", "___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": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "scaleManager", "longname": "Phaser.Cameras.Scene2D.Camera#scaleManager", "kind": "member", "description": "A reference to the Game Scale Manager.", "type": { "names": [ "Phaser.Scale.ScaleManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.ScaleManager" } }, "since": "3.16.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#scaleManager", "inherited": true, "___id": "T000002R046117", "___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": 106, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "cameraManager", "longname": "Phaser.Cameras.Scene2D.Camera#cameraManager", "kind": "member", "description": "A reference to the Scene's Camera Manager to which this Camera belongs.", "type": { "names": [ "Phaser.Cameras.Scene2D.CameraManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.CameraManager" } }, "since": "3.17.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#cameraManager", "inherited": true, "___id": "T000002R046118", "___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": 115, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "id", "longname": "Phaser.Cameras.Scene2D.Camera#id", "kind": "member", "description": "The Camera ID. Assigned by the Camera Manager and used to handle camera exclusion.\rThis value is a bitmask.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#id", "inherited": true, "___id": "T000002R046119", "___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": 126, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "name", "longname": "Phaser.Cameras.Scene2D.Camera#name", "kind": "member", "description": "The name of the Camera. This is left empty for your own use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#name", "inherited": true, "___id": "T000002R046120", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "roundPixels", "longname": "Phaser.Cameras.Scene2D.Camera#roundPixels", "kind": "member", "description": "Should this camera round its pixel values to integers?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#roundPixels", "inherited": true, "___id": "T000002R046121", "___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": 146, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "visible", "longname": "Phaser.Cameras.Scene2D.Camera#visible", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.10.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#visible", "inherited": true, "___id": "T000002R046122", "___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": 158, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "useBounds", "longname": "Phaser.Cameras.Scene2D.Camera#useBounds", "kind": "member", "description": "Is this Camera using a bounds to restrict scrolling movement?\r\rSet this property along with the bounds via `Camera.setBounds`.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#useBounds", "inherited": true, "___id": "T000002R046123", "___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": 170, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "worldView", "longname": "Phaser.Cameras.Scene2D.Camera#worldView", "kind": "member", "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.", "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "readonly": true, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#worldView", "inherited": true, "___id": "T000002R046124", "___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 the `postRenderCamera` method of the renderer.\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": 183, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "dirty", "longname": "Phaser.Cameras.Scene2D.Camera#dirty", "kind": "member", "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 the `postRenderCamera` method of the renderer.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#dirty", "inherited": true, "___id": "T000002R046125", "___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": 358, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "transparent", "longname": "Phaser.Cameras.Scene2D.Camera#transparent", "kind": "member", "description": "Does this Camera have a transparent background?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#transparent", "inherited": true, "___id": "T000002R046137", "___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": 368, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "backgroundColor", "longname": "Phaser.Cameras.Scene2D.Camera#backgroundColor", "kind": "member", "description": "The background color of this Camera. Only used if `transparent` is `false`.", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#backgroundColor", "inherited": true, "___id": "T000002R046138", "___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": 377, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "alpha", "longname": "Phaser.Cameras.Scene2D.Camera#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#alpha", "inherited": true, "___id": "T000002R046139", "___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": 388, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "disableCull", "longname": "Phaser.Cameras.Scene2D.Camera#disableCull", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#disableCull", "inherited": true, "___id": "T000002R046140", "___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": 410, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "midPoint", "longname": "Phaser.Cameras.Scene2D.Camera#midPoint", "kind": "member", "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.", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "readonly": true, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#midPoint", "inherited": true, "___id": "T000002R046142", "___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": 425, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "originX", "longname": "Phaser.Cameras.Scene2D.Camera#originX", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.5", "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#originX", "inherited": true, "___id": "T000002R046143", "___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": 442, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "originY", "longname": "Phaser.Cameras.Scene2D.Camera#originY", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.5", "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#originY", "inherited": true, "___id": "T000002R046144", "___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.BitmapMask|Phaser.Display.Masks.GeometryMask)}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 470, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "mask", "longname": "Phaser.Cameras.Scene2D.Camera#mask", "kind": "member", "description": "The Mask this Camera is using during render.\rSet the mask using the `setMask` method. Remove the mask using the `clearMask` method.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ], "nullable": true } }, "nullable": true, "since": "3.17.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#mask", "inherited": true, "___id": "T000002R046146", "___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": 494, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "renderList", "longname": "Phaser.Cameras.Scene2D.Camera#renderList", "kind": "member", "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.", "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.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#renderList", "inherited": true, "___id": "T000002R046148", "___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": 510, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "isSceneCamera", "longname": "Phaser.Cameras.Scene2D.Camera#isSceneCamera", "kind": "member", "description": "Is this Camera a Scene Camera? (which is the default), or a Camera\rbelonging to a Texture?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#isSceneCamera", "inherited": true, "___id": "T000002R046149", "___s": true }, { "comment": "/**\r\n * Adds the given Game Object to this cameras 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": 522, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "addToRenderList", "longname": "Phaser.Cameras.Scene2D.Camera#addToRenderList", "kind": "function", "description": "Adds the given Game Object to this cameras render list.\r\rThis is invoked during the rendering stage. Only objects that are actually rendered\rwill appear in the render list.", "since": "3.52.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "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" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#addToRenderList", "inherited": true, "___id": "T000002R046150", "___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": 538, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setAlpha", "longname": "Phaser.Cameras.Scene2D.Camera#setAlpha", "kind": "function", "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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The Camera alpha value.", "name": "value" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setAlpha", "inherited": true, "___id": "T000002R046151", "___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": 550, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setOrigin", "longname": "Phaser.Cameras.Scene2D.Camera#setOrigin", "kind": "function", "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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "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" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setOrigin", "inherited": true, "___id": "T000002R046152", "___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": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "getScroll", "longname": "Phaser.Cameras.Scene2D.Camera#getScroll", "kind": "function", "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.", "since": "3.11.0", "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.Camera", "scope": "instance", "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" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#getScroll", "inherited": true, "___id": "T000002R046153", "___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": 612, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "centerOnX", "longname": "Phaser.Cameras.Scene2D.Camera#centerOnX", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate to center on.", "name": "x" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#centerOnX", "inherited": true, "___id": "T000002R046154", "___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": 639, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "centerOnY", "longname": "Phaser.Cameras.Scene2D.Camera#centerOnY", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate to center on.", "name": "y" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#centerOnY", "inherited": true, "___id": "T000002R046155", "___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": 666, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "centerOn", "longname": "Phaser.Cameras.Scene2D.Camera#centerOn", "kind": "function", "description": "Moves the Camera so that it is centered on the given coordinates, bounds allowing.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "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" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#centerOn", "inherited": true, "___id": "T000002R046156", "___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": 685, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "centerToBounds", "longname": "Phaser.Cameras.Scene2D.Camera#centerToBounds", "kind": "function", "description": "Moves the Camera so that it is looking at the center of the Camera Bounds, if enabled.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#centerToBounds", "inherited": true, "___id": "T000002R046157", "___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": 710, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "centerToSize", "longname": "Phaser.Cameras.Scene2D.Camera#centerToSize", "kind": "function", "description": "Moves the Camera so that it is re-centered based on its viewport size.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#centerToSize", "inherited": true, "___id": "T000002R046158", "___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": 726, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "cull", "longname": "Phaser.Cameras.Scene2D.Camera#cull", "kind": "function", "description": "Takes an array of Game Objects and returns a new array featuring only those objects\rvisible by this camera.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [renderableObjects,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [renderableObjects,$return]" } ], "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.Camera", "scope": "instance", "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" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#cull", "inherited": true, "___id": "T000002R046159", "___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": 807, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "getWorldPoint", "longname": "Phaser.Cameras.Scene2D.Camera#getWorldPoint", "kind": "function", "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.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [output,$return]", "value": "{Phaser.Math.Vector2} O - [output,$return]" } ], "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.Camera", "scope": "instance", "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" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#getWorldPoint", "inherited": true, "___id": "T000002R046160", "___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|Phaser.GameObjects.Layer|Phaser.GameObjects.Layer[])} 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": 874, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "ignore", "longname": "Phaser.Cameras.Scene2D.Camera#ignore", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Array.", "Phaser.GameObjects.Group", "Phaser.GameObjects.Layer", "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" } ] }, { "type": "NameExpression", "name": "Phaser.GameObjects.Group" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Layer" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Layer", "type": "NameExpression" } ] } ] } }, "description": "The Game Object, or array of Game Objects, to be ignored by this Camera.", "name": "entries" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#ignore", "inherited": true, "___id": "T000002R046161", "___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": 979, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "clampX", "longname": "Phaser.Cameras.Scene2D.Camera#clampX", "kind": "function", "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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The adjusted value to use as scrollX." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to horizontally scroll clamp.", "name": "x" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#clampX", "inherited": true, "___id": "T000002R046162", "___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": 1011, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "clampY", "longname": "Phaser.Cameras.Scene2D.Camera#clampY", "kind": "function", "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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The adjusted value to use as scrollY." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to vertically scroll clamp.", "name": "y" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#clampY", "inherited": true, "___id": "T000002R046163", "___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": 1048, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "removeBounds", "longname": "Phaser.Cameras.Scene2D.Camera#removeBounds", "kind": "function", "description": "If this Camera has previously had movement bounds set on it, this will remove them.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#removeBounds", "inherited": true, "___id": "T000002R046164", "___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 cameras angle of rotation, given in degrees.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1067, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setAngle", "longname": "Phaser.Cameras.Scene2D.Camera#setAngle", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The cameras angle of rotation, given in degrees.", "name": "value" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setAngle", "inherited": true, "___id": "T000002R046165", "___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": 1088, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setBackgroundColor", "longname": "Phaser.Cameras.Scene2D.Camera#setBackgroundColor", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "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" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setBackgroundColor", "inherited": true, "___id": "T000002R046166", "___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": 1114, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setBounds", "longname": "Phaser.Cameras.Scene2D.Camera#setBounds", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "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" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setBounds", "inherited": true, "___id": "T000002R046167", "___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": 1166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "getBounds", "longname": "Phaser.Cameras.Scene2D.Camera#getBounds", "kind": "function", "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.", "since": "3.16.0", "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.Camera", "scope": "instance", "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" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#getBounds", "inherited": true, "___id": "T000002R046168", "___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": 1191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setName", "longname": "Phaser.Cameras.Scene2D.Camera#setName", "kind": "function", "description": "Sets the name of this Camera.\rThis value is for your own use and isn't used internally.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "''", "description": "The name of the Camera.", "name": "value" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setName", "inherited": true, "___id": "T000002R046169", "___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": 1211, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setPosition", "longname": "Phaser.Cameras.Scene2D.Camera#setPosition", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "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" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setPosition", "inherited": true, "___id": "T000002R046170", "___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": 1234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setRotation", "longname": "Phaser.Cameras.Scene2D.Camera#setRotation", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of the Camera, in radians.", "name": "value" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setRotation", "inherited": true, "___id": "T000002R046171", "___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": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setRoundPixels", "longname": "Phaser.Cameras.Scene2D.Camera#setRoundPixels", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to round Camera pixels, `false` to not.", "name": "value" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setRoundPixels", "inherited": true, "___id": "T000002R046172", "___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": 1274, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setScene", "longname": "Phaser.Cameras.Scene2D.Camera#setScene", "kind": "function", "description": "Sets the Scene the Camera is bound to.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "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" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setScene", "inherited": true, "___id": "T000002R046173", "___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": 1308, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setScroll", "longname": "Phaser.Cameras.Scene2D.Camera#setScroll", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "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" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setScroll", "inherited": true, "___id": "T000002R046174", "___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": 1333, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setSize", "longname": "Phaser.Cameras.Scene2D.Camera#setSize", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "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" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setSize", "inherited": true, "___id": "T000002R046175", "___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 * @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": 1358, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setViewport", "longname": "Phaser.Cameras.Scene2D.Camera#setViewport", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "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" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setViewport", "inherited": true, "___id": "T000002R046176", "___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": 1389, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setZoom", "longname": "Phaser.Cameras.Scene2D.Camera#setZoom", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "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" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setZoom", "inherited": true, "___id": "T000002R046177", "___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 can be either a GeometryMask or a BitmapMask.\r\n *\r\n * Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 1430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setMask", "longname": "Phaser.Cameras.Scene2D.Camera#setMask", "kind": "function", "description": "Sets the mask to be applied to this Camera during rendering.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\r\rBitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.17.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "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" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setMask", "inherited": true, "___id": "T000002R046178", "___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": 1461, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "clearMask", "longname": "Phaser.Cameras.Scene2D.Camera#clearMask", "kind": "function", "description": "Clears the mask that this Camera was using.", "since": "3.17.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#clearMask", "inherited": true, "___id": "T000002R046179", "___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": 1485, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setVisible", "longname": "Phaser.Cameras.Scene2D.Camera#setVisible", "kind": "function", "description": "Sets the visibility of this Camera.\r\rAn invisible Camera will skip rendering and input tests of everything it can see.", "since": "3.10.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Camera.", "name": "value" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setVisible", "inherited": true, "___id": "T000002R046180", "___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": 1498, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "toJSON", "longname": "Phaser.Cameras.Scene2D.Camera#toJSON", "kind": "function", "description": "Returns an Object suitable for JSON storage containing all of the Camera viewport and rendering properties.", "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.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#toJSON", "inherited": true, "___id": "T000002R046181", "___s": true }, { "comment": "/**\r\n * Set if this Camera is being used as a Scene Camera, or a Texture\r\n * Camera.\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": 1550, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "setIsSceneCamera", "longname": "Phaser.Cameras.Scene2D.Camera#setIsSceneCamera", "kind": "function", "description": "Set if this Camera is being used as a Scene Camera, or a Texture\rCamera.", "since": "3.60.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this being used as a Scene Camera, or a Texture camera?", "name": "value" } ], "inherits": "Phaser.Cameras.Scene2D.BaseCamera#setIsSceneCamera", "inherited": true, "___id": "T000002R046182", "___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": 1638, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "x", "longname": "Phaser.Cameras.Scene2D.Camera#x", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#x", "inherited": true, "___id": "T000002R046184", "___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": 1662, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "y", "longname": "Phaser.Cameras.Scene2D.Camera#y", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#y", "inherited": true, "___id": "T000002R046185", "___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": 1686, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "width", "longname": "Phaser.Cameras.Scene2D.Camera#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#width", "inherited": true, "___id": "T000002R046186", "___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": 1711, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "height", "longname": "Phaser.Cameras.Scene2D.Camera#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#height", "inherited": true, "___id": "T000002R046187", "___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": 1736, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "scrollX", "longname": "Phaser.Cameras.Scene2D.Camera#scrollX", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#scrollX", "inherited": true, "___id": "T000002R046188", "___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": 1769, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "scrollY", "longname": "Phaser.Cameras.Scene2D.Camera#scrollY", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#scrollY", "inherited": true, "___id": "T000002R046189", "___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": 1802, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "zoom", "longname": "Phaser.Cameras.Scene2D.Camera#zoom", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#zoom", "inherited": true, "___id": "T000002R046190", "___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": 1835, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "zoomX", "longname": "Phaser.Cameras.Scene2D.Camera#zoomX", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.50.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#zoomX", "inherited": true, "___id": "T000002R046191", "___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": 1866, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "zoomY", "longname": "Phaser.Cameras.Scene2D.Camera#zoomY", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.50.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#zoomY", "inherited": true, "___id": "T000002R046192", "___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": 1927, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "centerX", "longname": "Phaser.Cameras.Scene2D.Camera#centerX", "kind": "member", "description": "The horizontal position of the center of the Camera's viewport, relative to the left of the game canvas.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.10.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#centerX", "inherited": true, "___id": "T000002R046194", "___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": 1944, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "centerY", "longname": "Phaser.Cameras.Scene2D.Camera#centerY", "kind": "member", "description": "The vertical position of the center of the Camera's viewport, relative to the top of the game canvas.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.10.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#centerY", "inherited": true, "___id": "T000002R046195", "___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": 1961, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "displayWidth", "longname": "Phaser.Cameras.Scene2D.Camera#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#displayWidth", "inherited": true, "___id": "T000002R046196", "___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": 1984, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "name": "displayHeight", "longname": "Phaser.Cameras.Scene2D.Camera#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Cameras.Scene2D.BaseCamera#displayHeight", "inherited": true, "___id": "T000002R046197", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Cameras.Scene2D.Camera#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R046198", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Cameras.Scene2D.Camera#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R046199", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Cameras.Scene2D.Camera#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R046200", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Cameras.Scene2D.Camera#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R046201", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Cameras.Scene2D.Camera#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R046202", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Cameras.Scene2D.Camera#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R046203", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Cameras.Scene2D.Camera#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R046204", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Cameras.Scene2D.Camera#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R046205", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Cameras.Scene2D.Camera#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R046206", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Cameras.Scene2D.Camera#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R046207", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Cameras.Scene2D.Camera#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R046208", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.Cameras.Scene2D.Camera#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "___id": "T000002R046214", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.Cameras.Scene2D.Camera#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "___id": "T000002R046215", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.Cameras.Scene2D.Camera#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "___id": "T000002R046216", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.Cameras.Scene2D.Camera#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "___id": "T000002R046217", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.Cameras.Scene2D.Camera#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "___id": "T000002R046218", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.Cameras.Scene2D.Camera#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R046220", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.Cameras.Scene2D.Camera#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R046221", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.Cameras.Scene2D.Camera#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R046222", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.Cameras.Scene2D.Camera#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R046223", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.Cameras.Scene2D.Camera#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R046224", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.Cameras.Scene2D.Camera#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R046225", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.Cameras.Scene2D.Camera#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R046226", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.Cameras.Scene2D.Camera#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R046227", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.Cameras.Scene2D.Camera#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R046228", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.Cameras.Scene2D.Camera#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R046229", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.Cameras.Scene2D.Camera#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R046230", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.Cameras.Scene2D.Camera#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R046231", "___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": 31, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "type", "longname": "Phaser.Curves.CubicBezier#type", "kind": "member", "description": "String based identifier for the type of curve.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "inherits": "Phaser.Curves.Curve#type", "inherited": true, "___id": "T000002R046232", "___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": 40, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "defaultDivisions", "longname": "Phaser.Curves.CubicBezier#defaultDivisions", "kind": "member", "description": "The default number of divisions within the curve.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "5", "since": "3.0.0", "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "inherits": "Phaser.Curves.Curve#defaultDivisions", "inherited": true, "___id": "T000002R046233", "___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": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "arcLengthDivisions", "longname": "Phaser.Curves.CubicBezier#arcLengthDivisions", "kind": "member", "description": "The quantity of arc length divisions within the curve.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "100", "since": "3.0.0", "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "inherits": "Phaser.Curves.Curve#arcLengthDivisions", "inherited": true, "___id": "T000002R046234", "___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": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "cacheArcLengths", "longname": "Phaser.Curves.CubicBezier#cacheArcLengths", "kind": "member", "description": "An array of cached arc length values.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "inherits": "Phaser.Curves.Curve#cacheArcLengths", "inherited": true, "___id": "T000002R046235", "___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": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "needsUpdate", "longname": "Phaser.Curves.CubicBezier#needsUpdate", "kind": "member", "description": "Does the data of this curve need updating?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "inherits": "Phaser.Curves.Curve#needsUpdate", "inherited": true, "___id": "T000002R046236", "___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": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "active", "longname": "Phaser.Curves.CubicBezier#active", "kind": "member", "description": "For a curve on a Path, `false` means the Path will ignore this curve.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "inherits": "Phaser.Curves.Curve#active", "inherited": true, "___id": "T000002R046237", "___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": 135, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getBounds", "longname": "Phaser.Curves.CubicBezier#getBounds", "kind": "function", "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.", "since": "3.0.0", "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.CubicBezier", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getBounds", "inherited": true, "___id": "T000002R046240", "___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.Geom.Point[]} An Array of Point objects.\r\n */", "meta": { "filename": "Curve.js", "lineno": 169, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getDistancePoints", "longname": "Phaser.Curves.CubicBezier#getDistancePoints", "kind": "function", "description": "Returns an array of points, spaced out X distance pixels apart.\rThe smaller the distance, the larger the array will be.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } }, "description": "An Array of Point objects." } ], "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance, in pixels, between each point along the curve.", "name": "distance" } ], "inherits": "Phaser.Curves.Curve#getDistancePoints", "inherited": true, "___id": "T000002R046241", "___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 curves end point.\r\n */", "meta": { "filename": "Curve.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getEndPoint", "longname": "Phaser.Curves.CubicBezier#getEndPoint", "kind": "function", "description": "Get a point at the end of the curve.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "Vector2 containing the coordinates of the curves end point." } ], "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getEndPoint", "inherited": true, "___id": "T000002R046242", "___s": true }, { "comment": "/**\r\n * Get total curve arc length\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": 206, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getLength", "longname": "Phaser.Curves.CubicBezier#getLength", "kind": "function", "description": "Get total curve arc length", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total length of the curve." } ], "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "inherits": "Phaser.Curves.Curve#getLength", "inherited": true, "___id": "T000002R046243", "___s": true }, { "comment": "/**\r\n * Get a list of cumulative segment lengths.\r\n *\r\n * These lengths are\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": 222, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getLengths", "longname": "Phaser.Curves.CubicBezier#getLengths", "kind": "function", "description": "Get a list of cumulative segment lengths.\r\rThese lengths are\r\r- [0] 0\r- [1] The first segment\r- [2] The first and second segment\r- ...\r- [divisions] All segments", "since": "3.0.0", "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.CubicBezier", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The number of divisions or segments.", "name": "divisions" } ], "inherits": "Phaser.Curves.Curve#getLengths", "inherited": true, "___id": "T000002R046244", "___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": 278, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getPointAt", "longname": "Phaser.Curves.CubicBezier#getPointAt", "kind": "function", "description": "Get a point at a relative position on the curve, by arc length.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The point." } ], "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getPointAt", "inherited": true, "___id": "T000002R046245", "___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 {(array|Phaser.Math.Vector2[])} [out] - An optional array to store the points in.\r\n *\r\n * @return {(array|Phaser.Math.Vector2[])} An array of Points from the curve.\r\n */", "meta": { "filename": "Curve.js", "lineno": 300, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getPoints", "longname": "Phaser.Curves.CubicBezier#getPoints", "kind": "function", "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.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [out,$return]", "value": "{Phaser.Math.Vector2[]} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } ] } }, "description": "An array of Points from the curve." } ], "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "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" } ], "inherits": "Phaser.Curves.Curve#getPoints", "inherited": true, "___id": "T000002R046246", "___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": 349, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getRandomPoint", "longname": "Phaser.Curves.CubicBezier#getRandomPoint", "kind": "function", "description": "Get a random point from the curve.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The point." } ], "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getRandomPoint", "inherited": true, "___id": "T000002R046247", "___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 {(array|Phaser.Math.Vector2[])} [out] - An optional array to store the points in.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of points.\r\n */", "meta": { "filename": "Curve.js", "lineno": 370, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getSpacedPoints", "longname": "Phaser.Curves.CubicBezier#getSpacedPoints", "kind": "function", "description": "Get a sequence of equally spaced points (by arc distance) from the curve.\r\r`1 + divisions` points will be returned.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of points." } ], "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "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" } ], "inherits": "Phaser.Curves.Curve#getSpacedPoints", "inherited": true, "___id": "T000002R046248", "___s": true }, { "comment": "/**\r\n * Get a unit vector tangent at a relative position on the curve.\r\n * In case any sub curve does not implement its tangent derivation,\r\n * 2 points a small delta apart will be used to find its gradient\r\n * which seems to give a reasonable approximation\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": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getTangent", "longname": "Phaser.Curves.CubicBezier#getTangent", "kind": "function", "description": "Get a unit vector tangent at a relative position on the curve.\rIn case any sub curve does not implement its tangent derivation,\r2 points a small delta apart will be used to find its gradient\rwhich seems to give a reasonable approximation", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "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.CubicBezier", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getTangent", "inherited": true, "___id": "T000002R046249", "___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": 472, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getTangentAt", "longname": "Phaser.Curves.CubicBezier#getTangentAt", "kind": "function", "description": "Get a unit vector tangent at a relative position on the curve, by arc length.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The tangent vector." } ], "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getTangentAt", "inherited": true, "___id": "T000002R046250", "___s": true }, { "comment": "/**\r\n * Given a distance in pixels, get a t to find p.\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 distance.\r\n */", "meta": { "filename": "Curve.js", "lineno": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getTFromDistance", "longname": "Phaser.Curves.CubicBezier#getTFromDistance", "kind": "function", "description": "Given a distance in pixels, get a t to find p.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance." } ], "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getTFromDistance", "inherited": true, "___id": "T000002R046251", "___s": true }, { "comment": "/**\r\n * Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equidistant.\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": 513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getUtoTmapping", "longname": "Phaser.Curves.CubicBezier#getUtoTmapping", "kind": "function", "description": "Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equidistant.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The equidistant value." } ], "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getUtoTmapping", "inherited": true, "___id": "T000002R046252", "___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": 594, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "updateArcLengths", "longname": "Phaser.Curves.CubicBezier#updateArcLengths", "kind": "function", "description": "Calculate and cache the arc lengths.", "since": "3.0.0", "see": [ "Phaser.Curves.Curve#getLengths()" ], "memberof": "Phaser.Curves.CubicBezier", "scope": "instance", "inherits": "Phaser.Curves.Curve#updateArcLengths", "inherited": true, "___id": "T000002R046253", "___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": 31, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "type", "longname": "Phaser.Curves.Ellipse#type", "kind": "member", "description": "String based identifier for the type of curve.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "inherits": "Phaser.Curves.Curve#type", "inherited": true, "___id": "T000002R046254", "___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": 40, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "defaultDivisions", "longname": "Phaser.Curves.Ellipse#defaultDivisions", "kind": "member", "description": "The default number of divisions within the curve.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "5", "since": "3.0.0", "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "inherits": "Phaser.Curves.Curve#defaultDivisions", "inherited": true, "___id": "T000002R046255", "___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": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "arcLengthDivisions", "longname": "Phaser.Curves.Ellipse#arcLengthDivisions", "kind": "member", "description": "The quantity of arc length divisions within the curve.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "100", "since": "3.0.0", "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "inherits": "Phaser.Curves.Curve#arcLengthDivisions", "inherited": true, "___id": "T000002R046256", "___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": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "cacheArcLengths", "longname": "Phaser.Curves.Ellipse#cacheArcLengths", "kind": "member", "description": "An array of cached arc length values.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "inherits": "Phaser.Curves.Curve#cacheArcLengths", "inherited": true, "___id": "T000002R046257", "___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": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "needsUpdate", "longname": "Phaser.Curves.Ellipse#needsUpdate", "kind": "member", "description": "Does the data of this curve need updating?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "inherits": "Phaser.Curves.Curve#needsUpdate", "inherited": true, "___id": "T000002R046258", "___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": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "active", "longname": "Phaser.Curves.Ellipse#active", "kind": "member", "description": "For a curve on a Path, `false` means the Path will ignore this curve.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "inherits": "Phaser.Curves.Curve#active", "inherited": true, "___id": "T000002R046259", "___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": 111, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "draw", "longname": "Phaser.Curves.Ellipse#draw", "kind": "function", "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.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.Graphics} G - [graphics,$return]", "value": "{Phaser.GameObjects.Graphics} G - [graphics,$return]" } ], "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.Ellipse", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#draw", "inherited": true, "___id": "T000002R046262", "___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": 135, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getBounds", "longname": "Phaser.Curves.Ellipse#getBounds", "kind": "function", "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.", "since": "3.0.0", "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.Ellipse", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getBounds", "inherited": true, "___id": "T000002R046263", "___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.Geom.Point[]} An Array of Point objects.\r\n */", "meta": { "filename": "Curve.js", "lineno": 169, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getDistancePoints", "longname": "Phaser.Curves.Ellipse#getDistancePoints", "kind": "function", "description": "Returns an array of points, spaced out X distance pixels apart.\rThe smaller the distance, the larger the array will be.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } }, "description": "An Array of Point objects." } ], "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance, in pixels, between each point along the curve.", "name": "distance" } ], "inherits": "Phaser.Curves.Curve#getDistancePoints", "inherited": true, "___id": "T000002R046264", "___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 curves end point.\r\n */", "meta": { "filename": "Curve.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getEndPoint", "longname": "Phaser.Curves.Ellipse#getEndPoint", "kind": "function", "description": "Get a point at the end of the curve.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "Vector2 containing the coordinates of the curves end point." } ], "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getEndPoint", "inherited": true, "___id": "T000002R046265", "___s": true }, { "comment": "/**\r\n * Get total curve arc length\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": 206, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getLength", "longname": "Phaser.Curves.Ellipse#getLength", "kind": "function", "description": "Get total curve arc length", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total length of the curve." } ], "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "inherits": "Phaser.Curves.Curve#getLength", "inherited": true, "___id": "T000002R046266", "___s": true }, { "comment": "/**\r\n * Get a list of cumulative segment lengths.\r\n *\r\n * These lengths are\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": 222, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getLengths", "longname": "Phaser.Curves.Ellipse#getLengths", "kind": "function", "description": "Get a list of cumulative segment lengths.\r\rThese lengths are\r\r- [0] 0\r- [1] The first segment\r- [2] The first and second segment\r- ...\r- [divisions] All segments", "since": "3.0.0", "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.Ellipse", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The number of divisions or segments.", "name": "divisions" } ], "inherits": "Phaser.Curves.Curve#getLengths", "inherited": true, "___id": "T000002R046267", "___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": 278, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getPointAt", "longname": "Phaser.Curves.Ellipse#getPointAt", "kind": "function", "description": "Get a point at a relative position on the curve, by arc length.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The point." } ], "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getPointAt", "inherited": true, "___id": "T000002R046268", "___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 {(array|Phaser.Math.Vector2[])} [out] - An optional array to store the points in.\r\n *\r\n * @return {(array|Phaser.Math.Vector2[])} An array of Points from the curve.\r\n */", "meta": { "filename": "Curve.js", "lineno": 300, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getPoints", "longname": "Phaser.Curves.Ellipse#getPoints", "kind": "function", "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.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [out,$return]", "value": "{Phaser.Math.Vector2[]} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } ] } }, "description": "An array of Points from the curve." } ], "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "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" } ], "inherits": "Phaser.Curves.Curve#getPoints", "inherited": true, "___id": "T000002R046269", "___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": 349, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getRandomPoint", "longname": "Phaser.Curves.Ellipse#getRandomPoint", "kind": "function", "description": "Get a random point from the curve.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The point." } ], "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getRandomPoint", "inherited": true, "___id": "T000002R046270", "___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 {(array|Phaser.Math.Vector2[])} [out] - An optional array to store the points in.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of points.\r\n */", "meta": { "filename": "Curve.js", "lineno": 370, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getSpacedPoints", "longname": "Phaser.Curves.Ellipse#getSpacedPoints", "kind": "function", "description": "Get a sequence of equally spaced points (by arc distance) from the curve.\r\r`1 + divisions` points will be returned.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of points." } ], "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "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" } ], "inherits": "Phaser.Curves.Curve#getSpacedPoints", "inherited": true, "___id": "T000002R046271", "___s": true }, { "comment": "/**\r\n * Get a unit vector tangent at a relative position on the curve.\r\n * In case any sub curve does not implement its tangent derivation,\r\n * 2 points a small delta apart will be used to find its gradient\r\n * which seems to give a reasonable approximation\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": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getTangent", "longname": "Phaser.Curves.Ellipse#getTangent", "kind": "function", "description": "Get a unit vector tangent at a relative position on the curve.\rIn case any sub curve does not implement its tangent derivation,\r2 points a small delta apart will be used to find its gradient\rwhich seems to give a reasonable approximation", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "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.Ellipse", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getTangent", "inherited": true, "___id": "T000002R046272", "___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": 472, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getTangentAt", "longname": "Phaser.Curves.Ellipse#getTangentAt", "kind": "function", "description": "Get a unit vector tangent at a relative position on the curve, by arc length.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The tangent vector." } ], "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getTangentAt", "inherited": true, "___id": "T000002R046273", "___s": true }, { "comment": "/**\r\n * Given a distance in pixels, get a t to find p.\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 distance.\r\n */", "meta": { "filename": "Curve.js", "lineno": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getTFromDistance", "longname": "Phaser.Curves.Ellipse#getTFromDistance", "kind": "function", "description": "Given a distance in pixels, get a t to find p.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance." } ], "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getTFromDistance", "inherited": true, "___id": "T000002R046274", "___s": true }, { "comment": "/**\r\n * Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equidistant.\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": 513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getUtoTmapping", "longname": "Phaser.Curves.Ellipse#getUtoTmapping", "kind": "function", "description": "Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equidistant.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The equidistant value." } ], "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getUtoTmapping", "inherited": true, "___id": "T000002R046275", "___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": 594, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "updateArcLengths", "longname": "Phaser.Curves.Ellipse#updateArcLengths", "kind": "function", "description": "Calculate and cache the arc lengths.", "since": "3.0.0", "see": [ "Phaser.Curves.Curve#getLengths()" ], "memberof": "Phaser.Curves.Ellipse", "scope": "instance", "inherits": "Phaser.Curves.Curve#updateArcLengths", "inherited": true, "___id": "T000002R046276", "___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": 31, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "type", "longname": "Phaser.Curves.Line#type", "kind": "member", "description": "String based identifier for the type of curve.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Curves.Line", "scope": "instance", "inherits": "Phaser.Curves.Curve#type", "inherited": true, "___id": "T000002R046277", "___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": 40, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "defaultDivisions", "longname": "Phaser.Curves.Line#defaultDivisions", "kind": "member", "description": "The default number of divisions within the curve.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "5", "since": "3.0.0", "memberof": "Phaser.Curves.Line", "scope": "instance", "inherits": "Phaser.Curves.Curve#defaultDivisions", "inherited": true, "___id": "T000002R046278", "___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": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "cacheArcLengths", "longname": "Phaser.Curves.Line#cacheArcLengths", "kind": "member", "description": "An array of cached arc length values.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.Curves.Line", "scope": "instance", "inherits": "Phaser.Curves.Curve#cacheArcLengths", "inherited": true, "___id": "T000002R046279", "___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": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "needsUpdate", "longname": "Phaser.Curves.Line#needsUpdate", "kind": "member", "description": "Does the data of this curve need updating?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Curves.Line", "scope": "instance", "inherits": "Phaser.Curves.Curve#needsUpdate", "inherited": true, "___id": "T000002R046280", "___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": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "active", "longname": "Phaser.Curves.Line#active", "kind": "member", "description": "For a curve on a Path, `false` means the Path will ignore this curve.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Curves.Line", "scope": "instance", "inherits": "Phaser.Curves.Curve#active", "inherited": true, "___id": "T000002R046281", "___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.Geom.Point[]} An Array of Point objects.\r\n */", "meta": { "filename": "Curve.js", "lineno": 169, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getDistancePoints", "longname": "Phaser.Curves.Line#getDistancePoints", "kind": "function", "description": "Returns an array of points, spaced out X distance pixels apart.\rThe smaller the distance, the larger the array will be.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } }, "description": "An Array of Point objects." } ], "memberof": "Phaser.Curves.Line", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance, in pixels, between each point along the curve.", "name": "distance" } ], "inherits": "Phaser.Curves.Curve#getDistancePoints", "inherited": true, "___id": "T000002R046284", "___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 curves end point.\r\n */", "meta": { "filename": "Curve.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getEndPoint", "longname": "Phaser.Curves.Line#getEndPoint", "kind": "function", "description": "Get a point at the end of the curve.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "Vector2 containing the coordinates of the curves end point." } ], "memberof": "Phaser.Curves.Line", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getEndPoint", "inherited": true, "___id": "T000002R046285", "___s": true }, { "comment": "/**\r\n * Get total curve arc length\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": 206, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getLength", "longname": "Phaser.Curves.Line#getLength", "kind": "function", "description": "Get total curve arc length", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total length of the curve." } ], "memberof": "Phaser.Curves.Line", "scope": "instance", "inherits": "Phaser.Curves.Curve#getLength", "inherited": true, "___id": "T000002R046286", "___s": true }, { "comment": "/**\r\n * Get a list of cumulative segment lengths.\r\n *\r\n * These lengths are\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": 222, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getLengths", "longname": "Phaser.Curves.Line#getLengths", "kind": "function", "description": "Get a list of cumulative segment lengths.\r\rThese lengths are\r\r- [0] 0\r- [1] The first segment\r- [2] The first and second segment\r- ...\r- [divisions] All segments", "since": "3.0.0", "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.Line", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The number of divisions or segments.", "name": "divisions" } ], "inherits": "Phaser.Curves.Curve#getLengths", "inherited": true, "___id": "T000002R046287", "___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 {(array|Phaser.Math.Vector2[])} [out] - An optional array to store the points in.\r\n *\r\n * @return {(array|Phaser.Math.Vector2[])} An array of Points from the curve.\r\n */", "meta": { "filename": "Curve.js", "lineno": 300, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getPoints", "longname": "Phaser.Curves.Line#getPoints", "kind": "function", "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.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [out,$return]", "value": "{Phaser.Math.Vector2[]} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } ] } }, "description": "An array of Points from the curve." } ], "memberof": "Phaser.Curves.Line", "scope": "instance", "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "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" } ], "inherits": "Phaser.Curves.Curve#getPoints", "inherited": true, "___id": "T000002R046288", "___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": 349, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getRandomPoint", "longname": "Phaser.Curves.Line#getRandomPoint", "kind": "function", "description": "Get a random point from the curve.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The point." } ], "memberof": "Phaser.Curves.Line", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getRandomPoint", "inherited": true, "___id": "T000002R046289", "___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 {(array|Phaser.Math.Vector2[])} [out] - An optional array to store the points in.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of points.\r\n */", "meta": { "filename": "Curve.js", "lineno": 370, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getSpacedPoints", "longname": "Phaser.Curves.Line#getSpacedPoints", "kind": "function", "description": "Get a sequence of equally spaced points (by arc distance) from the curve.\r\r`1 + divisions` points will be returned.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of points." } ], "memberof": "Phaser.Curves.Line", "scope": "instance", "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "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" } ], "inherits": "Phaser.Curves.Curve#getSpacedPoints", "inherited": true, "___id": "T000002R046290", "___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": 472, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getTangentAt", "longname": "Phaser.Curves.Line#getTangentAt", "kind": "function", "description": "Get a unit vector tangent at a relative position on the curve, by arc length.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The tangent vector." } ], "memberof": "Phaser.Curves.Line", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getTangentAt", "inherited": true, "___id": "T000002R046291", "___s": true }, { "comment": "/**\r\n * Given a distance in pixels, get a t to find p.\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 distance.\r\n */", "meta": { "filename": "Curve.js", "lineno": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getTFromDistance", "longname": "Phaser.Curves.Line#getTFromDistance", "kind": "function", "description": "Given a distance in pixels, get a t to find p.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance." } ], "memberof": "Phaser.Curves.Line", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getTFromDistance", "inherited": true, "___id": "T000002R046292", "___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": 594, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "updateArcLengths", "longname": "Phaser.Curves.Line#updateArcLengths", "kind": "function", "description": "Calculate and cache the arc lengths.", "since": "3.0.0", "see": [ "Phaser.Curves.Curve#getLengths()" ], "memberof": "Phaser.Curves.Line", "scope": "instance", "inherits": "Phaser.Curves.Curve#updateArcLengths", "inherited": true, "___id": "T000002R046293", "___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": 31, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "type", "longname": "Phaser.Curves.QuadraticBezier#type", "kind": "member", "description": "String based identifier for the type of curve.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "inherits": "Phaser.Curves.Curve#type", "inherited": true, "___id": "T000002R046294", "___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": 40, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "defaultDivisions", "longname": "Phaser.Curves.QuadraticBezier#defaultDivisions", "kind": "member", "description": "The default number of divisions within the curve.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "5", "since": "3.0.0", "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "inherits": "Phaser.Curves.Curve#defaultDivisions", "inherited": true, "___id": "T000002R046295", "___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": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "arcLengthDivisions", "longname": "Phaser.Curves.QuadraticBezier#arcLengthDivisions", "kind": "member", "description": "The quantity of arc length divisions within the curve.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "100", "since": "3.0.0", "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "inherits": "Phaser.Curves.Curve#arcLengthDivisions", "inherited": true, "___id": "T000002R046296", "___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": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "cacheArcLengths", "longname": "Phaser.Curves.QuadraticBezier#cacheArcLengths", "kind": "member", "description": "An array of cached arc length values.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "inherits": "Phaser.Curves.Curve#cacheArcLengths", "inherited": true, "___id": "T000002R046297", "___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": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "needsUpdate", "longname": "Phaser.Curves.QuadraticBezier#needsUpdate", "kind": "member", "description": "Does the data of this curve need updating?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "inherits": "Phaser.Curves.Curve#needsUpdate", "inherited": true, "___id": "T000002R046298", "___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": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "active", "longname": "Phaser.Curves.QuadraticBezier#active", "kind": "member", "description": "For a curve on a Path, `false` means the Path will ignore this curve.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "inherits": "Phaser.Curves.Curve#active", "inherited": true, "___id": "T000002R046299", "___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": 135, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getBounds", "longname": "Phaser.Curves.QuadraticBezier#getBounds", "kind": "function", "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.", "since": "3.0.0", "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.QuadraticBezier", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getBounds", "inherited": true, "___id": "T000002R046302", "___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.Geom.Point[]} An Array of Point objects.\r\n */", "meta": { "filename": "Curve.js", "lineno": 169, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getDistancePoints", "longname": "Phaser.Curves.QuadraticBezier#getDistancePoints", "kind": "function", "description": "Returns an array of points, spaced out X distance pixels apart.\rThe smaller the distance, the larger the array will be.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } }, "description": "An Array of Point objects." } ], "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance, in pixels, between each point along the curve.", "name": "distance" } ], "inherits": "Phaser.Curves.Curve#getDistancePoints", "inherited": true, "___id": "T000002R046303", "___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 curves end point.\r\n */", "meta": { "filename": "Curve.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getEndPoint", "longname": "Phaser.Curves.QuadraticBezier#getEndPoint", "kind": "function", "description": "Get a point at the end of the curve.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "Vector2 containing the coordinates of the curves end point." } ], "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getEndPoint", "inherited": true, "___id": "T000002R046304", "___s": true }, { "comment": "/**\r\n * Get total curve arc length\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": 206, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getLength", "longname": "Phaser.Curves.QuadraticBezier#getLength", "kind": "function", "description": "Get total curve arc length", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total length of the curve." } ], "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "inherits": "Phaser.Curves.Curve#getLength", "inherited": true, "___id": "T000002R046305", "___s": true }, { "comment": "/**\r\n * Get a list of cumulative segment lengths.\r\n *\r\n * These lengths are\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": 222, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getLengths", "longname": "Phaser.Curves.QuadraticBezier#getLengths", "kind": "function", "description": "Get a list of cumulative segment lengths.\r\rThese lengths are\r\r- [0] 0\r- [1] The first segment\r- [2] The first and second segment\r- ...\r- [divisions] All segments", "since": "3.0.0", "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.QuadraticBezier", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The number of divisions or segments.", "name": "divisions" } ], "inherits": "Phaser.Curves.Curve#getLengths", "inherited": true, "___id": "T000002R046306", "___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": 278, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getPointAt", "longname": "Phaser.Curves.QuadraticBezier#getPointAt", "kind": "function", "description": "Get a point at a relative position on the curve, by arc length.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The point." } ], "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getPointAt", "inherited": true, "___id": "T000002R046307", "___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 {(array|Phaser.Math.Vector2[])} [out] - An optional array to store the points in.\r\n *\r\n * @return {(array|Phaser.Math.Vector2[])} An array of Points from the curve.\r\n */", "meta": { "filename": "Curve.js", "lineno": 300, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getPoints", "longname": "Phaser.Curves.QuadraticBezier#getPoints", "kind": "function", "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.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [out,$return]", "value": "{Phaser.Math.Vector2[]} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } ] } }, "description": "An array of Points from the curve." } ], "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "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" } ], "inherits": "Phaser.Curves.Curve#getPoints", "inherited": true, "___id": "T000002R046308", "___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": 349, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getRandomPoint", "longname": "Phaser.Curves.QuadraticBezier#getRandomPoint", "kind": "function", "description": "Get a random point from the curve.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The point." } ], "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getRandomPoint", "inherited": true, "___id": "T000002R046309", "___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 {(array|Phaser.Math.Vector2[])} [out] - An optional array to store the points in.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of points.\r\n */", "meta": { "filename": "Curve.js", "lineno": 370, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getSpacedPoints", "longname": "Phaser.Curves.QuadraticBezier#getSpacedPoints", "kind": "function", "description": "Get a sequence of equally spaced points (by arc distance) from the curve.\r\r`1 + divisions` points will be returned.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of points." } ], "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "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" } ], "inherits": "Phaser.Curves.Curve#getSpacedPoints", "inherited": true, "___id": "T000002R046310", "___s": true }, { "comment": "/**\r\n * Get a unit vector tangent at a relative position on the curve.\r\n * In case any sub curve does not implement its tangent derivation,\r\n * 2 points a small delta apart will be used to find its gradient\r\n * which seems to give a reasonable approximation\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": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getTangent", "longname": "Phaser.Curves.QuadraticBezier#getTangent", "kind": "function", "description": "Get a unit vector tangent at a relative position on the curve.\rIn case any sub curve does not implement its tangent derivation,\r2 points a small delta apart will be used to find its gradient\rwhich seems to give a reasonable approximation", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "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.QuadraticBezier", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getTangent", "inherited": true, "___id": "T000002R046311", "___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": 472, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getTangentAt", "longname": "Phaser.Curves.QuadraticBezier#getTangentAt", "kind": "function", "description": "Get a unit vector tangent at a relative position on the curve, by arc length.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The tangent vector." } ], "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getTangentAt", "inherited": true, "___id": "T000002R046312", "___s": true }, { "comment": "/**\r\n * Given a distance in pixels, get a t to find p.\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 distance.\r\n */", "meta": { "filename": "Curve.js", "lineno": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getTFromDistance", "longname": "Phaser.Curves.QuadraticBezier#getTFromDistance", "kind": "function", "description": "Given a distance in pixels, get a t to find p.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance." } ], "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getTFromDistance", "inherited": true, "___id": "T000002R046313", "___s": true }, { "comment": "/**\r\n * Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equidistant.\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": 513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getUtoTmapping", "longname": "Phaser.Curves.QuadraticBezier#getUtoTmapping", "kind": "function", "description": "Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equidistant.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The equidistant value." } ], "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getUtoTmapping", "inherited": true, "___id": "T000002R046314", "___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": 594, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "updateArcLengths", "longname": "Phaser.Curves.QuadraticBezier#updateArcLengths", "kind": "function", "description": "Calculate and cache the arc lengths.", "since": "3.0.0", "see": [ "Phaser.Curves.Curve#getLengths()" ], "memberof": "Phaser.Curves.QuadraticBezier", "scope": "instance", "inherits": "Phaser.Curves.Curve#updateArcLengths", "inherited": true, "___id": "T000002R046315", "___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": 31, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "type", "longname": "Phaser.Curves.Spline#type", "kind": "member", "description": "String based identifier for the type of curve.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Curves.Spline", "scope": "instance", "inherits": "Phaser.Curves.Curve#type", "inherited": true, "___id": "T000002R046316", "___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": 40, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "defaultDivisions", "longname": "Phaser.Curves.Spline#defaultDivisions", "kind": "member", "description": "The default number of divisions within the curve.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "5", "since": "3.0.0", "memberof": "Phaser.Curves.Spline", "scope": "instance", "inherits": "Phaser.Curves.Curve#defaultDivisions", "inherited": true, "___id": "T000002R046317", "___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": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "arcLengthDivisions", "longname": "Phaser.Curves.Spline#arcLengthDivisions", "kind": "member", "description": "The quantity of arc length divisions within the curve.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "100", "since": "3.0.0", "memberof": "Phaser.Curves.Spline", "scope": "instance", "inherits": "Phaser.Curves.Curve#arcLengthDivisions", "inherited": true, "___id": "T000002R046318", "___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": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "cacheArcLengths", "longname": "Phaser.Curves.Spline#cacheArcLengths", "kind": "member", "description": "An array of cached arc length values.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.Curves.Spline", "scope": "instance", "inherits": "Phaser.Curves.Curve#cacheArcLengths", "inherited": true, "___id": "T000002R046319", "___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": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "needsUpdate", "longname": "Phaser.Curves.Spline#needsUpdate", "kind": "member", "description": "Does the data of this curve need updating?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Curves.Spline", "scope": "instance", "inherits": "Phaser.Curves.Curve#needsUpdate", "inherited": true, "___id": "T000002R046320", "___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": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "active", "longname": "Phaser.Curves.Spline#active", "kind": "member", "description": "For a curve on a Path, `false` means the Path will ignore this curve.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Curves.Spline", "scope": "instance", "inherits": "Phaser.Curves.Curve#active", "inherited": true, "___id": "T000002R046321", "___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": 111, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "draw", "longname": "Phaser.Curves.Spline#draw", "kind": "function", "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.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.Graphics} G - [graphics,$return]", "value": "{Phaser.GameObjects.Graphics} G - [graphics,$return]" } ], "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.Spline", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#draw", "inherited": true, "___id": "T000002R046324", "___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": 135, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getBounds", "longname": "Phaser.Curves.Spline#getBounds", "kind": "function", "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.", "since": "3.0.0", "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.Spline", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getBounds", "inherited": true, "___id": "T000002R046325", "___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.Geom.Point[]} An Array of Point objects.\r\n */", "meta": { "filename": "Curve.js", "lineno": 169, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getDistancePoints", "longname": "Phaser.Curves.Spline#getDistancePoints", "kind": "function", "description": "Returns an array of points, spaced out X distance pixels apart.\rThe smaller the distance, the larger the array will be.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } }, "description": "An Array of Point objects." } ], "memberof": "Phaser.Curves.Spline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance, in pixels, between each point along the curve.", "name": "distance" } ], "inherits": "Phaser.Curves.Curve#getDistancePoints", "inherited": true, "___id": "T000002R046326", "___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 curves end point.\r\n */", "meta": { "filename": "Curve.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getEndPoint", "longname": "Phaser.Curves.Spline#getEndPoint", "kind": "function", "description": "Get a point at the end of the curve.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "Vector2 containing the coordinates of the curves end point." } ], "memberof": "Phaser.Curves.Spline", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getEndPoint", "inherited": true, "___id": "T000002R046327", "___s": true }, { "comment": "/**\r\n * Get total curve arc length\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": 206, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getLength", "longname": "Phaser.Curves.Spline#getLength", "kind": "function", "description": "Get total curve arc length", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total length of the curve." } ], "memberof": "Phaser.Curves.Spline", "scope": "instance", "inherits": "Phaser.Curves.Curve#getLength", "inherited": true, "___id": "T000002R046328", "___s": true }, { "comment": "/**\r\n * Get a list of cumulative segment lengths.\r\n *\r\n * These lengths are\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": 222, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getLengths", "longname": "Phaser.Curves.Spline#getLengths", "kind": "function", "description": "Get a list of cumulative segment lengths.\r\rThese lengths are\r\r- [0] 0\r- [1] The first segment\r- [2] The first and second segment\r- ...\r- [divisions] All segments", "since": "3.0.0", "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.Spline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The number of divisions or segments.", "name": "divisions" } ], "inherits": "Phaser.Curves.Curve#getLengths", "inherited": true, "___id": "T000002R046329", "___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": 278, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getPointAt", "longname": "Phaser.Curves.Spline#getPointAt", "kind": "function", "description": "Get a point at a relative position on the curve, by arc length.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The point." } ], "memberof": "Phaser.Curves.Spline", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getPointAt", "inherited": true, "___id": "T000002R046330", "___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 {(array|Phaser.Math.Vector2[])} [out] - An optional array to store the points in.\r\n *\r\n * @return {(array|Phaser.Math.Vector2[])} An array of Points from the curve.\r\n */", "meta": { "filename": "Curve.js", "lineno": 300, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getPoints", "longname": "Phaser.Curves.Spline#getPoints", "kind": "function", "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.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [out,$return]", "value": "{Phaser.Math.Vector2[]} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } ] } }, "description": "An array of Points from the curve." } ], "memberof": "Phaser.Curves.Spline", "scope": "instance", "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "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" } ], "inherits": "Phaser.Curves.Curve#getPoints", "inherited": true, "___id": "T000002R046331", "___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": 349, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getRandomPoint", "longname": "Phaser.Curves.Spline#getRandomPoint", "kind": "function", "description": "Get a random point from the curve.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The point." } ], "memberof": "Phaser.Curves.Spline", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getRandomPoint", "inherited": true, "___id": "T000002R046332", "___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 {(array|Phaser.Math.Vector2[])} [out] - An optional array to store the points in.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of points.\r\n */", "meta": { "filename": "Curve.js", "lineno": 370, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getSpacedPoints", "longname": "Phaser.Curves.Spline#getSpacedPoints", "kind": "function", "description": "Get a sequence of equally spaced points (by arc distance) from the curve.\r\r`1 + divisions` points will be returned.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of points." } ], "memberof": "Phaser.Curves.Spline", "scope": "instance", "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", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "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" } ], "inherits": "Phaser.Curves.Curve#getSpacedPoints", "inherited": true, "___id": "T000002R046333", "___s": true }, { "comment": "/**\r\n * Get a unit vector tangent at a relative position on the curve.\r\n * In case any sub curve does not implement its tangent derivation,\r\n * 2 points a small delta apart will be used to find its gradient\r\n * which seems to give a reasonable approximation\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": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getTangent", "longname": "Phaser.Curves.Spline#getTangent", "kind": "function", "description": "Get a unit vector tangent at a relative position on the curve.\rIn case any sub curve does not implement its tangent derivation,\r2 points a small delta apart will be used to find its gradient\rwhich seems to give a reasonable approximation", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "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.Spline", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getTangent", "inherited": true, "___id": "T000002R046334", "___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": 472, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getTangentAt", "longname": "Phaser.Curves.Spline#getTangentAt", "kind": "function", "description": "Get a unit vector tangent at a relative position on the curve, by arc length.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The tangent vector." } ], "memberof": "Phaser.Curves.Spline", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getTangentAt", "inherited": true, "___id": "T000002R046335", "___s": true }, { "comment": "/**\r\n * Given a distance in pixels, get a t to find p.\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 distance.\r\n */", "meta": { "filename": "Curve.js", "lineno": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getTFromDistance", "longname": "Phaser.Curves.Spline#getTFromDistance", "kind": "function", "description": "Given a distance in pixels, get a t to find p.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance." } ], "memberof": "Phaser.Curves.Spline", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getTFromDistance", "inherited": true, "___id": "T000002R046336", "___s": true }, { "comment": "/**\r\n * Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equidistant.\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": 513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "getUtoTmapping", "longname": "Phaser.Curves.Spline#getUtoTmapping", "kind": "function", "description": "Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equidistant.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The equidistant value." } ], "memberof": "Phaser.Curves.Spline", "scope": "instance", "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" } ], "inherits": "Phaser.Curves.Curve#getUtoTmapping", "inherited": true, "___id": "T000002R046337", "___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": 594, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "name": "updateArcLengths", "longname": "Phaser.Curves.Spline#updateArcLengths", "kind": "function", "description": "Calculate and cache the arc lengths.", "since": "3.0.0", "see": [ "Phaser.Curves.Curve#getLengths()" ], "memberof": "Phaser.Curves.Spline", "scope": "instance", "inherits": "Phaser.Curves.Curve#updateArcLengths", "inherited": true, "___id": "T000002R046338", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "parent", "longname": "Phaser.Data.DataManagerPlugin#parent", "kind": "member", "description": "The object that this DataManager belongs to.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Data.DataManagerPlugin", "scope": "instance", "inherits": "Phaser.Data.DataManager#parent", "inherited": true, "___id": "T000002R046339", "___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": 48, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "events", "longname": "Phaser.Data.DataManagerPlugin#events", "kind": "member", "description": "The DataManager's event emitter.", "type": { "names": [ "Phaser.Events.EventEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Events.EventEmitter" } }, "since": "3.0.0", "memberof": "Phaser.Data.DataManagerPlugin", "scope": "instance", "inherits": "Phaser.Data.DataManager#events", "inherited": true, "___id": "T000002R046340", "___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": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "list", "longname": "Phaser.Data.DataManagerPlugin#list", "kind": "member", "description": "The data 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.DataManagerPlugin", "scope": "instance", "inherits": "Phaser.Data.DataManager#list", "inherited": true, "___id": "T000002R046341", "___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 `setdata` 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": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "values", "longname": "Phaser.Data.DataManagerPlugin#values", "kind": "member", "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 `setdata` 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.", "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.DataManagerPlugin", "scope": "instance", "inherits": "Phaser.Data.DataManager#values", "inherited": true, "___id": "T000002R046342", "___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": 116, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "get", "longname": "Phaser.Data.DataManagerPlugin#get", "kind": "function", "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.", "since": "3.0.0", "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.DataManagerPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Data.DataManager#get", "inherited": true, "___id": "T000002R046344", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "getAll", "longname": "Phaser.Data.DataManagerPlugin#getAll", "kind": "function", "description": "Retrieves all data values in a new object.", "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.DataManagerPlugin", "scope": "instance", "inherits": "Phaser.Data.DataManager#getAll", "inherited": true, "___id": "T000002R046345", "___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": 190, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "query", "longname": "Phaser.Data.DataManagerPlugin#query", "kind": "function", "description": "Queries the DataManager for the values of keys matching the given regular expression.", "since": "3.0.0", "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.DataManagerPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Data.DataManager#query", "inherited": true, "___id": "T000002R046346", "___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": 215, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "set", "longname": "Phaser.Data.DataManagerPlugin#set", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Data Manager instance." } ], "memberof": "Phaser.Data.DataManagerPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Data.DataManager#set", "inherited": true, "___id": "T000002R046347", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key. If the key doesn't already exist in the Data Manager then it is increased from 0.\r\n *\r\n * When the value is first set, a `setdata` event is emitted.\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": 285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "inc", "longname": "Phaser.Data.DataManagerPlugin#inc", "kind": "function", "description": "Increase a value for the given key. If the key doesn't already exist in the Data Manager then it is increased from 0.\r\rWhen the value is first set, a `setdata` event is emitted.", "fires": [ "Phaser.Data.Events#event:SET_DATA", "Phaser.Data.Events#event:CHANGE_DATA", "Phaser.Data.Events#event:CHANGE_DATA_KEY" ], "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Data Manager instance." } ], "memberof": "Phaser.Data.DataManagerPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Data.DataManager#inc", "inherited": true, "___id": "T000002R046348", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key. If the key doesn't already exist in the Data Manager then it is toggled from false.\r\n *\r\n * When the value is first set, a `setdata` event is emitted.\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": 325, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "toggle", "longname": "Phaser.Data.DataManagerPlugin#toggle", "kind": "function", "description": "Toggle a boolean value for the given key. If the key doesn't already exist in the Data Manager then it is toggled from false.\r\rWhen the value is first set, a `setdata` event is emitted.", "fires": [ "Phaser.Data.Events#event:SET_DATA", "Phaser.Data.Events#event:CHANGE_DATA", "Phaser.Data.Events#event:CHANGE_DATA_KEY" ], "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Data Manager instance." } ], "memberof": "Phaser.Data.DataManagerPlugin", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.Data.DataManager#toggle", "inherited": true, "___id": "T000002R046349", "___s": true }, { "comment": "/**\r\n * Passes all data entries to the given callback.\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": 419, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "each", "longname": "Phaser.Data.DataManagerPlugin#each", "kind": "function", "description": "Passes all data entries to the given callback.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Data Manager instance." } ], "memberof": "Phaser.Data.DataManagerPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Data.DataManager#each", "inherited": true, "___id": "T000002R046351", "___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": 451, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "merge", "longname": "Phaser.Data.DataManagerPlugin#merge", "kind": "function", "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.", "fires": [ "Phaser.Data.Events#event:SET_DATA", "Phaser.Data.Events#event:CHANGE_DATA", "Phaser.Data.Events#event:CHANGE_DATA_KEY" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Data Manager instance." } ], "memberof": "Phaser.Data.DataManagerPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Data.DataManager#merge", "inherited": true, "___id": "T000002R046352", "___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": 484, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "remove", "longname": "Phaser.Data.DataManagerPlugin#remove", "kind": "function", "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```", "fires": [ "Phaser.Data.Events#event:REMOVE_DATA" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Data Manager instance." } ], "memberof": "Phaser.Data.DataManagerPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Data.DataManager#remove", "inherited": true, "___id": "T000002R046353", "___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": 553, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "pop", "longname": "Phaser.Data.DataManagerPlugin#pop", "kind": "function", "description": "Retrieves the data associated with the given 'key', deletes it from this Data Manager, then returns it.", "fires": [ "Phaser.Data.Events#event:REMOVE_DATA" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value of the given key." } ], "memberof": "Phaser.Data.DataManagerPlugin", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the value to retrieve and delete.", "name": "key" } ], "inherits": "Phaser.Data.DataManager#pop", "inherited": true, "___id": "T000002R046355", "___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": 581, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "has", "longname": "Phaser.Data.DataManagerPlugin#has", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `true` if the key exists, otherwise `false`." } ], "memberof": "Phaser.Data.DataManagerPlugin", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to check.", "name": "key" } ], "inherits": "Phaser.Data.DataManager#has", "inherited": true, "___id": "T000002R046356", "___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": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "setFreeze", "longname": "Phaser.Data.DataManagerPlugin#setFreeze", "kind": "function", "description": "Freeze or unfreeze this Data Manager. A frozen Data Manager will block all attempts\rto create new values or update existing ones.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Data Manager instance." } ], "memberof": "Phaser.Data.DataManagerPlugin", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to freeze or unfreeze the Data Manager.", "name": "value" } ], "inherits": "Phaser.Data.DataManager#setFreeze", "inherited": true, "___id": "T000002R046357", "___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": 617, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "reset", "longname": "Phaser.Data.DataManagerPlugin#reset", "kind": "function", "description": "Delete all data in this Data Manager and unfreeze it.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Data Manager instance." } ], "memberof": "Phaser.Data.DataManagerPlugin", "scope": "instance", "inherits": "Phaser.Data.DataManager#reset", "inherited": true, "___id": "T000002R046358", "___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": 655, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "freeze", "longname": "Phaser.Data.DataManagerPlugin#freeze", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Data.DataManagerPlugin", "scope": "instance", "inherits": "Phaser.Data.DataManager#freeze", "inherited": true, "___id": "T000002R046359", "___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": 677, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "name": "count", "longname": "Phaser.Data.DataManagerPlugin#count", "kind": "member", "description": "Return the total number of entries in this Data Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Data.DataManagerPlugin", "scope": "instance", "inherits": "Phaser.Data.DataManager#count", "inherited": true, "___id": "T000002R046360", "___s": true }, { "comment": "/**\r\n * The FX_CONST type of this effect.\r\n *\r\n * @name Phaser.FX.Controller#type\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "type", "longname": "Phaser.FX.Barrel#type", "kind": "member", "description": "The FX_CONST type of this effect.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Barrel", "scope": "instance", "inherits": "Phaser.FX.Controller#type", "inherited": true, "___id": "T000002R046361", "___s": true }, { "comment": "/**\r\n * A reference to the Game Object that owns this effect.\r\n *\r\n * @name Phaser.FX.Controller#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "gameObject", "longname": "Phaser.FX.Barrel#gameObject", "kind": "member", "description": "A reference to the Game Object that owns this effect.", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.60.0", "memberof": "Phaser.FX.Barrel", "scope": "instance", "inherits": "Phaser.FX.Controller#gameObject", "inherited": true, "___id": "T000002R046362", "___s": true }, { "comment": "/**\r\n * Toggle this boolean to enable or disable this effect,\r\n * without removing and adding it from the Game Object.\r\n *\r\n * Only works for Pre FX.\r\n *\r\n * Post FX are always active.\r\n *\r\n * @name Phaser.FX.Controller#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "active", "longname": "Phaser.FX.Barrel#active", "kind": "member", "description": "Toggle this boolean to enable or disable this effect,\rwithout removing and adding it from the Game Object.\r\rOnly works for Pre FX.\r\rPost FX are always active.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Barrel", "scope": "instance", "inherits": "Phaser.FX.Controller#active", "inherited": true, "___id": "T000002R046363", "___s": true }, { "comment": "/**\r\n * Sets the active state of this FX Controller.\r\n *\r\n * A disabled FX Controller will not be updated.\r\n *\r\n * @method Phaser.FX.Controller#setActive\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} value - `true` to enable this FX Controller, or `false` to disable it.\r\n *\r\n * @return {this} This FX Controller instance.\r\n */", "meta": { "filename": "Controller.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "setActive", "longname": "Phaser.FX.Barrel#setActive", "kind": "function", "description": "Sets the active state of this FX Controller.\r\rA disabled FX Controller will not be updated.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Controller instance." } ], "memberof": "Phaser.FX.Barrel", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable this FX Controller, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.FX.Controller#setActive", "inherited": true, "___id": "T000002R046364", "___s": true }, { "comment": "/**\r\n * Destroys this FX Controller.\r\n *\r\n * @method Phaser.FX.Controller#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "destroy", "longname": "Phaser.FX.Barrel#destroy", "kind": "function", "description": "Destroys this FX Controller.", "since": "3.60.0", "memberof": "Phaser.FX.Barrel", "scope": "instance", "inherits": "Phaser.FX.Controller#destroy", "inherited": true, "___id": "T000002R046365", "___s": true }, { "comment": "/**\r\n * The FX_CONST type of this effect.\r\n *\r\n * @name Phaser.FX.Controller#type\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "type", "longname": "Phaser.FX.Bloom#type", "kind": "member", "description": "The FX_CONST type of this effect.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bloom", "scope": "instance", "inherits": "Phaser.FX.Controller#type", "inherited": true, "___id": "T000002R046366", "___s": true }, { "comment": "/**\r\n * A reference to the Game Object that owns this effect.\r\n *\r\n * @name Phaser.FX.Controller#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "gameObject", "longname": "Phaser.FX.Bloom#gameObject", "kind": "member", "description": "A reference to the Game Object that owns this effect.", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bloom", "scope": "instance", "inherits": "Phaser.FX.Controller#gameObject", "inherited": true, "___id": "T000002R046367", "___s": true }, { "comment": "/**\r\n * Toggle this boolean to enable or disable this effect,\r\n * without removing and adding it from the Game Object.\r\n *\r\n * Only works for Pre FX.\r\n *\r\n * Post FX are always active.\r\n *\r\n * @name Phaser.FX.Controller#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "active", "longname": "Phaser.FX.Bloom#active", "kind": "member", "description": "Toggle this boolean to enable or disable this effect,\rwithout removing and adding it from the Game Object.\r\rOnly works for Pre FX.\r\rPost FX are always active.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bloom", "scope": "instance", "inherits": "Phaser.FX.Controller#active", "inherited": true, "___id": "T000002R046368", "___s": true }, { "comment": "/**\r\n * Sets the active state of this FX Controller.\r\n *\r\n * A disabled FX Controller will not be updated.\r\n *\r\n * @method Phaser.FX.Controller#setActive\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} value - `true` to enable this FX Controller, or `false` to disable it.\r\n *\r\n * @return {this} This FX Controller instance.\r\n */", "meta": { "filename": "Controller.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "setActive", "longname": "Phaser.FX.Bloom#setActive", "kind": "function", "description": "Sets the active state of this FX Controller.\r\rA disabled FX Controller will not be updated.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Controller instance." } ], "memberof": "Phaser.FX.Bloom", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable this FX Controller, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.FX.Controller#setActive", "inherited": true, "___id": "T000002R046369", "___s": true }, { "comment": "/**\r\n * Destroys this FX Controller.\r\n *\r\n * @method Phaser.FX.Controller#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "destroy", "longname": "Phaser.FX.Bloom#destroy", "kind": "function", "description": "Destroys this FX Controller.", "since": "3.60.0", "memberof": "Phaser.FX.Bloom", "scope": "instance", "inherits": "Phaser.FX.Controller#destroy", "inherited": true, "___id": "T000002R046370", "___s": true }, { "comment": "/**\r\n * The FX_CONST type of this effect.\r\n *\r\n * @name Phaser.FX.Controller#type\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "type", "longname": "Phaser.FX.Blur#type", "kind": "member", "description": "The FX_CONST type of this effect.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Blur", "scope": "instance", "inherits": "Phaser.FX.Controller#type", "inherited": true, "___id": "T000002R046371", "___s": true }, { "comment": "/**\r\n * A reference to the Game Object that owns this effect.\r\n *\r\n * @name Phaser.FX.Controller#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "gameObject", "longname": "Phaser.FX.Blur#gameObject", "kind": "member", "description": "A reference to the Game Object that owns this effect.", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.60.0", "memberof": "Phaser.FX.Blur", "scope": "instance", "inherits": "Phaser.FX.Controller#gameObject", "inherited": true, "___id": "T000002R046372", "___s": true }, { "comment": "/**\r\n * Toggle this boolean to enable or disable this effect,\r\n * without removing and adding it from the Game Object.\r\n *\r\n * Only works for Pre FX.\r\n *\r\n * Post FX are always active.\r\n *\r\n * @name Phaser.FX.Controller#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "active", "longname": "Phaser.FX.Blur#active", "kind": "member", "description": "Toggle this boolean to enable or disable this effect,\rwithout removing and adding it from the Game Object.\r\rOnly works for Pre FX.\r\rPost FX are always active.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Blur", "scope": "instance", "inherits": "Phaser.FX.Controller#active", "inherited": true, "___id": "T000002R046373", "___s": true }, { "comment": "/**\r\n * Sets the active state of this FX Controller.\r\n *\r\n * A disabled FX Controller will not be updated.\r\n *\r\n * @method Phaser.FX.Controller#setActive\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} value - `true` to enable this FX Controller, or `false` to disable it.\r\n *\r\n * @return {this} This FX Controller instance.\r\n */", "meta": { "filename": "Controller.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "setActive", "longname": "Phaser.FX.Blur#setActive", "kind": "function", "description": "Sets the active state of this FX Controller.\r\rA disabled FX Controller will not be updated.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Controller instance." } ], "memberof": "Phaser.FX.Blur", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable this FX Controller, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.FX.Controller#setActive", "inherited": true, "___id": "T000002R046374", "___s": true }, { "comment": "/**\r\n * Destroys this FX Controller.\r\n *\r\n * @method Phaser.FX.Controller#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "destroy", "longname": "Phaser.FX.Blur#destroy", "kind": "function", "description": "Destroys this FX Controller.", "since": "3.60.0", "memberof": "Phaser.FX.Blur", "scope": "instance", "inherits": "Phaser.FX.Controller#destroy", "inherited": true, "___id": "T000002R046375", "___s": true }, { "comment": "/**\r\n * The FX_CONST type of this effect.\r\n *\r\n * @name Phaser.FX.Controller#type\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "type", "longname": "Phaser.FX.Bokeh#type", "kind": "member", "description": "The FX_CONST type of this effect.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bokeh", "scope": "instance", "inherits": "Phaser.FX.Controller#type", "inherited": true, "___id": "T000002R046376", "___s": true }, { "comment": "/**\r\n * A reference to the Game Object that owns this effect.\r\n *\r\n * @name Phaser.FX.Controller#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "gameObject", "longname": "Phaser.FX.Bokeh#gameObject", "kind": "member", "description": "A reference to the Game Object that owns this effect.", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bokeh", "scope": "instance", "inherits": "Phaser.FX.Controller#gameObject", "inherited": true, "___id": "T000002R046377", "___s": true }, { "comment": "/**\r\n * Toggle this boolean to enable or disable this effect,\r\n * without removing and adding it from the Game Object.\r\n *\r\n * Only works for Pre FX.\r\n *\r\n * Post FX are always active.\r\n *\r\n * @name Phaser.FX.Controller#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "active", "longname": "Phaser.FX.Bokeh#active", "kind": "member", "description": "Toggle this boolean to enable or disable this effect,\rwithout removing and adding it from the Game Object.\r\rOnly works for Pre FX.\r\rPost FX are always active.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Bokeh", "scope": "instance", "inherits": "Phaser.FX.Controller#active", "inherited": true, "___id": "T000002R046378", "___s": true }, { "comment": "/**\r\n * Sets the active state of this FX Controller.\r\n *\r\n * A disabled FX Controller will not be updated.\r\n *\r\n * @method Phaser.FX.Controller#setActive\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} value - `true` to enable this FX Controller, or `false` to disable it.\r\n *\r\n * @return {this} This FX Controller instance.\r\n */", "meta": { "filename": "Controller.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "setActive", "longname": "Phaser.FX.Bokeh#setActive", "kind": "function", "description": "Sets the active state of this FX Controller.\r\rA disabled FX Controller will not be updated.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Controller instance." } ], "memberof": "Phaser.FX.Bokeh", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable this FX Controller, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.FX.Controller#setActive", "inherited": true, "___id": "T000002R046379", "___s": true }, { "comment": "/**\r\n * Destroys this FX Controller.\r\n *\r\n * @method Phaser.FX.Controller#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "destroy", "longname": "Phaser.FX.Bokeh#destroy", "kind": "function", "description": "Destroys this FX Controller.", "since": "3.60.0", "memberof": "Phaser.FX.Bokeh", "scope": "instance", "inherits": "Phaser.FX.Controller#destroy", "inherited": true, "___id": "T000002R046380", "___s": true }, { "comment": "/**\r\n * The FX_CONST type of this effect.\r\n *\r\n * @name Phaser.FX.Controller#type\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "type", "longname": "Phaser.FX.Circle#type", "kind": "member", "description": "The FX_CONST type of this effect.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Circle", "scope": "instance", "inherits": "Phaser.FX.Controller#type", "inherited": true, "___id": "T000002R046381", "___s": true }, { "comment": "/**\r\n * A reference to the Game Object that owns this effect.\r\n *\r\n * @name Phaser.FX.Controller#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "gameObject", "longname": "Phaser.FX.Circle#gameObject", "kind": "member", "description": "A reference to the Game Object that owns this effect.", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.60.0", "memberof": "Phaser.FX.Circle", "scope": "instance", "inherits": "Phaser.FX.Controller#gameObject", "inherited": true, "___id": "T000002R046382", "___s": true }, { "comment": "/**\r\n * Toggle this boolean to enable or disable this effect,\r\n * without removing and adding it from the Game Object.\r\n *\r\n * Only works for Pre FX.\r\n *\r\n * Post FX are always active.\r\n *\r\n * @name Phaser.FX.Controller#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "active", "longname": "Phaser.FX.Circle#active", "kind": "member", "description": "Toggle this boolean to enable or disable this effect,\rwithout removing and adding it from the Game Object.\r\rOnly works for Pre FX.\r\rPost FX are always active.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Circle", "scope": "instance", "inherits": "Phaser.FX.Controller#active", "inherited": true, "___id": "T000002R046383", "___s": true }, { "comment": "/**\r\n * Sets the active state of this FX Controller.\r\n *\r\n * A disabled FX Controller will not be updated.\r\n *\r\n * @method Phaser.FX.Controller#setActive\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} value - `true` to enable this FX Controller, or `false` to disable it.\r\n *\r\n * @return {this} This FX Controller instance.\r\n */", "meta": { "filename": "Controller.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "setActive", "longname": "Phaser.FX.Circle#setActive", "kind": "function", "description": "Sets the active state of this FX Controller.\r\rA disabled FX Controller will not be updated.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Controller instance." } ], "memberof": "Phaser.FX.Circle", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable this FX Controller, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.FX.Controller#setActive", "inherited": true, "___id": "T000002R046384", "___s": true }, { "comment": "/**\r\n * Destroys this FX Controller.\r\n *\r\n * @method Phaser.FX.Controller#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "destroy", "longname": "Phaser.FX.Circle#destroy", "kind": "function", "description": "Destroys this FX Controller.", "since": "3.60.0", "memberof": "Phaser.FX.Circle", "scope": "instance", "inherits": "Phaser.FX.Controller#destroy", "inherited": true, "___id": "T000002R046385", "___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": 40, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "alpha", "longname": "Phaser.FX.ColorMatrix#alpha", "kind": "member", "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)", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "inherits": "Phaser.Display.ColorMatrix#alpha", "inherited": true, "___id": "T000002R046387", "___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": 75, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "set", "longname": "Phaser.FX.ColorMatrix#set", "kind": "function", "description": "Sets this ColorMatrix from the given array of color values.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#set", "inherited": true, "___id": "T000002R046390", "___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": 94, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "reset", "longname": "Phaser.FX.ColorMatrix#reset", "kind": "function", "description": "Resets the ColorMatrix to default values and also resets\rthe `alpha` property back to 1.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "inherits": "Phaser.Display.ColorMatrix#reset", "inherited": true, "___id": "T000002R046391", "___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": 121, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "getData", "longname": "Phaser.FX.ColorMatrix#getData", "kind": "function", "description": "Gets the ColorMatrix as a Float32Array.\r\rCan be used directly as a 1fv shader uniform value.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The ColorMatrix as a Float32Array." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "inherits": "Phaser.Display.ColorMatrix#getData", "inherited": true, "___id": "T000002R046392", "___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": 150, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "brightness", "longname": "Phaser.FX.ColorMatrix#brightness", "kind": "function", "description": "Changes the brightness of this ColorMatrix by the given amount.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#brightness", "inherited": true, "___id": "T000002R046393", "___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": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "saturate", "longname": "Phaser.FX.ColorMatrix#saturate", "kind": "function", "description": "Changes the saturation of this ColorMatrix by the given amount.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#saturate", "inherited": true, "___id": "T000002R046394", "___s": true }, { "comment": "/**\r\n * Desaturates this ColorMatrix (removes color from it).\r\n *\r\n * @method Phaser.Display.ColorMatrix#saturation\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": 203, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "saturation", "longname": "Phaser.FX.ColorMatrix#saturation", "kind": "function", "description": "Desaturates this ColorMatrix (removes color from it).", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#saturation", "inherited": true, "___id": "T000002R046395", "___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": 220, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "hue", "longname": "Phaser.FX.ColorMatrix#hue", "kind": "function", "description": "Rotates the hues of this ColorMatrix by the value given.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#hue", "inherited": true, "___id": "T000002R046396", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "grayscale", "longname": "Phaser.FX.ColorMatrix#grayscale", "kind": "function", "description": "Sets this ColorMatrix to be grayscale.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#grayscale", "inherited": true, "___id": "T000002R046397", "___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": 271, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "blackWhite", "longname": "Phaser.FX.ColorMatrix#blackWhite", "kind": "function", "description": "Sets this ColorMatrix to be black and white.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#blackWhite", "inherited": true, "___id": "T000002R046398", "___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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "contrast", "longname": "Phaser.FX.ColorMatrix#contrast", "kind": "function", "description": "Change the contrast of this ColorMatrix by the amount given.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#contrast", "inherited": true, "___id": "T000002R046399", "___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": 315, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "negative", "longname": "Phaser.FX.ColorMatrix#negative", "kind": "function", "description": "Converts this ColorMatrix to have negative values.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#negative", "inherited": true, "___id": "T000002R046400", "___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": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "desaturateLuminance", "longname": "Phaser.FX.ColorMatrix#desaturateLuminance", "kind": "function", "description": "Apply a desaturated luminance to this ColorMatrix.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#desaturateLuminance", "inherited": true, "___id": "T000002R046401", "___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": 349, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "sepia", "longname": "Phaser.FX.ColorMatrix#sepia", "kind": "function", "description": "Applies a sepia tone to this ColorMatrix.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#sepia", "inherited": true, "___id": "T000002R046402", "___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": 366, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "night", "longname": "Phaser.FX.ColorMatrix#night", "kind": "function", "description": "Applies a night vision tone to this ColorMatrix.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#night", "inherited": true, "___id": "T000002R046403", "___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": 390, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "lsd", "longname": "Phaser.FX.ColorMatrix#lsd", "kind": "function", "description": "Applies a trippy color tone to this ColorMatrix.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#lsd", "inherited": true, "___id": "T000002R046404", "___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": 407, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "brown", "longname": "Phaser.FX.ColorMatrix#brown", "kind": "function", "description": "Applies a brown tone to this ColorMatrix.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#brown", "inherited": true, "___id": "T000002R046405", "___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": 424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "vintagePinhole", "longname": "Phaser.FX.ColorMatrix#vintagePinhole", "kind": "function", "description": "Applies a vintage pinhole color effect to this ColorMatrix.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#vintagePinhole", "inherited": true, "___id": "T000002R046406", "___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": 441, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "kodachrome", "longname": "Phaser.FX.ColorMatrix#kodachrome", "kind": "function", "description": "Applies a kodachrome color effect to this ColorMatrix.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#kodachrome", "inherited": true, "___id": "T000002R046407", "___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": 458, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "technicolor", "longname": "Phaser.FX.ColorMatrix#technicolor", "kind": "function", "description": "Applies a technicolor color effect to this ColorMatrix.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#technicolor", "inherited": true, "___id": "T000002R046408", "___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": 475, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "polaroid", "longname": "Phaser.FX.ColorMatrix#polaroid", "kind": "function", "description": "Applies a polaroid color effect to this ColorMatrix.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#polaroid", "inherited": true, "___id": "T000002R046409", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "shiftToBGR", "longname": "Phaser.FX.ColorMatrix#shiftToBGR", "kind": "function", "description": "Shifts the values of this ColorMatrix into BGR order.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#shiftToBGR", "inherited": true, "___id": "T000002R046410", "___s": true }, { "comment": "/**\r\n * Multiplies the two given matrices.\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": 509, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "name": "multiply", "longname": "Phaser.FX.ColorMatrix#multiply", "kind": "function", "description": "Multiplies the two given matrices.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.FX.ColorMatrix", "scope": "instance", "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" } ], "inherits": "Phaser.Display.ColorMatrix#multiply", "inherited": true, "___id": "T000002R046411", "___s": true }, { "comment": "/**\r\n * The FX_CONST type of this effect.\r\n *\r\n * @name Phaser.FX.Controller#type\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "type", "longname": "Phaser.FX.Displacement#type", "kind": "member", "description": "The FX_CONST type of this effect.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Displacement", "scope": "instance", "inherits": "Phaser.FX.Controller#type", "inherited": true, "___id": "T000002R046412", "___s": true }, { "comment": "/**\r\n * A reference to the Game Object that owns this effect.\r\n *\r\n * @name Phaser.FX.Controller#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "gameObject", "longname": "Phaser.FX.Displacement#gameObject", "kind": "member", "description": "A reference to the Game Object that owns this effect.", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.60.0", "memberof": "Phaser.FX.Displacement", "scope": "instance", "inherits": "Phaser.FX.Controller#gameObject", "inherited": true, "___id": "T000002R046413", "___s": true }, { "comment": "/**\r\n * Toggle this boolean to enable or disable this effect,\r\n * without removing and adding it from the Game Object.\r\n *\r\n * Only works for Pre FX.\r\n *\r\n * Post FX are always active.\r\n *\r\n * @name Phaser.FX.Controller#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "active", "longname": "Phaser.FX.Displacement#active", "kind": "member", "description": "Toggle this boolean to enable or disable this effect,\rwithout removing and adding it from the Game Object.\r\rOnly works for Pre FX.\r\rPost FX are always active.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Displacement", "scope": "instance", "inherits": "Phaser.FX.Controller#active", "inherited": true, "___id": "T000002R046414", "___s": true }, { "comment": "/**\r\n * Sets the active state of this FX Controller.\r\n *\r\n * A disabled FX Controller will not be updated.\r\n *\r\n * @method Phaser.FX.Controller#setActive\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} value - `true` to enable this FX Controller, or `false` to disable it.\r\n *\r\n * @return {this} This FX Controller instance.\r\n */", "meta": { "filename": "Controller.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "setActive", "longname": "Phaser.FX.Displacement#setActive", "kind": "function", "description": "Sets the active state of this FX Controller.\r\rA disabled FX Controller will not be updated.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Controller instance." } ], "memberof": "Phaser.FX.Displacement", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable this FX Controller, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.FX.Controller#setActive", "inherited": true, "___id": "T000002R046415", "___s": true }, { "comment": "/**\r\n * Destroys this FX Controller.\r\n *\r\n * @method Phaser.FX.Controller#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "destroy", "longname": "Phaser.FX.Displacement#destroy", "kind": "function", "description": "Destroys this FX Controller.", "since": "3.60.0", "memberof": "Phaser.FX.Displacement", "scope": "instance", "inherits": "Phaser.FX.Controller#destroy", "inherited": true, "___id": "T000002R046416", "___s": true }, { "comment": "/**\r\n * The FX_CONST type of this effect.\r\n *\r\n * @name Phaser.FX.Controller#type\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "type", "longname": "Phaser.FX.Glow#type", "kind": "member", "description": "The FX_CONST type of this effect.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Glow", "scope": "instance", "inherits": "Phaser.FX.Controller#type", "inherited": true, "___id": "T000002R046417", "___s": true }, { "comment": "/**\r\n * A reference to the Game Object that owns this effect.\r\n *\r\n * @name Phaser.FX.Controller#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "gameObject", "longname": "Phaser.FX.Glow#gameObject", "kind": "member", "description": "A reference to the Game Object that owns this effect.", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.60.0", "memberof": "Phaser.FX.Glow", "scope": "instance", "inherits": "Phaser.FX.Controller#gameObject", "inherited": true, "___id": "T000002R046418", "___s": true }, { "comment": "/**\r\n * Toggle this boolean to enable or disable this effect,\r\n * without removing and adding it from the Game Object.\r\n *\r\n * Only works for Pre FX.\r\n *\r\n * Post FX are always active.\r\n *\r\n * @name Phaser.FX.Controller#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "active", "longname": "Phaser.FX.Glow#active", "kind": "member", "description": "Toggle this boolean to enable or disable this effect,\rwithout removing and adding it from the Game Object.\r\rOnly works for Pre FX.\r\rPost FX are always active.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Glow", "scope": "instance", "inherits": "Phaser.FX.Controller#active", "inherited": true, "___id": "T000002R046419", "___s": true }, { "comment": "/**\r\n * Sets the active state of this FX Controller.\r\n *\r\n * A disabled FX Controller will not be updated.\r\n *\r\n * @method Phaser.FX.Controller#setActive\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} value - `true` to enable this FX Controller, or `false` to disable it.\r\n *\r\n * @return {this} This FX Controller instance.\r\n */", "meta": { "filename": "Controller.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "setActive", "longname": "Phaser.FX.Glow#setActive", "kind": "function", "description": "Sets the active state of this FX Controller.\r\rA disabled FX Controller will not be updated.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Controller instance." } ], "memberof": "Phaser.FX.Glow", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable this FX Controller, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.FX.Controller#setActive", "inherited": true, "___id": "T000002R046420", "___s": true }, { "comment": "/**\r\n * Destroys this FX Controller.\r\n *\r\n * @method Phaser.FX.Controller#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "destroy", "longname": "Phaser.FX.Glow#destroy", "kind": "function", "description": "Destroys this FX Controller.", "since": "3.60.0", "memberof": "Phaser.FX.Glow", "scope": "instance", "inherits": "Phaser.FX.Controller#destroy", "inherited": true, "___id": "T000002R046421", "___s": true }, { "comment": "/**\r\n * The FX_CONST type of this effect.\r\n *\r\n * @name Phaser.FX.Controller#type\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "type", "longname": "Phaser.FX.Gradient#type", "kind": "member", "description": "The FX_CONST type of this effect.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Gradient", "scope": "instance", "inherits": "Phaser.FX.Controller#type", "inherited": true, "___id": "T000002R046422", "___s": true }, { "comment": "/**\r\n * A reference to the Game Object that owns this effect.\r\n *\r\n * @name Phaser.FX.Controller#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "gameObject", "longname": "Phaser.FX.Gradient#gameObject", "kind": "member", "description": "A reference to the Game Object that owns this effect.", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.60.0", "memberof": "Phaser.FX.Gradient", "scope": "instance", "inherits": "Phaser.FX.Controller#gameObject", "inherited": true, "___id": "T000002R046423", "___s": true }, { "comment": "/**\r\n * Toggle this boolean to enable or disable this effect,\r\n * without removing and adding it from the Game Object.\r\n *\r\n * Only works for Pre FX.\r\n *\r\n * Post FX are always active.\r\n *\r\n * @name Phaser.FX.Controller#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "active", "longname": "Phaser.FX.Gradient#active", "kind": "member", "description": "Toggle this boolean to enable or disable this effect,\rwithout removing and adding it from the Game Object.\r\rOnly works for Pre FX.\r\rPost FX are always active.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Gradient", "scope": "instance", "inherits": "Phaser.FX.Controller#active", "inherited": true, "___id": "T000002R046424", "___s": true }, { "comment": "/**\r\n * Sets the active state of this FX Controller.\r\n *\r\n * A disabled FX Controller will not be updated.\r\n *\r\n * @method Phaser.FX.Controller#setActive\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} value - `true` to enable this FX Controller, or `false` to disable it.\r\n *\r\n * @return {this} This FX Controller instance.\r\n */", "meta": { "filename": "Controller.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "setActive", "longname": "Phaser.FX.Gradient#setActive", "kind": "function", "description": "Sets the active state of this FX Controller.\r\rA disabled FX Controller will not be updated.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Controller instance." } ], "memberof": "Phaser.FX.Gradient", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable this FX Controller, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.FX.Controller#setActive", "inherited": true, "___id": "T000002R046425", "___s": true }, { "comment": "/**\r\n * Destroys this FX Controller.\r\n *\r\n * @method Phaser.FX.Controller#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "destroy", "longname": "Phaser.FX.Gradient#destroy", "kind": "function", "description": "Destroys this FX Controller.", "since": "3.60.0", "memberof": "Phaser.FX.Gradient", "scope": "instance", "inherits": "Phaser.FX.Controller#destroy", "inherited": true, "___id": "T000002R046426", "___s": true }, { "comment": "/**\r\n * The FX_CONST type of this effect.\r\n *\r\n * @name Phaser.FX.Controller#type\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "type", "longname": "Phaser.FX.Pixelate#type", "kind": "member", "description": "The FX_CONST type of this effect.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Pixelate", "scope": "instance", "inherits": "Phaser.FX.Controller#type", "inherited": true, "___id": "T000002R046427", "___s": true }, { "comment": "/**\r\n * A reference to the Game Object that owns this effect.\r\n *\r\n * @name Phaser.FX.Controller#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "gameObject", "longname": "Phaser.FX.Pixelate#gameObject", "kind": "member", "description": "A reference to the Game Object that owns this effect.", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.60.0", "memberof": "Phaser.FX.Pixelate", "scope": "instance", "inherits": "Phaser.FX.Controller#gameObject", "inherited": true, "___id": "T000002R046428", "___s": true }, { "comment": "/**\r\n * Toggle this boolean to enable or disable this effect,\r\n * without removing and adding it from the Game Object.\r\n *\r\n * Only works for Pre FX.\r\n *\r\n * Post FX are always active.\r\n *\r\n * @name Phaser.FX.Controller#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "active", "longname": "Phaser.FX.Pixelate#active", "kind": "member", "description": "Toggle this boolean to enable or disable this effect,\rwithout removing and adding it from the Game Object.\r\rOnly works for Pre FX.\r\rPost FX are always active.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Pixelate", "scope": "instance", "inherits": "Phaser.FX.Controller#active", "inherited": true, "___id": "T000002R046429", "___s": true }, { "comment": "/**\r\n * Sets the active state of this FX Controller.\r\n *\r\n * A disabled FX Controller will not be updated.\r\n *\r\n * @method Phaser.FX.Controller#setActive\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} value - `true` to enable this FX Controller, or `false` to disable it.\r\n *\r\n * @return {this} This FX Controller instance.\r\n */", "meta": { "filename": "Controller.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "setActive", "longname": "Phaser.FX.Pixelate#setActive", "kind": "function", "description": "Sets the active state of this FX Controller.\r\rA disabled FX Controller will not be updated.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Controller instance." } ], "memberof": "Phaser.FX.Pixelate", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable this FX Controller, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.FX.Controller#setActive", "inherited": true, "___id": "T000002R046430", "___s": true }, { "comment": "/**\r\n * Destroys this FX Controller.\r\n *\r\n * @method Phaser.FX.Controller#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "destroy", "longname": "Phaser.FX.Pixelate#destroy", "kind": "function", "description": "Destroys this FX Controller.", "since": "3.60.0", "memberof": "Phaser.FX.Pixelate", "scope": "instance", "inherits": "Phaser.FX.Controller#destroy", "inherited": true, "___id": "T000002R046431", "___s": true }, { "comment": "/**\r\n * The FX_CONST type of this effect.\r\n *\r\n * @name Phaser.FX.Controller#type\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "type", "longname": "Phaser.FX.Shadow#type", "kind": "member", "description": "The FX_CONST type of this effect.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Shadow", "scope": "instance", "inherits": "Phaser.FX.Controller#type", "inherited": true, "___id": "T000002R046432", "___s": true }, { "comment": "/**\r\n * A reference to the Game Object that owns this effect.\r\n *\r\n * @name Phaser.FX.Controller#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "gameObject", "longname": "Phaser.FX.Shadow#gameObject", "kind": "member", "description": "A reference to the Game Object that owns this effect.", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.60.0", "memberof": "Phaser.FX.Shadow", "scope": "instance", "inherits": "Phaser.FX.Controller#gameObject", "inherited": true, "___id": "T000002R046433", "___s": true }, { "comment": "/**\r\n * Toggle this boolean to enable or disable this effect,\r\n * without removing and adding it from the Game Object.\r\n *\r\n * Only works for Pre FX.\r\n *\r\n * Post FX are always active.\r\n *\r\n * @name Phaser.FX.Controller#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "active", "longname": "Phaser.FX.Shadow#active", "kind": "member", "description": "Toggle this boolean to enable or disable this effect,\rwithout removing and adding it from the Game Object.\r\rOnly works for Pre FX.\r\rPost FX are always active.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Shadow", "scope": "instance", "inherits": "Phaser.FX.Controller#active", "inherited": true, "___id": "T000002R046434", "___s": true }, { "comment": "/**\r\n * Sets the active state of this FX Controller.\r\n *\r\n * A disabled FX Controller will not be updated.\r\n *\r\n * @method Phaser.FX.Controller#setActive\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} value - `true` to enable this FX Controller, or `false` to disable it.\r\n *\r\n * @return {this} This FX Controller instance.\r\n */", "meta": { "filename": "Controller.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "setActive", "longname": "Phaser.FX.Shadow#setActive", "kind": "function", "description": "Sets the active state of this FX Controller.\r\rA disabled FX Controller will not be updated.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Controller instance." } ], "memberof": "Phaser.FX.Shadow", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable this FX Controller, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.FX.Controller#setActive", "inherited": true, "___id": "T000002R046435", "___s": true }, { "comment": "/**\r\n * Destroys this FX Controller.\r\n *\r\n * @method Phaser.FX.Controller#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "destroy", "longname": "Phaser.FX.Shadow#destroy", "kind": "function", "description": "Destroys this FX Controller.", "since": "3.60.0", "memberof": "Phaser.FX.Shadow", "scope": "instance", "inherits": "Phaser.FX.Controller#destroy", "inherited": true, "___id": "T000002R046436", "___s": true }, { "comment": "/**\r\n * The FX_CONST type of this effect.\r\n *\r\n * @name Phaser.FX.Controller#type\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "type", "longname": "Phaser.FX.Shine#type", "kind": "member", "description": "The FX_CONST type of this effect.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Shine", "scope": "instance", "inherits": "Phaser.FX.Controller#type", "inherited": true, "___id": "T000002R046437", "___s": true }, { "comment": "/**\r\n * A reference to the Game Object that owns this effect.\r\n *\r\n * @name Phaser.FX.Controller#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "gameObject", "longname": "Phaser.FX.Shine#gameObject", "kind": "member", "description": "A reference to the Game Object that owns this effect.", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.60.0", "memberof": "Phaser.FX.Shine", "scope": "instance", "inherits": "Phaser.FX.Controller#gameObject", "inherited": true, "___id": "T000002R046438", "___s": true }, { "comment": "/**\r\n * Toggle this boolean to enable or disable this effect,\r\n * without removing and adding it from the Game Object.\r\n *\r\n * Only works for Pre FX.\r\n *\r\n * Post FX are always active.\r\n *\r\n * @name Phaser.FX.Controller#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "active", "longname": "Phaser.FX.Shine#active", "kind": "member", "description": "Toggle this boolean to enable or disable this effect,\rwithout removing and adding it from the Game Object.\r\rOnly works for Pre FX.\r\rPost FX are always active.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Shine", "scope": "instance", "inherits": "Phaser.FX.Controller#active", "inherited": true, "___id": "T000002R046439", "___s": true }, { "comment": "/**\r\n * Sets the active state of this FX Controller.\r\n *\r\n * A disabled FX Controller will not be updated.\r\n *\r\n * @method Phaser.FX.Controller#setActive\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} value - `true` to enable this FX Controller, or `false` to disable it.\r\n *\r\n * @return {this} This FX Controller instance.\r\n */", "meta": { "filename": "Controller.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "setActive", "longname": "Phaser.FX.Shine#setActive", "kind": "function", "description": "Sets the active state of this FX Controller.\r\rA disabled FX Controller will not be updated.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Controller instance." } ], "memberof": "Phaser.FX.Shine", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable this FX Controller, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.FX.Controller#setActive", "inherited": true, "___id": "T000002R046440", "___s": true }, { "comment": "/**\r\n * Destroys this FX Controller.\r\n *\r\n * @method Phaser.FX.Controller#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "destroy", "longname": "Phaser.FX.Shine#destroy", "kind": "function", "description": "Destroys this FX Controller.", "since": "3.60.0", "memberof": "Phaser.FX.Shine", "scope": "instance", "inherits": "Phaser.FX.Controller#destroy", "inherited": true, "___id": "T000002R046441", "___s": true }, { "comment": "/**\r\n * The FX_CONST type of this effect.\r\n *\r\n * @name Phaser.FX.Controller#type\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "type", "longname": "Phaser.FX.Vignette#type", "kind": "member", "description": "The FX_CONST type of this effect.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Vignette", "scope": "instance", "inherits": "Phaser.FX.Controller#type", "inherited": true, "___id": "T000002R046442", "___s": true }, { "comment": "/**\r\n * A reference to the Game Object that owns this effect.\r\n *\r\n * @name Phaser.FX.Controller#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "gameObject", "longname": "Phaser.FX.Vignette#gameObject", "kind": "member", "description": "A reference to the Game Object that owns this effect.", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.60.0", "memberof": "Phaser.FX.Vignette", "scope": "instance", "inherits": "Phaser.FX.Controller#gameObject", "inherited": true, "___id": "T000002R046443", "___s": true }, { "comment": "/**\r\n * Toggle this boolean to enable or disable this effect,\r\n * without removing and adding it from the Game Object.\r\n *\r\n * Only works for Pre FX.\r\n *\r\n * Post FX are always active.\r\n *\r\n * @name Phaser.FX.Controller#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "active", "longname": "Phaser.FX.Vignette#active", "kind": "member", "description": "Toggle this boolean to enable or disable this effect,\rwithout removing and adding it from the Game Object.\r\rOnly works for Pre FX.\r\rPost FX are always active.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Vignette", "scope": "instance", "inherits": "Phaser.FX.Controller#active", "inherited": true, "___id": "T000002R046444", "___s": true }, { "comment": "/**\r\n * Sets the active state of this FX Controller.\r\n *\r\n * A disabled FX Controller will not be updated.\r\n *\r\n * @method Phaser.FX.Controller#setActive\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} value - `true` to enable this FX Controller, or `false` to disable it.\r\n *\r\n * @return {this} This FX Controller instance.\r\n */", "meta": { "filename": "Controller.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "setActive", "longname": "Phaser.FX.Vignette#setActive", "kind": "function", "description": "Sets the active state of this FX Controller.\r\rA disabled FX Controller will not be updated.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Controller instance." } ], "memberof": "Phaser.FX.Vignette", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable this FX Controller, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.FX.Controller#setActive", "inherited": true, "___id": "T000002R046445", "___s": true }, { "comment": "/**\r\n * Destroys this FX Controller.\r\n *\r\n * @method Phaser.FX.Controller#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "destroy", "longname": "Phaser.FX.Vignette#destroy", "kind": "function", "description": "Destroys this FX Controller.", "since": "3.60.0", "memberof": "Phaser.FX.Vignette", "scope": "instance", "inherits": "Phaser.FX.Controller#destroy", "inherited": true, "___id": "T000002R046446", "___s": true }, { "comment": "/**\r\n * The FX_CONST type of this effect.\r\n *\r\n * @name Phaser.FX.Controller#type\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 29, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "type", "longname": "Phaser.FX.Wipe#type", "kind": "member", "description": "The FX_CONST type of this effect.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.FX.Wipe", "scope": "instance", "inherits": "Phaser.FX.Controller#type", "inherited": true, "___id": "T000002R046447", "___s": true }, { "comment": "/**\r\n * A reference to the Game Object that owns this effect.\r\n *\r\n * @name Phaser.FX.Controller#gameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "gameObject", "longname": "Phaser.FX.Wipe#gameObject", "kind": "member", "description": "A reference to the Game Object that owns this effect.", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.60.0", "memberof": "Phaser.FX.Wipe", "scope": "instance", "inherits": "Phaser.FX.Controller#gameObject", "inherited": true, "___id": "T000002R046448", "___s": true }, { "comment": "/**\r\n * Toggle this boolean to enable or disable this effect,\r\n * without removing and adding it from the Game Object.\r\n *\r\n * Only works for Pre FX.\r\n *\r\n * Post FX are always active.\r\n *\r\n * @name Phaser.FX.Controller#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "active", "longname": "Phaser.FX.Wipe#active", "kind": "member", "description": "Toggle this boolean to enable or disable this effect,\rwithout removing and adding it from the Game Object.\r\rOnly works for Pre FX.\r\rPost FX are always active.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.FX.Wipe", "scope": "instance", "inherits": "Phaser.FX.Controller#active", "inherited": true, "___id": "T000002R046449", "___s": true }, { "comment": "/**\r\n * Sets the active state of this FX Controller.\r\n *\r\n * A disabled FX Controller will not be updated.\r\n *\r\n * @method Phaser.FX.Controller#setActive\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} value - `true` to enable this FX Controller, or `false` to disable it.\r\n *\r\n * @return {this} This FX Controller instance.\r\n */", "meta": { "filename": "Controller.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "setActive", "longname": "Phaser.FX.Wipe#setActive", "kind": "function", "description": "Sets the active state of this FX Controller.\r\rA disabled FX Controller will not be updated.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FX Controller instance." } ], "memberof": "Phaser.FX.Wipe", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable this FX Controller, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.FX.Controller#setActive", "inherited": true, "___id": "T000002R046450", "___s": true }, { "comment": "/**\r\n * Destroys this FX Controller.\r\n *\r\n * @method Phaser.FX.Controller#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\fx", "code": {} }, "name": "destroy", "longname": "Phaser.FX.Wipe#destroy", "kind": "function", "description": "Destroys this FX Controller.", "since": "3.60.0", "memberof": "Phaser.FX.Wipe", "scope": "instance", "inherits": "Phaser.FX.Controller#destroy", "inherited": true, "___id": "T000002R046451", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.GameObject#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObject", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R046452", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.GameObject#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.GameObject", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R046453", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.GameObject#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.GameObject", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R046454", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.GameObject#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.GameObject", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R046455", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.GameObject#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.GameObject", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R046456", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.GameObject#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.GameObject", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R046457", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.GameObject#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.GameObject", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R046458", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.GameObject#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.GameObject", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R046459", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.GameObject#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.GameObject", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R046460", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.GameObject#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.GameObject", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R046461", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.GameObject#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.GameObject", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R046462", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.BitmapText#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R046463", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.BitmapText#displayList", "kind": "member", "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.", "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.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R046464", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.BitmapText#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R046465", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.BitmapText#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R046466", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.BitmapText#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R046467", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.BitmapText#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R046468", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.BitmapText#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R046469", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.BitmapText#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R046470", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.BitmapText#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R046471", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.BitmapText#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R046472", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.BitmapText#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R046473", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.BitmapText#input", "kind": "member", "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()`.", "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.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R046474", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.BitmapText#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R046475", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.BitmapText#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R046476", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.BitmapText#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R046477", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.BitmapText#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R046478", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.BitmapText#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R046479", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.BitmapText#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R046480", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.BitmapText#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R046481", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.BitmapText#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R046482", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.BitmapText#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R046483", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.BitmapText#getData", "kind": "function", "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.", "since": "3.0.0", "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.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R046484", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.BitmapText#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R046485", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.BitmapText#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R046486", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.BitmapText#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R046487", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.BitmapText#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R046488", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.BitmapText#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R046489", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.BitmapText#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R046490", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.BitmapText#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R046491", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.BitmapText#getIndexList", "kind": "function", "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.", "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.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R046492", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.BitmapText#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R046493", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.BitmapText#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R046494", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.BitmapText#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R046495", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.BitmapText#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R046496", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.BitmapText#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R046497", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.BitmapText#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R046498", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.BitmapText#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R046499", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.BitmapText#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R046500", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.BitmapText#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R046501", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.BitmapText#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R046502", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.BitmapText#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R046503", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.BitmapText#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R046504", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.BitmapText#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R046505", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.BitmapText#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R046506", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.BitmapText#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R046507", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.BitmapText#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R046508", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.BitmapText#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "___id": "T000002R046514", "___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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.BitmapText#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Alpha#setAlpha", "inherited": true, "___id": "T000002R046515", "___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 *\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.BitmapText#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alpha", "inherited": true, "___id": "T000002R046516", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.GameObjects.BitmapText#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "___id": "T000002R046517", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.GameObjects.BitmapText#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "___id": "T000002R046518", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.GameObjects.BitmapText#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "___id": "T000002R046519", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.GameObjects.BitmapText#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "___id": "T000002R046520", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.BitmapText#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R046522", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.BitmapText#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R046523", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.BitmapText#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R046525", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.BitmapText#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R046526", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.BitmapText#getCenter", "kind": "function", "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`.", "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]" } ], "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.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "___id": "T000002R046528", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.BitmapText#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "___id": "T000002R046529", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.BitmapText#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "___id": "T000002R046530", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.BitmapText#getTopRight", "kind": "function", "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`.", "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]" } ], "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.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "___id": "T000002R046531", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.BitmapText#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "___id": "T000002R046532", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.BitmapText#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "___id": "T000002R046533", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.BitmapText#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "___id": "T000002R046534", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.BitmapText#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "___id": "T000002R046535", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.BitmapText#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "___id": "T000002R046536", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.BitmapText#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "___id": "T000002R046537", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.BitmapText#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R046538", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.BitmapText#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R046539", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.BitmapText#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R046540", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.BitmapText#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R046541", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.BitmapText#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R046542", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.BitmapText#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R046544", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.BitmapText#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R046545", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.BitmapText#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R046546", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.BitmapText#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R046547", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.BitmapText#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "___id": "T000002R046548", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.BitmapText#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R046549", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.BitmapText#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "___id": "T000002R046550", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.BitmapText#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R046551", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.BitmapText#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R046552", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.BitmapText#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R046553", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.BitmapText#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "___id": "T000002R046554", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.BitmapText#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "___id": "T000002R046555", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.BitmapText#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "___id": "T000002R046556", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.BitmapText#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "___id": "T000002R046557", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.BitmapText#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R046558", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.BitmapText#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R046559", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.BitmapText#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R046560", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.BitmapText#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R046561", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.BitmapText#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R046562", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.BitmapText#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R046563", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.BitmapText#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R046564", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.BitmapText#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R046565", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.BitmapText#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R046566", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.BitmapText#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R046567", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.BitmapText#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R046568", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.BitmapText#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R046569", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.BitmapText#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R046570", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.BitmapText#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R046571", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.BitmapText#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R046572", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.BitmapText#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R046573", "___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": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "texture", "longname": "Phaser.GameObjects.BitmapText#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#texture", "inherited": true, "___id": "T000002R046574", "___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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "frame", "longname": "Phaser.GameObjects.BitmapText#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#frame", "inherited": true, "___id": "T000002R046575", "___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": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.GameObjects.BitmapText#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Texture#setTexture", "inherited": true, "___id": "T000002R046577", "___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": 75, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.GameObjects.BitmapText#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Texture#setFrame", "inherited": true, "___id": "T000002R046578", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertice 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": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopLeft", "longname": "Phaser.GameObjects.BitmapText#tintTopLeft", "kind": "member", "description": "The tint value being applied to the top-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopLeft", "inherited": true, "___id": "T000002R046579", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-right vertice 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopRight", "longname": "Phaser.GameObjects.BitmapText#tintTopRight", "kind": "member", "description": "The tint value being applied to the top-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopRight", "inherited": true, "___id": "T000002R046580", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-left vertice 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": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomLeft", "longname": "Phaser.GameObjects.BitmapText#tintBottomLeft", "kind": "member", "description": "The tint value being applied to the bottom-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "inherited": true, "___id": "T000002R046581", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-right vertice 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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomRight", "longname": "Phaser.GameObjects.BitmapText#tintBottomRight", "kind": "member", "description": "The tint value being applied to the bottom-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomRight", "inherited": true, "___id": "T000002R046582", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintFill", "longname": "Phaser.GameObjects.BitmapText#tintFill", "kind": "member", "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.11.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintFill", "inherited": true, "___id": "T000002R046583", "___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 'additive',\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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearTint", "longname": "Phaser.GameObjects.BitmapText#clearTint", "kind": "function", "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff and the tint type to 'additive',\rwhich results in no visible change to the texture.", "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.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#clearTint", "inherited": true, "___id": "T000002R046584", "___s": true }, { "comment": "/**\r\n * Sets an additive tint 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 * multiplying it by 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 * To swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.\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": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTint", "longname": "Phaser.GameObjects.BitmapText#setTint", "kind": "function", "description": "Sets an additive tint on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by 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\rTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.", "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.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Tint#setTint", "inherited": true, "___id": "T000002R046585", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on this Game Object.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. You can provide either one color value, in which case the whole\r\n * Game Object will be rendered in that color. Or you can provide a color per corner. The colors\r\n * 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 * To swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintFill\r\n * @webglOnly\r\n * @since 3.11.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.\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": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTintFill", "longname": "Phaser.GameObjects.BitmapText#setTintFill", "kind": "function", "description": "Sets a fill-based tint on this Game Object.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. You can provide either one color value, in which case the whole\rGame Object will be rendered in that color. Or you can provide a color per corner. The colors\rare 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\rTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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 not 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" } ], "inherits": "Phaser.GameObjects.Components.Tint#setTintFill", "inherited": true, "___id": "T000002R046586", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.\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": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tint", "longname": "Phaser.GameObjects.BitmapText#tint", "kind": "member", "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tint", "inherited": true, "___id": "T000002R046587", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * It checks to see if the 4 tint properties are set to the value 0xffffff\r\n * and that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.\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": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isTinted", "longname": "Phaser.GameObjects.BitmapText#isTinted", "kind": "member", "description": "Does this Game Object have a tint applied?\r\rIt checks to see if the 4 tint properties are set to the value 0xffffff\rand that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "readonly": true, "since": "3.11.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#isTinted", "inherited": true, "___id": "T000002R046588", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.BitmapText#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R046589", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.BitmapText#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R046593", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.BitmapText#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R046594", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.BitmapText#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R046595", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.BitmapText#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R046596", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.BitmapText#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R046597", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.BitmapText#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R046598", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.BitmapText#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R046599", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.BitmapText#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R046600", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.BitmapText#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R046601", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.BitmapText#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R046602", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.BitmapText#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R046603", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.BitmapText#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R046604", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.BitmapText#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R046605", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.BitmapText#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R046606", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.BitmapText#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R046607", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.BitmapText#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R046608", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.BitmapText#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R046609", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.BitmapText#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R046610", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.BitmapText#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R046611", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.BitmapText#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R046612", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.BitmapText#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R046613", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.BitmapText#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R046614", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.BitmapText#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R046615", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.BitmapText#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R046617", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.BitmapText#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R046618", "___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": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "font", "longname": "Phaser.GameObjects.DynamicBitmapText#font", "kind": "member", "description": "The key of the Bitmap Font used by this Bitmap Text.\rTo change the font after creation please use `setFont`.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#font", "inherited": true, "___id": "T000002R046619", "___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": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "fontData", "longname": "Phaser.GameObjects.DynamicBitmapText#fontData", "kind": "member", "description": "The data of the Bitmap Font used by this Bitmap Text.", "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#fontData", "inherited": true, "___id": "T000002R046620", "___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": 220, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "wordWrapCharCode", "longname": "Phaser.GameObjects.DynamicBitmapText#wordWrapCharCode", "kind": "member", "description": "The character code used to detect for word wrapping.\rDefaults to 32 (a space character).", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.21.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#wordWrapCharCode", "inherited": true, "___id": "T000002R046629", "___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": 240, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "dropShadowX", "longname": "Phaser.GameObjects.DynamicBitmapText#dropShadowX", "kind": "member", "description": "The horizontal offset of the drop shadow.\r\rYou can set this directly, or use `Phaser.GameObjects.BitmapText#setDropShadow`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#dropShadowX", "inherited": true, "___id": "T000002R046631", "___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": 251, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "dropShadowY", "longname": "Phaser.GameObjects.DynamicBitmapText#dropShadowY", "kind": "member", "description": "The vertical offset of the drop shadow.\r\rYou can set this directly, or use `Phaser.GameObjects.BitmapText#setDropShadow`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#dropShadowY", "inherited": true, "___id": "T000002R046632", "___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": 262, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "dropShadowColor", "longname": "Phaser.GameObjects.DynamicBitmapText#dropShadowColor", "kind": "member", "description": "The color of the drop shadow.\r\rYou can set this directly, or use `Phaser.GameObjects.BitmapText#setDropShadow`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#dropShadowColor", "inherited": true, "___id": "T000002R046633", "___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": 273, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "dropShadowAlpha", "longname": "Phaser.GameObjects.DynamicBitmapText#dropShadowAlpha", "kind": "member", "description": "The alpha value of the drop shadow.\r\rYou can set this directly, or use `Phaser.GameObjects.BitmapText#setDropShadow`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#dropShadowAlpha", "inherited": true, "___id": "T000002R046634", "___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": 284, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "fromAtlas", "longname": "Phaser.GameObjects.DynamicBitmapText#fromAtlas", "kind": "member", "description": "Indicates whether the font texture is from an atlas or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.54.0", "readonly": true, "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#fromAtlas", "inherited": true, "___id": "T000002R046635", "___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": 303, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "setLeftAlign", "longname": "Phaser.GameObjects.DynamicBitmapText#setLeftAlign", "kind": "function", "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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#setLeftAlign", "inherited": true, "___id": "T000002R046636", "___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": 321, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "setCenterAlign", "longname": "Phaser.GameObjects.DynamicBitmapText#setCenterAlign", "kind": "function", "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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#setCenterAlign", "inherited": true, "___id": "T000002R046637", "___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": 339, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "setRightAlign", "longname": "Phaser.GameObjects.DynamicBitmapText#setRightAlign", "kind": "function", "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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#setRightAlign", "inherited": true, "___id": "T000002R046638", "___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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "setFontSize", "longname": "Phaser.GameObjects.DynamicBitmapText#setFontSize", "kind": "function", "description": "Set the font size of this Bitmap Text.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The font size to set.", "name": "size" } ], "inherits": "Phaser.GameObjects.BitmapText#setFontSize", "inherited": true, "___id": "T000002R046639", "___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": 376, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "setLetterSpacing", "longname": "Phaser.GameObjects.DynamicBitmapText#setLetterSpacing", "kind": "function", "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.", "since": "3.4.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.BitmapText#setLetterSpacing", "inherited": true, "___id": "T000002R046640", "___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": 399, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "setLineSpacing", "longname": "Phaser.GameObjects.DynamicBitmapText#setLineSpacing", "kind": "function", "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.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.BitmapText#setLineSpacing", "inherited": true, "___id": "T000002R046641", "___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": 423, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "setText", "longname": "Phaser.GameObjects.DynamicBitmapText#setText", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.BitmapText#setText", "inherited": true, "___id": "T000002R046642", "___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": 459, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "setDropShadow", "longname": "Phaser.GameObjects.DynamicBitmapText#setDropShadow", "kind": "function", "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.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.BitmapText#setDropShadow", "inherited": true, "___id": "T000002R046643", "___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 works by taking the pixel color values from the Bitmap Text texture, and then\r\n * multiplying it by the color value of the tint. 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 swap this from being an additive tint to a fill based tint, set the `tintFill` parameter to `true`.\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 {boolean} [tintFill=false] - Use a fill-based tint (true), or an additive tint (false)\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the character. If not 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": 497, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "setCharacterTint", "longname": "Phaser.GameObjects.DynamicBitmapText#setCharacterTint", "kind": "function", "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 works by taking the pixel color values from the Bitmap Text texture, and then\rmultiplying it by the color value of the tint. You 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 swap this from being an additive tint to a fill based tint, set the `tintFill` parameter to `true`.\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.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "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": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Use a fill-based tint (true), or an additive tint (false)", "name": "tintFill" }, { "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 not 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" } ], "inherits": "Phaser.GameObjects.BitmapText#setCharacterTint", "inherited": true, "___id": "T000002R046644", "___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, if till that word, based on its offset within the text contents.\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 works by taking the pixel color values from the Bitmap Text texture, and then\r\n * multiplying it by the color value of the tint. 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 swap this from being an additive tint to a fill based tint, set the `tintFill` parameter to `true`.\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 {boolean} [tintFill=false] - Use a fill-based tint (true), or an additive tint (false)\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the word. If not 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": 606, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "setWordTint", "longname": "Phaser.GameObjects.DynamicBitmapText#setWordTint", "kind": "function", "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, if till that word, based on its offset within the text contents.\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 works by taking the pixel color values from the Bitmap Text texture, and then\rmultiplying it by the color value of the tint. You 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 swap this from being an additive tint to a fill based tint, set the `tintFill` parameter to `true`.\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.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "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": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Use a fill-based tint (true), or an additive tint (false)", "name": "tintFill" }, { "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 not 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" } ], "inherits": "Phaser.GameObjects.BitmapText#setWordTint", "inherited": true, "___id": "T000002R046645", "___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": 679, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "getTextBounds", "longname": "Phaser.GameObjects.DynamicBitmapText#getTextBounds", "kind": "function", "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.", "since": "3.0.0", "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.DynamicBitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.BitmapText#getTextBounds", "inherited": true, "___id": "T000002R046646", "___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": 716, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "getCharacterAt", "longname": "Phaser.GameObjects.DynamicBitmapText#getCharacterAt", "kind": "function", "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.", "since": "3.50.0", "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.DynamicBitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.BitmapText#getCharacterAt", "inherited": true, "___id": "T000002R046647", "___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": 765, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.DynamicBitmapText#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#updateDisplayOrigin", "inherited": true, "___id": "T000002R046648", "___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 test, 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": 783, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "setFont", "longname": "Phaser.GameObjects.DynamicBitmapText#setFont", "kind": "function", "description": "Changes the font this BitmapText is using to render.\r\rThe new texture is loaded and applied to the BitmapText. The existing test, size and alignment are preserved,\runless overridden via the arguments.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.BitmapText#setFont", "inherited": true, "___id": "T000002R046649", "___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": 824, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "setMaxWidth", "longname": "Phaser.GameObjects.DynamicBitmapText#setMaxWidth", "kind": "function", "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.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.BitmapText#setMaxWidth", "inherited": true, "___id": "T000002R046650", "___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": 858, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "align", "longname": "Phaser.GameObjects.DynamicBitmapText#align", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#align", "inherited": true, "___id": "T000002R046651", "___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": 891, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "text", "longname": "Phaser.GameObjects.DynamicBitmapText#text", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#text", "inherited": true, "___id": "T000002R046652", "___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": 914, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "fontSize", "longname": "Phaser.GameObjects.DynamicBitmapText#fontSize", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#fontSize", "inherited": true, "___id": "T000002R046653", "___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": 938, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "letterSpacing", "longname": "Phaser.GameObjects.DynamicBitmapText#letterSpacing", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#letterSpacing", "inherited": true, "___id": "T000002R046654", "___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": 964, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "lineSpacing", "longname": "Phaser.GameObjects.DynamicBitmapText#lineSpacing", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#lineSpacing", "inherited": true, "___id": "T000002R046655", "___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": 990, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "maxWidth", "longname": "Phaser.GameObjects.DynamicBitmapText#maxWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.21.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#maxWidth", "inherited": true, "___id": "T000002R046656", "___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": 1019, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.DynamicBitmapText#width", "kind": "member", "description": "The width of this Bitmap Text.\r\rThis property is read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#width", "inherited": true, "___id": "T000002R046657", "___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": 1040, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.DynamicBitmapText#height", "kind": "member", "description": "The height of this Bitmap text.\r\rThis property is read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#height", "inherited": true, "___id": "T000002R046658", "___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": 1061, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.DynamicBitmapText#displayWidth", "kind": "member", "description": "The displayed width of this Bitmap Text.\r\rThis value takes into account the scale factor.\r\rThis property is read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#displayWidth", "inherited": true, "___id": "T000002R046659", "___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": 1082, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.DynamicBitmapText#displayHeight", "kind": "member", "description": "The displayed height of this Bitmap Text.\r\rThis value takes into account the scale factor.\r\rThis property is read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#displayHeight", "inherited": true, "___id": "T000002R046660", "___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": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.DynamicBitmapText#toJSON", "kind": "function", "description": "Build a JSON representation of this Bitmap Text.", "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#toJSON", "inherited": true, "___id": "T000002R046661", "___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": 1131, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "name": "preDestroy", "longname": "Phaser.GameObjects.DynamicBitmapText#preDestroy", "kind": "function", "description": "Internal destroy handler, called as part of the destroy process.", "access": "protected", "since": "3.50.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.BitmapText#preDestroy", "inherited": true, "___id": "T000002R046662", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.DynamicBitmapText#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R046663", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.DynamicBitmapText#displayList", "kind": "member", "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.", "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R046664", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.DynamicBitmapText#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R046665", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.DynamicBitmapText#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R046666", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.DynamicBitmapText#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R046667", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.DynamicBitmapText#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R046668", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.DynamicBitmapText#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R046669", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.DynamicBitmapText#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R046670", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.DynamicBitmapText#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R046671", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.DynamicBitmapText#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R046672", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.DynamicBitmapText#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R046673", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.DynamicBitmapText#input", "kind": "member", "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()`.", "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R046674", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.DynamicBitmapText#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R046675", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.DynamicBitmapText#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R046676", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.DynamicBitmapText#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R046677", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.DynamicBitmapText#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R046678", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.DynamicBitmapText#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R046679", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.DynamicBitmapText#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R046680", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.DynamicBitmapText#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R046681", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.DynamicBitmapText#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R046682", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.DynamicBitmapText#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R046683", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.DynamicBitmapText#getData", "kind": "function", "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.", "since": "3.0.0", "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R046684", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.DynamicBitmapText#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R046685", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.DynamicBitmapText#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R046686", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.DynamicBitmapText#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R046687", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.DynamicBitmapText#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R046688", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.DynamicBitmapText#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R046689", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.DynamicBitmapText#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R046690", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.DynamicBitmapText#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R046691", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.DynamicBitmapText#getIndexList", "kind": "function", "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.", "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R046692", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.DynamicBitmapText#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R046693", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.DynamicBitmapText#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R046694", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.DynamicBitmapText#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R046695", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.DynamicBitmapText#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R046696", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.DynamicBitmapText#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R046697", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.DynamicBitmapText#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R046698", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.DynamicBitmapText#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R046699", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.DynamicBitmapText#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R046700", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.DynamicBitmapText#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R046701", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.DynamicBitmapText#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R046702", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.DynamicBitmapText#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R046703", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.DynamicBitmapText#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R046704", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.DynamicBitmapText#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R046705", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.DynamicBitmapText#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R046706", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.DynamicBitmapText#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R046707", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.DynamicBitmapText#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R046708", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.DynamicBitmapText#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "___id": "T000002R046714", "___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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.DynamicBitmapText#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#setAlpha", "inherited": true, "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" } ], "___id": "T000002R046715", "___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 *\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.DynamicBitmapText#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alpha", "inherited": true, "___id": "T000002R046716", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.GameObjects.DynamicBitmapText#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "___id": "T000002R046717", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.GameObjects.DynamicBitmapText#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "___id": "T000002R046718", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.GameObjects.DynamicBitmapText#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "___id": "T000002R046719", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.GameObjects.DynamicBitmapText#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "___id": "T000002R046720", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.DynamicBitmapText#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R046722", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.DynamicBitmapText#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "___id": "T000002R046723", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.DynamicBitmapText#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R046725", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.DynamicBitmapText#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "___id": "T000002R046726", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.DynamicBitmapText#getCenter", "kind": "function", "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`.", "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]" } ], "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "___id": "T000002R046728", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.DynamicBitmapText#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "___id": "T000002R046729", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.DynamicBitmapText#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "___id": "T000002R046730", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.DynamicBitmapText#getTopRight", "kind": "function", "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`.", "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]" } ], "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "___id": "T000002R046731", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.DynamicBitmapText#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "___id": "T000002R046732", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.DynamicBitmapText#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "___id": "T000002R046733", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.DynamicBitmapText#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "___id": "T000002R046734", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.DynamicBitmapText#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "___id": "T000002R046735", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.DynamicBitmapText#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "___id": "T000002R046736", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.DynamicBitmapText#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "___id": "T000002R046737", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.DynamicBitmapText#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R046738", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.DynamicBitmapText#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "___id": "T000002R046739", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.DynamicBitmapText#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "___id": "T000002R046740", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.DynamicBitmapText#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "___id": "T000002R046741", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.DynamicBitmapText#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "___id": "T000002R046742", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.DynamicBitmapText#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R046744", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.DynamicBitmapText#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R046745", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.DynamicBitmapText#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R046746", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.DynamicBitmapText#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R046747", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.DynamicBitmapText#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "___id": "T000002R046748", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.DynamicBitmapText#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R046749", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.DynamicBitmapText#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "___id": "T000002R046750", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.DynamicBitmapText#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R046751", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.DynamicBitmapText#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R046752", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.DynamicBitmapText#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R046753", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.DynamicBitmapText#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "___id": "T000002R046754", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.DynamicBitmapText#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R046755", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.DynamicBitmapText#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R046756", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.DynamicBitmapText#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R046757", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.DynamicBitmapText#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R046758", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.DynamicBitmapText#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R046759", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.DynamicBitmapText#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R046760", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.DynamicBitmapText#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R046761", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.DynamicBitmapText#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R046762", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.DynamicBitmapText#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R046763", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.DynamicBitmapText#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "___id": "T000002R046764", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.DynamicBitmapText#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R046765", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.DynamicBitmapText#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R046766", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.DynamicBitmapText#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R046767", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.DynamicBitmapText#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R046768", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.DynamicBitmapText#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R046769", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.DynamicBitmapText#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R046770", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.DynamicBitmapText#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R046771", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.DynamicBitmapText#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R046772", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.DynamicBitmapText#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "___id": "T000002R046773", "___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": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "texture", "longname": "Phaser.GameObjects.DynamicBitmapText#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#texture", "inherited": true, "___id": "T000002R046774", "___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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "frame", "longname": "Phaser.GameObjects.DynamicBitmapText#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#frame", "inherited": true, "___id": "T000002R046775", "___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": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.GameObjects.DynamicBitmapText#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#setTexture", "inherited": true, "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" } ], "___id": "T000002R046777", "___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": 75, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.GameObjects.DynamicBitmapText#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#setFrame", "inherited": true, "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" } ], "___id": "T000002R046778", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertice 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": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopLeft", "longname": "Phaser.GameObjects.DynamicBitmapText#tintTopLeft", "kind": "member", "description": "The tint value being applied to the top-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopLeft", "inherited": true, "___id": "T000002R046779", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-right vertice 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopRight", "longname": "Phaser.GameObjects.DynamicBitmapText#tintTopRight", "kind": "member", "description": "The tint value being applied to the top-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopRight", "inherited": true, "___id": "T000002R046780", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-left vertice 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": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomLeft", "longname": "Phaser.GameObjects.DynamicBitmapText#tintBottomLeft", "kind": "member", "description": "The tint value being applied to the bottom-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "inherited": true, "___id": "T000002R046781", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-right vertice 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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomRight", "longname": "Phaser.GameObjects.DynamicBitmapText#tintBottomRight", "kind": "member", "description": "The tint value being applied to the bottom-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomRight", "inherited": true, "___id": "T000002R046782", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintFill", "longname": "Phaser.GameObjects.DynamicBitmapText#tintFill", "kind": "member", "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.11.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintFill", "inherited": true, "___id": "T000002R046783", "___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 'additive',\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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearTint", "longname": "Phaser.GameObjects.DynamicBitmapText#clearTint", "kind": "function", "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff and the tint type to 'additive',\rwhich results in no visible change to the texture.", "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#clearTint", "inherited": true, "___id": "T000002R046784", "___s": true }, { "comment": "/**\r\n * Sets an additive tint 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 * multiplying it by 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 * To swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.\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": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTint", "longname": "Phaser.GameObjects.DynamicBitmapText#setTint", "kind": "function", "description": "Sets an additive tint on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by 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\rTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.", "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#setTint", "inherited": true, "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" } ], "___id": "T000002R046785", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on this Game Object.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. You can provide either one color value, in which case the whole\r\n * Game Object will be rendered in that color. Or you can provide a color per corner. The colors\r\n * 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 * To swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintFill\r\n * @webglOnly\r\n * @since 3.11.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.\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": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTintFill", "longname": "Phaser.GameObjects.DynamicBitmapText#setTintFill", "kind": "function", "description": "Sets a fill-based tint on this Game Object.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. You can provide either one color value, in which case the whole\rGame Object will be rendered in that color. Or you can provide a color per corner. The colors\rare 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\rTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#setTintFill", "inherited": true, "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 not 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" } ], "___id": "T000002R046786", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.\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": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tint", "longname": "Phaser.GameObjects.DynamicBitmapText#tint", "kind": "member", "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tint", "inherited": true, "___id": "T000002R046787", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * It checks to see if the 4 tint properties are set to the value 0xffffff\r\n * and that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.\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": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isTinted", "longname": "Phaser.GameObjects.DynamicBitmapText#isTinted", "kind": "member", "description": "Does this Game Object have a tint applied?\r\rIt checks to see if the 4 tint properties are set to the value 0xffffff\rand that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "readonly": true, "since": "3.11.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#isTinted", "inherited": true, "___id": "T000002R046788", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.DynamicBitmapText#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R046789", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.DynamicBitmapText#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R046793", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.DynamicBitmapText#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R046794", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.DynamicBitmapText#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R046795", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.DynamicBitmapText#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R046796", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.DynamicBitmapText#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R046797", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.DynamicBitmapText#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R046798", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.DynamicBitmapText#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R046799", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.DynamicBitmapText#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R046800", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.DynamicBitmapText#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R046801", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.DynamicBitmapText#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "___id": "T000002R046802", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.DynamicBitmapText#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "___id": "T000002R046803", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.DynamicBitmapText#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "___id": "T000002R046804", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.DynamicBitmapText#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "___id": "T000002R046805", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.DynamicBitmapText#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "___id": "T000002R046806", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.DynamicBitmapText#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "___id": "T000002R046807", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.DynamicBitmapText#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "___id": "T000002R046808", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.DynamicBitmapText#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "___id": "T000002R046809", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.DynamicBitmapText#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "___id": "T000002R046810", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.DynamicBitmapText#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "___id": "T000002R046811", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.DynamicBitmapText#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R046812", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.DynamicBitmapText#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R046813", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.DynamicBitmapText#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "___id": "T000002R046814", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.DynamicBitmapText#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R046815", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.DynamicBitmapText#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R046817", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.DynamicBitmapText#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "___id": "T000002R046818", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Blitter#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R046819", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Blitter#displayList", "kind": "member", "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.", "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.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R046820", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Blitter#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R046821", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Blitter#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R046822", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Blitter#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R046823", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Blitter#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R046824", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Blitter#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R046825", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Blitter#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R046826", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Blitter#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R046827", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Blitter#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R046828", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Blitter#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R046829", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Blitter#input", "kind": "member", "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()`.", "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.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R046830", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Blitter#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R046831", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Blitter#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R046832", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Blitter#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R046833", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Blitter#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R046834", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Blitter#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R046835", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Blitter#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R046836", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Blitter#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R046837", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Blitter#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R046838", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Blitter#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R046839", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Blitter#getData", "kind": "function", "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.", "since": "3.0.0", "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.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R046840", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Blitter#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R046841", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Blitter#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R046842", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Blitter#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R046843", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Blitter#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R046844", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Blitter#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R046845", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Blitter#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R046846", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Blitter#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R046847", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Blitter#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R046848", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Blitter#getIndexList", "kind": "function", "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.", "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.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R046849", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Blitter#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R046850", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Blitter#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R046851", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Blitter#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R046852", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Blitter#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R046853", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Blitter#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R046854", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Blitter#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R046855", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Blitter#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R046856", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Blitter#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R046857", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Blitter#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R046858", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Blitter#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R046859", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Blitter#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R046860", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Blitter#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R046861", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Blitter#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R046862", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Blitter#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R046863", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Blitter#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R046864", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Blitter#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R046865", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Blitter#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "___id": "T000002R046871", "___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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Blitter#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Alpha#setAlpha", "inherited": true, "___id": "T000002R046872", "___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 *\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Blitter#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alpha", "inherited": true, "___id": "T000002R046873", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.GameObjects.Blitter#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "___id": "T000002R046874", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.GameObjects.Blitter#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "___id": "T000002R046875", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.GameObjects.Blitter#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "___id": "T000002R046876", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.GameObjects.Blitter#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "___id": "T000002R046877", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Blitter#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R046879", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Blitter#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R046880", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Blitter#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R046882", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Blitter#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R046883", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Blitter#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R046884", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Blitter#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R046885", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Blitter#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R046886", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Blitter#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R046887", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Blitter#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R046888", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Blitter#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R046889", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Blitter#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R046890", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Blitter#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R046891", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Blitter#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "___id": "T000002R046892", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Blitter#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "___id": "T000002R046893", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Blitter#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "___id": "T000002R046894", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Blitter#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "___id": "T000002R046895", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Blitter#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R046896", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Blitter#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R046897", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Blitter#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R046898", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Blitter#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R046899", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Blitter#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R046900", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Blitter#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R046901", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Blitter#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R046902", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Blitter#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R046903", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Blitter#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R046904", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Blitter#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R046905", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Blitter#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R046906", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Blitter#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R046907", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Blitter#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R046908", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Blitter#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R046909", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Blitter#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R046910", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Blitter#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R046911", "___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": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Blitter#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#width", "inherited": true, "___id": "T000002R046913", "___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": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Blitter#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#height", "inherited": true, "___id": "T000002R046914", "___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": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Blitter#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayWidth", "inherited": true, "___id": "T000002R046915", "___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": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Blitter#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayHeight", "inherited": true, "___id": "T000002R046916", "___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": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSizeToFrame", "longname": "Phaser.GameObjects.Blitter#setSizeToFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setSizeToFrame", "inherited": true, "___id": "T000002R046917", "___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": 139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.GameObjects.Blitter#setSize", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setSize", "inherited": true, "___id": "T000002R046918", "___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.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": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Blitter#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setDisplaySize", "inherited": true, "___id": "T000002R046919", "___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": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "texture", "longname": "Phaser.GameObjects.Blitter#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#texture", "inherited": true, "___id": "T000002R046920", "___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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "frame", "longname": "Phaser.GameObjects.Blitter#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#frame", "inherited": true, "___id": "T000002R046921", "___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": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.GameObjects.Blitter#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Texture#setTexture", "inherited": true, "___id": "T000002R046923", "___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": 75, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.GameObjects.Blitter#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Texture#setFrame", "inherited": true, "___id": "T000002R046924", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Blitter#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R046925", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Blitter#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R046929", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Blitter#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R046930", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Blitter#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R046931", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Blitter#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R046932", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Blitter#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R046933", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Blitter#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R046934", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Blitter#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R046935", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Blitter#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R046936", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Blitter#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R046937", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Blitter#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R046938", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Blitter#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R046939", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Blitter#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R046940", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Blitter#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R046941", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Blitter#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R046942", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Blitter#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R046943", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Blitter#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R046944", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Blitter#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R046945", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Blitter#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R046946", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Blitter#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R046947", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Blitter#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R046948", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Blitter#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R046949", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Blitter#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R046950", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Blitter#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R046951", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Blitter#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R046953", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Blitter#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Blitter", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R046954", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Container#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R046955", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Container#displayList", "kind": "member", "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.", "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.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R046956", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Container#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R046957", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Container#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R046958", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Container#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R046959", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Container#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R046960", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Container#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R046961", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Container#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R046962", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Container#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R046963", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Container#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R046964", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Container#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R046965", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Container#input", "kind": "member", "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()`.", "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.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R046966", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Container#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R046967", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Container#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R046968", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Container#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R046969", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Container#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R046970", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Container#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R046971", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Container#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R046972", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Container#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R046973", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Container#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R046974", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Container#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R046975", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Container#getData", "kind": "function", "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.", "since": "3.0.0", "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.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R046976", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Container#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R046977", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Container#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R046978", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Container#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R046979", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Container#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R046980", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Container#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R046981", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Container#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R046982", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Container#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R046983", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Container#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R046984", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Container#getIndexList", "kind": "function", "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.", "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.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R046985", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Container#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R046986", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Container#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R046987", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Container#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R046988", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Container#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R046989", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Container#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R046990", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Container#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R046991", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Container#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Container", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R046992", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Container#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R046993", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Container#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R046994", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Container#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R046995", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Container#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R046996", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Container#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R046997", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Container#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R046998", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Container#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R046999", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Container#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R047000", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Container#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R047001", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Container#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R047003", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Container#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "___id": "T000002R047004", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Container#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R047005", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Container#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R047007", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Container#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R047008", "___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": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Container#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#width", "inherited": true, "___id": "T000002R047009", "___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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Container#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#height", "inherited": true, "___id": "T000002R047010", "___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": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Container#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#displayWidth", "inherited": true, "___id": "T000002R047011", "___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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Container#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#displayHeight", "inherited": true, "___id": "T000002R047012", "___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": 93, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.GameObjects.Container#setSize", "kind": "function", "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.", "since": "3.4.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ComputedSize#setSize", "inherited": true, "___id": "T000002R047013", "___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.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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Container#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.4.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ComputedSize#setDisplaySize", "inherited": true, "___id": "T000002R047014", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Container#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R047016", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Container#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R047017", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Container#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R047018", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Container#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R047019", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Container#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R047020", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Container#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R047021", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Container#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R047022", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Container#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R047023", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Container#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R047024", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Container#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R047025", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Container#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R047026", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Container#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R047027", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Container#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R047028", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Container#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Container", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R047029", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Container#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Container", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R047030", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Container#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R047031", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Container#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R047032", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Container#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R047033", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Container#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R047034", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Container#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R047035", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Container#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R047039", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Container#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R047040", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Container#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R047041", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Container#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R047042", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Container#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R047043", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Container#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R047044", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Container#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R047045", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Container#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R047046", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Container#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R047047", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Container#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R047048", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Container#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R047049", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Container#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R047050", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Container#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R047051", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Container#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R047052", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Container#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R047053", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Container#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R047054", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Container#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R047055", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Container#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R047056", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Container#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R047057", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Container#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R047058", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Container#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R047059", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Container#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R047060", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Container#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R047061", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Container#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Container", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R047063", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Container#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R047064", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.DOMElement#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R047065", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.DOMElement#displayList", "kind": "member", "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.", "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.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R047066", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.DOMElement#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R047067", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.DOMElement#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R047068", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.DOMElement#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R047069", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.DOMElement#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R047070", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.DOMElement#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R047071", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.DOMElement#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R047072", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.DOMElement#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R047073", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.DOMElement#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R047074", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.DOMElement#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R047075", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.DOMElement#input", "kind": "member", "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()`.", "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.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R047076", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.DOMElement#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R047077", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.DOMElement#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R047078", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.DOMElement#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R047079", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.DOMElement#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R047080", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.DOMElement#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R047081", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.DOMElement#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R047082", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.DOMElement#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R047083", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.DOMElement#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R047084", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.DOMElement#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R047085", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.DOMElement#getData", "kind": "function", "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.", "since": "3.0.0", "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.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R047086", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.DOMElement#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R047087", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.DOMElement#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R047088", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.DOMElement#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R047089", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.DOMElement#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R047090", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.DOMElement#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R047091", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.DOMElement#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R047092", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.DOMElement#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R047093", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.DOMElement#getIndexList", "kind": "function", "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.", "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.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R047094", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.DOMElement#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R047095", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.DOMElement#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R047096", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.DOMElement#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R047097", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.DOMElement#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R047098", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.DOMElement#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R047099", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.DOMElement#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R047100", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.DOMElement#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R047101", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.DOMElement#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R047102", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.DOMElement#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R047103", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.DOMElement#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R047104", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.DOMElement#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R047105", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.DOMElement#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R047106", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.DOMElement#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R047107", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.DOMElement#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R047108", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.DOMElement#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R047110", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.DOMElement#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "___id": "T000002R047111", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.DOMElement#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R047112", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.DOMElement#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R047114", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.DOMElement#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R047115", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.DOMElement#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R047117", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.DOMElement#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R047118", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.DOMElement#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R047120", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.DOMElement#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R047121", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.DOMElement#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R047122", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.DOMElement#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R047123", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.DOMElement#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "___id": "T000002R047124", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.DOMElement#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R047125", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.DOMElement#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "___id": "T000002R047126", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.DOMElement#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R047127", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.DOMElement#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R047128", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.DOMElement#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R047129", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.DOMElement#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R047130", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.DOMElement#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R047131", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.DOMElement#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R047135", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.DOMElement#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R047136", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.DOMElement#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R047137", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.DOMElement#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R047138", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.DOMElement#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R047139", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.DOMElement#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R047140", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.DOMElement#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R047141", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.DOMElement#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R047142", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.DOMElement#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R047143", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.DOMElement#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R047144", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.DOMElement#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R047145", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.DOMElement#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R047146", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.DOMElement#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R047147", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.DOMElement#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R047148", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.DOMElement#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R047149", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.DOMElement#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R047150", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.DOMElement#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R047151", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.DOMElement#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R047152", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.DOMElement#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R047153", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.DOMElement#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R047154", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.DOMElement#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R047155", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.DOMElement#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R047156", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.DOMElement#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R047157", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.DOMElement#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R047159", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.DOMElement#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R047160", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Extern#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R047161", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Extern#displayList", "kind": "member", "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.", "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.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R047162", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Extern#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R047163", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Extern#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R047164", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Extern#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R047165", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Extern#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R047166", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Extern#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R047167", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Extern#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R047168", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Extern#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R047169", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Extern#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R047170", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Extern#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R047171", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Extern#input", "kind": "member", "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()`.", "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.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R047172", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Extern#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R047173", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Extern#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R047174", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Extern#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R047175", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Extern#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R047176", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Extern#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R047177", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Extern#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R047178", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Extern#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R047179", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Extern#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R047180", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Extern#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R047181", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Extern#getData", "kind": "function", "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.", "since": "3.0.0", "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.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R047182", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Extern#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R047183", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Extern#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R047184", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Extern#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R047185", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Extern#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R047186", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Extern#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R047187", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Extern#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R047188", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Extern#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R047189", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Extern#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R047190", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Extern#getIndexList", "kind": "function", "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.", "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.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R047191", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Extern#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R047192", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Extern#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R047193", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Extern#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R047194", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Extern#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R047195", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Extern#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R047196", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Extern#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R047197", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Extern#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R047198", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Extern#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R047199", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Extern#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R047200", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Extern#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R047201", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Extern#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R047202", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Extern#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R047203", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Extern#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R047204", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Extern#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R047205", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Extern#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R047206", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Extern#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R047207", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Extern#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "___id": "T000002R047213", "___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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Extern#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Alpha#setAlpha", "inherited": true, "___id": "T000002R047214", "___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 *\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Extern#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alpha", "inherited": true, "___id": "T000002R047215", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.GameObjects.Extern#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "___id": "T000002R047216", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.GameObjects.Extern#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "___id": "T000002R047217", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.GameObjects.Extern#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "___id": "T000002R047218", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.GameObjects.Extern#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "___id": "T000002R047219", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Extern#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R047221", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Extern#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R047222", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Extern#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R047224", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Extern#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R047225", "___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.Components.Flip#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipX", "longname": "Phaser.GameObjects.Extern#flipX", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipX", "inherited": true, "___id": "T000002R047226", "___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.Components.Flip#flipY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipY", "longname": "Phaser.GameObjects.Extern#flipY", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipY", "inherited": true, "___id": "T000002R047227", "___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 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 * @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": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipX", "longname": "Phaser.GameObjects.Extern#toggleFlipX", "kind": "function", "description": "Toggles the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipX", "inherited": true, "___id": "T000002R047228", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipY", "longname": "Phaser.GameObjects.Extern#toggleFlipY", "kind": "function", "description": "Toggles the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipY", "inherited": true, "___id": "T000002R047229", "___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 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 * @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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipX", "longname": "Phaser.GameObjects.Extern#setFlipX", "kind": "function", "description": "Sets the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipX", "inherited": true, "___id": "T000002R047230", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\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": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipY", "longname": "Phaser.GameObjects.Extern#setFlipY", "kind": "function", "description": "Sets the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipY", "inherited": true, "___id": "T000002R047231", "___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 inversed 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 horizontal 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": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlip", "longname": "Phaser.GameObjects.Extern#setFlip", "kind": "function", "description": "Sets the horizontal and vertical flipped state of this Game Object.\r\rA Game Object that is flipped will render inversed 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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 horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlip", "inherited": true, "___id": "T000002R047232", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetFlip", "longname": "Phaser.GameObjects.Extern#resetFlip", "kind": "function", "description": "Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#resetFlip", "inherited": true, "___id": "T000002R047233", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Extern#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R047235", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Extern#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R047236", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Extern#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R047237", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Extern#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R047238", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Extern#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "___id": "T000002R047239", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Extern#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R047240", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Extern#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "___id": "T000002R047241", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Extern#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R047242", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Extern#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R047243", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Extern#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R047244", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Extern#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R047245", "___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": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Extern#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#width", "inherited": true, "___id": "T000002R047247", "___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": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Extern#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#height", "inherited": true, "___id": "T000002R047248", "___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": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Extern#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayWidth", "inherited": true, "___id": "T000002R047249", "___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": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Extern#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayHeight", "inherited": true, "___id": "T000002R047250", "___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": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSizeToFrame", "longname": "Phaser.GameObjects.Extern#setSizeToFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setSizeToFrame", "inherited": true, "___id": "T000002R047251", "___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": 139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.GameObjects.Extern#setSize", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setSize", "inherited": true, "___id": "T000002R047252", "___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.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": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Extern#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setDisplaySize", "inherited": true, "___id": "T000002R047253", "___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": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "texture", "longname": "Phaser.GameObjects.Extern#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#texture", "inherited": true, "___id": "T000002R047254", "___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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "frame", "longname": "Phaser.GameObjects.Extern#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#frame", "inherited": true, "___id": "T000002R047255", "___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": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.GameObjects.Extern#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Texture#setTexture", "inherited": true, "___id": "T000002R047257", "___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": 75, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.GameObjects.Extern#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Texture#setFrame", "inherited": true, "___id": "T000002R047258", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertice 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": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopLeft", "longname": "Phaser.GameObjects.Extern#tintTopLeft", "kind": "member", "description": "The tint value being applied to the top-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopLeft", "inherited": true, "___id": "T000002R047259", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-right vertice 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopRight", "longname": "Phaser.GameObjects.Extern#tintTopRight", "kind": "member", "description": "The tint value being applied to the top-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopRight", "inherited": true, "___id": "T000002R047260", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-left vertice 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": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomLeft", "longname": "Phaser.GameObjects.Extern#tintBottomLeft", "kind": "member", "description": "The tint value being applied to the bottom-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "inherited": true, "___id": "T000002R047261", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-right vertice 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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomRight", "longname": "Phaser.GameObjects.Extern#tintBottomRight", "kind": "member", "description": "The tint value being applied to the bottom-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomRight", "inherited": true, "___id": "T000002R047262", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintFill", "longname": "Phaser.GameObjects.Extern#tintFill", "kind": "member", "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.11.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintFill", "inherited": true, "___id": "T000002R047263", "___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 'additive',\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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearTint", "longname": "Phaser.GameObjects.Extern#clearTint", "kind": "function", "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff and the tint type to 'additive',\rwhich results in no visible change to the texture.", "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.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#clearTint", "inherited": true, "___id": "T000002R047264", "___s": true }, { "comment": "/**\r\n * Sets an additive tint 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 * multiplying it by 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 * To swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.\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": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTint", "longname": "Phaser.GameObjects.Extern#setTint", "kind": "function", "description": "Sets an additive tint on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by 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\rTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.", "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.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Tint#setTint", "inherited": true, "___id": "T000002R047265", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on this Game Object.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. You can provide either one color value, in which case the whole\r\n * Game Object will be rendered in that color. Or you can provide a color per corner. The colors\r\n * 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 * To swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintFill\r\n * @webglOnly\r\n * @since 3.11.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.\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": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTintFill", "longname": "Phaser.GameObjects.Extern#setTintFill", "kind": "function", "description": "Sets a fill-based tint on this Game Object.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. You can provide either one color value, in which case the whole\rGame Object will be rendered in that color. Or you can provide a color per corner. The colors\rare 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\rTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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 not 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" } ], "inherits": "Phaser.GameObjects.Components.Tint#setTintFill", "inherited": true, "___id": "T000002R047266", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.\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": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tint", "longname": "Phaser.GameObjects.Extern#tint", "kind": "member", "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tint", "inherited": true, "___id": "T000002R047267", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * It checks to see if the 4 tint properties are set to the value 0xffffff\r\n * and that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.\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": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isTinted", "longname": "Phaser.GameObjects.Extern#isTinted", "kind": "member", "description": "Does this Game Object have a tint applied?\r\rIt checks to see if the 4 tint properties are set to the value 0xffffff\rand that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "readonly": true, "since": "3.11.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#isTinted", "inherited": true, "___id": "T000002R047268", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Extern#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R047269", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Extern#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R047273", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Extern#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R047274", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Extern#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R047275", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Extern#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R047276", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Extern#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R047277", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Extern#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R047278", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Extern#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R047279", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Extern#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R047280", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Extern#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R047281", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Extern#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R047282", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Extern#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R047283", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Extern#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R047284", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Extern#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R047285", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Extern#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R047286", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Extern#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R047287", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Extern#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R047288", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Extern#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R047289", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Extern#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R047290", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Extern#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R047291", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Extern#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R047292", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Extern#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R047293", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Extern#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R047294", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Extern#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R047295", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Extern#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R047297", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Extern#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Extern", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R047298", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Graphics#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R047299", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Graphics#displayList", "kind": "member", "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.", "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.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R047300", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Graphics#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R047301", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Graphics#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R047302", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Graphics#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R047303", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Graphics#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R047304", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Graphics#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R047305", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Graphics#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R047306", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Graphics#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R047307", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Graphics#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R047308", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Graphics#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R047309", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Graphics#input", "kind": "member", "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()`.", "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.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R047310", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Graphics#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R047311", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Graphics#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R047312", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Graphics#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R047313", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Graphics#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R047314", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Graphics#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R047315", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Graphics#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R047316", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Graphics#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R047317", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Graphics#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R047318", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Graphics#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R047319", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Graphics#getData", "kind": "function", "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.", "since": "3.0.0", "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.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R047320", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Graphics#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R047321", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Graphics#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R047322", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Graphics#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R047323", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Graphics#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R047324", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Graphics#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R047325", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Graphics#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R047326", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Graphics#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R047327", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Graphics#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R047328", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Graphics#getIndexList", "kind": "function", "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.", "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.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R047329", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Graphics#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R047330", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Graphics#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R047331", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Graphics#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R047332", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Graphics#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R047333", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Graphics#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R047334", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Graphics#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R047335", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Graphics#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R047336", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Graphics#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R047337", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Graphics#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R047338", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Graphics#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R047339", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Graphics#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R047340", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Graphics#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R047341", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Graphics#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R047342", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Graphics#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R047343", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Graphics#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R047344", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Graphics#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R047345", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Graphics#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R047347", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Graphics#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "___id": "T000002R047348", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Graphics#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R047349", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Graphics#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R047351", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Graphics#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R047352", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Graphics#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R047354", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Graphics#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R047355", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Graphics#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R047356", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Graphics#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R047357", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Graphics#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R047358", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Graphics#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R047359", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Graphics#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R047360", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Graphics#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R047361", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Graphics#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R047362", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Graphics#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R047363", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Graphics#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "___id": "T000002R047364", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Graphics#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "___id": "T000002R047365", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Graphics#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "___id": "T000002R047366", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Graphics#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "___id": "T000002R047367", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Graphics#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R047368", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Graphics#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R047369", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Graphics#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R047370", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Graphics#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R047371", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Graphics#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R047372", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Graphics#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R047373", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Graphics#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R047374", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Graphics#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R047375", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Graphics#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R047376", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Graphics#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R047377", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Graphics#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R047378", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Graphics#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R047379", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Graphics#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R047380", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Graphics#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R047381", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Graphics#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R047385", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Graphics#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R047386", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Graphics#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R047387", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Graphics#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R047388", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Graphics#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R047389", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Graphics#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R047390", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Graphics#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R047391", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Graphics#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R047392", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Graphics#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R047393", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Graphics#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R047394", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Graphics#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R047395", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Graphics#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R047396", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Graphics#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R047397", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Graphics#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R047398", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Graphics#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R047399", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Graphics#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R047400", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Graphics#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R047401", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Graphics#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R047402", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Graphics#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R047403", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Graphics#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R047404", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Graphics#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R047405", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Graphics#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R047406", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Graphics#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R047407", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Graphics#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R047409", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Graphics#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R047410", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Graphics#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R047411", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Graphics#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R047412", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Graphics#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Graphics", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R047413", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Group#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Group", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R047414", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Group#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Group", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R047415", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Group#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Group", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R047416", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Group#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Group", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R047417", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Group#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Group", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R047418", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Group#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Group", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R047419", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Group#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Group", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R047420", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Group#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Group", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R047421", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Group#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Group", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R047422", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Group#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Group", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R047423", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Group#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Group", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R047424", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Image#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R047425", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Image#displayList", "kind": "member", "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.", "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.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R047426", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Image#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R047427", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Image#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R047428", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Image#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R047429", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Image#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R047430", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Image#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R047431", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Image#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R047432", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Image#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R047433", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Image#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R047434", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Image#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R047435", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Image#input", "kind": "member", "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()`.", "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.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R047436", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Image#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R047437", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Image#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R047438", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Image#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R047439", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Image#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R047440", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Image#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R047441", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Image#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R047442", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Image#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R047443", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Image#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R047444", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Image#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R047445", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Image#getData", "kind": "function", "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.", "since": "3.0.0", "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.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R047446", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Image#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R047447", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Image#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R047448", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Image#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R047449", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Image#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R047450", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Image#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R047451", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Image#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R047452", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Image#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R047453", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Image#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R047454", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Image#getIndexList", "kind": "function", "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.", "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.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R047455", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Image#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R047456", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Image#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R047457", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Image#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R047458", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Image#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R047459", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Image#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R047460", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Image#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R047461", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Image#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R047462", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Image#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R047463", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Image#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R047464", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Image#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R047465", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Image#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R047466", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Image#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R047467", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Image#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R047468", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Image#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R047469", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Image#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R047470", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Image#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R047471", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Image#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "___id": "T000002R047477", "___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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Image#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Alpha#setAlpha", "inherited": true, "___id": "T000002R047478", "___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 *\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Image#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alpha", "inherited": true, "___id": "T000002R047479", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.GameObjects.Image#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "___id": "T000002R047480", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.GameObjects.Image#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "___id": "T000002R047481", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.GameObjects.Image#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "___id": "T000002R047482", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.GameObjects.Image#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "___id": "T000002R047483", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Image#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R047485", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Image#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R047486", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Image#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R047488", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Image#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R047489", "___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.Components.Flip#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipX", "longname": "Phaser.GameObjects.Image#flipX", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipX", "inherited": true, "___id": "T000002R047490", "___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.Components.Flip#flipY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipY", "longname": "Phaser.GameObjects.Image#flipY", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipY", "inherited": true, "___id": "T000002R047491", "___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 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 * @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": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipX", "longname": "Phaser.GameObjects.Image#toggleFlipX", "kind": "function", "description": "Toggles the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipX", "inherited": true, "___id": "T000002R047492", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipY", "longname": "Phaser.GameObjects.Image#toggleFlipY", "kind": "function", "description": "Toggles the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipY", "inherited": true, "___id": "T000002R047493", "___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 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 * @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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipX", "longname": "Phaser.GameObjects.Image#setFlipX", "kind": "function", "description": "Sets the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipX", "inherited": true, "___id": "T000002R047494", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\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": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipY", "longname": "Phaser.GameObjects.Image#setFlipY", "kind": "function", "description": "Sets the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipY", "inherited": true, "___id": "T000002R047495", "___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 inversed 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 horizontal 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": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlip", "longname": "Phaser.GameObjects.Image#setFlip", "kind": "function", "description": "Sets the horizontal and vertical flipped state of this Game Object.\r\rA Game Object that is flipped will render inversed 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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 horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlip", "inherited": true, "___id": "T000002R047496", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetFlip", "longname": "Phaser.GameObjects.Image#resetFlip", "kind": "function", "description": "Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#resetFlip", "inherited": true, "___id": "T000002R047497", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.Image#getCenter", "kind": "function", "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`.", "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]" } ], "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.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "___id": "T000002R047499", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.Image#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "___id": "T000002R047500", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.Image#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "___id": "T000002R047501", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.Image#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "___id": "T000002R047502", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.Image#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "___id": "T000002R047503", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.Image#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "___id": "T000002R047504", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.Image#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "___id": "T000002R047505", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.Image#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "___id": "T000002R047506", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.Image#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "___id": "T000002R047507", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.Image#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "___id": "T000002R047508", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Image#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R047509", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Image#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R047510", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Image#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R047511", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Image#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R047512", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Image#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R047513", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Image#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R047515", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Image#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R047516", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Image#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R047517", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Image#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R047518", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Image#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "___id": "T000002R047519", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Image#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R047520", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Image#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "___id": "T000002R047521", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Image#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R047522", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Image#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R047523", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Image#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R047524", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Image#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R047525", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Image#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "___id": "T000002R047526", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Image#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Image", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "___id": "T000002R047527", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Image#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "___id": "T000002R047528", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Image#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "___id": "T000002R047529", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Image#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R047530", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Image#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R047531", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Image#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R047532", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Image#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R047533", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Image#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R047534", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Image#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R047535", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Image#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R047536", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Image#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Image", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R047537", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Image#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Image", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R047538", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Image#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R047539", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Image#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R047540", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Image#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R047541", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Image#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R047542", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Image#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R047543", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Image#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R047544", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Image#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R047545", "___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": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Image#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#width", "inherited": true, "___id": "T000002R047547", "___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": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Image#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#height", "inherited": true, "___id": "T000002R047548", "___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": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Image#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayWidth", "inherited": true, "___id": "T000002R047549", "___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": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Image#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayHeight", "inherited": true, "___id": "T000002R047550", "___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": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSizeToFrame", "longname": "Phaser.GameObjects.Image#setSizeToFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setSizeToFrame", "inherited": true, "___id": "T000002R047551", "___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": 139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.GameObjects.Image#setSize", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setSize", "inherited": true, "___id": "T000002R047552", "___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.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": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Image#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setDisplaySize", "inherited": true, "___id": "T000002R047553", "___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": {} }, "name": "texture", "longname": "Phaser.GameObjects.Image#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#texture", "inherited": true, "___id": "T000002R047554", "___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": {} }, "name": "frame", "longname": "Phaser.GameObjects.Image#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#frame", "inherited": true, "___id": "T000002R047555", "___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": {} }, "name": "isCropped", "longname": "Phaser.GameObjects.Image#isCropped", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#isCropped", "inherited": true, "___id": "T000002R047556", "___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 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 rect 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. 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.\r\n * @param {number} [width] - The width of the crop rectangle in pixels.\r\n * @param {number} [height] - The height of the crop rectangle in pixels.\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": {} }, "name": "setCrop", "longname": "Phaser.GameObjects.Image#setCrop", "kind": "function", "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 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 rect 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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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. 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.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the crop rectangle in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the crop rectangle in pixels.", "name": "height" } ], "inherits": "Phaser.GameObjects.Components.TextureCrop#setCrop", "inherited": true, "___id": "T000002R047557", "___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": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.GameObjects.Image#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.TextureCrop#setTexture", "inherited": true, "___id": "T000002R047558", "___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": 128, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.GameObjects.Image#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.TextureCrop#setFrame", "inherited": true, "___id": "T000002R047559", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertice 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": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopLeft", "longname": "Phaser.GameObjects.Image#tintTopLeft", "kind": "member", "description": "The tint value being applied to the top-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopLeft", "inherited": true, "___id": "T000002R047561", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-right vertice 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopRight", "longname": "Phaser.GameObjects.Image#tintTopRight", "kind": "member", "description": "The tint value being applied to the top-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopRight", "inherited": true, "___id": "T000002R047562", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-left vertice 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": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomLeft", "longname": "Phaser.GameObjects.Image#tintBottomLeft", "kind": "member", "description": "The tint value being applied to the bottom-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "inherited": true, "___id": "T000002R047563", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-right vertice 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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomRight", "longname": "Phaser.GameObjects.Image#tintBottomRight", "kind": "member", "description": "The tint value being applied to the bottom-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomRight", "inherited": true, "___id": "T000002R047564", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintFill", "longname": "Phaser.GameObjects.Image#tintFill", "kind": "member", "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.11.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintFill", "inherited": true, "___id": "T000002R047565", "___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 'additive',\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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearTint", "longname": "Phaser.GameObjects.Image#clearTint", "kind": "function", "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff and the tint type to 'additive',\rwhich results in no visible change to the texture.", "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.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#clearTint", "inherited": true, "___id": "T000002R047566", "___s": true }, { "comment": "/**\r\n * Sets an additive tint 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 * multiplying it by 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 * To swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.\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": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTint", "longname": "Phaser.GameObjects.Image#setTint", "kind": "function", "description": "Sets an additive tint on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by 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\rTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.", "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.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Tint#setTint", "inherited": true, "___id": "T000002R047567", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on this Game Object.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. You can provide either one color value, in which case the whole\r\n * Game Object will be rendered in that color. Or you can provide a color per corner. The colors\r\n * 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 * To swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintFill\r\n * @webglOnly\r\n * @since 3.11.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.\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": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTintFill", "longname": "Phaser.GameObjects.Image#setTintFill", "kind": "function", "description": "Sets a fill-based tint on this Game Object.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. You can provide either one color value, in which case the whole\rGame Object will be rendered in that color. Or you can provide a color per corner. The colors\rare 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\rTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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 not 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" } ], "inherits": "Phaser.GameObjects.Components.Tint#setTintFill", "inherited": true, "___id": "T000002R047568", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.\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": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tint", "longname": "Phaser.GameObjects.Image#tint", "kind": "member", "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tint", "inherited": true, "___id": "T000002R047569", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * It checks to see if the 4 tint properties are set to the value 0xffffff\r\n * and that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.\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": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isTinted", "longname": "Phaser.GameObjects.Image#isTinted", "kind": "member", "description": "Does this Game Object have a tint applied?\r\rIt checks to see if the 4 tint properties are set to the value 0xffffff\rand that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "readonly": true, "since": "3.11.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#isTinted", "inherited": true, "___id": "T000002R047570", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Image#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R047571", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Image#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R047575", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Image#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R047576", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Image#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R047577", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Image#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R047578", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Image#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R047579", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Image#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R047580", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Image#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R047581", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Image#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R047582", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Image#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R047583", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Image#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R047584", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Image#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R047585", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Image#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R047586", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Image#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R047587", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Image#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R047588", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Image#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R047589", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Image#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R047590", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Image#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R047591", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Image#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R047592", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Image#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R047593", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Image#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R047594", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Image#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R047595", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Image#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R047596", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Image#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R047597", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Image#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R047599", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Image#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R047600", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Layer#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R047602", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Layer#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "___id": "T000002R047603", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Layer#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R047604", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Layer#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Layer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R047606", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Layer#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R047607", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Layer#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R047609", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Layer#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R047610", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Layer#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R047611", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Layer#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R047612", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Layer#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R047613", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Layer#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R047614", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Layer#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Layer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R047615", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Layer#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R047616", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Layer#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R047617", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Layer#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R047618", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Layer#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R047619", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Layer#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R047620", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Layer#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R047621", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Layer#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Layer", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R047622", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Layer#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Layer", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R047623", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Layer#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R047624", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Layer#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R047625", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Layer#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R047626", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Layer#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R047627", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Layer#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R047629", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Layer#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Layer", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R047630", "___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": 41, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Light#type", "kind": "member", "description": "The geometry constant type of this object: `GEOM_CONST.CIRCLE`.\rUsed for fast type comparisons.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.19.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.Geom.Circle#type", "inherited": true, "___id": "T000002R047631", "___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": 52, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "x", "longname": "Phaser.GameObjects.Light#x", "kind": "member", "description": "The x position of the center of the circle.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.Geom.Circle#x", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#x", "___id": "T000002R047632", "___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": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "y", "longname": "Phaser.GameObjects.Light#y", "kind": "member", "description": "The y position of the center of the circle.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.Geom.Circle#y", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#y", "___id": "T000002R047633", "___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": 93, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "contains", "longname": "Phaser.GameObjects.Light#contains", "kind": "function", "description": "Check to see if the Circle contains the given x / y coordinates.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the coordinates are within the circle, otherwise false." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "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" } ], "inherits": "Phaser.Geom.Circle#contains", "inherited": true, "___id": "T000002R047636", "___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.Geom.Point} 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.Geom.Point|object)} [out] - An object to store the return values in. If not given a Point object will be created.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} A Point, or point-like object, containing the coordinates of the point around the circle.\r\n */", "meta": { "filename": "Circle.js", "lineno": 109, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "getPoint", "longname": "Phaser.GameObjects.Light#getPoint", "kind": "function", "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.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [out,$return]", "value": "{Phaser.Geom.Point} O - [out,$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A Point, or point-like object, containing the coordinates of the point around the circle." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "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.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "An object to store the return values in. If not given a Point object will be created.", "name": "out" } ], "inherits": "Phaser.Geom.Circle#getPoint", "inherited": true, "___id": "T000002R047637", "___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.Geom.Point[]} 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 circle and dividing it by the stepRate.\r\n * @param {(array|Phaser.Geom.Point[])} [output] - An array to insert the points in to. If not provided a new array will be created.\r\n *\r\n * @return {(array|Phaser.Geom.Point[])} An array of Point objects pertaining to the points around the circumference of the circle.\r\n */", "meta": { "filename": "Circle.js", "lineno": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "getPoints", "longname": "Phaser.GameObjects.Light#getPoints", "kind": "function", "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.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point[]} O - [output,$return]", "value": "{Phaser.Geom.Point[]} O - [output,$return]" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "description": "An array of Point objects pertaining to the points around the circumference of the circle." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "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 circle and dividing it by the stepRate.", "name": "stepRate" }, { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Point", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An array to insert the points in to. If not provided a new array will be created.", "name": "output" } ], "inherits": "Phaser.Geom.Circle#getPoints", "inherited": true, "___id": "T000002R047638", "___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.Geom.Point} O - [point,$return]\r\n *\r\n * @param {(Phaser.Geom.Point|object)} [point] - A Point or point-like object to set the random `x` and `y` values in.\r\n *\r\n * @return {(Phaser.Geom.Point|object)} A Point object with the random values set in the `x` and `y` properties.\r\n */", "meta": { "filename": "Circle.js", "lineno": 149, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "getRandomPoint", "longname": "Phaser.GameObjects.Light#getRandomPoint", "kind": "function", "description": "Returns a uniformly distributed random point from anywhere within the Circle.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Point} O - [point,$return]", "value": "{Phaser.Geom.Point} O - [point,$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "A Point object with the random values set in the `x` and `y` properties." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Geom.Point", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Point" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "A Point or point-like object to set the random `x` and `y` values in.", "name": "point" } ], "inherits": "Phaser.Geom.Circle#getRandomPoint", "inherited": true, "___id": "T000002R047639", "___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": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "setTo", "longname": "Phaser.GameObjects.Light#setTo", "kind": "function", "description": "Sets the x, y and radius of this circle.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Circle object." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "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" } ], "inherits": "Phaser.Geom.Circle#setTo", "inherited": true, "___id": "T000002R047640", "___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": 188, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "setEmpty", "longname": "Phaser.GameObjects.Light#setEmpty", "kind": "function", "description": "Sets this Circle to be empty with a radius of zero.\rDoes not change its position.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Circle object." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.Geom.Circle#setEmpty", "inherited": true, "___id": "T000002R047641", "___s": true }, { "comment": "/**\r\n * Sets the position of this Circle.\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": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Light#setPosition", "kind": "function", "description": "Sets the position of this Circle.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Circle object." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "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" } ], "inherits": "Phaser.Geom.Circle#setPosition", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#setPosition", "___id": "T000002R047642", "___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": 226, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "isEmpty", "longname": "Phaser.GameObjects.Light#isEmpty", "kind": "function", "description": "Checks to see if the Circle is empty: has a radius of zero.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Circle is empty, otherwise false." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.Geom.Circle#isEmpty", "inherited": true, "___id": "T000002R047643", "___s": true }, { "comment": "/**\r\n * The radius of the Circle.\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": 239, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "radius", "longname": "Phaser.GameObjects.Light#radius", "kind": "member", "description": "The radius of the Circle.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.Geom.Circle#radius", "inherited": true, "___id": "T000002R047644", "___s": true }, { "comment": "/**\r\n * The diameter of the Circle.\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": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "diameter", "longname": "Phaser.GameObjects.Light#diameter", "kind": "member", "description": "The diameter of the Circle.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.Geom.Circle#diameter", "inherited": true, "___id": "T000002R047645", "___s": true }, { "comment": "/**\r\n * The left position of the Circle.\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": 283, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "left", "longname": "Phaser.GameObjects.Light#left", "kind": "member", "description": "The left position of the Circle.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.Geom.Circle#left", "inherited": true, "___id": "T000002R047646", "___s": true }, { "comment": "/**\r\n * The right position of the Circle.\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": 304, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "right", "longname": "Phaser.GameObjects.Light#right", "kind": "member", "description": "The right position of the Circle.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.Geom.Circle#right", "inherited": true, "___id": "T000002R047647", "___s": true }, { "comment": "/**\r\n * The top position of the Circle.\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": 325, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "top", "longname": "Phaser.GameObjects.Light#top", "kind": "member", "description": "The top position of the Circle.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.Geom.Circle#top", "inherited": true, "___id": "T000002R047648", "___s": true }, { "comment": "/**\r\n * The bottom position of the Circle.\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": 346, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "name": "bottom", "longname": "Phaser.GameObjects.Light#bottom", "kind": "member", "description": "The bottom position of the Circle.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.Geom.Circle#bottom", "inherited": true, "___id": "T000002R047649", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Light#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R047651", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Light#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R047652", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Light#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R047653", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Light#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R047654", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Light#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "___id": "T000002R047655", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Light#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R047656", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Light#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "___id": "T000002R047657", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Light#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R047658", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Light#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R047659", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Light#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R047660", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Light#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R047661", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Light#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R047662", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Light#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R047666", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Light#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R047667", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Light#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R047668", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Light#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R047669", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Light#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R047670", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Light#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R047671", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Light#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R047672", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Light#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R047673", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Light#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R047674", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Light#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R047675", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Light#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R047676", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Light#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R047677", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Light#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R047678", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Light#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R047679", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Light#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R047680", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Light#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R047681", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Light#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R047682", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Light#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R047683", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Light#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R047684", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Light#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R047685", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Light#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R047687", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Light#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Light", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R047688", "___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": 40, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "name": "lights", "longname": "Phaser.GameObjects.LightsPlugin#lights", "kind": "member", "description": "The Lights in the Scene.", "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.LightsPlugin", "scope": "instance", "inherits": "Phaser.GameObjects.LightsManager#lights", "inherited": true, "___id": "T000002R047689", "___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": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "name": "ambientColor", "longname": "Phaser.GameObjects.LightsPlugin#ambientColor", "kind": "member", "description": "The ambient color.", "type": { "names": [ "Phaser.Display.RGB" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.RGB" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.LightsPlugin", "scope": "instance", "inherits": "Phaser.GameObjects.LightsManager#ambientColor", "inherited": true, "___id": "T000002R047690", "___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": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.LightsPlugin#active", "kind": "member", "description": "Whether the Lights Manager is enabled.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.LightsPlugin", "scope": "instance", "inherits": "Phaser.GameObjects.LightsManager#active", "inherited": true, "___id": "T000002R047691", "___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": 69, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "name": "maxLights", "longname": "Phaser.GameObjects.LightsPlugin#maxLights", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.15.0", "memberof": "Phaser.GameObjects.LightsPlugin", "scope": "instance", "inherits": "Phaser.GameObjects.LightsManager#maxLights", "inherited": true, "___id": "T000002R047692", "___s": true }, { "comment": "/**\r\n * The number of lights that the LightPipeline 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": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "name": "visibleLights", "longname": "Phaser.GameObjects.LightsPlugin#visibleLights", "kind": "member", "description": "The number of lights that the LightPipeline processed in the _previous_ frame.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.GameObjects.LightsPlugin", "scope": "instance", "inherits": "Phaser.GameObjects.LightsManager#visibleLights", "inherited": true, "___id": "T000002R047693", "___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 calcuations. 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 dislay 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": 91, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "name": "addPointLight", "longname": "Phaser.GameObjects.LightsPlugin#addPointLight", "kind": "function", "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 calcuations. 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 dislay 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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.PointLight" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.PointLight" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.LightsPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.LightsManager#addPointLight", "inherited": true, "___id": "T000002R047694", "___s": true }, { "comment": "/**\r\n * Enable the Lights Manager.\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": 137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "name": "enable", "longname": "Phaser.GameObjects.LightsPlugin#enable", "kind": "function", "description": "Enable the Lights Manager.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Lights Manager instance." } ], "memberof": "Phaser.GameObjects.LightsPlugin", "scope": "instance", "inherits": "Phaser.GameObjects.LightsManager#enable", "inherited": true, "___id": "T000002R047695", "___s": true }, { "comment": "/**\r\n * Disable the Lights Manager.\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": 157, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "name": "disable", "longname": "Phaser.GameObjects.LightsPlugin#disable", "kind": "function", "description": "Disable the Lights Manager.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Lights Manager instance." } ], "memberof": "Phaser.GameObjects.LightsPlugin", "scope": "instance", "inherits": "Phaser.GameObjects.LightsManager#disable", "inherited": true, "___id": "T000002R047696", "___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 pipeline, 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": 172, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "name": "getLights", "longname": "Phaser.GameObjects.LightsPlugin#getLights", "kind": "function", "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 pipeline, the lights are then culled\rbased on the distance from the center of the camera. Only those closest are rendered.", "since": "3.50.0", "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.LightsPlugin", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to cull Lights for.", "name": "camera" } ], "inherits": "Phaser.GameObjects.LightsManager#getLights", "inherited": true, "___id": "T000002R047697", "___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": 228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "name": "setAmbientColor", "longname": "Phaser.GameObjects.LightsPlugin#setAmbientColor", "kind": "function", "description": "Set the ambient light color.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Lights Manager instance." } ], "memberof": "Phaser.GameObjects.LightsPlugin", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The integer RGB color of the ambient light.", "name": "rgb" } ], "inherits": "Phaser.GameObjects.LightsManager#setAmbientColor", "inherited": true, "___id": "T000002R047698", "___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": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "name": "getMaxVisibleLights", "longname": "Phaser.GameObjects.LightsPlugin#getMaxVisibleLights", "kind": "function", "description": "Returns the maximum number of Lights allowed to appear at once.", "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.LightsPlugin", "scope": "instance", "inherits": "Phaser.GameObjects.LightsManager#getMaxVisibleLights", "inherited": true, "___id": "T000002R047699", "___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": 260, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "name": "getLightCount", "longname": "Phaser.GameObjects.LightsPlugin#getLightCount", "kind": "function", "description": "Get the number of Lights managed by this Lights Manager.", "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.LightsPlugin", "scope": "instance", "inherits": "Phaser.GameObjects.LightsManager#getLightCount", "inherited": true, "___id": "T000002R047700", "___s": true }, { "comment": "/**\r\n * Add a Light.\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 *\r\n * @return {Phaser.GameObjects.Light} The Light that was added.\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 273, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "name": "addLight", "longname": "Phaser.GameObjects.LightsPlugin#addLight", "kind": "function", "description": "Add a Light.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Light" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Light" } }, "description": "The Light that was added." } ], "memberof": "Phaser.GameObjects.LightsPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.LightsManager#addLight", "inherited": true, "___id": "T000002R047701", "___s": true }, { "comment": "/**\r\n * Remove a Light.\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": 304, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "name": "removeLight", "longname": "Phaser.GameObjects.LightsPlugin#removeLight", "kind": "function", "description": "Remove a Light.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Lights Manager instance." } ], "memberof": "Phaser.GameObjects.LightsPlugin", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.Light" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Light" } }, "description": "The Light to remove.", "name": "light" } ], "inherits": "Phaser.GameObjects.LightsManager#removeLight", "inherited": true, "___id": "T000002R047702", "___s": true }, { "comment": "/**\r\n * Shut down the Lights Manager.\r\n *\r\n * Recycles all active Lights into the Light pool, resets ambient light color and clears the lists of Lights and\r\n * culled Lights.\r\n *\r\n * @method Phaser.GameObjects.LightsManager#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.LightsPlugin#shutdown", "kind": "function", "description": "Shut down the Lights Manager.\r\rRecycles all active Lights into the Light pool, resets ambient light color and clears the lists of Lights and\rculled Lights.", "since": "3.0.0", "memberof": "Phaser.GameObjects.LightsPlugin", "scope": "instance", "inherits": "Phaser.GameObjects.LightsManager#shutdown", "inherited": true, "___id": "T000002R047703", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Mesh#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R047704", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Mesh#displayList", "kind": "member", "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.", "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.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R047705", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Mesh#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R047706", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Mesh#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R047707", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Mesh#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R047708", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Mesh#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R047709", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Mesh#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R047710", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Mesh#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R047711", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Mesh#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R047712", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Mesh#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R047713", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Mesh#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R047714", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Mesh#input", "kind": "member", "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()`.", "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.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R047715", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Mesh#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R047716", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Mesh#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R047717", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Mesh#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R047718", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Mesh#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R047719", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Mesh#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R047720", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Mesh#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R047721", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Mesh#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R047722", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Mesh#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R047723", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Mesh#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R047724", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Mesh#getData", "kind": "function", "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.", "since": "3.0.0", "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.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R047725", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Mesh#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R047726", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Mesh#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R047727", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Mesh#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R047728", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Mesh#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R047729", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Mesh#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R047730", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Mesh#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R047731", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Mesh#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R047732", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Mesh#getIndexList", "kind": "function", "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.", "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.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R047733", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Mesh#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R047734", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Mesh#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R047735", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Mesh#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R047736", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Mesh#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R047737", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Mesh#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R047738", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Mesh#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R047739", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Mesh#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R047740", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Mesh#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R047741", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Mesh#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R047742", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Mesh#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R047743", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Mesh#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R047744", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Mesh#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R047745", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Mesh#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R047746", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Mesh#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R047747", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Mesh#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R047748", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Mesh#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R047749", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Mesh#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R047751", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Mesh#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "___id": "T000002R047752", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Mesh#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R047753", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Mesh#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R047755", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Mesh#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R047756", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Mesh#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R047758", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Mesh#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R047759", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Mesh#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R047760", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Mesh#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R047761", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Mesh#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R047762", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Mesh#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R047763", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Mesh#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R047764", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Mesh#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R047765", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Mesh#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R047766", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Mesh#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R047767", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Mesh#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "___id": "T000002R047768", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Mesh#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "___id": "T000002R047769", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Mesh#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "___id": "T000002R047770", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Mesh#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "___id": "T000002R047771", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Mesh#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R047772", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Mesh#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R047773", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Mesh#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R047774", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Mesh#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R047775", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Mesh#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R047776", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Mesh#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R047777", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Mesh#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R047778", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Mesh#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R047779", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Mesh#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R047780", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Mesh#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R047781", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Mesh#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R047782", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Mesh#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R047783", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Mesh#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R047784", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Mesh#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R047785", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Mesh#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R047786", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Mesh#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R047787", "___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": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Mesh#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#width", "inherited": true, "___id": "T000002R047789", "___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": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Mesh#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#height", "inherited": true, "___id": "T000002R047790", "___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": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Mesh#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayWidth", "inherited": true, "___id": "T000002R047791", "___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": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Mesh#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayHeight", "inherited": true, "___id": "T000002R047792", "___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": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSizeToFrame", "longname": "Phaser.GameObjects.Mesh#setSizeToFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setSizeToFrame", "inherited": true, "___id": "T000002R047793", "___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": 139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.GameObjects.Mesh#setSize", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setSize", "inherited": true, "___id": "T000002R047794", "___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.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": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Mesh#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setDisplaySize", "inherited": true, "___id": "T000002R047795", "___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": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "texture", "longname": "Phaser.GameObjects.Mesh#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#texture", "inherited": true, "___id": "T000002R047796", "___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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "frame", "longname": "Phaser.GameObjects.Mesh#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#frame", "inherited": true, "___id": "T000002R047797", "___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": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.GameObjects.Mesh#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Texture#setTexture", "inherited": true, "___id": "T000002R047799", "___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": 75, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.GameObjects.Mesh#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Texture#setFrame", "inherited": true, "___id": "T000002R047800", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Mesh#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R047801", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Mesh#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R047805", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Mesh#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R047806", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Mesh#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R047807", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Mesh#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R047808", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Mesh#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R047809", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Mesh#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R047810", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Mesh#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R047811", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Mesh#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R047812", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Mesh#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R047813", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Mesh#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R047814", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Mesh#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R047815", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Mesh#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R047816", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Mesh#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R047817", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Mesh#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R047818", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Mesh#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R047819", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Mesh#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R047820", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Mesh#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R047821", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Mesh#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R047822", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Mesh#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R047823", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Mesh#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R047824", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Mesh#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R047825", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Mesh#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R047826", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Mesh#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R047827", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Mesh#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R047829", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Mesh#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R047830", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.NineSlice#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R047831", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.NineSlice#displayList", "kind": "member", "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.", "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.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R047832", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.NineSlice#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R047833", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.NineSlice#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R047834", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.NineSlice#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R047835", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.NineSlice#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R047836", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.NineSlice#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R047837", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.NineSlice#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R047838", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.NineSlice#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R047839", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.NineSlice#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R047840", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.NineSlice#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R047841", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.NineSlice#input", "kind": "member", "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()`.", "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.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R047842", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.NineSlice#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R047843", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.NineSlice#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R047844", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.NineSlice#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R047845", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.NineSlice#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R047846", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.NineSlice#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R047847", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.NineSlice#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R047848", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.NineSlice#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R047849", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.NineSlice#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R047850", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.NineSlice#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R047851", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.NineSlice#getData", "kind": "function", "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.", "since": "3.0.0", "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.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R047852", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.NineSlice#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R047853", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.NineSlice#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R047854", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.NineSlice#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R047855", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.NineSlice#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R047856", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.NineSlice#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R047857", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.NineSlice#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R047858", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.NineSlice#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R047859", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.NineSlice#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R047860", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.NineSlice#getIndexList", "kind": "function", "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.", "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.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R047861", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.NineSlice#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R047862", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.NineSlice#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R047863", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.NineSlice#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R047864", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.NineSlice#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R047865", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.NineSlice#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R047866", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.NineSlice#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R047867", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.NineSlice#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R047868", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.NineSlice#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R047869", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.NineSlice#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R047870", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.NineSlice#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R047871", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.NineSlice#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R047872", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.NineSlice#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R047873", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.NineSlice#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R047874", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.NineSlice#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R047875", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.NineSlice#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R047876", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.NineSlice#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R047877", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.NineSlice#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R047879", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.NineSlice#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "___id": "T000002R047880", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.NineSlice#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R047881", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.NineSlice#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R047883", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.NineSlice#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R047884", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.NineSlice#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R047886", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.NineSlice#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R047887", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.NineSlice#getCenter", "kind": "function", "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`.", "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]" } ], "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.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "___id": "T000002R047889", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.NineSlice#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "___id": "T000002R047890", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.NineSlice#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "___id": "T000002R047891", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.NineSlice#getTopRight", "kind": "function", "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`.", "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]" } ], "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.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "___id": "T000002R047892", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.NineSlice#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "___id": "T000002R047893", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.NineSlice#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "___id": "T000002R047894", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.NineSlice#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "___id": "T000002R047895", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.NineSlice#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "___id": "T000002R047896", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.NineSlice#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "___id": "T000002R047897", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.NineSlice#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "___id": "T000002R047898", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.NineSlice#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R047899", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.NineSlice#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R047900", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.NineSlice#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R047901", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.NineSlice#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R047902", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.NineSlice#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R047903", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.NineSlice#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R047905", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.NineSlice#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R047906", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.NineSlice#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R047907", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.NineSlice#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "___id": "T000002R047908", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.NineSlice#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R047909", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.NineSlice#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R047910", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.NineSlice#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R047911", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.NineSlice#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R047912", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.NineSlice#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "___id": "T000002R047913", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.NineSlice#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "___id": "T000002R047914", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.NineSlice#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "___id": "T000002R047915", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.NineSlice#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "___id": "T000002R047916", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.NineSlice#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R047917", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.NineSlice#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R047918", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.NineSlice#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R047919", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.NineSlice#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R047920", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.NineSlice#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R047921", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.NineSlice#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R047922", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.NineSlice#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R047923", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.NineSlice#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R047924", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.NineSlice#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R047925", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.NineSlice#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R047926", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.NineSlice#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R047927", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.NineSlice#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R047928", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.NineSlice#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R047929", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.NineSlice#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R047930", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.NineSlice#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R047931", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.NineSlice#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R047932", "___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": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "texture", "longname": "Phaser.GameObjects.NineSlice#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#texture", "inherited": true, "___id": "T000002R047933", "___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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "frame", "longname": "Phaser.GameObjects.NineSlice#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#frame", "inherited": true, "___id": "T000002R047934", "___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": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.GameObjects.NineSlice#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Texture#setTexture", "inherited": true, "___id": "T000002R047936", "___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": 75, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.GameObjects.NineSlice#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Texture#setFrame", "inherited": true, "___id": "T000002R047937", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.NineSlice#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R047938", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.NineSlice#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R047942", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.NineSlice#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R047943", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.NineSlice#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R047944", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.NineSlice#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R047945", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.NineSlice#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R047946", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.NineSlice#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R047947", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.NineSlice#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R047948", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.NineSlice#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R047949", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.NineSlice#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R047950", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.NineSlice#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R047951", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.NineSlice#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R047952", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.NineSlice#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R047953", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.NineSlice#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R047954", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.NineSlice#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R047955", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.NineSlice#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R047956", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.NineSlice#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R047957", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.NineSlice#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R047958", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.NineSlice#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R047959", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.NineSlice#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R047960", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.NineSlice#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R047961", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.NineSlice#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R047962", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.NineSlice#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R047963", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.NineSlice#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R047964", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.NineSlice#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R047966", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.NineSlice#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R047967", "___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#manager\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": {} }, "name": "manager", "longname": "Phaser.GameObjects.Particles.GravityWell#manager", "kind": "member", "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.", "type": { "names": [ "Phaser.GameObjects.Particles.ParticleEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.ParticleEmitter" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.GravityWell", "scope": "instance", "inherits": "Phaser.GameObjects.Particles.ParticleProcessor#manager", "inherited": true, "___id": "T000002R047968", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Particles.GravityWell#x", "kind": "member", "description": "The x coordinate of the Particle Processor, in world space.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.GravityWell", "scope": "instance", "inherits": "Phaser.GameObjects.Particles.ParticleProcessor#x", "inherited": true, "___id": "T000002R047969", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Particles.GravityWell#y", "kind": "member", "description": "The y coordinate of the Particle Processor, in world space.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.GravityWell", "scope": "instance", "inherits": "Phaser.GameObjects.Particles.ParticleProcessor#y", "inherited": true, "___id": "T000002R047970", "___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": {} }, "name": "active", "longname": "Phaser.GameObjects.Particles.GravityWell#active", "kind": "member", "description": "The active state of the Particle Processor.\r\rAn inactive Particle Processor will be skipped for processing by\rits parent Emitter.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.GravityWell", "scope": "instance", "inherits": "Phaser.GameObjects.Particles.ParticleProcessor#active", "inherited": true, "___id": "T000002R047971", "___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": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Particles.GravityWell#destroy", "kind": "function", "description": "Destroys this Particle Processor by removing all external references.\r\rThis is called automatically when the owning Particle Emitter is destroyed.", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.GravityWell", "scope": "instance", "inherits": "Phaser.GameObjects.Particles.ParticleProcessor#destroy", "inherited": true, "___id": "T000002R047972", "___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#manager\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": {} }, "name": "manager", "longname": "Phaser.GameObjects.Particles.ParticleBounds#manager", "kind": "member", "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.", "type": { "names": [ "Phaser.GameObjects.Particles.ParticleEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.ParticleEmitter" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleBounds", "scope": "instance", "inherits": "Phaser.GameObjects.Particles.ParticleProcessor#manager", "inherited": true, "___id": "T000002R047973", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Particles.ParticleBounds#x", "kind": "member", "description": "The x coordinate of the Particle Processor, in world space.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleBounds", "scope": "instance", "inherits": "Phaser.GameObjects.Particles.ParticleProcessor#x", "inherited": true, "___id": "T000002R047974", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Particles.ParticleBounds#y", "kind": "member", "description": "The y coordinate of the Particle Processor, in world space.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleBounds", "scope": "instance", "inherits": "Phaser.GameObjects.Particles.ParticleProcessor#y", "inherited": true, "___id": "T000002R047975", "___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": {} }, "name": "active", "longname": "Phaser.GameObjects.Particles.ParticleBounds#active", "kind": "member", "description": "The active state of the Particle Processor.\r\rAn inactive Particle Processor will be skipped for processing by\rits parent Emitter.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleBounds", "scope": "instance", "inherits": "Phaser.GameObjects.Particles.ParticleProcessor#active", "inherited": true, "___id": "T000002R047976", "___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": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Particles.ParticleBounds#destroy", "kind": "function", "description": "Destroys this Particle Processor by removing all external references.\r\rThis is called automatically when the owning Particle Emitter is destroyed.", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleBounds", "scope": "instance", "inherits": "Phaser.GameObjects.Particles.ParticleProcessor#destroy", "inherited": true, "___id": "T000002R047977", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R047978", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#displayList", "kind": "member", "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.", "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.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R047979", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R047980", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R047981", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R047982", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R047983", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R047984", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R047985", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R047986", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R047987", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R047988", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#input", "kind": "member", "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()`.", "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.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R047989", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R047990", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R047991", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R047992", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R047993", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R047994", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R047995", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R047996", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R047997", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R047998", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getData", "kind": "function", "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.", "since": "3.0.0", "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.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R047999", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R048000", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R048001", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R048002", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R048003", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R048004", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R048005", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R048006", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getIndexList", "kind": "function", "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.", "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.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R048007", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R048008", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R048009", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R048010", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R048011", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R048012", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R048013", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R048014", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R048015", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R048016", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R048017", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R048018", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R048019", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R048020", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R048021", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R048022", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R048023", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R048025", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "___id": "T000002R048026", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R048027", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R048029", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R048030", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R048032", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R048033", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R048034", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R048035", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R048036", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R048037", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R048038", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R048039", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R048040", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R048041", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "___id": "T000002R048042", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "___id": "T000002R048043", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "___id": "T000002R048044", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "___id": "T000002R048045", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R048046", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R048047", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R048048", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R048049", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R048050", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R048051", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R048052", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R048053", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R048054", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R048055", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R048056", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R048057", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R048058", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R048059", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R048060", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R048061", "___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": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "texture", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#texture", "inherited": true, "___id": "T000002R048062", "___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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "frame", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#frame", "inherited": true, "___id": "T000002R048063", "___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": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Texture#setTexture", "inherited": true, "___id": "T000002R048065", "___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": 75, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Texture#setFrame", "inherited": true, "___id": "T000002R048066", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R048067", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R048071", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R048072", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R048073", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R048074", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R048075", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R048076", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R048077", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R048078", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R048079", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R048080", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R048081", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R048082", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R048083", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R048084", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R048085", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R048086", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R048087", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R048088", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R048089", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R048090", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R048091", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R048092", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R048093", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R048095", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R048096", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Sprite#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R048097", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Sprite#displayList", "kind": "member", "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.", "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.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R048098", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Sprite#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R048099", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Sprite#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R048100", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Sprite#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R048101", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Sprite#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R048102", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Sprite#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R048103", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Sprite#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R048104", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Sprite#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R048105", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Sprite#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R048106", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Sprite#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R048107", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Sprite#input", "kind": "member", "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()`.", "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.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R048108", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Sprite#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R048109", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Sprite#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R048110", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Sprite#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R048111", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Sprite#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R048112", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Sprite#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R048113", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Sprite#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R048114", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Sprite#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R048115", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Sprite#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R048116", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Sprite#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R048117", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Sprite#getData", "kind": "function", "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.", "since": "3.0.0", "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.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R048118", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Sprite#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R048119", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Sprite#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R048120", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Sprite#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R048121", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Sprite#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R048122", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Sprite#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R048123", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Sprite#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R048124", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Sprite#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R048125", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Sprite#getIndexList", "kind": "function", "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.", "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.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R048126", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Sprite#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R048127", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Sprite#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R048128", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Sprite#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R048129", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Sprite#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R048130", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Sprite#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R048131", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Sprite#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R048132", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Sprite#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R048133", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Sprite#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R048134", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Sprite#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R048135", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Sprite#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R048136", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Sprite#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R048137", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Sprite#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R048138", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Sprite#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R048139", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Sprite#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R048140", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Sprite#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R048141", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Sprite#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R048142", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Sprite#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "___id": "T000002R048148", "___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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Sprite#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Alpha#setAlpha", "inherited": true, "___id": "T000002R048149", "___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 *\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Sprite#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alpha", "inherited": true, "___id": "T000002R048150", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.GameObjects.Sprite#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "___id": "T000002R048151", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.GameObjects.Sprite#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "___id": "T000002R048152", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.GameObjects.Sprite#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "___id": "T000002R048153", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.GameObjects.Sprite#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "___id": "T000002R048154", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Sprite#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R048156", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Sprite#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R048157", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Sprite#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R048159", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Sprite#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R048160", "___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.Components.Flip#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipX", "longname": "Phaser.GameObjects.Sprite#flipX", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipX", "inherited": true, "___id": "T000002R048161", "___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.Components.Flip#flipY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipY", "longname": "Phaser.GameObjects.Sprite#flipY", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipY", "inherited": true, "___id": "T000002R048162", "___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 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 * @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": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipX", "longname": "Phaser.GameObjects.Sprite#toggleFlipX", "kind": "function", "description": "Toggles the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipX", "inherited": true, "___id": "T000002R048163", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipY", "longname": "Phaser.GameObjects.Sprite#toggleFlipY", "kind": "function", "description": "Toggles the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipY", "inherited": true, "___id": "T000002R048164", "___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 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 * @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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipX", "longname": "Phaser.GameObjects.Sprite#setFlipX", "kind": "function", "description": "Sets the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipX", "inherited": true, "___id": "T000002R048165", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\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": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipY", "longname": "Phaser.GameObjects.Sprite#setFlipY", "kind": "function", "description": "Sets the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipY", "inherited": true, "___id": "T000002R048166", "___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 inversed 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 horizontal 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": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlip", "longname": "Phaser.GameObjects.Sprite#setFlip", "kind": "function", "description": "Sets the horizontal and vertical flipped state of this Game Object.\r\rA Game Object that is flipped will render inversed 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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 horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlip", "inherited": true, "___id": "T000002R048167", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetFlip", "longname": "Phaser.GameObjects.Sprite#resetFlip", "kind": "function", "description": "Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#resetFlip", "inherited": true, "___id": "T000002R048168", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.Sprite#getCenter", "kind": "function", "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`.", "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]" } ], "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.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "___id": "T000002R048170", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.Sprite#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "___id": "T000002R048171", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.Sprite#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "___id": "T000002R048172", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.Sprite#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "___id": "T000002R048173", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.Sprite#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "___id": "T000002R048174", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.Sprite#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "___id": "T000002R048175", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.Sprite#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "___id": "T000002R048176", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.Sprite#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "___id": "T000002R048177", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.Sprite#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "___id": "T000002R048178", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.Sprite#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "___id": "T000002R048179", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Sprite#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R048180", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Sprite#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R048181", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Sprite#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R048182", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Sprite#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R048183", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Sprite#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R048184", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Sprite#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R048186", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Sprite#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R048187", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Sprite#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R048188", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Sprite#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R048189", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Sprite#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "___id": "T000002R048190", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Sprite#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R048191", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Sprite#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "___id": "T000002R048192", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Sprite#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R048193", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Sprite#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R048194", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Sprite#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R048195", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Sprite#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R048196", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Sprite#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "___id": "T000002R048197", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Sprite#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "___id": "T000002R048198", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Sprite#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "___id": "T000002R048199", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Sprite#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "___id": "T000002R048200", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Sprite#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R048201", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Sprite#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R048202", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Sprite#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R048203", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Sprite#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R048204", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Sprite#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R048205", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Sprite#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R048206", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Sprite#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R048207", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Sprite#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R048208", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Sprite#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R048209", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Sprite#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R048210", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Sprite#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R048211", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Sprite#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R048212", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Sprite#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R048213", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Sprite#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R048214", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Sprite#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R048215", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Sprite#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R048216", "___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": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Sprite#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#width", "inherited": true, "___id": "T000002R048218", "___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": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Sprite#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#height", "inherited": true, "___id": "T000002R048219", "___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": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Sprite#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayWidth", "inherited": true, "___id": "T000002R048220", "___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": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Sprite#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayHeight", "inherited": true, "___id": "T000002R048221", "___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": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSizeToFrame", "longname": "Phaser.GameObjects.Sprite#setSizeToFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setSizeToFrame", "inherited": true, "___id": "T000002R048222", "___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": 139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.GameObjects.Sprite#setSize", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setSize", "inherited": true, "___id": "T000002R048223", "___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.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": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Sprite#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setDisplaySize", "inherited": true, "___id": "T000002R048224", "___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": {} }, "name": "texture", "longname": "Phaser.GameObjects.Sprite#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#texture", "inherited": true, "___id": "T000002R048225", "___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": {} }, "name": "frame", "longname": "Phaser.GameObjects.Sprite#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#frame", "inherited": true, "___id": "T000002R048226", "___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": {} }, "name": "isCropped", "longname": "Phaser.GameObjects.Sprite#isCropped", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#isCropped", "inherited": true, "___id": "T000002R048227", "___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 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 rect 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. 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.\r\n * @param {number} [width] - The width of the crop rectangle in pixels.\r\n * @param {number} [height] - The height of the crop rectangle in pixels.\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": {} }, "name": "setCrop", "longname": "Phaser.GameObjects.Sprite#setCrop", "kind": "function", "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 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 rect 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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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. 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.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the crop rectangle in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the crop rectangle in pixels.", "name": "height" } ], "inherits": "Phaser.GameObjects.Components.TextureCrop#setCrop", "inherited": true, "___id": "T000002R048228", "___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": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.GameObjects.Sprite#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.TextureCrop#setTexture", "inherited": true, "___id": "T000002R048229", "___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": 128, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.GameObjects.Sprite#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.TextureCrop#setFrame", "inherited": true, "___id": "T000002R048230", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertice 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": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopLeft", "longname": "Phaser.GameObjects.Sprite#tintTopLeft", "kind": "member", "description": "The tint value being applied to the top-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopLeft", "inherited": true, "___id": "T000002R048232", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-right vertice 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopRight", "longname": "Phaser.GameObjects.Sprite#tintTopRight", "kind": "member", "description": "The tint value being applied to the top-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopRight", "inherited": true, "___id": "T000002R048233", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-left vertice 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": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomLeft", "longname": "Phaser.GameObjects.Sprite#tintBottomLeft", "kind": "member", "description": "The tint value being applied to the bottom-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "inherited": true, "___id": "T000002R048234", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-right vertice 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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomRight", "longname": "Phaser.GameObjects.Sprite#tintBottomRight", "kind": "member", "description": "The tint value being applied to the bottom-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomRight", "inherited": true, "___id": "T000002R048235", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintFill", "longname": "Phaser.GameObjects.Sprite#tintFill", "kind": "member", "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.11.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintFill", "inherited": true, "___id": "T000002R048236", "___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 'additive',\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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearTint", "longname": "Phaser.GameObjects.Sprite#clearTint", "kind": "function", "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff and the tint type to 'additive',\rwhich results in no visible change to the texture.", "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.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#clearTint", "inherited": true, "___id": "T000002R048237", "___s": true }, { "comment": "/**\r\n * Sets an additive tint 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 * multiplying it by 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 * To swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.\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": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTint", "longname": "Phaser.GameObjects.Sprite#setTint", "kind": "function", "description": "Sets an additive tint on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by 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\rTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.", "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.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Tint#setTint", "inherited": true, "___id": "T000002R048238", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on this Game Object.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. You can provide either one color value, in which case the whole\r\n * Game Object will be rendered in that color. Or you can provide a color per corner. The colors\r\n * 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 * To swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintFill\r\n * @webglOnly\r\n * @since 3.11.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.\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": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTintFill", "longname": "Phaser.GameObjects.Sprite#setTintFill", "kind": "function", "description": "Sets a fill-based tint on this Game Object.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. You can provide either one color value, in which case the whole\rGame Object will be rendered in that color. Or you can provide a color per corner. The colors\rare 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\rTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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 not 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" } ], "inherits": "Phaser.GameObjects.Components.Tint#setTintFill", "inherited": true, "___id": "T000002R048239", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.\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": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tint", "longname": "Phaser.GameObjects.Sprite#tint", "kind": "member", "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tint", "inherited": true, "___id": "T000002R048240", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * It checks to see if the 4 tint properties are set to the value 0xffffff\r\n * and that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.\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": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isTinted", "longname": "Phaser.GameObjects.Sprite#isTinted", "kind": "member", "description": "Does this Game Object have a tint applied?\r\rIt checks to see if the 4 tint properties are set to the value 0xffffff\rand that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "readonly": true, "since": "3.11.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#isTinted", "inherited": true, "___id": "T000002R048241", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Sprite#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R048242", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Sprite#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R048246", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Sprite#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R048247", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Sprite#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R048248", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Sprite#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R048249", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Sprite#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R048250", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Sprite#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R048251", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Sprite#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R048252", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Sprite#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R048253", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Sprite#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R048254", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Sprite#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R048255", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Sprite#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R048256", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Sprite#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R048257", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Sprite#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R048258", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Sprite#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R048259", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Sprite#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R048260", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Sprite#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R048261", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Sprite#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R048262", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Sprite#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R048263", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Sprite#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R048264", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Sprite#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R048265", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Sprite#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R048266", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Sprite#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R048267", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Sprite#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R048268", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Sprite#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R048270", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Sprite#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R048271", "___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": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "anims", "longname": "Phaser.GameObjects.PathFollower#anims", "kind": "member", "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.", "type": { "names": [ "Phaser.Animations.AnimationState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationState" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Sprite#anims", "inherited": true, "___id": "T000002R048273", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "play", "longname": "Phaser.GameObjects.PathFollower#play", "kind": "function", "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.", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#play", "inherited": true, "___id": "T000002R048274", "___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": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "playReverse", "longname": "Phaser.GameObjects.PathFollower#playReverse", "kind": "function", "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.", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#playReverse", "inherited": true, "___id": "T000002R048275", "___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": 270, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "playAfterDelay", "longname": "Phaser.GameObjects.PathFollower#playAfterDelay", "kind": "function", "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'.", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#playAfterDelay", "inherited": true, "___id": "T000002R048276", "___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": 300, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "playAfterRepeat", "longname": "Phaser.GameObjects.PathFollower#playAfterRepeat", "kind": "function", "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.", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#playAfterRepeat", "inherited": true, "___id": "T000002R048277", "___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": 327, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "chain", "longname": "Phaser.GameObjects.PathFollower#chain", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#chain", "inherited": true, "___id": "T000002R048278", "___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": 359, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "stop", "longname": "Phaser.GameObjects.PathFollower#stop", "kind": "function", "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.", "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Sprite#stop", "inherited": true, "___id": "T000002R048279", "___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": 377, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "stopAfterDelay", "longname": "Phaser.GameObjects.PathFollower#stopAfterDelay", "kind": "function", "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.", "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.PathFollower", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of milliseconds to wait before stopping this animation.", "name": "delay" } ], "inherits": "Phaser.GameObjects.Sprite#stopAfterDelay", "inherited": true, "___id": "T000002R048280", "___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": 400, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "stopAfterRepeat", "longname": "Phaser.GameObjects.PathFollower#stopAfterRepeat", "kind": "function", "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.", "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.PathFollower", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#stopAfterRepeat", "inherited": true, "___id": "T000002R048281", "___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": 423, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "stopOnFrame", "longname": "Phaser.GameObjects.PathFollower#stopOnFrame", "kind": "function", "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.", "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.PathFollower", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The frame to check before stopping this animation.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Sprite#stopOnFrame", "inherited": true, "___id": "T000002R048282", "___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": 447, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.PathFollower#toJSON", "kind": "function", "description": "Build a JSON representation of this Sprite.", "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Sprite#toJSON", "inherited": true, "___id": "T000002R048283", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.PathFollower#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R048287", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.PathFollower#displayList", "kind": "member", "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.", "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R048288", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.PathFollower#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R048289", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.PathFollower#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R048290", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.PathFollower#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R048291", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.PathFollower#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R048292", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.PathFollower#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R048293", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.PathFollower#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R048294", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.PathFollower#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R048295", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.PathFollower#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R048296", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.PathFollower#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R048297", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.PathFollower#input", "kind": "member", "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()`.", "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R048298", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.PathFollower#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R048299", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.PathFollower#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R048300", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.PathFollower#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R048301", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.PathFollower#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R048302", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.PathFollower#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R048303", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.PathFollower#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R048304", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.PathFollower#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R048305", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.PathFollower#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R048306", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.PathFollower#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R048307", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.PathFollower#getData", "kind": "function", "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.", "since": "3.0.0", "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R048308", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.PathFollower#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R048309", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.PathFollower#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R048310", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.PathFollower#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R048311", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.PathFollower#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R048312", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.PathFollower#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R048313", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.PathFollower#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R048314", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.PathFollower#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R048315", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.PathFollower#getIndexList", "kind": "function", "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.", "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R048316", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.PathFollower#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R048317", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.PathFollower#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R048318", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.PathFollower#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R048319", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.PathFollower#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R048320", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.PathFollower#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R048321", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.PathFollower#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R048322", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.PathFollower#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R048323", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.PathFollower#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R048324", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.PathFollower#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R048325", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.PathFollower#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R048326", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.PathFollower#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R048327", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.PathFollower#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R048328", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.PathFollower#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R048329", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.PathFollower#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R048330", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.PathFollower#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R048331", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.PathFollower#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R048332", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.PathFollower#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "___id": "T000002R048338", "___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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.PathFollower#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#setAlpha", "inherited": true, "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" } ], "___id": "T000002R048339", "___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 *\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.PathFollower#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alpha", "inherited": true, "___id": "T000002R048340", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.GameObjects.PathFollower#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "___id": "T000002R048341", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.GameObjects.PathFollower#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "___id": "T000002R048342", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.GameObjects.PathFollower#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "___id": "T000002R048343", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.GameObjects.PathFollower#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "___id": "T000002R048344", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.PathFollower#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R048346", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.PathFollower#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "___id": "T000002R048347", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.PathFollower#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R048349", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.PathFollower#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "___id": "T000002R048350", "___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.Components.Flip#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipX", "longname": "Phaser.GameObjects.PathFollower#flipX", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipX", "inherited": true, "___id": "T000002R048351", "___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.Components.Flip#flipY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipY", "longname": "Phaser.GameObjects.PathFollower#flipY", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipY", "inherited": true, "___id": "T000002R048352", "___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 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 * @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": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipX", "longname": "Phaser.GameObjects.PathFollower#toggleFlipX", "kind": "function", "description": "Toggles the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipX", "inherited": true, "___id": "T000002R048353", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipY", "longname": "Phaser.GameObjects.PathFollower#toggleFlipY", "kind": "function", "description": "Toggles the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipY", "inherited": true, "___id": "T000002R048354", "___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 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 * @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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipX", "longname": "Phaser.GameObjects.PathFollower#setFlipX", "kind": "function", "description": "Sets the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlipX", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "___id": "T000002R048355", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\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": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipY", "longname": "Phaser.GameObjects.PathFollower#setFlipY", "kind": "function", "description": "Sets the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlipY", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "___id": "T000002R048356", "___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 inversed 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 horizontal 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": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlip", "longname": "Phaser.GameObjects.PathFollower#setFlip", "kind": "function", "description": "Sets the horizontal and vertical flipped state of this Game Object.\r\rA Game Object that is flipped will render inversed 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlip", "inherited": true, "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 horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "___id": "T000002R048357", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetFlip", "longname": "Phaser.GameObjects.PathFollower#resetFlip", "kind": "function", "description": "Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#resetFlip", "inherited": true, "___id": "T000002R048358", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.PathFollower#getCenter", "kind": "function", "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`.", "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]" } ], "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "___id": "T000002R048360", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.PathFollower#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "___id": "T000002R048361", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.PathFollower#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "___id": "T000002R048362", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.PathFollower#getTopRight", "kind": "function", "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`.", "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]" } ], "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "___id": "T000002R048363", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.PathFollower#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "___id": "T000002R048364", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.PathFollower#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "___id": "T000002R048365", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.PathFollower#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "___id": "T000002R048366", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.PathFollower#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "___id": "T000002R048367", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.PathFollower#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "___id": "T000002R048368", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.PathFollower#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "___id": "T000002R048369", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.PathFollower#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R048370", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.PathFollower#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "___id": "T000002R048371", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.PathFollower#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "___id": "T000002R048372", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.PathFollower#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "___id": "T000002R048373", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.PathFollower#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "___id": "T000002R048374", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.PathFollower#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R048376", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.PathFollower#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R048377", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.PathFollower#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R048378", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.PathFollower#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R048379", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.PathFollower#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "___id": "T000002R048380", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.PathFollower#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R048381", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.PathFollower#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "___id": "T000002R048382", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.PathFollower#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R048383", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.PathFollower#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R048384", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.PathFollower#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R048385", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.PathFollower#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R048386", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.PathFollower#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "___id": "T000002R048387", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.PathFollower#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R048388", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.PathFollower#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R048389", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.PathFollower#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R048390", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.PathFollower#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R048391", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.PathFollower#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R048392", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.PathFollower#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R048393", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.PathFollower#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R048394", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.PathFollower#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R048395", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.PathFollower#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R048396", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.PathFollower#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "___id": "T000002R048397", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.PathFollower#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R048398", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.PathFollower#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R048399", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.PathFollower#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R048400", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.PathFollower#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R048401", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.PathFollower#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R048402", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.PathFollower#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R048403", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.PathFollower#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R048404", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.PathFollower#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R048405", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.PathFollower#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "___id": "T000002R048406", "___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": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.PathFollower#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#width", "inherited": true, "___id": "T000002R048408", "___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": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.PathFollower#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#height", "inherited": true, "___id": "T000002R048409", "___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": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.PathFollower#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayWidth", "inherited": true, "___id": "T000002R048410", "___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": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.PathFollower#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayHeight", "inherited": true, "___id": "T000002R048411", "___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": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSizeToFrame", "longname": "Phaser.GameObjects.PathFollower#setSizeToFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setSizeToFrame", "inherited": true, "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" } ], "___id": "T000002R048412", "___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": 139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.GameObjects.PathFollower#setSize", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setSize", "inherited": true, "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" } ], "___id": "T000002R048413", "___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.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": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.PathFollower#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setDisplaySize", "inherited": true, "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" } ], "___id": "T000002R048414", "___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": {} }, "name": "texture", "longname": "Phaser.GameObjects.PathFollower#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#texture", "inherited": true, "___id": "T000002R048415", "___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": {} }, "name": "frame", "longname": "Phaser.GameObjects.PathFollower#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#frame", "inherited": true, "___id": "T000002R048416", "___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": {} }, "name": "isCropped", "longname": "Phaser.GameObjects.PathFollower#isCropped", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#isCropped", "inherited": true, "___id": "T000002R048417", "___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 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 rect 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. 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.\r\n * @param {number} [width] - The width of the crop rectangle in pixels.\r\n * @param {number} [height] - The height of the crop rectangle in pixels.\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": {} }, "name": "setCrop", "longname": "Phaser.GameObjects.PathFollower#setCrop", "kind": "function", "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 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 rect 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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setCrop", "inherited": true, "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. 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.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the crop rectangle in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the crop rectangle in pixels.", "name": "height" } ], "___id": "T000002R048418", "___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": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.GameObjects.PathFollower#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setTexture", "inherited": true, "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" } ], "___id": "T000002R048419", "___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": 128, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.GameObjects.PathFollower#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setFrame", "inherited": true, "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" } ], "___id": "T000002R048420", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertice 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": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopLeft", "longname": "Phaser.GameObjects.PathFollower#tintTopLeft", "kind": "member", "description": "The tint value being applied to the top-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopLeft", "inherited": true, "___id": "T000002R048422", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-right vertice 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopRight", "longname": "Phaser.GameObjects.PathFollower#tintTopRight", "kind": "member", "description": "The tint value being applied to the top-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopRight", "inherited": true, "___id": "T000002R048423", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-left vertice 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": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomLeft", "longname": "Phaser.GameObjects.PathFollower#tintBottomLeft", "kind": "member", "description": "The tint value being applied to the bottom-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "inherited": true, "___id": "T000002R048424", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-right vertice 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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomRight", "longname": "Phaser.GameObjects.PathFollower#tintBottomRight", "kind": "member", "description": "The tint value being applied to the bottom-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomRight", "inherited": true, "___id": "T000002R048425", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintFill", "longname": "Phaser.GameObjects.PathFollower#tintFill", "kind": "member", "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.11.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintFill", "inherited": true, "___id": "T000002R048426", "___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 'additive',\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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearTint", "longname": "Phaser.GameObjects.PathFollower#clearTint", "kind": "function", "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff and the tint type to 'additive',\rwhich results in no visible change to the texture.", "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#clearTint", "inherited": true, "___id": "T000002R048427", "___s": true }, { "comment": "/**\r\n * Sets an additive tint 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 * multiplying it by 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 * To swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.\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": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTint", "longname": "Phaser.GameObjects.PathFollower#setTint", "kind": "function", "description": "Sets an additive tint on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by 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\rTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.", "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#setTint", "inherited": true, "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" } ], "___id": "T000002R048428", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on this Game Object.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. You can provide either one color value, in which case the whole\r\n * Game Object will be rendered in that color. Or you can provide a color per corner. The colors\r\n * 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 * To swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintFill\r\n * @webglOnly\r\n * @since 3.11.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.\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": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTintFill", "longname": "Phaser.GameObjects.PathFollower#setTintFill", "kind": "function", "description": "Sets a fill-based tint on this Game Object.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. You can provide either one color value, in which case the whole\rGame Object will be rendered in that color. Or you can provide a color per corner. The colors\rare 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\rTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#setTintFill", "inherited": true, "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 not 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" } ], "___id": "T000002R048429", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.\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": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tint", "longname": "Phaser.GameObjects.PathFollower#tint", "kind": "member", "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tint", "inherited": true, "___id": "T000002R048430", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * It checks to see if the 4 tint properties are set to the value 0xffffff\r\n * and that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.\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": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isTinted", "longname": "Phaser.GameObjects.PathFollower#isTinted", "kind": "member", "description": "Does this Game Object have a tint applied?\r\rIt checks to see if the 4 tint properties are set to the value 0xffffff\rand that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "readonly": true, "since": "3.11.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#isTinted", "inherited": true, "___id": "T000002R048431", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.PathFollower#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R048432", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.PathFollower#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R048436", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.PathFollower#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R048437", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.PathFollower#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R048438", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.PathFollower#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R048439", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.PathFollower#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R048440", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.PathFollower#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R048441", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.PathFollower#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R048442", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.PathFollower#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R048443", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.PathFollower#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R048444", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.PathFollower#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "___id": "T000002R048445", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.PathFollower#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "___id": "T000002R048446", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.PathFollower#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "___id": "T000002R048447", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.PathFollower#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "___id": "T000002R048448", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.PathFollower#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "___id": "T000002R048449", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.PathFollower#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "___id": "T000002R048450", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.PathFollower#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "___id": "T000002R048451", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.PathFollower#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "___id": "T000002R048452", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.PathFollower#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "___id": "T000002R048453", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.PathFollower#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "___id": "T000002R048454", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.PathFollower#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R048455", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.PathFollower#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R048456", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.PathFollower#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "___id": "T000002R048457", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.PathFollower#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R048458", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.PathFollower#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R048460", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.PathFollower#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "___id": "T000002R048461", "___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": 23, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "path", "longname": "Phaser.GameObjects.PathFollower#path", "kind": "member", "description": "The Path this PathFollower is following. It can only follow one Path at a time.", "type": { "names": [ "Phaser.Curves.Path" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Curves.Path" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PathFollower#path", "inherited": true, "___id": "T000002R048462", "___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": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "rotateToPath", "longname": "Phaser.GameObjects.PathFollower#rotateToPath", "kind": "member", "description": "Should the PathFollower automatically rotate to point in the direction of the Path?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PathFollower#rotateToPath", "inherited": true, "___id": "T000002R048463", "___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": 111, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPath", "longname": "Phaser.GameObjects.PathFollower#setPath", "kind": "function", "description": "Set the Path that this PathFollower should follow.\r\rOptionally accepts {@link Phaser.Types.GameObjects.PathFollower.PathConfig} settings.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.PathFollower#setPath", "inherited": true, "___id": "T000002R048464", "___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": 145, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setRotateToPath", "longname": "Phaser.GameObjects.PathFollower#setRotateToPath", "kind": "function", "description": "Set whether the PathFollower should automatically rotate to point in the direction of the Path.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.PathFollower#setRotateToPath", "inherited": true, "___id": "T000002R048465", "___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` is this PathFollower is actively following a Path, otherwise `false`.\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isFollowing", "longname": "Phaser.GameObjects.PathFollower#isFollowing", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` is this PathFollower is actively following a Path, otherwise `false`." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PathFollower#isFollowing", "inherited": true, "___id": "T000002R048466", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "startFollow", "longname": "Phaser.GameObjects.PathFollower#startFollow", "kind": "function", "description": "Starts this PathFollower following its given Path.", "since": "3.3.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.PathFollower#startFollow", "inherited": true, "___id": "T000002R048467", "___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": 285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pauseFollow", "longname": "Phaser.GameObjects.PathFollower#pauseFollow", "kind": "function", "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.", "since": "3.3.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PathFollower#pauseFollow", "inherited": true, "___id": "T000002R048468", "___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": 306, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resumeFollow", "longname": "Phaser.GameObjects.PathFollower#resumeFollow", "kind": "function", "description": "Resumes a previously paused PathFollower.\r\rIf the PathFollower was not paused this has no effect.", "since": "3.3.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PathFollower#resumeFollow", "inherited": true, "___id": "T000002R048469", "___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": 328, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "stopFollow", "longname": "Phaser.GameObjects.PathFollower#stopFollow", "kind": "function", "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.", "since": "3.3.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PathFollower#stopFollow", "inherited": true, "___id": "T000002R048470", "___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": 350, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pathUpdate", "longname": "Phaser.GameObjects.PathFollower#pathUpdate", "kind": "function", "description": "Internal update handler that advances this PathFollower along the path.\r\rCalled automatically by the Scene step, should not typically be called directly.", "since": "3.17.0", "memberof": "Phaser.GameObjects.PathFollower", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PathFollower#pathUpdate", "inherited": true, "___id": "T000002R048471", "___s": true }, { "comment": "/**\r\n * An array containing the Face instances belonging to this Mesh.\r\n *\r\n * A Face consists of 3 Vertex objects.\r\n *\r\n * This array is populated during calls such as `addVertices` or `addOBJ`.\r\n *\r\n * @name Phaser.GameObjects.Mesh#faces\r\n * @type {Phaser.Geom.Mesh.Face[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 117, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "faces", "longname": "Phaser.GameObjects.Plane#faces", "kind": "member", "description": "An array containing the Face instances belonging to this Mesh.\r\rA Face consists of 3 Vertex objects.\r\rThis array is populated during calls such as `addVertices` or `addOBJ`.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Mesh.Face", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#faces", "inherited": true, "___id": "T000002R048472", "___s": true }, { "comment": "/**\r\n * An array containing Vertex instances. One instance per vertex in this Mesh.\r\n *\r\n * This array is populated during calls such as `addVertex` or `addOBJ`.\r\n *\r\n * @name Phaser.GameObjects.Mesh#vertices\r\n * @type {Phaser.Geom.Mesh.Vertex[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "vertices", "longname": "Phaser.GameObjects.Plane#vertices", "kind": "member", "description": "An array containing Vertex instances. One instance per vertex in this Mesh.\r\rThis array is populated during calls such as `addVertex` or `addOBJ`.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Mesh.Vertex", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#vertices", "inherited": true, "___id": "T000002R048473", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertex colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Mesh#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "tintFill", "longname": "Phaser.GameObjects.Plane#tintFill", "kind": "member", "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertex colors replace the texture, but respects texture alpha.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#tintFill", "inherited": true, "___id": "T000002R048474", "___s": true }, { "comment": "/**\r\n * You can optionally choose to render the vertices of this Mesh 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 `Mesh.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 Mesh 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 * Please note that high vertex count Meshes will struggle to debug properly.\r\n *\r\n * @name Phaser.GameObjects.Mesh#debugCallback\r\n * @type {function}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "debugCallback", "longname": "Phaser.GameObjects.Plane#debugCallback", "kind": "member", "description": "You can optionally choose to render the vertices of this Mesh 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 `Mesh.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 Mesh 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`.\r\rPlease note that high vertex count Meshes will struggle to debug properly.", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#debugCallback", "inherited": true, "___id": "T000002R048475", "___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.Mesh#debugGraphic\r\n * @type {Phaser.GameObjects.Graphics}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "debugGraphic", "longname": "Phaser.GameObjects.Plane#debugGraphic", "kind": "member", "description": "The Graphics instance that the debug vertices will be drawn to, if `setDebug` has\rbeen called.", "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#debugGraphic", "inherited": true, "___id": "T000002R048476", "___s": true }, { "comment": "/**\r\n * When rendering, skip any Face that isn't counter clockwise?\r\n *\r\n * Enable this to hide backward-facing Faces during rendering.\r\n *\r\n * Disable it to render all Faces.\r\n *\r\n * @name Phaser.GameObjects.Mesh#hideCCW\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 189, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "hideCCW", "longname": "Phaser.GameObjects.Plane#hideCCW", "kind": "member", "description": "When rendering, skip any Face that isn't counter clockwise?\r\rEnable this to hide backward-facing Faces during rendering.\r\rDisable it to render all Faces.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#hideCCW", "inherited": true, "___id": "T000002R048477", "___s": true }, { "comment": "/**\r\n * A Vector3 containing the 3D position of the vertices in this Mesh.\r\n *\r\n * Modifying the components of this property will allow you to reposition where\r\n * the vertices are rendered within the Mesh. This happens in the `preUpdate` phase,\r\n * where each vertex is transformed using the view and projection matrices.\r\n *\r\n * Changing this property will impact all vertices being rendered by this Mesh.\r\n *\r\n * You can also adjust the 'view' by using the `pan` methods.\r\n *\r\n * @name Phaser.GameObjects.Mesh#modelPosition\r\n * @type {Phaser.Math.Vector3}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 202, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "modelPosition", "longname": "Phaser.GameObjects.Plane#modelPosition", "kind": "member", "description": "A Vector3 containing the 3D position of the vertices in this Mesh.\r\rModifying the components of this property will allow you to reposition where\rthe vertices are rendered within the Mesh. This happens in the `preUpdate` phase,\rwhere each vertex is transformed using the view and projection matrices.\r\rChanging this property will impact all vertices being rendered by this Mesh.\r\rYou can also adjust the 'view' by using the `pan` methods.", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#modelPosition", "inherited": true, "___id": "T000002R048478", "___s": true }, { "comment": "/**\r\n * A Vector3 containing the 3D scale of the vertices in this Mesh.\r\n *\r\n * Modifying the components of this property will allow you to scale\r\n * the vertices within the Mesh. This happens in the `preUpdate` phase,\r\n * where each vertex is transformed using the view and projection matrices.\r\n *\r\n * Changing this property will impact all vertices being rendered by this Mesh.\r\n *\r\n * @name Phaser.GameObjects.Mesh#modelScale\r\n * @type {Phaser.Math.Vector3}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 219, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "modelScale", "longname": "Phaser.GameObjects.Plane#modelScale", "kind": "member", "description": "A Vector3 containing the 3D scale of the vertices in this Mesh.\r\rModifying the components of this property will allow you to scale\rthe vertices within the Mesh. This happens in the `preUpdate` phase,\rwhere each vertex is transformed using the view and projection matrices.\r\rChanging this property will impact all vertices being rendered by this Mesh.", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#modelScale", "inherited": true, "___id": "T000002R048479", "___s": true }, { "comment": "/**\r\n * A Vector3 containing the 3D rotation of the vertices in this Mesh.\r\n *\r\n * The values should be given in radians, i.e. to rotate the vertices by 90\r\n * degrees you can use `modelRotation.x = Phaser.Math.DegToRad(90)`.\r\n *\r\n * Modifying the components of this property will allow you to rotate\r\n * the vertices within the Mesh. This happens in the `preUpdate` phase,\r\n * where each vertex is transformed using the view and projection matrices.\r\n *\r\n * Changing this property will impact all vertices being rendered by this Mesh.\r\n *\r\n * @name Phaser.GameObjects.Mesh#modelRotation\r\n * @type {Phaser.Math.Vector3}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "modelRotation", "longname": "Phaser.GameObjects.Plane#modelRotation", "kind": "member", "description": "A Vector3 containing the 3D rotation of the vertices in this Mesh.\r\rThe values should be given in radians, i.e. to rotate the vertices by 90\rdegrees you can use `modelRotation.x = Phaser.Math.DegToRad(90)`.\r\rModifying the components of this property will allow you to rotate\rthe vertices within the Mesh. This happens in the `preUpdate` phase,\rwhere each vertex is transformed using the view and projection matrices.\r\rChanging this property will impact all vertices being rendered by this Mesh.", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#modelRotation", "inherited": true, "___id": "T000002R048480", "___s": true }, { "comment": "/**\r\n * The transformation matrix for this Mesh.\r\n *\r\n * @name Phaser.GameObjects.Mesh#transformMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 265, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "transformMatrix", "longname": "Phaser.GameObjects.Plane#transformMatrix", "kind": "member", "description": "The transformation matrix for this Mesh.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#transformMatrix", "inherited": true, "___id": "T000002R048482", "___s": true }, { "comment": "/**\r\n * The view position for this Mesh.\r\n *\r\n * Use the methods`panX`, `panY` and `panZ` to adjust the view.\r\n *\r\n * @name Phaser.GameObjects.Mesh#viewPosition\r\n * @type {Phaser.Math.Vector3}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 274, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "viewPosition", "longname": "Phaser.GameObjects.Plane#viewPosition", "kind": "member", "description": "The view position for this Mesh.\r\rUse the methods`panX`, `panY` and `panZ` to adjust the view.", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#viewPosition", "inherited": true, "___id": "T000002R048483", "___s": true }, { "comment": "/**\r\n * The view matrix for this Mesh.\r\n *\r\n * @name Phaser.GameObjects.Mesh#viewMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 285, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "viewMatrix", "longname": "Phaser.GameObjects.Plane#viewMatrix", "kind": "member", "description": "The view matrix for this Mesh.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#viewMatrix", "inherited": true, "___id": "T000002R048484", "___s": true }, { "comment": "/**\r\n * The projection matrix for this Mesh.\r\n *\r\n * Update it with the `setPerspective` or `setOrtho` methods.\r\n *\r\n * @name Phaser.GameObjects.Mesh#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 294, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.GameObjects.Plane#projectionMatrix", "kind": "member", "description": "The projection matrix for this Mesh.\r\rUpdate it with the `setPerspective` or `setOrtho` methods.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#projectionMatrix", "inherited": true, "___id": "T000002R048485", "___s": true }, { "comment": "/**\r\n * How many faces were rendered by this Mesh Game Object in the last\r\n * draw? This is reset in the `preUpdate` method and then incremented\r\n * each time a face is drawn. Note that in multi-camera Scenes this\r\n * value may exceed that found in `Mesh.getFaceCount` due to\r\n * cameras drawing the same faces more than once.\r\n *\r\n * @name Phaser.GameObjects.Mesh#totalRendered\r\n * @type {number}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 305, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "totalRendered", "longname": "Phaser.GameObjects.Plane#totalRendered", "kind": "member", "description": "How many faces were rendered by this Mesh Game Object in the last\rdraw? This is reset in the `preUpdate` method and then incremented\reach time a face is drawn. Note that in multi-camera Scenes this\rvalue may exceed that found in `Mesh.getFaceCount` due to\rcameras drawing the same faces more than once.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#totalRendered", "inherited": true, "___id": "T000002R048486", "___s": true }, { "comment": "/**\r\n * By default, the Mesh will check to see if its model or view transform has\r\n * changed each frame and only recalculate the vertex positions if they have.\r\n *\r\n * This avoids lots of additional math in the `preUpdate` step when not required.\r\n *\r\n * However, if you are performing per-Face or per-Vertex manipulation on this Mesh,\r\n * such as tweening a Face, or moving it without moving the rest of the Mesh,\r\n * then you may need to disable the dirty cache in order for the Mesh to re-render\r\n * correctly. You can toggle this property to do that. Please note that leaving\r\n * this set to `true` will cause the Mesh to recalculate the position of every single\r\n * vertex in it, every single frame. So only really do this if you know you\r\n * need it.\r\n *\r\n * @name Phaser.GameObjects.Mesh#ignoreDirtyCache\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 331, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "ignoreDirtyCache", "longname": "Phaser.GameObjects.Plane#ignoreDirtyCache", "kind": "member", "description": "By default, the Mesh will check to see if its model or view transform has\rchanged each frame and only recalculate the vertex positions if they have.\r\rThis avoids lots of additional math in the `preUpdate` step when not required.\r\rHowever, if you are performing per-Face or per-Vertex manipulation on this Mesh,\rsuch as tweening a Face, or moving it without moving the rest of the Mesh,\rthen you may need to disable the dirty cache in order for the Mesh to re-render\rcorrectly. You can toggle this property to do that. Please note that leaving\rthis set to `true` will cause the Mesh to recalculate the position of every single\rvertex in it, every single frame. So only really do this if you know you\rneed it.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#ignoreDirtyCache", "inherited": true, "___id": "T000002R048488", "___s": true }, { "comment": "/**\r\n * The Camera fov (field of view) in degrees.\r\n *\r\n * This is set automatically as part of the `Mesh.setPerspective` call, but exposed\r\n * here for additional math.\r\n *\r\n * Do not modify this property directly, doing so will not change the fov. For that,\r\n * call the respective Mesh methods.\r\n *\r\n * @name Phaser.GameObjects.Mesh#fov\r\n * @type {number}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 351, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "fov", "longname": "Phaser.GameObjects.Plane#fov", "kind": "member", "description": "The Camera fov (field of view) in degrees.\r\rThis is set automatically as part of the `Mesh.setPerspective` call, but exposed\rhere for additional math.\r\rDo not modify this property directly, doing so will not change the fov. For that,\rcall the respective Mesh methods.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#fov", "inherited": true, "___id": "T000002R048489", "___s": true }, { "comment": "/**\r\n * Translates the view position of this Mesh on the x axis by the given amount.\r\n *\r\n * @method Phaser.GameObjects.Mesh#panX\r\n * @since 3.50.0\r\n *\r\n * @param {number} v - The amount to pan by.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 399, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "panX", "longname": "Phaser.GameObjects.Plane#panX", "kind": "function", "description": "Translates the view position of this Mesh on the x axis by the given amount.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to pan by.", "name": "v" } ], "inherits": "Phaser.GameObjects.Mesh#panX", "inherited": true, "___id": "T000002R048490", "___s": true }, { "comment": "/**\r\n * Translates the view position of this Mesh on the y axis by the given amount.\r\n *\r\n * @method Phaser.GameObjects.Mesh#panY\r\n * @since 3.50.0\r\n *\r\n * @param {number} v - The amount to pan by.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "panY", "longname": "Phaser.GameObjects.Plane#panY", "kind": "function", "description": "Translates the view position of this Mesh on the y axis by the given amount.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to pan by.", "name": "v" } ], "inherits": "Phaser.GameObjects.Mesh#panY", "inherited": true, "___id": "T000002R048491", "___s": true }, { "comment": "/**\r\n * Translates the view position of this Mesh on the z axis by the given amount.\r\n *\r\n * As the default `panZ` value is 0, vertices with `z=0` (the default) need special\r\n * care or else they will not display as they are \"behind\" the camera.\r\n *\r\n * Consider using `mesh.panZ(mesh.height / (2 * Math.tan(Math.PI / 16)))`,\r\n * which will interpret vertex geometry 1:1 with pixel geometry (or see `setOrtho`).\r\n *\r\n * @method Phaser.GameObjects.Mesh#panZ\r\n * @since 3.50.0\r\n *\r\n * @param {number} v - The amount to pan by.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "panZ", "longname": "Phaser.GameObjects.Plane#panZ", "kind": "function", "description": "Translates the view position of this Mesh on the z axis by the given amount.\r\rAs the default `panZ` value is 0, vertices with `z=0` (the default) need special\rcare or else they will not display as they are \"behind\" the camera.\r\rConsider using `mesh.panZ(mesh.height / (2 * Math.tan(Math.PI / 16)))`,\rwhich will interpret vertex geometry 1:1 with pixel geometry (or see `setOrtho`).", "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to pan by.", "name": "v" } ], "inherits": "Phaser.GameObjects.Mesh#panZ", "inherited": true, "___id": "T000002R048492", "___s": true }, { "comment": "/**\r\n * Builds a new perspective projection matrix from the given values.\r\n *\r\n * These are also the initial projection matrix and parameters for `Mesh` (see `Mesh.panZ` for more discussion).\r\n *\r\n * See also `setOrtho`.\r\n *\r\n * @method Phaser.GameObjects.Mesh#setPerspective\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The width of the projection matrix. Typically the same as the Mesh and/or Renderer.\r\n * @param {number} height - The height of the projection matrix. Typically the same as the Mesh and/or Renderer.\r\n * @param {number} [fov=45] - The field of view, in degrees.\r\n * @param {number} [near=0.01] - The near value of the view.\r\n * @param {number} [far=1000] - The far value of the view.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "setPerspective", "longname": "Phaser.GameObjects.Plane#setPerspective", "kind": "function", "description": "Builds a new perspective projection matrix from the given values.\r\rThese are also the initial projection matrix and parameters for `Mesh` (see `Mesh.panZ` for more discussion).\r\rSee also `setOrtho`.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the projection matrix. Typically the same as the Mesh and/or Renderer.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the projection matrix. Typically the same as the Mesh and/or Renderer.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 45, "description": "The field of view, in degrees.", "name": "fov" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.01, "description": "The near value of the view.", "name": "near" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The far value of the view.", "name": "far" } ], "inherits": "Phaser.GameObjects.Mesh#setPerspective", "inherited": true, "___id": "T000002R048493", "___s": true }, { "comment": "/**\r\n * Builds a new orthographic projection matrix from the given values.\r\n *\r\n * If using this mode you will often need to set `Mesh.hideCCW` to `false` as well.\r\n *\r\n * By default, calling this method with no parameters will set the scaleX value to\r\n * match the renderer's aspect ratio. If you would like to render vertex positions 1:1\r\n * to pixel positions, consider calling as `mesh.setOrtho(mesh.width, mesh.height)`.\r\n *\r\n * See also `setPerspective`.\r\n *\r\n * @method Phaser.GameObjects.Mesh#setOrtho\r\n * @since 3.50.0\r\n *\r\n * @param {number} [scaleX=1] - The default horizontal scale in relation to the Mesh / Renderer dimensions.\r\n * @param {number} [scaleY=1] - The default vertical scale in relation to the Mesh / Renderer dimensions.\r\n * @param {number} [near=-1000] - The near value of the view.\r\n * @param {number} [far=1000] - The far value of the view.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 488, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "setOrtho", "longname": "Phaser.GameObjects.Plane#setOrtho", "kind": "function", "description": "Builds a new orthographic projection matrix from the given values.\r\rIf using this mode you will often need to set `Mesh.hideCCW` to `false` as well.\r\rBy default, calling this method with no parameters will set the scaleX value to\rmatch the renderer's aspect ratio. If you would like to render vertex positions 1:1\rto pixel positions, consider calling as `mesh.setOrtho(mesh.width, mesh.height)`.\r\rSee also `setPerspective`.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The default horizontal scale in relation to the Mesh / Renderer dimensions.", "name": "scaleX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The default vertical scale in relation to the Mesh / Renderer dimensions.", "name": "scaleY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": -1000, "description": "The near value of the view.", "name": "near" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The far value of the view.", "name": "far" } ], "inherits": "Phaser.GameObjects.Mesh#setOrtho", "inherited": true, "___id": "T000002R048494", "___s": true }, { "comment": "/**\r\n * Iterates and destroys all current Faces in this Mesh, then resets the\r\n * `faces` and `vertices` arrays.\r\n *\r\n * @method Phaser.GameObjects.Mesh#clear\r\n * @since 3.50.0\r\n *\r\n * @return {this} This Mesh Game Object.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 524, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "clear", "longname": "Phaser.GameObjects.Plane#clear", "kind": "function", "description": "Iterates and destroys all current Faces in this Mesh, then resets the\r`faces` and `vertices` arrays.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Mesh Game Object." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#clear", "inherited": true, "___id": "T000002R048495", "___s": true }, { "comment": "/**\r\n * This method will add the data from a triangulated Wavefront OBJ model file to this Mesh.\r\n *\r\n * The data should have been loaded via the OBJFile:\r\n *\r\n * ```javascript\r\n * this.load.obj(key, url);\r\n * ```\r\n *\r\n * Then use the same `key` as the first parameter to this method.\r\n *\r\n * Multiple Mesh Game Objects can use the same model data without impacting on each other.\r\n *\r\n * Make sure your 3D package has triangulated the model data prior to exporting it.\r\n *\r\n * You can add multiple models to a single Mesh, although they will act as one when\r\n * moved or rotated. You can scale the model data, should it be too small, or too large, to see.\r\n * You can also offset the vertices of the model via the `x`, `y` and `z` parameters.\r\n *\r\n * @method Phaser.GameObjects.Mesh#addVerticesFromObj\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the model data in the OBJ Cache to add to this Mesh.\r\n * @param {number} [scale=1] - An amount to scale the model data by. Use this if the model has exported too small, or large, to see.\r\n * @param {number} [x=0] - Translate the model x position by this amount.\r\n * @param {number} [y=0] - Translate the model y position by this amount.\r\n * @param {number} [z=0] - Translate the model z position by this amount.\r\n * @param {number} [rotateX=0] - Rotate the model on the x axis by this amount, in radians.\r\n * @param {number} [rotateY=0] - Rotate the model on the y axis by this amount, in radians.\r\n * @param {number} [rotateZ=0] - Rotate the model on the z axis by this amount, in radians.\r\n * @param {boolean} [zIsUp=true] - Is the z axis up (true), or is y axis up (false)?\r\n *\r\n * @return {this} This Mesh Game Object.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 546, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "addVerticesFromObj", "longname": "Phaser.GameObjects.Plane#addVerticesFromObj", "kind": "function", "description": "This method will add the data from a triangulated Wavefront OBJ model file to this Mesh.\r\rThe data should have been loaded via the OBJFile:\r\r```javascript\rthis.load.obj(key, url);\r```\r\rThen use the same `key` as the first parameter to this method.\r\rMultiple Mesh Game Objects can use the same model data without impacting on each other.\r\rMake sure your 3D package has triangulated the model data prior to exporting it.\r\rYou can add multiple models to a single Mesh, although they will act as one when\rmoved or rotated. You can scale the model data, should it be too small, or too large, to see.\rYou can also offset the vertices of the model via the `x`, `y` and `z` parameters.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Mesh Game Object." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the model data in the OBJ Cache to add to this Mesh.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "An amount to scale the model data by. Use this if the model has exported too small, or large, to see.", "name": "scale" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Translate the model x position by this amount.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Translate the model y position by this amount.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Translate the model z position by this amount.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Rotate the model on the x axis by this amount, in radians.", "name": "rotateX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Rotate the model on the y axis by this amount, in radians.", "name": "rotateY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Rotate the model on the z axis by this amount, in radians.", "name": "rotateZ" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Is the z axis up (true), or is y axis up (false)?", "name": "zIsUp" } ], "inherits": "Phaser.GameObjects.Mesh#addVerticesFromObj", "inherited": true, "___id": "T000002R048496", "___s": true }, { "comment": "/**\r\n * Compare the depth of two Faces.\r\n *\r\n * @method Phaser.GameObjects.Mesh#sortByDepth\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Geom.Mesh.Face} faceA - The first Face.\r\n * @param {Phaser.Geom.Mesh.Face} faceB - The second Face.\r\n *\r\n * @return {number} The difference between the depths of each Face.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 598, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "sortByDepth", "longname": "Phaser.GameObjects.Plane#sortByDepth", "kind": "function", "description": "Compare the depth of two Faces.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The difference between the depths of each Face." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Geom.Mesh.Face" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Face" } }, "description": "The first Face.", "name": "faceA" }, { "type": { "names": [ "Phaser.Geom.Mesh.Face" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Face" } }, "description": "The second Face.", "name": "faceB" } ], "inherits": "Phaser.GameObjects.Mesh#sortByDepth", "inherited": true, "___id": "T000002R048497", "___s": true }, { "comment": "/**\r\n * Runs a depth sort across all Faces in this Mesh, comparing their averaged depth.\r\n *\r\n * This is called automatically if you use any of the `rotate` methods, but you can\r\n * also invoke it to sort the Faces should you manually position them.\r\n *\r\n * @method Phaser.GameObjects.Mesh#depthSort\r\n * @since 3.50.0\r\n *\r\n * @return {this} This Mesh Game Object.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 614, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "depthSort", "longname": "Phaser.GameObjects.Plane#depthSort", "kind": "function", "description": "Runs a depth sort across all Faces in this Mesh, comparing their averaged depth.\r\rThis is called automatically if you use any of the `rotate` methods, but you can\ralso invoke it to sort the Faces should you manually position them.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Mesh Game Object." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#depthSort", "inherited": true, "___id": "T000002R048498", "___s": true }, { "comment": "/**\r\n * Adds a new Vertex into the vertices array of this Mesh.\r\n *\r\n * Just adding a vertex isn't enough to render it. You need to also\r\n * make it part of a Face, with 3 Vertex instances per Face.\r\n *\r\n * @method Phaser.GameObjects.Mesh#addVertex\r\n * @since 3.50.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} z - The z 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 * @param {number} [color=0xffffff] - The color value of the vertex.\r\n * @param {number} [alpha=1] - The alpha value of the vertex.\r\n *\r\n * @return {this} This Mesh Game Object.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 632, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "addVertex", "longname": "Phaser.GameObjects.Plane#addVertex", "kind": "function", "description": "Adds a new Vertex into the vertices array of this Mesh.\r\rJust adding a vertex isn't enough to render it. You need to also\rmake it part of a Face, with 3 Vertex instances per Face.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Mesh Game Object." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "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 z position of the vertex.", "name": "z" }, { "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" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color value of the vertex.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The alpha value of the vertex.", "name": "alpha" } ], "inherits": "Phaser.GameObjects.Mesh#addVertex", "inherited": true, "___id": "T000002R048499", "___s": true }, { "comment": "/**\r\n * Adds a new Face into the faces array of this Mesh.\r\n *\r\n * A Face consists of references to 3 Vertex instances, which must be provided.\r\n *\r\n * @method Phaser.GameObjects.Mesh#addFace\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Geom.Mesh.Vertex} vertex1 - The first vertex of the Face.\r\n * @param {Phaser.Geom.Mesh.Vertex} vertex2 - The second vertex of the Face.\r\n * @param {Phaser.Geom.Mesh.Vertex} vertex3 - The third vertex of the Face.\r\n *\r\n * @return {this} This Mesh Game Object.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 660, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "addFace", "longname": "Phaser.GameObjects.Plane#addFace", "kind": "function", "description": "Adds a new Face into the faces array of this Mesh.\r\rA Face consists of references to 3 Vertex instances, which must be provided.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Mesh Game Object." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Geom.Mesh.Vertex" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Vertex" } }, "description": "The first vertex of the Face.", "name": "vertex1" }, { "type": { "names": [ "Phaser.Geom.Mesh.Vertex" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Vertex" } }, "description": "The second vertex of the Face.", "name": "vertex2" }, { "type": { "names": [ "Phaser.Geom.Mesh.Vertex" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Vertex" } }, "description": "The third vertex of the Face.", "name": "vertex3" } ], "inherits": "Phaser.GameObjects.Mesh#addFace", "inherited": true, "___id": "T000002R048500", "___s": true }, { "comment": "/**\r\n * Adds new vertices to this Mesh by parsing the given data.\r\n *\r\n * This method will take vertex data in one of two formats, based on the `containsZ` parameter.\r\n *\r\n * If your vertex data are `x`, `y` pairs, then `containsZ` should be `false` (this is the default, and will result in `z=0` for each vertex).\r\n *\r\n * If your vertex data is groups of `x`, `y` and `z` values, then the `containsZ` parameter must be true.\r\n *\r\n * The `uvs` parameter is a numeric array consisting of `u` and `v` pairs.\r\n *\r\n * The `normals` parameter is a numeric array consisting of `x`, `y` vertex normal values and, if `containsZ` is true, `z` values as well.\r\n *\r\n * The `indicies` parameter is an optional array that, if given, is an indexed list of vertices to be added.\r\n *\r\n * The `colors` parameter is an optional array, or single value, that if given sets the color of each vertex created.\r\n *\r\n * The `alphas` parameter is an optional array, or single value, that if given sets the alpha of each vertex created.\r\n *\r\n * When providing indexed data it is assumed that _all_ of the arrays are indexed, not just the vertices.\r\n *\r\n * The following example will create a 256 x 256 sized quad using an index array:\r\n *\r\n * ```javascript\r\n * let mesh = new Mesh(this); // Assuming `this` is a scene!\r\n * const vertices = [\r\n * -128, 128,\r\n * 128, 128,\r\n * -128, -128,\r\n * 128, -128\r\n * ];\r\n *\r\n * const uvs = [\r\n * 0, 1,\r\n * 1, 1,\r\n * 0, 0,\r\n * 1, 0\r\n * ];\r\n *\r\n * const indices = [ 0, 2, 1, 2, 3, 1 ];\r\n *\r\n * mesh.addVertices(vertices, uvs, indicies);\r\n * // Note: Otherwise the added points will be \"behind\" the camera! This value will project vertex `x` & `y` values 1:1 to pixel values.\r\n * mesh.hideCCW = false;\r\n * mesh.setOrtho(mesh.width, mesh.height);\r\n * ```\r\n *\r\n * If the data is not indexed, it's assumed that the arrays all contain sequential data.\r\n *\r\n * @method Phaser.GameObjects.Mesh#addVertices\r\n * @since 3.50.0\r\n *\r\n * @param {number[]} vertices - The vertices array. Either `xy` pairs, or `xyz` if the `containsZ` parameter is `true`.\r\n * @param {number[]} uvs - The UVs pairs array.\r\n * @param {number[]} [indicies] - Optional vertex indicies array. If you don't have one, pass `null` or an empty array.\r\n * @param {boolean} [containsZ=false] - Does the vertices data include a `z` component? If not, it will be assumed `z=0`, see methods `panZ` or `setOrtho`.\r\n * @param {number[]} [normals] - Optional vertex normals array. If you don't have one, pass `null` or an empty array.\r\n * @param {number|number[]} [colors=0xffffff] - An array of colors, one per vertex, or a single color value applied to all vertices.\r\n * @param {number|number[]} [alphas=1] - An array of alpha values, one per vertex, or a single alpha value applied to all vertices.\r\n *\r\n * @return {this} This Mesh Game Object.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 685, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "addVertices", "longname": "Phaser.GameObjects.Plane#addVertices", "kind": "function", "description": "Adds new vertices to this Mesh by parsing the given data.\r\rThis method will take vertex data in one of two formats, based on the `containsZ` parameter.\r\rIf your vertex data are `x`, `y` pairs, then `containsZ` should be `false` (this is the default, and will result in `z=0` for each vertex).\r\rIf your vertex data is groups of `x`, `y` and `z` values, then the `containsZ` parameter must be true.\r\rThe `uvs` parameter is a numeric array consisting of `u` and `v` pairs.\r\rThe `normals` parameter is a numeric array consisting of `x`, `y` vertex normal values and, if `containsZ` is true, `z` values as well.\r\rThe `indicies` parameter is an optional array that, if given, is an indexed list of vertices to be added.\r\rThe `colors` parameter is an optional array, or single value, that if given sets the color of each vertex created.\r\rThe `alphas` parameter is an optional array, or single value, that if given sets the alpha of each vertex created.\r\rWhen providing indexed data it is assumed that _all_ of the arrays are indexed, not just the vertices.\r\rThe following example will create a 256 x 256 sized quad using an index array:\r\r```javascript\rlet mesh = new Mesh(this); // Assuming `this` is a scene!\rconst vertices = [\r -128, 128,\r 128, 128,\r -128, -128,\r 128, -128\r];\r\rconst uvs = [\r 0, 1,\r 1, 1,\r 0, 0,\r 1, 0\r];\r\rconst indices = [ 0, 2, 1, 2, 3, 1 ];\r\rmesh.addVertices(vertices, uvs, indicies);\r// Note: Otherwise the added points will be \"behind\" the camera! This value will project vertex `x` & `y` values 1:1 to pixel values.\rmesh.hideCCW = false;\rmesh.setOrtho(mesh.width, mesh.height);\r```\r\rIf the data is not indexed, it's assumed that the arrays all contain sequential data.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Mesh Game Object." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The vertices array. Either `xy` pairs, or `xyz` if the `containsZ` parameter is `true`.", "name": "vertices" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The UVs pairs array.", "name": "uvs" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "Optional vertex indicies array. If you don't have one, pass `null` or an empty array.", "name": "indicies" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does the vertices data include a `z` component? If not, it will be assumed `z=0`, see methods `panZ` or `setOrtho`.", "name": "containsZ" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "Optional vertex normals array. If you don't have one, pass `null` or an empty array.", "name": "normals" }, { "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": "0xffffff", "description": "An array of colors, one per vertex, or a single color value applied to all vertices.", "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, "defaultvalue": 1, "description": "An array of alpha values, one per vertex, or a single alpha value applied to all vertices.", "name": "alphas" } ], "inherits": "Phaser.GameObjects.Mesh#addVertices", "inherited": true, "___id": "T000002R048501", "___s": true }, { "comment": "/**\r\n * Returns the total number of Faces in this Mesh Game Object.\r\n *\r\n * @method Phaser.GameObjects.Mesh#getFaceCount\r\n * @since 3.50.0\r\n *\r\n * @return {number} The number of Faces in this Mesh Game Object.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 766, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "getFaceCount", "longname": "Phaser.GameObjects.Plane#getFaceCount", "kind": "function", "description": "Returns the total number of Faces in this Mesh Game Object.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of Faces in this Mesh Game Object." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#getFaceCount", "inherited": true, "___id": "T000002R048502", "___s": true }, { "comment": "/**\r\n * Returns the total number of Vertices in this Mesh Game Object.\r\n *\r\n * @method Phaser.GameObjects.Mesh#getVertexCount\r\n * @since 3.50.0\r\n *\r\n * @return {number} The number of Vertices in this Mesh Game Object.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 779, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "getVertexCount", "longname": "Phaser.GameObjects.Plane#getVertexCount", "kind": "function", "description": "Returns the total number of Vertices in this Mesh Game Object.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of Vertices in this Mesh Game Object." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#getVertexCount", "inherited": true, "___id": "T000002R048503", "___s": true }, { "comment": "/**\r\n * Returns the Face at the given index in this Mesh Game Object.\r\n *\r\n * @method Phaser.GameObjects.Mesh#getFace\r\n * @since 3.50.0\r\n *\r\n * @param {number} index - The index of the Face to get.\r\n *\r\n * @return {Phaser.Geom.Mesh.Face} The Face at the given index, or `undefined` if index out of range.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 792, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "getFace", "longname": "Phaser.GameObjects.Plane#getFace", "kind": "function", "description": "Returns the Face at the given index in this Mesh Game Object.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Geom.Mesh.Face" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Mesh.Face" } }, "description": "The Face at the given index, or `undefined` if index out of range." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the Face to get.", "name": "index" } ], "inherits": "Phaser.GameObjects.Mesh#getFace", "inherited": true, "___id": "T000002R048504", "___s": true }, { "comment": "/**\r\n * Tests to see if _any_ face in this Mesh intersects with the given coordinates.\r\n *\r\n * The given position is translated through the matrix of this Mesh and the given Camera,\r\n * before being compared against the vertices.\r\n *\r\n * @method Phaser.GameObjects.Mesh#hasFaceAt\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - The x position to check against.\r\n * @param {number} y - The y position to check against.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The camera to pass the coordinates through. If not give, the default Scene Camera is used.\r\n *\r\n * @return {boolean} Returns `true` if _any_ face of this Mesh intersects with the given coordinate, otherwise `false`.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 807, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "hasFaceAt", "longname": "Phaser.GameObjects.Plane#hasFaceAt", "kind": "function", "description": "Tests to see if _any_ face in this Mesh intersects with the given coordinates.\r\rThe given position is translated through the matrix of this Mesh and the given Camera,\rbefore being compared against the vertices.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `true` if _any_ face of this Mesh intersects with the given coordinate, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position to check against.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position to check against.", "name": "y" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The camera to pass the coordinates through. If not give, the default Scene Camera is used.", "name": "camera" } ], "inherits": "Phaser.GameObjects.Mesh#hasFaceAt", "inherited": true, "___id": "T000002R048505", "___s": true }, { "comment": "/**\r\n * Return an array of Face objects from this Mesh that intersect with the given coordinates.\r\n *\r\n * The given position is translated through the matrix of this Mesh and the given Camera,\r\n * before being compared against the vertices.\r\n *\r\n * If more than one Face intersects, they will all be returned in the array, but the array will\r\n * be depth sorted first, so the first element will always be that closest to the camera.\r\n *\r\n * @method Phaser.GameObjects.Mesh#getFaceAt\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The x position to check against.\r\n * @param {number} y - The y position to check against.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The camera to pass the coordinates through. If not give, the default Scene Camera is used.\r\n *\r\n * @return {Phaser.Geom.Mesh.Face[]} An array of Face objects that intersect with the given point, ordered by depth.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 843, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "getFaceAt", "longname": "Phaser.GameObjects.Plane#getFaceAt", "kind": "function", "description": "Return an array of Face objects from this Mesh that intersect with the given coordinates.\r\rThe given position is translated through the matrix of this Mesh and the given Camera,\rbefore being compared against the vertices.\r\rIf more than one Face intersects, they will all be returned in the array, but the array will\rbe depth sorted first, so the first element will always be that closest to the camera.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Mesh.Face", "type": "NameExpression" } ] } }, "description": "An array of Face objects that intersect with the given point, ordered by depth." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position to check against.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position to check against.", "name": "y" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The camera to pass the coordinates through. If not give, the default Scene Camera is used.", "name": "camera" } ], "inherits": "Phaser.GameObjects.Mesh#getFaceAt", "inherited": true, "___id": "T000002R048506", "___s": true }, { "comment": "/**\r\n * This method enables rendering of the Mesh 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 Mesh objects to a single Graphics instance.\r\n *\r\n * The Mesh class has a built-in debug rendering callback `Mesh.renderDebug`, 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, faces)`\r\n *\r\n * `src` is the Mesh instance being debugged.\r\n * `faces` is an array of the Faces that were rendered.\r\n *\r\n * You can get the final drawn vertex position from a Face object like this:\r\n *\r\n * ```javascript\r\n * let face = faces[i];\r\n *\r\n * let x0 = face.vertex1.tx;\r\n * let y0 = face.vertex1.ty;\r\n * let x1 = face.vertex2.tx;\r\n * let y1 = face.vertex2.ty;\r\n * let x2 = face.vertex3.tx;\r\n * let y2 = face.vertex3.ty;\r\n *\r\n * graphic.strokeTriangle(x0, y0, x1, y1, x2, y2);\r\n * ```\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.Mesh#setDebug\r\n * @since 3.50.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": "Mesh.js", "lineno": 883, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "setDebug", "longname": "Phaser.GameObjects.Plane#setDebug", "kind": "function", "description": "This method enables rendering of the Mesh 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 Mesh objects to a single Graphics instance.\r\rThe Mesh class has a built-in debug rendering callback `Mesh.renderDebug`, 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, faces)`\r\r`src` is the Mesh instance being debugged.\r`faces` is an array of the Faces that were rendered.\r\rYou can get the final drawn vertex position from a Face object like this:\r\r```javascript\rlet face = faces[i];\r\rlet x0 = face.vertex1.tx;\rlet y0 = face.vertex1.ty;\rlet x1 = face.vertex2.tx;\rlet y1 = face.vertex2.ty;\rlet x2 = face.vertex3.tx;\rlet y2 = face.vertex3.ty;\r\rgraphic.strokeTriangle(x0, y0, x1, y1, x2, y2);\r```\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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Mesh#setDebug", "inherited": true, "___id": "T000002R048507", "___s": true }, { "comment": "/**\r\n * Checks if the transformation data in this mesh is dirty.\r\n *\r\n * This is used internally by the `preUpdate` step to determine if the vertices should\r\n * be recalculated or not.\r\n *\r\n * @method Phaser.GameObjects.Mesh#isDirty\r\n * @since 3.50.0\r\n *\r\n * @return {boolean} Returns `true` if the data of this mesh is dirty, otherwise `false`.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 949, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "isDirty", "longname": "Phaser.GameObjects.Plane#isDirty", "kind": "function", "description": "Checks if the transformation data in this mesh is dirty.\r\rThis is used internally by the `preUpdate` step to determine if the vertices should\rbe recalculated or not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `true` if the data of this mesh is dirty, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#isDirty", "inherited": true, "___id": "T000002R048508", "___s": true }, { "comment": "/**\r\n * The built-in Mesh debug rendering method.\r\n *\r\n * See `Mesh.setDebug` for more details.\r\n *\r\n * @method Phaser.GameObjects.Mesh#renderDebug\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.Mesh} src - The Mesh object being rendered.\r\n * @param {Phaser.Geom.Mesh.Face[]} faces - An array of Faces.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1091, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "renderDebug", "longname": "Phaser.GameObjects.Plane#renderDebug", "kind": "function", "description": "The built-in Mesh debug rendering method.\r\rSee `Mesh.setDebug` for more details.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.Mesh" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Mesh" } }, "description": "The Mesh object being rendered.", "name": "src" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Mesh.Face", "type": "NameExpression" } ] } }, "description": "An array of Faces.", "name": "faces" } ], "inherits": "Phaser.GameObjects.Mesh#renderDebug", "inherited": true, "___id": "T000002R048509", "___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 on all vertices,\r\n * which results in no visible change to the texture.\r\n *\r\n * @method Phaser.GameObjects.Mesh#clearTint\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1136, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "clearTint", "longname": "Phaser.GameObjects.Plane#clearTint", "kind": "function", "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff on all vertices,\rwhich results in no visible change to the texture.", "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.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#clearTint", "inherited": true, "___id": "T000002R048510", "___s": true }, { "comment": "/**\r\n * Pass this Mesh Game Object to the Input Manager to enable it for Input.\r\n *\r\n * Unlike other Game Objects, the Mesh Game Object uses its own special hit area callback, which you cannot override.\r\n *\r\n * @example\r\n * mesh.setInteractive();\r\n *\r\n * @method Phaser.GameObjects.Mesh#setInteractive\r\n * @since 3.60.0\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1153, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Plane#setInteractive", "kind": "function", "description": "Pass this Mesh Game Object to the Input Manager to enable it for Input.\r\rUnlike other Game Objects, the Mesh Game Object uses its own special hit area callback, which you cannot override.", "examples": [ "mesh.setInteractive();" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#setInteractive", "inherited": true, "___id": "T000002R048511", "___s": true }, { "comment": "/**\r\n * Sets an additive tint on all vertices of this Mesh Game Object.\r\n *\r\n * The tint works by taking the pixel color values from the Game Objects texture, and then\r\n * multiplying it by the color value of the tint.\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.\r\n *\r\n * To remove a tint call `clearTint`.\r\n *\r\n * @method Phaser.GameObjects.Mesh#setTint\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {number} [tint=0xffffff] - The tint being applied to all vertices of this Mesh Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "setTint", "longname": "Phaser.GameObjects.Plane#setTint", "kind": "function", "description": "Sets an additive tint on all vertices of this Mesh Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by the color value of the tint.\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.\r\rTo remove a tint call `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.Plane", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The tint being applied to all vertices of this Mesh Game Object.", "name": "tint" } ], "inherits": "Phaser.GameObjects.Mesh#setTint", "inherited": true, "___id": "T000002R048512", "___s": true }, { "comment": "/**\r\n * Scrolls the UV texture coordinates of all faces in this Mesh by\r\n * adding the given x/y amounts to them.\r\n *\r\n * If you only wish to scroll one coordinate, pass a value of zero\r\n * to the other.\r\n *\r\n * Use small values for scrolling. UVs are set from the range 0\r\n * to 1, so you should increment (or decrement) them by suitably\r\n * small values, such as 0.01.\r\n *\r\n * Due to a limitation in WebGL1 you can only UV scroll textures\r\n * that are a power-of-two in size. Scrolling NPOT textures will\r\n * work but will result in clamping the pixels to the edges.\r\n *\r\n * Note that if this Mesh is using a _frame_ from a texture atlas\r\n * then you will be unable to UV scroll its texture.\r\n *\r\n * @method Phaser.GameObjects.Mesh#uvScroll\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - The amount to horizontally shift the UV coordinates by.\r\n * @param {number} y - The amount to vertically shift the UV coordinates by.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1224, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "uvScroll", "longname": "Phaser.GameObjects.Plane#uvScroll", "kind": "function", "description": "Scrolls the UV texture coordinates of all faces in this Mesh by\radding the given x/y amounts to them.\r\rIf you only wish to scroll one coordinate, pass a value of zero\rto the other.\r\rUse small values for scrolling. UVs are set from the range 0\rto 1, so you should increment (or decrement) them by suitably\rsmall values, such as 0.01.\r\rDue to a limitation in WebGL1 you can only UV scroll textures\rthat are a power-of-two in size. Scrolling NPOT textures will\rwork but will result in clamping the pixels to the edges.\r\rNote that if this Mesh is using a _frame_ from a texture atlas\rthen you will be unable to UV scroll its texture.", "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.Plane", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to horizontally shift the UV coordinates by.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to vertically shift the UV coordinates by.", "name": "y" } ], "inherits": "Phaser.GameObjects.Mesh#uvScroll", "inherited": true, "___id": "T000002R048513", "___s": true }, { "comment": "/**\r\n * Scales the UV texture coordinates of all faces in this Mesh by\r\n * the exact given amounts.\r\n *\r\n * If you only wish to scale one coordinate, pass a value of one\r\n * to the other.\r\n *\r\n * Due to a limitation in WebGL1 you can only UV scale textures\r\n * that are a power-of-two in size. Scaling NPOT textures will\r\n * work but will result in clamping the pixels to the edges if\r\n * you scale beyond a value of 1. Scaling below 1 will work\r\n * regardless of texture size.\r\n *\r\n * Note that if this Mesh is using a _frame_ from a texture atlas\r\n * then you will be unable to UV scale its texture.\r\n *\r\n * @method Phaser.GameObjects.Mesh#uvScale\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - The amount to horizontally scale the UV coordinates by.\r\n * @param {number} y - The amount to vertically scale the UV coordinates by.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1263, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "uvScale", "longname": "Phaser.GameObjects.Plane#uvScale", "kind": "function", "description": "Scales the UV texture coordinates of all faces in this Mesh by\rthe exact given amounts.\r\rIf you only wish to scale one coordinate, pass a value of one\rto the other.\r\rDue to a limitation in WebGL1 you can only UV scale textures\rthat are a power-of-two in size. Scaling NPOT textures will\rwork but will result in clamping the pixels to the edges if\ryou scale beyond a value of 1. Scaling below 1 will work\rregardless of texture size.\r\rNote that if this Mesh is using a _frame_ from a texture atlas\rthen you will be unable to UV scale its texture.", "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.Plane", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to horizontally scale the UV coordinates by.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to vertically scale the UV coordinates by.", "name": "y" } ], "inherits": "Phaser.GameObjects.Mesh#uvScale", "inherited": true, "___id": "T000002R048514", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only.\r\n *\r\n * @method Phaser.GameObjects.Mesh#tint\r\n * @type {number}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1300, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "tint", "longname": "Phaser.GameObjects.Plane#tint", "kind": "function", "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } } } ], "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#tint", "inherited": true, "___id": "T000002R048515", "___s": true }, { "comment": "/**\r\n * The x rotation of the Model in 3D space, as specified in degrees.\r\n *\r\n * If you need the value in radians use the `modelRotation.x` property directly.\r\n *\r\n * @method Phaser.GameObjects.Mesh#rotateX\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1317, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "rotateX", "longname": "Phaser.GameObjects.Plane#rotateX", "kind": "function", "description": "The x rotation of the Model in 3D space, as specified in degrees.\r\rIf you need the value in radians use the `modelRotation.x` property directly.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } } } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#rotateX", "inherited": true, "___id": "T000002R048516", "___s": true }, { "comment": "/**\r\n * The y rotation of the Model in 3D space, as specified in degrees.\r\n *\r\n * If you need the value in radians use the `modelRotation.y` property directly.\r\n *\r\n * @method Phaser.GameObjects.Mesh#rotateY\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "rotateY", "longname": "Phaser.GameObjects.Plane#rotateY", "kind": "function", "description": "The y rotation of the Model in 3D space, as specified in degrees.\r\rIf you need the value in radians use the `modelRotation.y` property directly.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } } } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#rotateY", "inherited": true, "___id": "T000002R048517", "___s": true }, { "comment": "/**\r\n * The z rotation of the Model in 3D space, as specified in degrees.\r\n *\r\n * If you need the value in radians use the `modelRotation.z` property directly.\r\n *\r\n * @method Phaser.GameObjects.Mesh#rotateZ\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Mesh.js", "lineno": 1363, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh", "code": {} }, "name": "rotateZ", "longname": "Phaser.GameObjects.Plane#rotateZ", "kind": "function", "description": "The z rotation of the Model in 3D space, as specified in degrees.\r\rIf you need the value in radians use the `modelRotation.z` property directly.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } } } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Mesh#rotateZ", "inherited": true, "___id": "T000002R048518", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Plane#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R048521", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Plane#displayList", "kind": "member", "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.", "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.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R048522", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Plane#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R048523", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Plane#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R048524", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Plane#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R048525", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Plane#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R048526", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Plane#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R048527", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Plane#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R048528", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Plane#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R048529", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Plane#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R048530", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Plane#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R048531", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Plane#input", "kind": "member", "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()`.", "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.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R048532", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Plane#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R048533", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Plane#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R048534", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Plane#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R048535", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Plane#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R048536", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Plane#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R048537", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Plane#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R048538", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Plane#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R048539", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Plane#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R048540", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Plane#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R048541", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Plane#getData", "kind": "function", "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.", "since": "3.0.0", "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.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R048542", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Plane#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R048543", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Plane#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R048544", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Plane#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R048545", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Plane#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R048546", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Plane#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R048547", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Plane#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R048548", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Plane#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R048549", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Plane#getIndexList", "kind": "function", "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.", "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.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R048550", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Plane#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R048551", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Plane#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R048552", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Plane#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R048553", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Plane#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R048554", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Plane#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R048555", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Plane#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R048556", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Plane#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R048557", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Plane#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R048558", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Plane#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R048559", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Plane#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R048560", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Plane#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R048561", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Plane#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R048562", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Plane#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R048563", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Plane#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R048564", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Plane#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R048565", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Plane#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R048566", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Plane#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R048568", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Plane#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "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" } ], "___id": "T000002R048569", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Plane#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R048570", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Plane#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R048572", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Plane#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "___id": "T000002R048573", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Plane#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R048575", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Plane#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "___id": "T000002R048576", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Plane#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R048577", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Plane#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "___id": "T000002R048578", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Plane#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "___id": "T000002R048579", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Plane#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "___id": "T000002R048580", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Plane#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "___id": "T000002R048581", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Plane#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R048582", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Plane#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R048583", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Plane#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R048584", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Plane#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "___id": "T000002R048585", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Plane#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R048586", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Plane#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R048587", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Plane#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R048588", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Plane#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R048589", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Plane#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R048590", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Plane#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R048591", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Plane#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R048592", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Plane#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R048593", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Plane#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R048594", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Plane#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "___id": "T000002R048595", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Plane#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R048596", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Plane#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R048597", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Plane#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R048598", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Plane#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R048599", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Plane#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R048600", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Plane#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R048601", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Plane#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R048602", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Plane#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R048603", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Plane#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "___id": "T000002R048604", "___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": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Plane#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#width", "inherited": true, "___id": "T000002R048606", "___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": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Plane#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#height", "inherited": true, "___id": "T000002R048607", "___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": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Plane#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayWidth", "inherited": true, "___id": "T000002R048608", "___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": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Plane#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayHeight", "inherited": true, "___id": "T000002R048609", "___s": true }, { "comment": "/**\r\n * An internal method that resets the perspective projection for this Plane\r\n * when it changes texture or frame, and also resets the cell UV coordinates,\r\n * if required.\r\n *\r\n * @method Phaser.GameObjects.Plane#setSizeToFrame\r\n * @since 3.60.0\r\n * @override\r\n *\r\n * @param {boolean} [resetUV=true] - Reset all of the cell UV coordinates?\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Plane.js", "lineno": 226, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\plane", "code": {} }, "name": "setSizeToFrame", "longname": "Phaser.GameObjects.Plane#setSizeToFrame", "kind": "function", "description": "An internal method that resets the perspective projection for this Plane\rwhen it changes texture or frame, and also resets the cell UV coordinates,\rif required.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setSizeToFrame", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Reset all of the cell UV coordinates?", "name": "resetUV" } ], "overrides": "Phaser.GameObjects.Mesh#setSizeToFrame", "___id": "T000002R048610", "___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": 139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.GameObjects.Plane#setSize", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setSize", "inherited": true, "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" } ], "___id": "T000002R048611", "___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.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": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Plane#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setDisplaySize", "inherited": true, "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" } ], "___id": "T000002R048612", "___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": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "texture", "longname": "Phaser.GameObjects.Plane#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#texture", "inherited": true, "___id": "T000002R048613", "___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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "frame", "longname": "Phaser.GameObjects.Plane#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#frame", "inherited": true, "___id": "T000002R048614", "___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": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.GameObjects.Plane#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#setTexture", "inherited": true, "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" } ], "___id": "T000002R048616", "___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": 75, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.GameObjects.Plane#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#setFrame", "inherited": true, "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" } ], "___id": "T000002R048617", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Plane#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R048618", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Plane#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R048622", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Plane#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R048623", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Plane#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R048624", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Plane#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R048625", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Plane#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R048626", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Plane#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R048627", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Plane#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R048628", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Plane#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R048629", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Plane#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R048630", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Plane#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "___id": "T000002R048631", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Plane#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "___id": "T000002R048632", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Plane#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "___id": "T000002R048633", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Plane#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "___id": "T000002R048634", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Plane#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "___id": "T000002R048635", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Plane#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "___id": "T000002R048636", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Plane#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "___id": "T000002R048637", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Plane#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "___id": "T000002R048638", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Plane#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "___id": "T000002R048639", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Plane#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "___id": "T000002R048640", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Plane#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R048641", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Plane#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R048642", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Plane#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "___id": "T000002R048643", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Plane#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R048644", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Plane#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R048646", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Plane#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Plane", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "___id": "T000002R048647", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.PointLight#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R048648", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.PointLight#displayList", "kind": "member", "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.", "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.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R048649", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.PointLight#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R048650", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.PointLight#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R048651", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.PointLight#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R048652", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.PointLight#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R048653", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.PointLight#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R048654", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.PointLight#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R048655", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.PointLight#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R048656", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.PointLight#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R048657", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.PointLight#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R048658", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.PointLight#input", "kind": "member", "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()`.", "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.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R048659", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.PointLight#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R048660", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.PointLight#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R048661", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.PointLight#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R048662", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.PointLight#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R048663", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.PointLight#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R048664", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.PointLight#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R048665", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.PointLight#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R048666", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.PointLight#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R048667", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.PointLight#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R048668", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.PointLight#getData", "kind": "function", "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.", "since": "3.0.0", "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.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R048669", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.PointLight#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R048670", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.PointLight#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R048671", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.PointLight#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R048672", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.PointLight#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R048673", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.PointLight#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R048674", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.PointLight#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R048675", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.PointLight#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R048676", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.PointLight#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R048677", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.PointLight#getIndexList", "kind": "function", "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.", "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.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R048678", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.PointLight#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R048679", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.PointLight#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R048680", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.PointLight#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R048681", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.PointLight#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R048682", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.PointLight#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R048683", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.PointLight#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R048684", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.PointLight#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R048685", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.PointLight#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R048686", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.PointLight#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R048687", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.PointLight#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R048688", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.PointLight#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R048689", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.PointLight#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R048690", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.PointLight#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R048691", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.PointLight#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R048692", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.PointLight#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R048693", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.PointLight#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R048694", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.PointLight#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R048696", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.PointLight#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "___id": "T000002R048697", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.PointLight#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R048698", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.PointLight#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R048700", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.PointLight#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R048701", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.PointLight#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R048703", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.PointLight#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R048704", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.PointLight#getCenter", "kind": "function", "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`.", "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]" } ], "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.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "___id": "T000002R048706", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.PointLight#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "___id": "T000002R048707", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.PointLight#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "___id": "T000002R048708", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.PointLight#getTopRight", "kind": "function", "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`.", "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]" } ], "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.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "___id": "T000002R048709", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.PointLight#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "___id": "T000002R048710", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.PointLight#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "___id": "T000002R048711", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.PointLight#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "___id": "T000002R048712", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.PointLight#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "___id": "T000002R048713", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.PointLight#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "___id": "T000002R048714", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.PointLight#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "___id": "T000002R048715", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.PointLight#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R048716", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.PointLight#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R048717", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.PointLight#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R048718", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.PointLight#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R048719", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.PointLight#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R048720", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.PointLight#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R048721", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.PointLight#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R048722", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.PointLight#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R048723", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.PointLight#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "___id": "T000002R048724", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.PointLight#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "___id": "T000002R048725", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.PointLight#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "___id": "T000002R048726", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.PointLight#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "___id": "T000002R048727", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.PointLight#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R048728", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.PointLight#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R048729", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.PointLight#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R048730", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.PointLight#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R048731", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.PointLight#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R048732", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.PointLight#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R048733", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.PointLight#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R048734", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.PointLight#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R048735", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.PointLight#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R048736", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.PointLight#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R048737", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.PointLight#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R048738", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.PointLight#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R048739", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.PointLight#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R048740", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.PointLight#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R048741", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.PointLight#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R048742", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.PointLight#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R048743", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.PointLight#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R048744", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.PointLight#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R048748", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.PointLight#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R048749", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.PointLight#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R048750", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.PointLight#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R048751", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.PointLight#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R048752", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.PointLight#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R048753", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.PointLight#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R048754", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.PointLight#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R048755", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.PointLight#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R048756", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.PointLight#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R048757", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.PointLight#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R048758", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.PointLight#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R048759", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.PointLight#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R048760", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.PointLight#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R048761", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.PointLight#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R048762", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.PointLight#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R048763", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.PointLight#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R048764", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.PointLight#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R048765", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.PointLight#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R048766", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.PointLight#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R048767", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.PointLight#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R048768", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.PointLight#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R048769", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.PointLight#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R048770", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.PointLight#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R048772", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.PointLight#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.PointLight", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R048773", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.RenderTexture#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R048777", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.RenderTexture#displayList", "kind": "member", "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.", "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R048778", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.RenderTexture#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R048779", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.RenderTexture#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R048780", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.RenderTexture#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R048781", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.RenderTexture#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R048782", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.RenderTexture#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R048783", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.RenderTexture#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R048784", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.RenderTexture#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R048785", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.RenderTexture#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R048786", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.RenderTexture#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R048787", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.RenderTexture#input", "kind": "member", "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()`.", "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R048788", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.RenderTexture#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R048789", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.RenderTexture#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R048790", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.RenderTexture#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R048791", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.RenderTexture#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R048792", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.RenderTexture#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R048793", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.RenderTexture#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R048794", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.RenderTexture#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R048795", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.RenderTexture#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R048796", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.RenderTexture#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R048797", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.RenderTexture#getData", "kind": "function", "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.", "since": "3.0.0", "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R048798", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.RenderTexture#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R048799", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.RenderTexture#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R048800", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.RenderTexture#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R048801", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.RenderTexture#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R048802", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.RenderTexture#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R048803", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.RenderTexture#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R048804", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.RenderTexture#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R048805", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.RenderTexture#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R048806", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.RenderTexture#getIndexList", "kind": "function", "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.", "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R048807", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.RenderTexture#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R048808", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.RenderTexture#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R048809", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.RenderTexture#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R048810", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.RenderTexture#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R048811", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.RenderTexture#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R048812", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.RenderTexture#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R048813", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.RenderTexture#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R048814", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.RenderTexture#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R048815", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.RenderTexture#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R048816", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.RenderTexture#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R048817", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.RenderTexture#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R048818", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.RenderTexture#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R048819", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.RenderTexture#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R048820", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.RenderTexture#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R048821", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.RenderTexture#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R048822", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.RenderTexture#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R048823", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.RenderTexture#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "___id": "T000002R048829", "___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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.RenderTexture#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#setAlpha", "inherited": true, "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" } ], "___id": "T000002R048830", "___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 *\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.RenderTexture#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alpha", "inherited": true, "___id": "T000002R048831", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.GameObjects.RenderTexture#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "___id": "T000002R048832", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.GameObjects.RenderTexture#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "___id": "T000002R048833", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.GameObjects.RenderTexture#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "___id": "T000002R048834", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.GameObjects.RenderTexture#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "___id": "T000002R048835", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.RenderTexture#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R048837", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.RenderTexture#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "___id": "T000002R048838", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.RenderTexture#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R048840", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.RenderTexture#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "___id": "T000002R048841", "___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.Components.Flip#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipX", "longname": "Phaser.GameObjects.RenderTexture#flipX", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipX", "inherited": true, "___id": "T000002R048842", "___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.Components.Flip#flipY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipY", "longname": "Phaser.GameObjects.RenderTexture#flipY", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipY", "inherited": true, "___id": "T000002R048843", "___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 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 * @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": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipX", "longname": "Phaser.GameObjects.RenderTexture#toggleFlipX", "kind": "function", "description": "Toggles the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipX", "inherited": true, "___id": "T000002R048844", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipY", "longname": "Phaser.GameObjects.RenderTexture#toggleFlipY", "kind": "function", "description": "Toggles the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipY", "inherited": true, "___id": "T000002R048845", "___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 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 * @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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipX", "longname": "Phaser.GameObjects.RenderTexture#setFlipX", "kind": "function", "description": "Sets the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlipX", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "___id": "T000002R048846", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\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": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipY", "longname": "Phaser.GameObjects.RenderTexture#setFlipY", "kind": "function", "description": "Sets the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlipY", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "___id": "T000002R048847", "___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 inversed 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 horizontal 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": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlip", "longname": "Phaser.GameObjects.RenderTexture#setFlip", "kind": "function", "description": "Sets the horizontal and vertical flipped state of this Game Object.\r\rA Game Object that is flipped will render inversed 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlip", "inherited": true, "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 horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "___id": "T000002R048848", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetFlip", "longname": "Phaser.GameObjects.RenderTexture#resetFlip", "kind": "function", "description": "Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#resetFlip", "inherited": true, "___id": "T000002R048849", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.RenderTexture#getCenter", "kind": "function", "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`.", "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]" } ], "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "___id": "T000002R048851", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.RenderTexture#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "___id": "T000002R048852", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.RenderTexture#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "___id": "T000002R048853", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.RenderTexture#getTopRight", "kind": "function", "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`.", "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]" } ], "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "___id": "T000002R048854", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.RenderTexture#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "___id": "T000002R048855", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.RenderTexture#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "___id": "T000002R048856", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.RenderTexture#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "___id": "T000002R048857", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.RenderTexture#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "___id": "T000002R048858", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.RenderTexture#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "___id": "T000002R048859", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.RenderTexture#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "___id": "T000002R048860", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.RenderTexture#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R048861", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.RenderTexture#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "___id": "T000002R048862", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.RenderTexture#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "___id": "T000002R048863", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.RenderTexture#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "___id": "T000002R048864", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.RenderTexture#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "___id": "T000002R048865", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.RenderTexture#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R048867", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.RenderTexture#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R048868", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.RenderTexture#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R048869", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.RenderTexture#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R048870", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.RenderTexture#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "___id": "T000002R048871", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.RenderTexture#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R048872", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.RenderTexture#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "___id": "T000002R048873", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.RenderTexture#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R048874", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.RenderTexture#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R048875", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.RenderTexture#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R048876", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.RenderTexture#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R048877", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.RenderTexture#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "___id": "T000002R048878", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.RenderTexture#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R048879", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.RenderTexture#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R048880", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.RenderTexture#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R048881", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.RenderTexture#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R048882", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.RenderTexture#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R048883", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.RenderTexture#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R048884", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.RenderTexture#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R048885", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.RenderTexture#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R048886", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.RenderTexture#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R048887", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.RenderTexture#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "___id": "T000002R048888", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.RenderTexture#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R048889", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.RenderTexture#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R048890", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.RenderTexture#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R048891", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.RenderTexture#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R048892", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.RenderTexture#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R048893", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.RenderTexture#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R048894", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.RenderTexture#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R048895", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.RenderTexture#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R048896", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.RenderTexture#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "___id": "T000002R048897", "___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": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.RenderTexture#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#width", "inherited": true, "___id": "T000002R048899", "___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": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.RenderTexture#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#height", "inherited": true, "___id": "T000002R048900", "___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": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.RenderTexture#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayWidth", "inherited": true, "___id": "T000002R048901", "___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": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.RenderTexture#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayHeight", "inherited": true, "___id": "T000002R048902", "___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": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSizeToFrame", "longname": "Phaser.GameObjects.RenderTexture#setSizeToFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setSizeToFrame", "inherited": true, "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" } ], "___id": "T000002R048903", "___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.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": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.RenderTexture#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setDisplaySize", "inherited": true, "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" } ], "___id": "T000002R048904", "___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": {} }, "name": "texture", "longname": "Phaser.GameObjects.RenderTexture#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#texture", "inherited": true, "___id": "T000002R048905", "___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": {} }, "name": "frame", "longname": "Phaser.GameObjects.RenderTexture#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#frame", "inherited": true, "___id": "T000002R048906", "___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": {} }, "name": "isCropped", "longname": "Phaser.GameObjects.RenderTexture#isCropped", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#isCropped", "inherited": true, "___id": "T000002R048907", "___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 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 rect 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. 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.\r\n * @param {number} [width] - The width of the crop rectangle in pixels.\r\n * @param {number} [height] - The height of the crop rectangle in pixels.\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": {} }, "name": "setCrop", "longname": "Phaser.GameObjects.RenderTexture#setCrop", "kind": "function", "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 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 rect 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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setCrop", "inherited": true, "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. 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.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the crop rectangle in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the crop rectangle in pixels.", "name": "height" } ], "___id": "T000002R048908", "___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": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.GameObjects.RenderTexture#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setTexture", "inherited": true, "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" } ], "___id": "T000002R048909", "___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": 128, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.GameObjects.RenderTexture#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setFrame", "inherited": true, "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" } ], "___id": "T000002R048910", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertice 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": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopLeft", "longname": "Phaser.GameObjects.RenderTexture#tintTopLeft", "kind": "member", "description": "The tint value being applied to the top-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopLeft", "inherited": true, "___id": "T000002R048912", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-right vertice 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopRight", "longname": "Phaser.GameObjects.RenderTexture#tintTopRight", "kind": "member", "description": "The tint value being applied to the top-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopRight", "inherited": true, "___id": "T000002R048913", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-left vertice 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": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomLeft", "longname": "Phaser.GameObjects.RenderTexture#tintBottomLeft", "kind": "member", "description": "The tint value being applied to the bottom-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "inherited": true, "___id": "T000002R048914", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-right vertice 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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomRight", "longname": "Phaser.GameObjects.RenderTexture#tintBottomRight", "kind": "member", "description": "The tint value being applied to the bottom-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomRight", "inherited": true, "___id": "T000002R048915", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintFill", "longname": "Phaser.GameObjects.RenderTexture#tintFill", "kind": "member", "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.11.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintFill", "inherited": true, "___id": "T000002R048916", "___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 'additive',\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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearTint", "longname": "Phaser.GameObjects.RenderTexture#clearTint", "kind": "function", "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff and the tint type to 'additive',\rwhich results in no visible change to the texture.", "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#clearTint", "inherited": true, "___id": "T000002R048917", "___s": true }, { "comment": "/**\r\n * Sets an additive tint 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 * multiplying it by 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 * To swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.\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": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTint", "longname": "Phaser.GameObjects.RenderTexture#setTint", "kind": "function", "description": "Sets an additive tint on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by 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\rTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.", "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#setTint", "inherited": true, "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" } ], "___id": "T000002R048918", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on this Game Object.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. You can provide either one color value, in which case the whole\r\n * Game Object will be rendered in that color. Or you can provide a color per corner. The colors\r\n * 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 * To swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintFill\r\n * @webglOnly\r\n * @since 3.11.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.\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": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTintFill", "longname": "Phaser.GameObjects.RenderTexture#setTintFill", "kind": "function", "description": "Sets a fill-based tint on this Game Object.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. You can provide either one color value, in which case the whole\rGame Object will be rendered in that color. Or you can provide a color per corner. The colors\rare 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\rTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#setTintFill", "inherited": true, "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 not 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" } ], "___id": "T000002R048919", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.\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": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tint", "longname": "Phaser.GameObjects.RenderTexture#tint", "kind": "member", "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tint", "inherited": true, "___id": "T000002R048920", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * It checks to see if the 4 tint properties are set to the value 0xffffff\r\n * and that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.\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": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isTinted", "longname": "Phaser.GameObjects.RenderTexture#isTinted", "kind": "member", "description": "Does this Game Object have a tint applied?\r\rIt checks to see if the 4 tint properties are set to the value 0xffffff\rand that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "readonly": true, "since": "3.11.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#isTinted", "inherited": true, "___id": "T000002R048921", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.RenderTexture#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R048922", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.RenderTexture#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R048926", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.RenderTexture#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R048927", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.RenderTexture#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R048928", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.RenderTexture#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R048929", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.RenderTexture#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R048930", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.RenderTexture#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R048931", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.RenderTexture#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R048932", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.RenderTexture#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R048933", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.RenderTexture#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R048934", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.RenderTexture#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "___id": "T000002R048935", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.RenderTexture#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "___id": "T000002R048936", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.RenderTexture#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "___id": "T000002R048937", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.RenderTexture#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "___id": "T000002R048938", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.RenderTexture#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "___id": "T000002R048939", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.RenderTexture#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "___id": "T000002R048940", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.RenderTexture#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "___id": "T000002R048941", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.RenderTexture#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "___id": "T000002R048942", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.RenderTexture#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "___id": "T000002R048943", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.RenderTexture#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "___id": "T000002R048944", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.RenderTexture#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R048945", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.RenderTexture#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R048946", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.RenderTexture#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "___id": "T000002R048947", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.RenderTexture#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R048948", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.RenderTexture#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R048950", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.RenderTexture#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "___id": "T000002R048951", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Rope#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R048952", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Rope#displayList", "kind": "member", "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.", "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.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R048953", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Rope#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R048954", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Rope#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R048955", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Rope#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R048956", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Rope#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R048957", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Rope#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R048958", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Rope#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R048959", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Rope#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R048960", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Rope#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R048961", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Rope#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R048962", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Rope#input", "kind": "member", "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()`.", "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.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R048963", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Rope#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R048964", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Rope#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R048965", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Rope#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R048966", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Rope#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R048967", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Rope#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R048968", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Rope#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R048969", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Rope#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R048970", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Rope#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R048971", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Rope#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R048972", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Rope#getData", "kind": "function", "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.", "since": "3.0.0", "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.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R048973", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Rope#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R048974", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Rope#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R048975", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Rope#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R048976", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Rope#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R048977", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Rope#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R048978", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Rope#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R048979", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Rope#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R048980", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Rope#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R048981", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Rope#getIndexList", "kind": "function", "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.", "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.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R048982", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Rope#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R048983", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Rope#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R048984", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Rope#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R048985", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Rope#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R048986", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Rope#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R048987", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Rope#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R048988", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Rope#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R048989", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Rope#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R048990", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Rope#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R048991", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Rope#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R048992", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Rope#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R048993", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Rope#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R048994", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Rope#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R048995", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Rope#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R048996", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Rope#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R048997", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Rope#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R048998", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Rope#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R049000", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Rope#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "___id": "T000002R049001", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Rope#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R049002", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Rope#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R049004", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Rope#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R049005", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Rope#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R049007", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Rope#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R049008", "___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 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 * @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": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipX", "longname": "Phaser.GameObjects.Rope#toggleFlipX", "kind": "function", "description": "Toggles the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipX", "inherited": true, "___id": "T000002R049009", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipY", "longname": "Phaser.GameObjects.Rope#toggleFlipY", "kind": "function", "description": "Toggles the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipY", "inherited": true, "___id": "T000002R049010", "___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 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 * @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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipX", "longname": "Phaser.GameObjects.Rope#setFlipX", "kind": "function", "description": "Sets the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipX", "inherited": true, "___id": "T000002R049011", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\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": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipY", "longname": "Phaser.GameObjects.Rope#setFlipY", "kind": "function", "description": "Sets the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipY", "inherited": true, "___id": "T000002R049012", "___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 inversed 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 horizontal 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": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlip", "longname": "Phaser.GameObjects.Rope#setFlip", "kind": "function", "description": "Sets the horizontal and vertical flipped state of this Game Object.\r\rA Game Object that is flipped will render inversed 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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 horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlip", "inherited": true, "___id": "T000002R049013", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetFlip", "longname": "Phaser.GameObjects.Rope#resetFlip", "kind": "function", "description": "Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#resetFlip", "inherited": true, "___id": "T000002R049014", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Rope#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R049015", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Rope#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R049016", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Rope#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R049017", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Rope#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R049018", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Rope#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R049019", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Rope#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R049020", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Rope#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R049021", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Rope#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R049022", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Rope#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "___id": "T000002R049023", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Rope#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Rope", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "___id": "T000002R049024", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Rope#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "___id": "T000002R049025", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Rope#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "___id": "T000002R049026", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Rope#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R049027", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Rope#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R049028", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Rope#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R049029", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Rope#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R049030", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Rope#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R049031", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Rope#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R049032", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Rope#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R049033", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Rope#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Rope", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R049034", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Rope#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Rope", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R049035", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Rope#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R049036", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Rope#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R049037", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Rope#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R049038", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Rope#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R049039", "___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": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Rope#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#width", "inherited": true, "___id": "T000002R049041", "___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": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Rope#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#height", "inherited": true, "___id": "T000002R049042", "___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": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Rope#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayWidth", "inherited": true, "___id": "T000002R049043", "___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": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Rope#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayHeight", "inherited": true, "___id": "T000002R049044", "___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": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSizeToFrame", "longname": "Phaser.GameObjects.Rope#setSizeToFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setSizeToFrame", "inherited": true, "___id": "T000002R049045", "___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": 139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.GameObjects.Rope#setSize", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setSize", "inherited": true, "___id": "T000002R049046", "___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.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": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Rope#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setDisplaySize", "inherited": true, "___id": "T000002R049047", "___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": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "texture", "longname": "Phaser.GameObjects.Rope#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#texture", "inherited": true, "___id": "T000002R049048", "___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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "frame", "longname": "Phaser.GameObjects.Rope#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Texture#frame", "inherited": true, "___id": "T000002R049049", "___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": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.GameObjects.Rope#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Texture#setTexture", "inherited": true, "___id": "T000002R049051", "___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": 75, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.GameObjects.Rope#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Texture#setFrame", "inherited": true, "___id": "T000002R049052", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Rope#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R049053", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Rope#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R049057", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Rope#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R049058", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Rope#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R049059", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Rope#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R049060", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Rope#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R049061", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Rope#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R049062", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Rope#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R049063", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Rope#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R049064", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Rope#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R049065", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Rope#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R049066", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Rope#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R049067", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Rope#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R049068", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Rope#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R049069", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Rope#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R049070", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Rope#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R049071", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Rope#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R049072", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Rope#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R049073", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Rope#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R049074", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Rope#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R049075", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Rope#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R049076", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Rope#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R049077", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Rope#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R049078", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Rope#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R049079", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Rope#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R049081", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Rope#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R049082", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Rope#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R049083", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Rope#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R049084", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Rope#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R049085", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Shader#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R049086", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Shader#displayList", "kind": "member", "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.", "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.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R049087", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Shader#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R049088", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Shader#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R049089", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Shader#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R049090", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Shader#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R049091", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Shader#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R049092", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Shader#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R049093", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Shader#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R049094", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Shader#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R049095", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Shader#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R049096", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Shader#input", "kind": "member", "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()`.", "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.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R049097", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Shader#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R049098", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Shader#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R049099", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Shader#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R049100", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Shader#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R049101", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Shader#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R049102", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Shader#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R049103", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Shader#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R049104", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Shader#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R049105", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Shader#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R049106", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Shader#getData", "kind": "function", "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.", "since": "3.0.0", "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.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R049107", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Shader#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R049108", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Shader#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R049109", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Shader#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R049110", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Shader#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R049111", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Shader#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R049112", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Shader#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R049113", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Shader#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R049114", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Shader#getIndexList", "kind": "function", "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.", "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.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R049115", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Shader#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R049116", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Shader#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R049117", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Shader#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R049118", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Shader#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R049119", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Shader#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R049120", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Shader#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R049121", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Shader#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R049122", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Shader#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R049123", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Shader#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R049124", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Shader#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R049125", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Shader#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R049126", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Shader#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R049127", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Shader#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R049128", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Shader#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R049129", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Shader#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R049130", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Shader#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R049131", "___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": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Shader#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#width", "inherited": true, "___id": "T000002R049132", "___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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Shader#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#height", "inherited": true, "___id": "T000002R049133", "___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": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Shader#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#displayWidth", "inherited": true, "___id": "T000002R049134", "___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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Shader#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#displayHeight", "inherited": true, "___id": "T000002R049135", "___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": 93, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.GameObjects.Shader#setSize", "kind": "function", "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.", "since": "3.4.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ComputedSize#setSize", "inherited": true, "___id": "T000002R049136", "___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.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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Shader#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.4.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ComputedSize#setDisplaySize", "inherited": true, "___id": "T000002R049137", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Shader#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R049139", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Shader#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R049140", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.Shader#getCenter", "kind": "function", "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`.", "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]" } ], "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.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "___id": "T000002R049142", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.Shader#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "___id": "T000002R049143", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.Shader#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "___id": "T000002R049144", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.Shader#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "___id": "T000002R049145", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.Shader#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "___id": "T000002R049146", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.Shader#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "___id": "T000002R049147", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.Shader#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "___id": "T000002R049148", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.Shader#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "___id": "T000002R049149", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.Shader#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "___id": "T000002R049150", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.Shader#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "___id": "T000002R049151", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Shader#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R049152", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Shader#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R049153", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Shader#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R049154", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Shader#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R049155", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Shader#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R049156", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Shader#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R049158", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Shader#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R049159", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Shader#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R049160", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Shader#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R049161", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Shader#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "___id": "T000002R049162", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Shader#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R049163", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Shader#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "___id": "T000002R049164", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Shader#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R049165", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Shader#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R049166", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Shader#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R049167", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Shader#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R049168", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Shader#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R049169", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Shader#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R049173", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Shader#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R049174", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Shader#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R049175", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Shader#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R049176", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Shader#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R049177", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Shader#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R049178", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Shader#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R049179", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Shader#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R049180", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Shader#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R049181", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Shader#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R049182", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Shader#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R049183", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Shader#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R049184", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Shader#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R049185", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Shader#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R049186", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Shader#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R049187", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Shader#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R049188", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Shader#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R049189", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Shader#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R049190", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Shader#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R049191", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Shader#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R049192", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Shader#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R049193", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Shader#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R049194", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Shader#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R049195", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Shader#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R049197", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Shader#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shader", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R049198", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Shape#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R049199", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Shape#displayList", "kind": "member", "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.", "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.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R049200", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Shape#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R049201", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Shape#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R049202", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Shape#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R049203", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Shape#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R049204", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Shape#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R049205", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Shape#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R049206", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Shape#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R049207", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Shape#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R049208", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Shape#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R049209", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Shape#input", "kind": "member", "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()`.", "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.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R049210", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Shape#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R049211", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Shape#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R049212", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Shape#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R049213", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Shape#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R049214", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Shape#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R049215", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Shape#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R049216", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Shape#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R049217", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Shape#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R049218", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Shape#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R049219", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Shape#getData", "kind": "function", "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.", "since": "3.0.0", "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.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R049220", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Shape#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R049221", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Shape#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R049222", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Shape#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R049223", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Shape#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R049224", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Shape#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R049225", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Shape#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R049226", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Shape#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R049227", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Shape#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R049228", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Shape#getIndexList", "kind": "function", "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.", "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.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R049229", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Shape#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R049230", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Shape#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R049231", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Shape#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R049232", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Shape#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R049233", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Shape#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R049234", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Shape#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R049235", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Shape#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R049236", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Shape#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R049237", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Shape#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R049238", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Shape#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R049239", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Shape#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R049240", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Shape#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R049241", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Shape#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R049242", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Shape#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R049243", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Shape#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R049244", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Shape#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R049245", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Shape#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R049247", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Shape#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "___id": "T000002R049248", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Shape#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R049249", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Shape#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R049251", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Shape#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R049252", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Shape#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R049254", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Shape#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R049255", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.Shape#getCenter", "kind": "function", "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`.", "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]" } ], "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.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "___id": "T000002R049257", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.Shape#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "___id": "T000002R049258", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.Shape#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "___id": "T000002R049259", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.Shape#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "___id": "T000002R049260", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.Shape#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "___id": "T000002R049261", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.Shape#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "___id": "T000002R049262", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.Shape#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "___id": "T000002R049263", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.Shape#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "___id": "T000002R049264", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.Shape#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "___id": "T000002R049265", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.Shape#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "___id": "T000002R049266", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Shape#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R049267", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Shape#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R049268", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Shape#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R049269", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Shape#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R049270", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Shape#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R049271", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Shape#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R049273", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Shape#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R049274", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Shape#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R049275", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Shape#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R049276", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Shape#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "___id": "T000002R049277", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Shape#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R049278", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Shape#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "___id": "T000002R049279", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Shape#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R049280", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Shape#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R049281", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Shape#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R049282", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Shape#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R049283", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Shape#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "___id": "T000002R049284", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Shape#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Shape", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "___id": "T000002R049285", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Shape#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "___id": "T000002R049286", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Shape#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "___id": "T000002R049287", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Shape#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R049288", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Shape#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R049289", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Shape#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R049290", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Shape#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R049291", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Shape#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R049292", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Shape#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R049293", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Shape#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R049294", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Shape#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Shape", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R049295", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Shape#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Shape", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R049296", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Shape#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R049297", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Shape#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R049298", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Shape#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R049299", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Shape#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R049300", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Shape#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R049301", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Shape#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R049302", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Shape#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R049303", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Shape#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R049304", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Shape#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R049308", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Shape#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R049309", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Shape#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R049310", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Shape#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R049311", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Shape#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R049312", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Shape#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R049313", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Shape#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R049314", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Shape#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R049315", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Shape#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R049316", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Shape#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R049317", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Shape#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R049318", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Shape#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R049319", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Shape#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R049320", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Shape#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R049321", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Shape#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R049322", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Shape#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R049323", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Shape#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R049324", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Shape#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R049325", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Shape#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R049326", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Shape#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R049327", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Shape#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R049328", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Shape#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R049329", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Shape#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R049330", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Shape#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R049332", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Shape#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R049333", "___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": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "geom", "longname": "Phaser.GameObjects.Arc#geom", "kind": "member", "description": "The source Shape data. Typically a geometry object.\rYou should not manipulate this directly.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "readonly": true, "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#geom", "inherited": true, "___id": "T000002R049337", "___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": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathData", "longname": "Phaser.GameObjects.Arc#pathData", "kind": "member", "description": "Holds the polygon path data for filled rendering.", "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathData", "inherited": true, "___id": "T000002R049338", "___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": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathIndexes", "longname": "Phaser.GameObjects.Arc#pathIndexes", "kind": "member", "description": "Holds the earcut polygon path index data for filled rendering.", "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathIndexes", "inherited": true, "___id": "T000002R049339", "___s": true }, { "comment": "/**\r\n * The fill color used by this Shape.\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": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillColor", "longname": "Phaser.GameObjects.Arc#fillColor", "kind": "member", "description": "The fill color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillColor", "inherited": true, "___id": "T000002R049340", "___s": true }, { "comment": "/**\r\n * The fill alpha value used by this Shape.\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": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillAlpha", "longname": "Phaser.GameObjects.Arc#fillAlpha", "kind": "member", "description": "The fill alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillAlpha", "inherited": true, "___id": "T000002R049341", "___s": true }, { "comment": "/**\r\n * The stroke color used by this Shape.\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": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeColor", "longname": "Phaser.GameObjects.Arc#strokeColor", "kind": "member", "description": "The stroke color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeColor", "inherited": true, "___id": "T000002R049342", "___s": true }, { "comment": "/**\r\n * The stroke alpha value used by this Shape.\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": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeAlpha", "longname": "Phaser.GameObjects.Arc#strokeAlpha", "kind": "member", "description": "The stroke alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeAlpha", "inherited": true, "___id": "T000002R049343", "___s": true }, { "comment": "/**\r\n * The stroke line width used by this Shape.\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": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "lineWidth", "longname": "Phaser.GameObjects.Arc#lineWidth", "kind": "member", "description": "The stroke line width used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#lineWidth", "inherited": true, "___id": "T000002R049344", "___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": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isFilled", "longname": "Phaser.GameObjects.Arc#isFilled", "kind": "member", "description": "Controls if this Shape is filled or not.\rNote that some Shapes do not support being filled (such as Line shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isFilled", "inherited": true, "___id": "T000002R049345", "___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": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isStroked", "longname": "Phaser.GameObjects.Arc#isStroked", "kind": "member", "description": "Controls if this Shape is stroked or not.\rNote that some Shapes do not support being stroked (such as Iso Box shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isStroked", "inherited": true, "___id": "T000002R049346", "___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": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "closePath", "longname": "Phaser.GameObjects.Arc#closePath", "kind": "member", "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)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#closePath", "inherited": true, "___id": "T000002R049347", "___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": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Arc#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#width", "inherited": true, "___id": "T000002R049349", "___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": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Arc#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#height", "inherited": true, "___id": "T000002R049350", "___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": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setFillStyle", "longname": "Phaser.GameObjects.Arc#setFillStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setFillStyle", "inherited": true, "___id": "T000002R049351", "___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": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setStrokeStyle", "longname": "Phaser.GameObjects.Arc#setStrokeStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setStrokeStyle", "inherited": true, "___id": "T000002R049352", "___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": 284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setClosePath", "longname": "Phaser.GameObjects.Arc#setClosePath", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setClosePath", "inherited": true, "___id": "T000002R049353", "___s": true }, { "comment": "/**\r\n * Sets the display size of this Shape.\r\n *\r\n * Calling this will adjust the scale.\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.\r\n * @param {number} height - The display height of this Shape.\r\n *\r\n * @return {this} This Shape instance.\r\n */", "meta": { "filename": "Shape.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Arc#setDisplaySize", "kind": "function", "description": "Sets the display size of this Shape.\r\rCalling this will adjust the scale.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shape instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display width of this Shape.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display height of this Shape.", "name": "height" } ], "inherits": "Phaser.GameObjects.Shape#setDisplaySize", "inherited": true, "___id": "T000002R049355", "___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": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "preDestroy", "longname": "Phaser.GameObjects.Arc#preDestroy", "kind": "function", "description": "Internal destroy handler, called as part of the destroy process.", "access": "protected", "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#preDestroy", "inherited": true, "___id": "T000002R049356", "___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": 368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Arc#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayWidth", "inherited": true, "___id": "T000002R049357", "___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": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Arc#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayHeight", "inherited": true, "___id": "T000002R049358", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Arc#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R049360", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Arc#displayList", "kind": "member", "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.", "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R049361", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Arc#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R049362", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Arc#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R049363", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Arc#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R049364", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Arc#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R049365", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Arc#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R049366", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Arc#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R049367", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Arc#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R049368", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Arc#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R049369", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Arc#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R049370", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Arc#input", "kind": "member", "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()`.", "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R049371", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Arc#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R049372", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Arc#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R049373", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Arc#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R049374", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Arc#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R049375", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Arc#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R049376", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Arc#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R049377", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Arc#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R049378", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Arc#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R049379", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Arc#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R049380", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Arc#getData", "kind": "function", "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.", "since": "3.0.0", "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R049381", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Arc#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R049382", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Arc#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R049383", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Arc#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R049384", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Arc#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R049385", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Arc#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R049386", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Arc#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R049387", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Arc#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R049388", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Arc#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R049389", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Arc#getIndexList", "kind": "function", "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.", "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R049390", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Arc#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R049391", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Arc#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R049392", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Arc#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R049393", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Arc#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R049394", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Arc#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R049395", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Arc#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R049396", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Arc#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R049397", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Arc#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R049398", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Arc#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R049399", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Arc#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R049400", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Arc#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R049401", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Arc#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R049402", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Arc#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R049403", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Arc#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R049404", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Arc#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R049405", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Arc#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R049406", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Arc#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R049408", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Arc#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "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" } ], "___id": "T000002R049409", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Arc#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R049410", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Arc#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R049412", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Arc#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "___id": "T000002R049413", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Arc#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R049415", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Arc#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "___id": "T000002R049416", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.Arc#getCenter", "kind": "function", "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`.", "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]" } ], "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "___id": "T000002R049418", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.Arc#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "___id": "T000002R049419", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.Arc#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "___id": "T000002R049420", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.Arc#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "___id": "T000002R049421", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.Arc#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "___id": "T000002R049422", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.Arc#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "___id": "T000002R049423", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.Arc#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "___id": "T000002R049424", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.Arc#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "___id": "T000002R049425", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.Arc#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "___id": "T000002R049426", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.Arc#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "___id": "T000002R049427", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Arc#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R049428", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Arc#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "___id": "T000002R049429", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Arc#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "___id": "T000002R049430", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Arc#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "___id": "T000002R049431", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Arc#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "___id": "T000002R049432", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Arc#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R049434", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Arc#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R049435", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Arc#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R049436", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Arc#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R049437", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Arc#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "___id": "T000002R049438", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Arc#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R049439", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Arc#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "___id": "T000002R049440", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Arc#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R049441", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Arc#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R049442", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Arc#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R049443", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Arc#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R049444", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Arc#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "___id": "T000002R049445", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Arc#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R049446", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Arc#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R049447", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Arc#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R049448", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Arc#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R049449", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Arc#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R049450", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Arc#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R049451", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Arc#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R049452", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Arc#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R049453", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Arc#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R049454", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Arc#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "___id": "T000002R049455", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Arc#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R049456", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Arc#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R049457", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Arc#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R049458", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Arc#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R049459", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Arc#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R049460", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Arc#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R049461", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Arc#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R049462", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Arc#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R049463", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Arc#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "___id": "T000002R049464", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Arc#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R049465", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Arc#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R049469", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Arc#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R049470", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Arc#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R049471", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Arc#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R049472", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Arc#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R049473", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Arc#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R049474", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Arc#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R049475", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Arc#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R049476", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Arc#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R049477", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Arc#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "___id": "T000002R049478", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Arc#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "___id": "T000002R049479", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Arc#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "___id": "T000002R049480", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Arc#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "___id": "T000002R049481", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Arc#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "___id": "T000002R049482", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Arc#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "___id": "T000002R049483", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Arc#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "___id": "T000002R049484", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Arc#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "___id": "T000002R049485", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Arc#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "___id": "T000002R049486", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Arc#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "___id": "T000002R049487", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Arc#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R049488", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Arc#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R049489", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Arc#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "___id": "T000002R049490", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Arc#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R049491", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Arc#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R049493", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Arc#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "___id": "T000002R049494", "___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": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "geom", "longname": "Phaser.GameObjects.Curve#geom", "kind": "member", "description": "The source Shape data. Typically a geometry object.\rYou should not manipulate this directly.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "readonly": true, "since": "3.13.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#geom", "inherited": true, "___id": "T000002R049498", "___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": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathData", "longname": "Phaser.GameObjects.Curve#pathData", "kind": "member", "description": "Holds the polygon path data for filled rendering.", "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathData", "inherited": true, "___id": "T000002R049499", "___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": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathIndexes", "longname": "Phaser.GameObjects.Curve#pathIndexes", "kind": "member", "description": "Holds the earcut polygon path index data for filled rendering.", "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathIndexes", "inherited": true, "___id": "T000002R049500", "___s": true }, { "comment": "/**\r\n * The fill color used by this Shape.\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": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillColor", "longname": "Phaser.GameObjects.Curve#fillColor", "kind": "member", "description": "The fill color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillColor", "inherited": true, "___id": "T000002R049501", "___s": true }, { "comment": "/**\r\n * The fill alpha value used by this Shape.\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": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillAlpha", "longname": "Phaser.GameObjects.Curve#fillAlpha", "kind": "member", "description": "The fill alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillAlpha", "inherited": true, "___id": "T000002R049502", "___s": true }, { "comment": "/**\r\n * The stroke color used by this Shape.\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": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeColor", "longname": "Phaser.GameObjects.Curve#strokeColor", "kind": "member", "description": "The stroke color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeColor", "inherited": true, "___id": "T000002R049503", "___s": true }, { "comment": "/**\r\n * The stroke alpha value used by this Shape.\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": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeAlpha", "longname": "Phaser.GameObjects.Curve#strokeAlpha", "kind": "member", "description": "The stroke alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeAlpha", "inherited": true, "___id": "T000002R049504", "___s": true }, { "comment": "/**\r\n * The stroke line width used by this Shape.\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": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "lineWidth", "longname": "Phaser.GameObjects.Curve#lineWidth", "kind": "member", "description": "The stroke line width used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#lineWidth", "inherited": true, "___id": "T000002R049505", "___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": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isFilled", "longname": "Phaser.GameObjects.Curve#isFilled", "kind": "member", "description": "Controls if this Shape is filled or not.\rNote that some Shapes do not support being filled (such as Line shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isFilled", "inherited": true, "___id": "T000002R049506", "___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": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isStroked", "longname": "Phaser.GameObjects.Curve#isStroked", "kind": "member", "description": "Controls if this Shape is stroked or not.\rNote that some Shapes do not support being stroked (such as Iso Box shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isStroked", "inherited": true, "___id": "T000002R049507", "___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": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "closePath", "longname": "Phaser.GameObjects.Curve#closePath", "kind": "member", "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)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#closePath", "inherited": true, "___id": "T000002R049508", "___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": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Curve#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#width", "inherited": true, "___id": "T000002R049510", "___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": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Curve#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#height", "inherited": true, "___id": "T000002R049511", "___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": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setFillStyle", "longname": "Phaser.GameObjects.Curve#setFillStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setFillStyle", "inherited": true, "___id": "T000002R049512", "___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": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setStrokeStyle", "longname": "Phaser.GameObjects.Curve#setStrokeStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setStrokeStyle", "inherited": true, "___id": "T000002R049513", "___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": 284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setClosePath", "longname": "Phaser.GameObjects.Curve#setClosePath", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setClosePath", "inherited": true, "___id": "T000002R049514", "___s": true }, { "comment": "/**\r\n * Sets the display size of this Shape.\r\n *\r\n * Calling this will adjust the scale.\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.\r\n * @param {number} height - The display height of this Shape.\r\n *\r\n * @return {this} This Shape instance.\r\n */", "meta": { "filename": "Shape.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Curve#setDisplaySize", "kind": "function", "description": "Sets the display size of this Shape.\r\rCalling this will adjust the scale.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shape instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display width of this Shape.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display height of this Shape.", "name": "height" } ], "inherits": "Phaser.GameObjects.Shape#setDisplaySize", "inherited": true, "___id": "T000002R049516", "___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": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "preDestroy", "longname": "Phaser.GameObjects.Curve#preDestroy", "kind": "function", "description": "Internal destroy handler, called as part of the destroy process.", "access": "protected", "since": "3.13.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#preDestroy", "inherited": true, "___id": "T000002R049517", "___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": 368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Curve#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayWidth", "inherited": true, "___id": "T000002R049518", "___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": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Curve#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayHeight", "inherited": true, "___id": "T000002R049519", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Curve#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R049521", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Curve#displayList", "kind": "member", "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.", "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R049522", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Curve#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R049523", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Curve#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R049524", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Curve#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R049525", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Curve#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R049526", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Curve#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R049527", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Curve#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R049528", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Curve#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R049529", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Curve#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R049530", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Curve#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R049531", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Curve#input", "kind": "member", "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()`.", "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R049532", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Curve#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R049533", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Curve#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R049534", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Curve#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R049535", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Curve#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R049536", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Curve#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R049537", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Curve#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R049538", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Curve#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R049539", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Curve#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R049540", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Curve#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R049541", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Curve#getData", "kind": "function", "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.", "since": "3.0.0", "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R049542", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Curve#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R049543", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Curve#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R049544", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Curve#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R049545", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Curve#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R049546", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Curve#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R049547", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Curve#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R049548", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Curve#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R049549", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Curve#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R049550", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Curve#getIndexList", "kind": "function", "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.", "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R049551", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Curve#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R049552", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Curve#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R049553", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Curve#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R049554", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Curve#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R049555", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Curve#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R049556", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Curve#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R049557", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Curve#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R049558", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Curve#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R049559", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Curve#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R049560", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Curve#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R049561", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Curve#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R049562", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Curve#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R049563", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Curve#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R049564", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Curve#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R049565", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Curve#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R049566", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Curve#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R049567", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Curve#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R049569", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Curve#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "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" } ], "___id": "T000002R049570", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Curve#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R049571", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Curve#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R049573", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Curve#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "___id": "T000002R049574", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Curve#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R049576", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Curve#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "___id": "T000002R049577", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.Curve#getCenter", "kind": "function", "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`.", "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]" } ], "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "___id": "T000002R049579", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.Curve#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "___id": "T000002R049580", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.Curve#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "___id": "T000002R049581", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.Curve#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "___id": "T000002R049582", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.Curve#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "___id": "T000002R049583", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.Curve#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "___id": "T000002R049584", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.Curve#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "___id": "T000002R049585", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.Curve#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "___id": "T000002R049586", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.Curve#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "___id": "T000002R049587", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.Curve#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "___id": "T000002R049588", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Curve#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R049589", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Curve#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "___id": "T000002R049590", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Curve#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "___id": "T000002R049591", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Curve#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "___id": "T000002R049592", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Curve#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "___id": "T000002R049593", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Curve#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R049595", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Curve#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R049596", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Curve#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R049597", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Curve#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R049598", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Curve#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "___id": "T000002R049599", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Curve#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R049600", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Curve#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "___id": "T000002R049601", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Curve#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R049602", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Curve#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R049603", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Curve#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R049604", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Curve#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R049605", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Curve#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "___id": "T000002R049606", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Curve#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R049607", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Curve#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R049608", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Curve#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R049609", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Curve#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R049610", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Curve#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R049611", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Curve#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R049612", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Curve#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R049613", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Curve#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R049614", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Curve#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R049615", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Curve#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "___id": "T000002R049616", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Curve#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R049617", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Curve#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R049618", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Curve#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R049619", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Curve#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R049620", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Curve#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R049621", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Curve#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R049622", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Curve#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R049623", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Curve#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R049624", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Curve#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "___id": "T000002R049625", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Curve#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R049626", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Curve#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R049630", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Curve#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R049631", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Curve#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R049632", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Curve#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R049633", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Curve#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R049634", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Curve#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R049635", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Curve#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R049636", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Curve#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R049637", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Curve#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R049638", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Curve#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "___id": "T000002R049639", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Curve#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "___id": "T000002R049640", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Curve#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "___id": "T000002R049641", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Curve#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "___id": "T000002R049642", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Curve#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "___id": "T000002R049643", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Curve#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "___id": "T000002R049644", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Curve#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "___id": "T000002R049645", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Curve#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "___id": "T000002R049646", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Curve#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "___id": "T000002R049647", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Curve#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "___id": "T000002R049648", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Curve#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R049649", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Curve#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R049650", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Curve#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "___id": "T000002R049651", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Curve#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R049652", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Curve#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R049654", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Curve#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "___id": "T000002R049655", "___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": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "geom", "longname": "Phaser.GameObjects.Ellipse#geom", "kind": "member", "description": "The source Shape data. Typically a geometry object.\rYou should not manipulate this directly.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "readonly": true, "since": "3.13.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#geom", "inherited": true, "___id": "T000002R049659", "___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": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathData", "longname": "Phaser.GameObjects.Ellipse#pathData", "kind": "member", "description": "Holds the polygon path data for filled rendering.", "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathData", "inherited": true, "___id": "T000002R049660", "___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": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathIndexes", "longname": "Phaser.GameObjects.Ellipse#pathIndexes", "kind": "member", "description": "Holds the earcut polygon path index data for filled rendering.", "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathIndexes", "inherited": true, "___id": "T000002R049661", "___s": true }, { "comment": "/**\r\n * The fill color used by this Shape.\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": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillColor", "longname": "Phaser.GameObjects.Ellipse#fillColor", "kind": "member", "description": "The fill color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillColor", "inherited": true, "___id": "T000002R049662", "___s": true }, { "comment": "/**\r\n * The fill alpha value used by this Shape.\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": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillAlpha", "longname": "Phaser.GameObjects.Ellipse#fillAlpha", "kind": "member", "description": "The fill alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillAlpha", "inherited": true, "___id": "T000002R049663", "___s": true }, { "comment": "/**\r\n * The stroke color used by this Shape.\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": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeColor", "longname": "Phaser.GameObjects.Ellipse#strokeColor", "kind": "member", "description": "The stroke color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeColor", "inherited": true, "___id": "T000002R049664", "___s": true }, { "comment": "/**\r\n * The stroke alpha value used by this Shape.\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": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeAlpha", "longname": "Phaser.GameObjects.Ellipse#strokeAlpha", "kind": "member", "description": "The stroke alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeAlpha", "inherited": true, "___id": "T000002R049665", "___s": true }, { "comment": "/**\r\n * The stroke line width used by this Shape.\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": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "lineWidth", "longname": "Phaser.GameObjects.Ellipse#lineWidth", "kind": "member", "description": "The stroke line width used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#lineWidth", "inherited": true, "___id": "T000002R049666", "___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": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isFilled", "longname": "Phaser.GameObjects.Ellipse#isFilled", "kind": "member", "description": "Controls if this Shape is filled or not.\rNote that some Shapes do not support being filled (such as Line shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isFilled", "inherited": true, "___id": "T000002R049667", "___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": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isStroked", "longname": "Phaser.GameObjects.Ellipse#isStroked", "kind": "member", "description": "Controls if this Shape is stroked or not.\rNote that some Shapes do not support being stroked (such as Iso Box shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isStroked", "inherited": true, "___id": "T000002R049668", "___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": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "closePath", "longname": "Phaser.GameObjects.Ellipse#closePath", "kind": "member", "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)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#closePath", "inherited": true, "___id": "T000002R049669", "___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": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Ellipse#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#width", "inherited": true, "___id": "T000002R049671", "___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": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Ellipse#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#height", "inherited": true, "___id": "T000002R049672", "___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": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setFillStyle", "longname": "Phaser.GameObjects.Ellipse#setFillStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setFillStyle", "inherited": true, "___id": "T000002R049673", "___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": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setStrokeStyle", "longname": "Phaser.GameObjects.Ellipse#setStrokeStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setStrokeStyle", "inherited": true, "___id": "T000002R049674", "___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": 284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setClosePath", "longname": "Phaser.GameObjects.Ellipse#setClosePath", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setClosePath", "inherited": true, "___id": "T000002R049675", "___s": true }, { "comment": "/**\r\n * Sets the display size of this Shape.\r\n *\r\n * Calling this will adjust the scale.\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.\r\n * @param {number} height - The display height of this Shape.\r\n *\r\n * @return {this} This Shape instance.\r\n */", "meta": { "filename": "Shape.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Ellipse#setDisplaySize", "kind": "function", "description": "Sets the display size of this Shape.\r\rCalling this will adjust the scale.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shape instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display width of this Shape.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display height of this Shape.", "name": "height" } ], "inherits": "Phaser.GameObjects.Shape#setDisplaySize", "inherited": true, "___id": "T000002R049676", "___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": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "preDestroy", "longname": "Phaser.GameObjects.Ellipse#preDestroy", "kind": "function", "description": "Internal destroy handler, called as part of the destroy process.", "access": "protected", "since": "3.13.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#preDestroy", "inherited": true, "___id": "T000002R049677", "___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": 368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Ellipse#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayWidth", "inherited": true, "___id": "T000002R049678", "___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": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Ellipse#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayHeight", "inherited": true, "___id": "T000002R049679", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Ellipse#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R049681", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Ellipse#displayList", "kind": "member", "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.", "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R049682", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Ellipse#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R049683", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Ellipse#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R049684", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Ellipse#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R049685", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Ellipse#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R049686", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Ellipse#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R049687", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Ellipse#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R049688", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Ellipse#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R049689", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Ellipse#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R049690", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Ellipse#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R049691", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Ellipse#input", "kind": "member", "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()`.", "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R049692", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Ellipse#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R049693", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Ellipse#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R049694", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Ellipse#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R049695", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Ellipse#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R049696", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Ellipse#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R049697", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Ellipse#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R049698", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Ellipse#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R049699", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Ellipse#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R049700", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Ellipse#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R049701", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Ellipse#getData", "kind": "function", "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.", "since": "3.0.0", "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R049702", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Ellipse#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R049703", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Ellipse#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R049704", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Ellipse#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R049705", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Ellipse#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R049706", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Ellipse#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R049707", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Ellipse#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R049708", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Ellipse#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R049709", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Ellipse#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R049710", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Ellipse#getIndexList", "kind": "function", "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.", "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R049711", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Ellipse#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R049712", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Ellipse#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R049713", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Ellipse#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R049714", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Ellipse#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R049715", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Ellipse#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R049716", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Ellipse#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R049717", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Ellipse#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R049718", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Ellipse#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R049719", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Ellipse#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R049720", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Ellipse#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R049721", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Ellipse#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R049722", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Ellipse#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R049723", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Ellipse#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R049724", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Ellipse#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R049725", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Ellipse#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R049726", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Ellipse#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R049727", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Ellipse#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R049729", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Ellipse#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "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" } ], "___id": "T000002R049730", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Ellipse#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R049731", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Ellipse#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R049733", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Ellipse#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "___id": "T000002R049734", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Ellipse#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R049736", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Ellipse#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "___id": "T000002R049737", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.Ellipse#getCenter", "kind": "function", "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`.", "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]" } ], "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "___id": "T000002R049739", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.Ellipse#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "___id": "T000002R049740", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.Ellipse#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "___id": "T000002R049741", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.Ellipse#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "___id": "T000002R049742", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.Ellipse#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "___id": "T000002R049743", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.Ellipse#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "___id": "T000002R049744", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.Ellipse#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "___id": "T000002R049745", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.Ellipse#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "___id": "T000002R049746", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.Ellipse#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "___id": "T000002R049747", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.Ellipse#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "___id": "T000002R049748", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Ellipse#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R049749", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Ellipse#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "___id": "T000002R049750", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Ellipse#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "___id": "T000002R049751", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Ellipse#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "___id": "T000002R049752", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Ellipse#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "___id": "T000002R049753", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Ellipse#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R049755", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Ellipse#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R049756", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Ellipse#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R049757", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Ellipse#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R049758", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Ellipse#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "___id": "T000002R049759", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Ellipse#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R049760", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Ellipse#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "___id": "T000002R049761", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Ellipse#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R049762", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Ellipse#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R049763", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Ellipse#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R049764", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Ellipse#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R049765", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Ellipse#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "___id": "T000002R049766", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Ellipse#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R049767", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Ellipse#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R049768", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Ellipse#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R049769", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Ellipse#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R049770", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Ellipse#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R049771", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Ellipse#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R049772", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Ellipse#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R049773", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Ellipse#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R049774", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Ellipse#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R049775", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Ellipse#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "___id": "T000002R049776", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Ellipse#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R049777", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Ellipse#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R049778", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Ellipse#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R049779", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Ellipse#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R049780", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Ellipse#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R049781", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Ellipse#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R049782", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Ellipse#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R049783", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Ellipse#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R049784", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Ellipse#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "___id": "T000002R049785", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Ellipse#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R049786", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Ellipse#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R049790", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Ellipse#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R049791", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Ellipse#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R049792", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Ellipse#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R049793", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Ellipse#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R049794", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Ellipse#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R049795", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Ellipse#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R049796", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Ellipse#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R049797", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Ellipse#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R049798", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Ellipse#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "___id": "T000002R049799", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Ellipse#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "___id": "T000002R049800", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Ellipse#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "___id": "T000002R049801", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Ellipse#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "___id": "T000002R049802", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Ellipse#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "___id": "T000002R049803", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Ellipse#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "___id": "T000002R049804", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Ellipse#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "___id": "T000002R049805", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Ellipse#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "___id": "T000002R049806", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Ellipse#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "___id": "T000002R049807", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Ellipse#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "___id": "T000002R049808", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Ellipse#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R049809", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Ellipse#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R049810", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Ellipse#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "___id": "T000002R049811", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Ellipse#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R049812", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Ellipse#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R049814", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Ellipse#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "___id": "T000002R049815", "___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": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "geom", "longname": "Phaser.GameObjects.Grid#geom", "kind": "member", "description": "The source Shape data. Typically a geometry object.\rYou should not manipulate this directly.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "readonly": true, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#geom", "inherited": true, "___id": "T000002R049819", "___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": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathData", "longname": "Phaser.GameObjects.Grid#pathData", "kind": "member", "description": "Holds the polygon path data for filled rendering.", "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathData", "inherited": true, "___id": "T000002R049820", "___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": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathIndexes", "longname": "Phaser.GameObjects.Grid#pathIndexes", "kind": "member", "description": "Holds the earcut polygon path index data for filled rendering.", "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathIndexes", "inherited": true, "___id": "T000002R049821", "___s": true }, { "comment": "/**\r\n * The fill color used by this Shape.\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": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillColor", "longname": "Phaser.GameObjects.Grid#fillColor", "kind": "member", "description": "The fill color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillColor", "inherited": true, "___id": "T000002R049822", "___s": true }, { "comment": "/**\r\n * The fill alpha value used by this Shape.\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": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillAlpha", "longname": "Phaser.GameObjects.Grid#fillAlpha", "kind": "member", "description": "The fill alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillAlpha", "inherited": true, "___id": "T000002R049823", "___s": true }, { "comment": "/**\r\n * The stroke color used by this Shape.\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": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeColor", "longname": "Phaser.GameObjects.Grid#strokeColor", "kind": "member", "description": "The stroke color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeColor", "inherited": true, "___id": "T000002R049824", "___s": true }, { "comment": "/**\r\n * The stroke alpha value used by this Shape.\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": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeAlpha", "longname": "Phaser.GameObjects.Grid#strokeAlpha", "kind": "member", "description": "The stroke alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeAlpha", "inherited": true, "___id": "T000002R049825", "___s": true }, { "comment": "/**\r\n * The stroke line width used by this Shape.\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": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "lineWidth", "longname": "Phaser.GameObjects.Grid#lineWidth", "kind": "member", "description": "The stroke line width used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#lineWidth", "inherited": true, "___id": "T000002R049826", "___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": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isFilled", "longname": "Phaser.GameObjects.Grid#isFilled", "kind": "member", "description": "Controls if this Shape is filled or not.\rNote that some Shapes do not support being filled (such as Line shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isFilled", "inherited": true, "___id": "T000002R049827", "___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": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isStroked", "longname": "Phaser.GameObjects.Grid#isStroked", "kind": "member", "description": "Controls if this Shape is stroked or not.\rNote that some Shapes do not support being stroked (such as Iso Box shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isStroked", "inherited": true, "___id": "T000002R049828", "___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": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "closePath", "longname": "Phaser.GameObjects.Grid#closePath", "kind": "member", "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)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#closePath", "inherited": true, "___id": "T000002R049829", "___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": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Grid#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#width", "inherited": true, "___id": "T000002R049831", "___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": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Grid#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#height", "inherited": true, "___id": "T000002R049832", "___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": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setStrokeStyle", "longname": "Phaser.GameObjects.Grid#setStrokeStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setStrokeStyle", "inherited": true, "___id": "T000002R049833", "___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": 284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setClosePath", "longname": "Phaser.GameObjects.Grid#setClosePath", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setClosePath", "inherited": true, "___id": "T000002R049834", "___s": true }, { "comment": "/**\r\n * Sets the display size of this Shape.\r\n *\r\n * Calling this will adjust the scale.\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.\r\n * @param {number} height - The display height of this Shape.\r\n *\r\n * @return {this} This Shape instance.\r\n */", "meta": { "filename": "Shape.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Grid#setDisplaySize", "kind": "function", "description": "Sets the display size of this Shape.\r\rCalling this will adjust the scale.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shape instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display width of this Shape.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display height of this Shape.", "name": "height" } ], "inherits": "Phaser.GameObjects.Shape#setDisplaySize", "inherited": true, "___id": "T000002R049836", "___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": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "preDestroy", "longname": "Phaser.GameObjects.Grid#preDestroy", "kind": "function", "description": "Internal destroy handler, called as part of the destroy process.", "access": "protected", "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#preDestroy", "inherited": true, "___id": "T000002R049837", "___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": 368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Grid#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayWidth", "inherited": true, "___id": "T000002R049838", "___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": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Grid#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayHeight", "inherited": true, "___id": "T000002R049839", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Grid#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R049841", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Grid#displayList", "kind": "member", "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.", "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R049842", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Grid#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R049843", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Grid#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R049844", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Grid#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R049845", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Grid#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R049846", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Grid#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R049847", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Grid#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R049848", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Grid#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R049849", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Grid#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R049850", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Grid#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R049851", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Grid#input", "kind": "member", "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()`.", "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R049852", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Grid#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R049853", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Grid#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R049854", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Grid#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R049855", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Grid#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R049856", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Grid#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R049857", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Grid#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R049858", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Grid#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R049859", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Grid#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R049860", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Grid#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R049861", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Grid#getData", "kind": "function", "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.", "since": "3.0.0", "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R049862", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Grid#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R049863", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Grid#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R049864", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Grid#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R049865", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Grid#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R049866", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Grid#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R049867", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Grid#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R049868", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Grid#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R049869", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Grid#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R049870", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Grid#getIndexList", "kind": "function", "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.", "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R049871", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Grid#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R049872", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Grid#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R049873", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Grid#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R049874", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Grid#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R049875", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Grid#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R049876", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Grid#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R049877", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Grid#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R049878", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Grid#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R049879", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Grid#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R049880", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Grid#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R049881", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Grid#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R049882", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Grid#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R049883", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Grid#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R049884", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Grid#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R049885", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Grid#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R049886", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Grid#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R049887", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Grid#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R049889", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Grid#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "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" } ], "___id": "T000002R049890", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Grid#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R049891", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Grid#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R049893", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Grid#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "___id": "T000002R049894", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Grid#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R049896", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Grid#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "___id": "T000002R049897", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.Grid#getCenter", "kind": "function", "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`.", "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]" } ], "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "___id": "T000002R049899", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.Grid#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "___id": "T000002R049900", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.Grid#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "___id": "T000002R049901", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.Grid#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "___id": "T000002R049902", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.Grid#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "___id": "T000002R049903", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.Grid#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "___id": "T000002R049904", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.Grid#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "___id": "T000002R049905", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.Grid#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "___id": "T000002R049906", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.Grid#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "___id": "T000002R049907", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.Grid#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "___id": "T000002R049908", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Grid#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R049909", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Grid#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "___id": "T000002R049910", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Grid#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "___id": "T000002R049911", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Grid#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "___id": "T000002R049912", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Grid#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "___id": "T000002R049913", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Grid#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R049915", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Grid#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R049916", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Grid#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R049917", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Grid#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R049918", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Grid#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "___id": "T000002R049919", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Grid#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R049920", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Grid#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "___id": "T000002R049921", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Grid#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R049922", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Grid#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R049923", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Grid#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R049924", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Grid#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R049925", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Grid#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "___id": "T000002R049926", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Grid#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R049927", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Grid#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R049928", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Grid#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R049929", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Grid#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R049930", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Grid#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R049931", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Grid#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R049932", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Grid#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R049933", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Grid#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R049934", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Grid#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R049935", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Grid#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "___id": "T000002R049936", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Grid#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R049937", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Grid#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R049938", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Grid#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R049939", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Grid#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R049940", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Grid#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R049941", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Grid#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R049942", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Grid#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R049943", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Grid#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R049944", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Grid#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "___id": "T000002R049945", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Grid#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R049946", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Grid#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R049950", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Grid#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R049951", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Grid#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R049952", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Grid#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R049953", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Grid#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R049954", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Grid#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R049955", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Grid#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R049956", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Grid#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R049957", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Grid#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R049958", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Grid#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "___id": "T000002R049959", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Grid#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "___id": "T000002R049960", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Grid#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "___id": "T000002R049961", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Grid#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "___id": "T000002R049962", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Grid#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "___id": "T000002R049963", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Grid#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "___id": "T000002R049964", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Grid#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "___id": "T000002R049965", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Grid#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "___id": "T000002R049966", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Grid#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "___id": "T000002R049967", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Grid#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "___id": "T000002R049968", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Grid#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R049969", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Grid#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R049970", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Grid#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "___id": "T000002R049971", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Grid#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R049972", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Grid#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R049974", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Grid#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "___id": "T000002R049975", "___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": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "geom", "longname": "Phaser.GameObjects.IsoBox#geom", "kind": "member", "description": "The source Shape data. Typically a geometry object.\rYou should not manipulate this directly.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "readonly": true, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#geom", "inherited": true, "___id": "T000002R049979", "___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": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathData", "longname": "Phaser.GameObjects.IsoBox#pathData", "kind": "member", "description": "Holds the polygon path data for filled rendering.", "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathData", "inherited": true, "___id": "T000002R049980", "___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": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathIndexes", "longname": "Phaser.GameObjects.IsoBox#pathIndexes", "kind": "member", "description": "Holds the earcut polygon path index data for filled rendering.", "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathIndexes", "inherited": true, "___id": "T000002R049981", "___s": true }, { "comment": "/**\r\n * The fill color used by this Shape.\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": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillColor", "longname": "Phaser.GameObjects.IsoBox#fillColor", "kind": "member", "description": "The fill color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillColor", "inherited": true, "___id": "T000002R049982", "___s": true }, { "comment": "/**\r\n * The fill alpha value used by this Shape.\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": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillAlpha", "longname": "Phaser.GameObjects.IsoBox#fillAlpha", "kind": "member", "description": "The fill alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillAlpha", "inherited": true, "___id": "T000002R049983", "___s": true }, { "comment": "/**\r\n * The stroke color used by this Shape.\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": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeColor", "longname": "Phaser.GameObjects.IsoBox#strokeColor", "kind": "member", "description": "The stroke color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeColor", "inherited": true, "___id": "T000002R049984", "___s": true }, { "comment": "/**\r\n * The stroke alpha value used by this Shape.\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": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeAlpha", "longname": "Phaser.GameObjects.IsoBox#strokeAlpha", "kind": "member", "description": "The stroke alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeAlpha", "inherited": true, "___id": "T000002R049985", "___s": true }, { "comment": "/**\r\n * The stroke line width used by this Shape.\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": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "lineWidth", "longname": "Phaser.GameObjects.IsoBox#lineWidth", "kind": "member", "description": "The stroke line width used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#lineWidth", "inherited": true, "___id": "T000002R049986", "___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": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isFilled", "longname": "Phaser.GameObjects.IsoBox#isFilled", "kind": "member", "description": "Controls if this Shape is filled or not.\rNote that some Shapes do not support being filled (such as Line shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isFilled", "inherited": true, "___id": "T000002R049987", "___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": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isStroked", "longname": "Phaser.GameObjects.IsoBox#isStroked", "kind": "member", "description": "Controls if this Shape is stroked or not.\rNote that some Shapes do not support being stroked (such as Iso Box shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isStroked", "inherited": true, "___id": "T000002R049988", "___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": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "closePath", "longname": "Phaser.GameObjects.IsoBox#closePath", "kind": "member", "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)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#closePath", "inherited": true, "___id": "T000002R049989", "___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": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.IsoBox#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#width", "inherited": true, "___id": "T000002R049991", "___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": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.IsoBox#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#height", "inherited": true, "___id": "T000002R049992", "___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": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setStrokeStyle", "longname": "Phaser.GameObjects.IsoBox#setStrokeStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setStrokeStyle", "inherited": true, "___id": "T000002R049993", "___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": 284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setClosePath", "longname": "Phaser.GameObjects.IsoBox#setClosePath", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setClosePath", "inherited": true, "___id": "T000002R049994", "___s": true }, { "comment": "/**\r\n * Sets the display size of this Shape.\r\n *\r\n * Calling this will adjust the scale.\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.\r\n * @param {number} height - The display height of this Shape.\r\n *\r\n * @return {this} This Shape instance.\r\n */", "meta": { "filename": "Shape.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.IsoBox#setDisplaySize", "kind": "function", "description": "Sets the display size of this Shape.\r\rCalling this will adjust the scale.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shape instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display width of this Shape.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display height of this Shape.", "name": "height" } ], "inherits": "Phaser.GameObjects.Shape#setDisplaySize", "inherited": true, "___id": "T000002R049996", "___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": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "preDestroy", "longname": "Phaser.GameObjects.IsoBox#preDestroy", "kind": "function", "description": "Internal destroy handler, called as part of the destroy process.", "access": "protected", "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#preDestroy", "inherited": true, "___id": "T000002R049997", "___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": 368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.IsoBox#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayWidth", "inherited": true, "___id": "T000002R049998", "___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": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.IsoBox#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayHeight", "inherited": true, "___id": "T000002R049999", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.IsoBox#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R050001", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.IsoBox#displayList", "kind": "member", "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.", "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R050002", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.IsoBox#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R050003", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.IsoBox#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R050004", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.IsoBox#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R050005", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.IsoBox#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R050006", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.IsoBox#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R050007", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.IsoBox#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R050008", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.IsoBox#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R050009", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.IsoBox#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R050010", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.IsoBox#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R050011", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.IsoBox#input", "kind": "member", "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()`.", "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R050012", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.IsoBox#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R050013", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.IsoBox#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R050014", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.IsoBox#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R050015", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.IsoBox#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R050016", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.IsoBox#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R050017", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.IsoBox#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R050018", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.IsoBox#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R050019", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.IsoBox#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R050020", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.IsoBox#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R050021", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.IsoBox#getData", "kind": "function", "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.", "since": "3.0.0", "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R050022", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.IsoBox#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R050023", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.IsoBox#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R050024", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.IsoBox#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R050025", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.IsoBox#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R050026", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.IsoBox#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R050027", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.IsoBox#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R050028", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.IsoBox#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R050029", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.IsoBox#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R050030", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.IsoBox#getIndexList", "kind": "function", "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.", "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R050031", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.IsoBox#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R050032", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.IsoBox#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R050033", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.IsoBox#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R050034", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.IsoBox#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R050035", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.IsoBox#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R050036", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.IsoBox#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R050037", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.IsoBox#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R050038", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.IsoBox#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R050039", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.IsoBox#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R050040", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.IsoBox#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R050041", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.IsoBox#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R050042", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.IsoBox#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R050043", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.IsoBox#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R050044", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.IsoBox#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R050045", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.IsoBox#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R050046", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.IsoBox#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R050047", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.IsoBox#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R050049", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.IsoBox#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "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" } ], "___id": "T000002R050050", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.IsoBox#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R050051", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.IsoBox#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R050053", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.IsoBox#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "___id": "T000002R050054", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.IsoBox#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R050056", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.IsoBox#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "___id": "T000002R050057", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.IsoBox#getCenter", "kind": "function", "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`.", "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]" } ], "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "___id": "T000002R050059", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.IsoBox#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "___id": "T000002R050060", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.IsoBox#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "___id": "T000002R050061", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.IsoBox#getTopRight", "kind": "function", "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`.", "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]" } ], "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "___id": "T000002R050062", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.IsoBox#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "___id": "T000002R050063", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.IsoBox#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "___id": "T000002R050064", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.IsoBox#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "___id": "T000002R050065", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.IsoBox#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "___id": "T000002R050066", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.IsoBox#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "___id": "T000002R050067", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.IsoBox#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "___id": "T000002R050068", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.IsoBox#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R050069", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.IsoBox#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "___id": "T000002R050070", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.IsoBox#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "___id": "T000002R050071", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.IsoBox#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "___id": "T000002R050072", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.IsoBox#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "___id": "T000002R050073", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.IsoBox#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R050075", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.IsoBox#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R050076", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.IsoBox#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R050077", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.IsoBox#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R050078", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.IsoBox#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "___id": "T000002R050079", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.IsoBox#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R050080", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.IsoBox#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "___id": "T000002R050081", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.IsoBox#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R050082", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.IsoBox#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R050083", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.IsoBox#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R050084", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.IsoBox#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R050085", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.IsoBox#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "___id": "T000002R050086", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.IsoBox#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R050087", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.IsoBox#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R050088", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.IsoBox#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R050089", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.IsoBox#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R050090", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.IsoBox#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R050091", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.IsoBox#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R050092", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.IsoBox#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R050093", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.IsoBox#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R050094", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.IsoBox#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R050095", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.IsoBox#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "___id": "T000002R050096", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.IsoBox#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R050097", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.IsoBox#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R050098", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.IsoBox#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R050099", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.IsoBox#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R050100", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.IsoBox#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R050101", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.IsoBox#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R050102", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.IsoBox#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R050103", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.IsoBox#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R050104", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.IsoBox#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "___id": "T000002R050105", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.IsoBox#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R050106", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.IsoBox#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R050110", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.IsoBox#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R050111", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.IsoBox#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R050112", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.IsoBox#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R050113", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.IsoBox#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R050114", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.IsoBox#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R050115", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.IsoBox#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R050116", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.IsoBox#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R050117", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.IsoBox#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R050118", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.IsoBox#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "___id": "T000002R050119", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.IsoBox#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "___id": "T000002R050120", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.IsoBox#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "___id": "T000002R050121", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.IsoBox#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "___id": "T000002R050122", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.IsoBox#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "___id": "T000002R050123", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.IsoBox#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "___id": "T000002R050124", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.IsoBox#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "___id": "T000002R050125", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.IsoBox#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "___id": "T000002R050126", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.IsoBox#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "___id": "T000002R050127", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.IsoBox#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "___id": "T000002R050128", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.IsoBox#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R050129", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.IsoBox#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R050130", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.IsoBox#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "___id": "T000002R050131", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.IsoBox#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R050132", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.IsoBox#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R050134", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.IsoBox#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "___id": "T000002R050135", "___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": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "geom", "longname": "Phaser.GameObjects.IsoTriangle#geom", "kind": "member", "description": "The source Shape data. Typically a geometry object.\rYou should not manipulate this directly.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "readonly": true, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#geom", "inherited": true, "___id": "T000002R050139", "___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": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathData", "longname": "Phaser.GameObjects.IsoTriangle#pathData", "kind": "member", "description": "Holds the polygon path data for filled rendering.", "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathData", "inherited": true, "___id": "T000002R050140", "___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": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathIndexes", "longname": "Phaser.GameObjects.IsoTriangle#pathIndexes", "kind": "member", "description": "Holds the earcut polygon path index data for filled rendering.", "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathIndexes", "inherited": true, "___id": "T000002R050141", "___s": true }, { "comment": "/**\r\n * The fill color used by this Shape.\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": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillColor", "longname": "Phaser.GameObjects.IsoTriangle#fillColor", "kind": "member", "description": "The fill color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillColor", "inherited": true, "___id": "T000002R050142", "___s": true }, { "comment": "/**\r\n * The fill alpha value used by this Shape.\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": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillAlpha", "longname": "Phaser.GameObjects.IsoTriangle#fillAlpha", "kind": "member", "description": "The fill alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillAlpha", "inherited": true, "___id": "T000002R050143", "___s": true }, { "comment": "/**\r\n * The stroke color used by this Shape.\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": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeColor", "longname": "Phaser.GameObjects.IsoTriangle#strokeColor", "kind": "member", "description": "The stroke color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeColor", "inherited": true, "___id": "T000002R050144", "___s": true }, { "comment": "/**\r\n * The stroke alpha value used by this Shape.\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": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeAlpha", "longname": "Phaser.GameObjects.IsoTriangle#strokeAlpha", "kind": "member", "description": "The stroke alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeAlpha", "inherited": true, "___id": "T000002R050145", "___s": true }, { "comment": "/**\r\n * The stroke line width used by this Shape.\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": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "lineWidth", "longname": "Phaser.GameObjects.IsoTriangle#lineWidth", "kind": "member", "description": "The stroke line width used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#lineWidth", "inherited": true, "___id": "T000002R050146", "___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": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isFilled", "longname": "Phaser.GameObjects.IsoTriangle#isFilled", "kind": "member", "description": "Controls if this Shape is filled or not.\rNote that some Shapes do not support being filled (such as Line shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isFilled", "inherited": true, "___id": "T000002R050147", "___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": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isStroked", "longname": "Phaser.GameObjects.IsoTriangle#isStroked", "kind": "member", "description": "Controls if this Shape is stroked or not.\rNote that some Shapes do not support being stroked (such as Iso Box shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isStroked", "inherited": true, "___id": "T000002R050148", "___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": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "closePath", "longname": "Phaser.GameObjects.IsoTriangle#closePath", "kind": "member", "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)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#closePath", "inherited": true, "___id": "T000002R050149", "___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": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.IsoTriangle#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#width", "inherited": true, "___id": "T000002R050151", "___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": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.IsoTriangle#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#height", "inherited": true, "___id": "T000002R050152", "___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": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setStrokeStyle", "longname": "Phaser.GameObjects.IsoTriangle#setStrokeStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setStrokeStyle", "inherited": true, "___id": "T000002R050153", "___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": 284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setClosePath", "longname": "Phaser.GameObjects.IsoTriangle#setClosePath", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setClosePath", "inherited": true, "___id": "T000002R050154", "___s": true }, { "comment": "/**\r\n * Sets the display size of this Shape.\r\n *\r\n * Calling this will adjust the scale.\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.\r\n * @param {number} height - The display height of this Shape.\r\n *\r\n * @return {this} This Shape instance.\r\n */", "meta": { "filename": "Shape.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.IsoTriangle#setDisplaySize", "kind": "function", "description": "Sets the display size of this Shape.\r\rCalling this will adjust the scale.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shape instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display width of this Shape.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display height of this Shape.", "name": "height" } ], "inherits": "Phaser.GameObjects.Shape#setDisplaySize", "inherited": true, "___id": "T000002R050156", "___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": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "preDestroy", "longname": "Phaser.GameObjects.IsoTriangle#preDestroy", "kind": "function", "description": "Internal destroy handler, called as part of the destroy process.", "access": "protected", "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#preDestroy", "inherited": true, "___id": "T000002R050157", "___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": 368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.IsoTriangle#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayWidth", "inherited": true, "___id": "T000002R050158", "___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": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.IsoTriangle#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayHeight", "inherited": true, "___id": "T000002R050159", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.IsoTriangle#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R050161", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.IsoTriangle#displayList", "kind": "member", "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.", "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R050162", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.IsoTriangle#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R050163", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.IsoTriangle#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R050164", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.IsoTriangle#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R050165", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.IsoTriangle#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R050166", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.IsoTriangle#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R050167", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.IsoTriangle#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R050168", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.IsoTriangle#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R050169", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.IsoTriangle#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R050170", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.IsoTriangle#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R050171", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.IsoTriangle#input", "kind": "member", "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()`.", "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R050172", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.IsoTriangle#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R050173", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.IsoTriangle#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R050174", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.IsoTriangle#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R050175", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.IsoTriangle#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R050176", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.IsoTriangle#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R050177", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.IsoTriangle#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R050178", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.IsoTriangle#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R050179", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.IsoTriangle#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R050180", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.IsoTriangle#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R050181", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.IsoTriangle#getData", "kind": "function", "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.", "since": "3.0.0", "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R050182", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.IsoTriangle#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R050183", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.IsoTriangle#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R050184", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.IsoTriangle#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R050185", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.IsoTriangle#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R050186", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.IsoTriangle#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R050187", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.IsoTriangle#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R050188", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.IsoTriangle#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R050189", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.IsoTriangle#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R050190", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.IsoTriangle#getIndexList", "kind": "function", "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.", "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R050191", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.IsoTriangle#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R050192", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.IsoTriangle#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R050193", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.IsoTriangle#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R050194", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.IsoTriangle#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R050195", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.IsoTriangle#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R050196", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.IsoTriangle#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R050197", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.IsoTriangle#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R050198", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.IsoTriangle#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R050199", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.IsoTriangle#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R050200", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.IsoTriangle#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R050201", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.IsoTriangle#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R050202", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.IsoTriangle#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R050203", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.IsoTriangle#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R050204", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.IsoTriangle#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R050205", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.IsoTriangle#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R050206", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.IsoTriangle#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R050207", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.IsoTriangle#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R050209", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.IsoTriangle#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "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" } ], "___id": "T000002R050210", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.IsoTriangle#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R050211", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.IsoTriangle#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R050213", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.IsoTriangle#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "___id": "T000002R050214", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.IsoTriangle#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R050216", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.IsoTriangle#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "___id": "T000002R050217", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.IsoTriangle#getCenter", "kind": "function", "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`.", "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]" } ], "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "___id": "T000002R050219", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.IsoTriangle#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "___id": "T000002R050220", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.IsoTriangle#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "___id": "T000002R050221", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.IsoTriangle#getTopRight", "kind": "function", "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`.", "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]" } ], "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "___id": "T000002R050222", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.IsoTriangle#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "___id": "T000002R050223", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.IsoTriangle#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "___id": "T000002R050224", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.IsoTriangle#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "___id": "T000002R050225", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.IsoTriangle#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "___id": "T000002R050226", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.IsoTriangle#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "___id": "T000002R050227", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.IsoTriangle#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "___id": "T000002R050228", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.IsoTriangle#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R050229", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.IsoTriangle#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "___id": "T000002R050230", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.IsoTriangle#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "___id": "T000002R050231", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.IsoTriangle#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "___id": "T000002R050232", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.IsoTriangle#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "___id": "T000002R050233", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.IsoTriangle#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R050235", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.IsoTriangle#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R050236", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.IsoTriangle#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R050237", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.IsoTriangle#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R050238", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.IsoTriangle#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "___id": "T000002R050239", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.IsoTriangle#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R050240", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.IsoTriangle#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "___id": "T000002R050241", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.IsoTriangle#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R050242", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.IsoTriangle#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R050243", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.IsoTriangle#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R050244", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.IsoTriangle#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R050245", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.IsoTriangle#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "___id": "T000002R050246", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.IsoTriangle#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R050247", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.IsoTriangle#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R050248", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.IsoTriangle#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R050249", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.IsoTriangle#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R050250", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.IsoTriangle#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R050251", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.IsoTriangle#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R050252", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.IsoTriangle#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R050253", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.IsoTriangle#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R050254", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.IsoTriangle#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R050255", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.IsoTriangle#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "___id": "T000002R050256", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.IsoTriangle#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R050257", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.IsoTriangle#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R050258", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.IsoTriangle#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R050259", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.IsoTriangle#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R050260", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.IsoTriangle#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R050261", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.IsoTriangle#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R050262", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.IsoTriangle#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R050263", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.IsoTriangle#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R050264", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.IsoTriangle#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "___id": "T000002R050265", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.IsoTriangle#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R050266", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.IsoTriangle#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R050270", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.IsoTriangle#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R050271", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.IsoTriangle#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R050272", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.IsoTriangle#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R050273", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.IsoTriangle#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R050274", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.IsoTriangle#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R050275", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.IsoTriangle#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R050276", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.IsoTriangle#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R050277", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.IsoTriangle#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R050278", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.IsoTriangle#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "___id": "T000002R050279", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.IsoTriangle#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "___id": "T000002R050280", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.IsoTriangle#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "___id": "T000002R050281", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.IsoTriangle#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "___id": "T000002R050282", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.IsoTriangle#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "___id": "T000002R050283", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.IsoTriangle#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "___id": "T000002R050284", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.IsoTriangle#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "___id": "T000002R050285", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.IsoTriangle#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "___id": "T000002R050286", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.IsoTriangle#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "___id": "T000002R050287", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.IsoTriangle#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "___id": "T000002R050288", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.IsoTriangle#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R050289", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.IsoTriangle#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R050290", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.IsoTriangle#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "___id": "T000002R050291", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.IsoTriangle#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R050292", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.IsoTriangle#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R050294", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.IsoTriangle#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "___id": "T000002R050295", "___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": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "geom", "longname": "Phaser.GameObjects.Line#geom", "kind": "member", "description": "The source Shape data. Typically a geometry object.\rYou should not manipulate this directly.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "readonly": true, "since": "3.13.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#geom", "inherited": true, "___id": "T000002R050299", "___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": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathData", "longname": "Phaser.GameObjects.Line#pathData", "kind": "member", "description": "Holds the polygon path data for filled rendering.", "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathData", "inherited": true, "___id": "T000002R050300", "___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": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathIndexes", "longname": "Phaser.GameObjects.Line#pathIndexes", "kind": "member", "description": "Holds the earcut polygon path index data for filled rendering.", "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathIndexes", "inherited": true, "___id": "T000002R050301", "___s": true }, { "comment": "/**\r\n * The fill color used by this Shape.\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": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillColor", "longname": "Phaser.GameObjects.Line#fillColor", "kind": "member", "description": "The fill color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillColor", "inherited": true, "___id": "T000002R050302", "___s": true }, { "comment": "/**\r\n * The fill alpha value used by this Shape.\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": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillAlpha", "longname": "Phaser.GameObjects.Line#fillAlpha", "kind": "member", "description": "The fill alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillAlpha", "inherited": true, "___id": "T000002R050303", "___s": true }, { "comment": "/**\r\n * The stroke color used by this Shape.\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": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeColor", "longname": "Phaser.GameObjects.Line#strokeColor", "kind": "member", "description": "The stroke color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeColor", "inherited": true, "___id": "T000002R050304", "___s": true }, { "comment": "/**\r\n * The stroke alpha value used by this Shape.\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": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeAlpha", "longname": "Phaser.GameObjects.Line#strokeAlpha", "kind": "member", "description": "The stroke alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeAlpha", "inherited": true, "___id": "T000002R050305", "___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": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isFilled", "longname": "Phaser.GameObjects.Line#isFilled", "kind": "member", "description": "Controls if this Shape is filled or not.\rNote that some Shapes do not support being filled (such as Line shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isFilled", "inherited": true, "___id": "T000002R050306", "___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": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isStroked", "longname": "Phaser.GameObjects.Line#isStroked", "kind": "member", "description": "Controls if this Shape is stroked or not.\rNote that some Shapes do not support being stroked (such as Iso Box shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isStroked", "inherited": true, "___id": "T000002R050307", "___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": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "closePath", "longname": "Phaser.GameObjects.Line#closePath", "kind": "member", "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)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#closePath", "inherited": true, "___id": "T000002R050308", "___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": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Line#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#width", "inherited": true, "___id": "T000002R050310", "___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": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Line#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#height", "inherited": true, "___id": "T000002R050311", "___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": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setFillStyle", "longname": "Phaser.GameObjects.Line#setFillStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setFillStyle", "inherited": true, "___id": "T000002R050312", "___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": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setStrokeStyle", "longname": "Phaser.GameObjects.Line#setStrokeStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setStrokeStyle", "inherited": true, "___id": "T000002R050313", "___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": 284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setClosePath", "longname": "Phaser.GameObjects.Line#setClosePath", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setClosePath", "inherited": true, "___id": "T000002R050314", "___s": true }, { "comment": "/**\r\n * Sets the display size of this Shape.\r\n *\r\n * Calling this will adjust the scale.\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.\r\n * @param {number} height - The display height of this Shape.\r\n *\r\n * @return {this} This Shape instance.\r\n */", "meta": { "filename": "Shape.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Line#setDisplaySize", "kind": "function", "description": "Sets the display size of this Shape.\r\rCalling this will adjust the scale.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shape instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display width of this Shape.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display height of this Shape.", "name": "height" } ], "inherits": "Phaser.GameObjects.Shape#setDisplaySize", "inherited": true, "___id": "T000002R050316", "___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": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "preDestroy", "longname": "Phaser.GameObjects.Line#preDestroy", "kind": "function", "description": "Internal destroy handler, called as part of the destroy process.", "access": "protected", "since": "3.13.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#preDestroy", "inherited": true, "___id": "T000002R050317", "___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": 368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Line#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayWidth", "inherited": true, "___id": "T000002R050318", "___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": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Line#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayHeight", "inherited": true, "___id": "T000002R050319", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Line#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R050321", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Line#displayList", "kind": "member", "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.", "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R050322", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Line#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R050323", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Line#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R050324", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Line#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R050325", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Line#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R050326", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Line#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R050327", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Line#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R050328", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Line#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R050329", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Line#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R050330", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Line#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R050331", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Line#input", "kind": "member", "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()`.", "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R050332", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Line#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R050333", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Line#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R050334", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Line#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R050335", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Line#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R050336", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Line#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R050337", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Line#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R050338", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Line#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R050339", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Line#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R050340", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Line#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R050341", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Line#getData", "kind": "function", "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.", "since": "3.0.0", "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R050342", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Line#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R050343", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Line#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R050344", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Line#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R050345", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Line#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R050346", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Line#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R050347", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Line#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R050348", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Line#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R050349", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Line#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R050350", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Line#getIndexList", "kind": "function", "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.", "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R050351", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Line#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R050352", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Line#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R050353", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Line#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R050354", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Line#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R050355", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Line#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R050356", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Line#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R050357", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Line#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Line", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R050358", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Line#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R050359", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Line#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R050360", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Line#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R050361", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Line#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R050362", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Line#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R050363", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Line#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R050364", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Line#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R050365", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Line#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R050366", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Line#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R050367", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Line#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R050369", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Line#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "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" } ], "___id": "T000002R050370", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Line#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R050371", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Line#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R050373", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Line#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "___id": "T000002R050374", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Line#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R050376", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Line#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "___id": "T000002R050377", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.Line#getCenter", "kind": "function", "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`.", "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]" } ], "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "___id": "T000002R050379", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.Line#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "___id": "T000002R050380", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.Line#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "___id": "T000002R050381", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.Line#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "___id": "T000002R050382", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.Line#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "___id": "T000002R050383", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.Line#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "___id": "T000002R050384", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.Line#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "___id": "T000002R050385", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.Line#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "___id": "T000002R050386", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.Line#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "___id": "T000002R050387", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.Line#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "___id": "T000002R050388", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Line#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R050389", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Line#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "___id": "T000002R050390", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Line#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "___id": "T000002R050391", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Line#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "___id": "T000002R050392", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Line#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "___id": "T000002R050393", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Line#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R050395", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Line#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R050396", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Line#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R050397", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Line#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R050398", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Line#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "___id": "T000002R050399", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Line#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R050400", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Line#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "___id": "T000002R050401", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Line#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R050402", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Line#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R050403", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Line#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R050404", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Line#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R050405", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Line#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "___id": "T000002R050406", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Line#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R050407", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Line#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R050408", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Line#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R050409", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Line#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R050410", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Line#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R050411", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Line#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R050412", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Line#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R050413", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Line#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R050414", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Line#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R050415", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Line#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "___id": "T000002R050416", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Line#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R050417", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Line#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R050418", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Line#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R050419", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Line#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R050420", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Line#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R050421", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Line#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R050422", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Line#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R050423", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Line#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R050424", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Line#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "___id": "T000002R050425", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Line#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R050426", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Line#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R050430", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Line#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R050431", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Line#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R050432", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Line#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R050433", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Line#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R050434", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Line#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R050435", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Line#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R050436", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Line#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R050437", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Line#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R050438", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Line#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "___id": "T000002R050439", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Line#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "___id": "T000002R050440", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Line#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "___id": "T000002R050441", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Line#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "___id": "T000002R050442", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Line#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "___id": "T000002R050443", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Line#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "___id": "T000002R050444", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Line#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "___id": "T000002R050445", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Line#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "___id": "T000002R050446", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Line#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "___id": "T000002R050447", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Line#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "___id": "T000002R050448", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Line#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R050449", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Line#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R050450", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Line#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "___id": "T000002R050451", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Line#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R050452", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Line#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R050454", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Line#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "___id": "T000002R050455", "___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": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "geom", "longname": "Phaser.GameObjects.Polygon#geom", "kind": "member", "description": "The source Shape data. Typically a geometry object.\rYou should not manipulate this directly.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "readonly": true, "since": "3.13.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#geom", "inherited": true, "___id": "T000002R050459", "___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": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathData", "longname": "Phaser.GameObjects.Polygon#pathData", "kind": "member", "description": "Holds the polygon path data for filled rendering.", "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathData", "inherited": true, "___id": "T000002R050460", "___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": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathIndexes", "longname": "Phaser.GameObjects.Polygon#pathIndexes", "kind": "member", "description": "Holds the earcut polygon path index data for filled rendering.", "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathIndexes", "inherited": true, "___id": "T000002R050461", "___s": true }, { "comment": "/**\r\n * The fill color used by this Shape.\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": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillColor", "longname": "Phaser.GameObjects.Polygon#fillColor", "kind": "member", "description": "The fill color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillColor", "inherited": true, "___id": "T000002R050462", "___s": true }, { "comment": "/**\r\n * The fill alpha value used by this Shape.\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": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillAlpha", "longname": "Phaser.GameObjects.Polygon#fillAlpha", "kind": "member", "description": "The fill alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillAlpha", "inherited": true, "___id": "T000002R050463", "___s": true }, { "comment": "/**\r\n * The stroke color used by this Shape.\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": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeColor", "longname": "Phaser.GameObjects.Polygon#strokeColor", "kind": "member", "description": "The stroke color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeColor", "inherited": true, "___id": "T000002R050464", "___s": true }, { "comment": "/**\r\n * The stroke alpha value used by this Shape.\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": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeAlpha", "longname": "Phaser.GameObjects.Polygon#strokeAlpha", "kind": "member", "description": "The stroke alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeAlpha", "inherited": true, "___id": "T000002R050465", "___s": true }, { "comment": "/**\r\n * The stroke line width used by this Shape.\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": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "lineWidth", "longname": "Phaser.GameObjects.Polygon#lineWidth", "kind": "member", "description": "The stroke line width used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#lineWidth", "inherited": true, "___id": "T000002R050466", "___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": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isFilled", "longname": "Phaser.GameObjects.Polygon#isFilled", "kind": "member", "description": "Controls if this Shape is filled or not.\rNote that some Shapes do not support being filled (such as Line shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isFilled", "inherited": true, "___id": "T000002R050467", "___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": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isStroked", "longname": "Phaser.GameObjects.Polygon#isStroked", "kind": "member", "description": "Controls if this Shape is stroked or not.\rNote that some Shapes do not support being stroked (such as Iso Box shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isStroked", "inherited": true, "___id": "T000002R050468", "___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": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "closePath", "longname": "Phaser.GameObjects.Polygon#closePath", "kind": "member", "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)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#closePath", "inherited": true, "___id": "T000002R050469", "___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": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Polygon#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#width", "inherited": true, "___id": "T000002R050471", "___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": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Polygon#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#height", "inherited": true, "___id": "T000002R050472", "___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": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setFillStyle", "longname": "Phaser.GameObjects.Polygon#setFillStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setFillStyle", "inherited": true, "___id": "T000002R050473", "___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": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setStrokeStyle", "longname": "Phaser.GameObjects.Polygon#setStrokeStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setStrokeStyle", "inherited": true, "___id": "T000002R050474", "___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": 284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setClosePath", "longname": "Phaser.GameObjects.Polygon#setClosePath", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setClosePath", "inherited": true, "___id": "T000002R050475", "___s": true }, { "comment": "/**\r\n * Sets the display size of this Shape.\r\n *\r\n * Calling this will adjust the scale.\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.\r\n * @param {number} height - The display height of this Shape.\r\n *\r\n * @return {this} This Shape instance.\r\n */", "meta": { "filename": "Shape.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Polygon#setDisplaySize", "kind": "function", "description": "Sets the display size of this Shape.\r\rCalling this will adjust the scale.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shape instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display width of this Shape.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display height of this Shape.", "name": "height" } ], "inherits": "Phaser.GameObjects.Shape#setDisplaySize", "inherited": true, "___id": "T000002R050477", "___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": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "preDestroy", "longname": "Phaser.GameObjects.Polygon#preDestroy", "kind": "function", "description": "Internal destroy handler, called as part of the destroy process.", "access": "protected", "since": "3.13.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#preDestroy", "inherited": true, "___id": "T000002R050478", "___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": 368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Polygon#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayWidth", "inherited": true, "___id": "T000002R050479", "___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": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Polygon#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayHeight", "inherited": true, "___id": "T000002R050480", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Polygon#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R050482", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Polygon#displayList", "kind": "member", "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.", "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R050483", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Polygon#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R050484", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Polygon#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R050485", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Polygon#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R050486", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Polygon#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R050487", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Polygon#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R050488", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Polygon#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R050489", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Polygon#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R050490", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Polygon#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R050491", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Polygon#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R050492", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Polygon#input", "kind": "member", "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()`.", "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R050493", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Polygon#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R050494", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Polygon#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R050495", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Polygon#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R050496", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Polygon#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R050497", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Polygon#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R050498", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Polygon#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R050499", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Polygon#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R050500", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Polygon#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R050501", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Polygon#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R050502", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Polygon#getData", "kind": "function", "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.", "since": "3.0.0", "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R050503", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Polygon#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R050504", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Polygon#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R050505", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Polygon#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R050506", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Polygon#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R050507", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Polygon#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R050508", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Polygon#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R050509", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Polygon#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R050510", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Polygon#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R050511", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Polygon#getIndexList", "kind": "function", "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.", "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R050512", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Polygon#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R050513", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Polygon#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R050514", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Polygon#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R050515", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Polygon#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R050516", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Polygon#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R050517", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Polygon#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R050518", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Polygon#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R050519", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Polygon#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R050520", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Polygon#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R050521", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Polygon#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R050522", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Polygon#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R050523", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Polygon#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R050524", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Polygon#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R050525", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Polygon#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R050526", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Polygon#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R050527", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Polygon#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R050528", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Polygon#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R050530", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Polygon#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "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" } ], "___id": "T000002R050531", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Polygon#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R050532", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Polygon#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R050534", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Polygon#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "___id": "T000002R050535", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Polygon#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R050537", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Polygon#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "___id": "T000002R050538", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.Polygon#getCenter", "kind": "function", "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`.", "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]" } ], "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "___id": "T000002R050540", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.Polygon#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "___id": "T000002R050541", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.Polygon#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "___id": "T000002R050542", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.Polygon#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "___id": "T000002R050543", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.Polygon#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "___id": "T000002R050544", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.Polygon#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "___id": "T000002R050545", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.Polygon#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "___id": "T000002R050546", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.Polygon#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "___id": "T000002R050547", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.Polygon#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "___id": "T000002R050548", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.Polygon#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "___id": "T000002R050549", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Polygon#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R050550", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Polygon#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "___id": "T000002R050551", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Polygon#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "___id": "T000002R050552", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Polygon#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "___id": "T000002R050553", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Polygon#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "___id": "T000002R050554", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Polygon#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R050556", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Polygon#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R050557", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Polygon#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R050558", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Polygon#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R050559", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Polygon#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "___id": "T000002R050560", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Polygon#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R050561", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Polygon#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "___id": "T000002R050562", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Polygon#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R050563", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Polygon#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R050564", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Polygon#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R050565", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Polygon#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R050566", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Polygon#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "___id": "T000002R050567", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Polygon#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R050568", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Polygon#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R050569", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Polygon#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R050570", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Polygon#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R050571", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Polygon#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R050572", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Polygon#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R050573", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Polygon#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R050574", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Polygon#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R050575", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Polygon#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R050576", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Polygon#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "___id": "T000002R050577", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Polygon#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R050578", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Polygon#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R050579", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Polygon#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R050580", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Polygon#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R050581", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Polygon#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R050582", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Polygon#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R050583", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Polygon#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R050584", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Polygon#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R050585", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Polygon#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "___id": "T000002R050586", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Polygon#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R050587", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Polygon#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R050591", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Polygon#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R050592", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Polygon#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R050593", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Polygon#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R050594", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Polygon#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R050595", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Polygon#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R050596", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Polygon#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R050597", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Polygon#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R050598", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Polygon#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R050599", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Polygon#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "___id": "T000002R050600", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Polygon#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "___id": "T000002R050601", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Polygon#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "___id": "T000002R050602", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Polygon#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "___id": "T000002R050603", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Polygon#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "___id": "T000002R050604", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Polygon#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "___id": "T000002R050605", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Polygon#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "___id": "T000002R050606", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Polygon#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "___id": "T000002R050607", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Polygon#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "___id": "T000002R050608", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Polygon#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "___id": "T000002R050609", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Polygon#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R050610", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Polygon#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R050611", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Polygon#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "___id": "T000002R050612", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Polygon#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R050613", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Polygon#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R050615", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Polygon#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "___id": "T000002R050616", "___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": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "geom", "longname": "Phaser.GameObjects.Rectangle#geom", "kind": "member", "description": "The source Shape data. Typically a geometry object.\rYou should not manipulate this directly.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "readonly": true, "since": "3.13.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#geom", "inherited": true, "___id": "T000002R050620", "___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": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathData", "longname": "Phaser.GameObjects.Rectangle#pathData", "kind": "member", "description": "Holds the polygon path data for filled rendering.", "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathData", "inherited": true, "___id": "T000002R050621", "___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": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathIndexes", "longname": "Phaser.GameObjects.Rectangle#pathIndexes", "kind": "member", "description": "Holds the earcut polygon path index data for filled rendering.", "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathIndexes", "inherited": true, "___id": "T000002R050622", "___s": true }, { "comment": "/**\r\n * The fill color used by this Shape.\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": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillColor", "longname": "Phaser.GameObjects.Rectangle#fillColor", "kind": "member", "description": "The fill color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillColor", "inherited": true, "___id": "T000002R050623", "___s": true }, { "comment": "/**\r\n * The fill alpha value used by this Shape.\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": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillAlpha", "longname": "Phaser.GameObjects.Rectangle#fillAlpha", "kind": "member", "description": "The fill alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillAlpha", "inherited": true, "___id": "T000002R050624", "___s": true }, { "comment": "/**\r\n * The stroke color used by this Shape.\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": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeColor", "longname": "Phaser.GameObjects.Rectangle#strokeColor", "kind": "member", "description": "The stroke color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeColor", "inherited": true, "___id": "T000002R050625", "___s": true }, { "comment": "/**\r\n * The stroke alpha value used by this Shape.\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": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeAlpha", "longname": "Phaser.GameObjects.Rectangle#strokeAlpha", "kind": "member", "description": "The stroke alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeAlpha", "inherited": true, "___id": "T000002R050626", "___s": true }, { "comment": "/**\r\n * The stroke line width used by this Shape.\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": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "lineWidth", "longname": "Phaser.GameObjects.Rectangle#lineWidth", "kind": "member", "description": "The stroke line width used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#lineWidth", "inherited": true, "___id": "T000002R050627", "___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": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isFilled", "longname": "Phaser.GameObjects.Rectangle#isFilled", "kind": "member", "description": "Controls if this Shape is filled or not.\rNote that some Shapes do not support being filled (such as Line shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isFilled", "inherited": true, "___id": "T000002R050628", "___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": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isStroked", "longname": "Phaser.GameObjects.Rectangle#isStroked", "kind": "member", "description": "Controls if this Shape is stroked or not.\rNote that some Shapes do not support being stroked (such as Iso Box shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isStroked", "inherited": true, "___id": "T000002R050629", "___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": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "closePath", "longname": "Phaser.GameObjects.Rectangle#closePath", "kind": "member", "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)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#closePath", "inherited": true, "___id": "T000002R050630", "___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": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Rectangle#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#width", "inherited": true, "___id": "T000002R050632", "___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": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Rectangle#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#height", "inherited": true, "___id": "T000002R050633", "___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": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setFillStyle", "longname": "Phaser.GameObjects.Rectangle#setFillStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setFillStyle", "inherited": true, "___id": "T000002R050634", "___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": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setStrokeStyle", "longname": "Phaser.GameObjects.Rectangle#setStrokeStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setStrokeStyle", "inherited": true, "___id": "T000002R050635", "___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": 284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setClosePath", "longname": "Phaser.GameObjects.Rectangle#setClosePath", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setClosePath", "inherited": true, "___id": "T000002R050636", "___s": true }, { "comment": "/**\r\n * Sets the display size of this Shape.\r\n *\r\n * Calling this will adjust the scale.\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.\r\n * @param {number} height - The display height of this Shape.\r\n *\r\n * @return {this} This Shape instance.\r\n */", "meta": { "filename": "Shape.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Rectangle#setDisplaySize", "kind": "function", "description": "Sets the display size of this Shape.\r\rCalling this will adjust the scale.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shape instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display width of this Shape.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display height of this Shape.", "name": "height" } ], "inherits": "Phaser.GameObjects.Shape#setDisplaySize", "inherited": true, "___id": "T000002R050637", "___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": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "preDestroy", "longname": "Phaser.GameObjects.Rectangle#preDestroy", "kind": "function", "description": "Internal destroy handler, called as part of the destroy process.", "access": "protected", "since": "3.13.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#preDestroy", "inherited": true, "___id": "T000002R050638", "___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": 368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Rectangle#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayWidth", "inherited": true, "___id": "T000002R050639", "___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": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Rectangle#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayHeight", "inherited": true, "___id": "T000002R050640", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Rectangle#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R050642", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Rectangle#displayList", "kind": "member", "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.", "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R050643", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Rectangle#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R050644", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Rectangle#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R050645", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Rectangle#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R050646", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Rectangle#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R050647", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Rectangle#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R050648", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Rectangle#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R050649", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Rectangle#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R050650", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Rectangle#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R050651", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Rectangle#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R050652", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Rectangle#input", "kind": "member", "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()`.", "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R050653", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Rectangle#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R050654", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Rectangle#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R050655", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Rectangle#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R050656", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Rectangle#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R050657", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Rectangle#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R050658", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Rectangle#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R050659", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Rectangle#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R050660", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Rectangle#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R050661", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Rectangle#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R050662", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Rectangle#getData", "kind": "function", "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.", "since": "3.0.0", "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R050663", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Rectangle#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R050664", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Rectangle#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R050665", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Rectangle#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R050666", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Rectangle#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R050667", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Rectangle#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R050668", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Rectangle#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R050669", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Rectangle#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R050670", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Rectangle#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R050671", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Rectangle#getIndexList", "kind": "function", "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.", "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R050672", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Rectangle#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R050673", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Rectangle#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R050674", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Rectangle#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R050675", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Rectangle#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R050676", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Rectangle#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R050677", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Rectangle#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R050678", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Rectangle#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R050679", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Rectangle#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R050680", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Rectangle#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R050681", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Rectangle#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R050682", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Rectangle#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R050683", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Rectangle#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R050684", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Rectangle#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R050685", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Rectangle#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R050686", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Rectangle#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R050687", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Rectangle#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R050688", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Rectangle#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R050690", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Rectangle#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "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" } ], "___id": "T000002R050691", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Rectangle#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R050692", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Rectangle#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R050694", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Rectangle#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "___id": "T000002R050695", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Rectangle#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R050697", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Rectangle#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "___id": "T000002R050698", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.Rectangle#getCenter", "kind": "function", "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`.", "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]" } ], "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "___id": "T000002R050700", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.Rectangle#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "___id": "T000002R050701", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.Rectangle#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "___id": "T000002R050702", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.Rectangle#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "___id": "T000002R050703", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.Rectangle#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "___id": "T000002R050704", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.Rectangle#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "___id": "T000002R050705", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.Rectangle#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "___id": "T000002R050706", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.Rectangle#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "___id": "T000002R050707", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.Rectangle#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "___id": "T000002R050708", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.Rectangle#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "___id": "T000002R050709", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Rectangle#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R050710", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Rectangle#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "___id": "T000002R050711", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Rectangle#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "___id": "T000002R050712", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Rectangle#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "___id": "T000002R050713", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Rectangle#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "___id": "T000002R050714", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Rectangle#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R050716", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Rectangle#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R050717", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Rectangle#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R050718", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Rectangle#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R050719", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Rectangle#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "___id": "T000002R050720", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Rectangle#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R050721", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Rectangle#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "___id": "T000002R050722", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Rectangle#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R050723", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Rectangle#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R050724", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Rectangle#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R050725", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Rectangle#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R050726", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Rectangle#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "___id": "T000002R050727", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Rectangle#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R050728", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Rectangle#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R050729", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Rectangle#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R050730", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Rectangle#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R050731", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Rectangle#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R050732", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Rectangle#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R050733", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Rectangle#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R050734", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Rectangle#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R050735", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Rectangle#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R050736", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Rectangle#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "___id": "T000002R050737", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Rectangle#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R050738", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Rectangle#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R050739", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Rectangle#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R050740", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Rectangle#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R050741", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Rectangle#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R050742", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Rectangle#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R050743", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Rectangle#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R050744", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Rectangle#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R050745", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Rectangle#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "___id": "T000002R050746", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Rectangle#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R050747", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Rectangle#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R050751", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Rectangle#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R050752", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Rectangle#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R050753", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Rectangle#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R050754", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Rectangle#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R050755", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Rectangle#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R050756", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Rectangle#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R050757", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Rectangle#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R050758", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Rectangle#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R050759", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Rectangle#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "___id": "T000002R050760", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Rectangle#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "___id": "T000002R050761", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Rectangle#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "___id": "T000002R050762", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Rectangle#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "___id": "T000002R050763", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Rectangle#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "___id": "T000002R050764", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Rectangle#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "___id": "T000002R050765", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Rectangle#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "___id": "T000002R050766", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Rectangle#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "___id": "T000002R050767", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Rectangle#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "___id": "T000002R050768", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Rectangle#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "___id": "T000002R050769", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Rectangle#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R050770", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Rectangle#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R050771", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Rectangle#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "___id": "T000002R050772", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Rectangle#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R050773", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Rectangle#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R050775", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Rectangle#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "___id": "T000002R050776", "___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": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "geom", "longname": "Phaser.GameObjects.Star#geom", "kind": "member", "description": "The source Shape data. Typically a geometry object.\rYou should not manipulate this directly.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "readonly": true, "since": "3.13.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#geom", "inherited": true, "___id": "T000002R050780", "___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": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathData", "longname": "Phaser.GameObjects.Star#pathData", "kind": "member", "description": "Holds the polygon path data for filled rendering.", "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathData", "inherited": true, "___id": "T000002R050781", "___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": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathIndexes", "longname": "Phaser.GameObjects.Star#pathIndexes", "kind": "member", "description": "Holds the earcut polygon path index data for filled rendering.", "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathIndexes", "inherited": true, "___id": "T000002R050782", "___s": true }, { "comment": "/**\r\n * The fill color used by this Shape.\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": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillColor", "longname": "Phaser.GameObjects.Star#fillColor", "kind": "member", "description": "The fill color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillColor", "inherited": true, "___id": "T000002R050783", "___s": true }, { "comment": "/**\r\n * The fill alpha value used by this Shape.\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": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillAlpha", "longname": "Phaser.GameObjects.Star#fillAlpha", "kind": "member", "description": "The fill alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillAlpha", "inherited": true, "___id": "T000002R050784", "___s": true }, { "comment": "/**\r\n * The stroke color used by this Shape.\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": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeColor", "longname": "Phaser.GameObjects.Star#strokeColor", "kind": "member", "description": "The stroke color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeColor", "inherited": true, "___id": "T000002R050785", "___s": true }, { "comment": "/**\r\n * The stroke alpha value used by this Shape.\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": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeAlpha", "longname": "Phaser.GameObjects.Star#strokeAlpha", "kind": "member", "description": "The stroke alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeAlpha", "inherited": true, "___id": "T000002R050786", "___s": true }, { "comment": "/**\r\n * The stroke line width used by this Shape.\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": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "lineWidth", "longname": "Phaser.GameObjects.Star#lineWidth", "kind": "member", "description": "The stroke line width used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#lineWidth", "inherited": true, "___id": "T000002R050787", "___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": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isFilled", "longname": "Phaser.GameObjects.Star#isFilled", "kind": "member", "description": "Controls if this Shape is filled or not.\rNote that some Shapes do not support being filled (such as Line shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isFilled", "inherited": true, "___id": "T000002R050788", "___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": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isStroked", "longname": "Phaser.GameObjects.Star#isStroked", "kind": "member", "description": "Controls if this Shape is stroked or not.\rNote that some Shapes do not support being stroked (such as Iso Box shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isStroked", "inherited": true, "___id": "T000002R050789", "___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": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "closePath", "longname": "Phaser.GameObjects.Star#closePath", "kind": "member", "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)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#closePath", "inherited": true, "___id": "T000002R050790", "___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": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Star#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#width", "inherited": true, "___id": "T000002R050792", "___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": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Star#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#height", "inherited": true, "___id": "T000002R050793", "___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": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setFillStyle", "longname": "Phaser.GameObjects.Star#setFillStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setFillStyle", "inherited": true, "___id": "T000002R050794", "___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": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setStrokeStyle", "longname": "Phaser.GameObjects.Star#setStrokeStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setStrokeStyle", "inherited": true, "___id": "T000002R050795", "___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": 284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setClosePath", "longname": "Phaser.GameObjects.Star#setClosePath", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setClosePath", "inherited": true, "___id": "T000002R050796", "___s": true }, { "comment": "/**\r\n * Sets the display size of this Shape.\r\n *\r\n * Calling this will adjust the scale.\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.\r\n * @param {number} height - The display height of this Shape.\r\n *\r\n * @return {this} This Shape instance.\r\n */", "meta": { "filename": "Shape.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Star#setDisplaySize", "kind": "function", "description": "Sets the display size of this Shape.\r\rCalling this will adjust the scale.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shape instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display width of this Shape.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display height of this Shape.", "name": "height" } ], "inherits": "Phaser.GameObjects.Shape#setDisplaySize", "inherited": true, "___id": "T000002R050798", "___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": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "preDestroy", "longname": "Phaser.GameObjects.Star#preDestroy", "kind": "function", "description": "Internal destroy handler, called as part of the destroy process.", "access": "protected", "since": "3.13.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#preDestroy", "inherited": true, "___id": "T000002R050799", "___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": 368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Star#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayWidth", "inherited": true, "___id": "T000002R050800", "___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": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Star#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayHeight", "inherited": true, "___id": "T000002R050801", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Star#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R050803", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Star#displayList", "kind": "member", "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.", "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R050804", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Star#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R050805", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Star#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R050806", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Star#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R050807", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Star#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R050808", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Star#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R050809", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Star#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R050810", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Star#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R050811", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Star#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R050812", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Star#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R050813", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Star#input", "kind": "member", "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()`.", "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R050814", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Star#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R050815", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Star#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R050816", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Star#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R050817", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Star#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R050818", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Star#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R050819", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Star#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R050820", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Star#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R050821", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Star#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R050822", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Star#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R050823", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Star#getData", "kind": "function", "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.", "since": "3.0.0", "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R050824", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Star#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R050825", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Star#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R050826", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Star#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R050827", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Star#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R050828", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Star#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R050829", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Star#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R050830", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Star#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R050831", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Star#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R050832", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Star#getIndexList", "kind": "function", "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.", "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R050833", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Star#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R050834", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Star#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R050835", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Star#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R050836", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Star#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R050837", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Star#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R050838", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Star#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R050839", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Star#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Star", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R050840", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Star#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R050841", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Star#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R050842", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Star#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R050843", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Star#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R050844", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Star#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R050845", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Star#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R050846", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Star#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R050847", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Star#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R050848", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Star#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R050849", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Star#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R050851", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Star#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "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" } ], "___id": "T000002R050852", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Star#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R050853", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Star#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R050855", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Star#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "___id": "T000002R050856", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Star#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R050858", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Star#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "___id": "T000002R050859", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.Star#getCenter", "kind": "function", "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`.", "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]" } ], "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "___id": "T000002R050861", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.Star#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "___id": "T000002R050862", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.Star#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "___id": "T000002R050863", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.Star#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "___id": "T000002R050864", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.Star#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "___id": "T000002R050865", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.Star#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "___id": "T000002R050866", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.Star#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "___id": "T000002R050867", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.Star#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "___id": "T000002R050868", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.Star#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "___id": "T000002R050869", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.Star#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "___id": "T000002R050870", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Star#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R050871", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Star#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "___id": "T000002R050872", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Star#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "___id": "T000002R050873", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Star#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "___id": "T000002R050874", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Star#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "___id": "T000002R050875", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Star#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R050877", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Star#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R050878", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Star#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R050879", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Star#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R050880", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Star#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "___id": "T000002R050881", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Star#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R050882", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Star#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "___id": "T000002R050883", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Star#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R050884", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Star#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R050885", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Star#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R050886", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Star#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R050887", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Star#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "___id": "T000002R050888", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Star#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R050889", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Star#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R050890", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Star#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R050891", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Star#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R050892", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Star#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R050893", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Star#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R050894", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Star#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R050895", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Star#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R050896", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Star#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R050897", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Star#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "___id": "T000002R050898", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Star#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R050899", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Star#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R050900", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Star#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R050901", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Star#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R050902", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Star#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R050903", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Star#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R050904", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Star#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R050905", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Star#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R050906", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Star#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "___id": "T000002R050907", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Star#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R050908", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Star#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R050912", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Star#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R050913", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Star#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R050914", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Star#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R050915", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Star#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R050916", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Star#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R050917", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Star#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R050918", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Star#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R050919", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Star#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R050920", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Star#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "___id": "T000002R050921", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Star#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "___id": "T000002R050922", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Star#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "___id": "T000002R050923", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Star#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "___id": "T000002R050924", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Star#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "___id": "T000002R050925", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Star#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "___id": "T000002R050926", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Star#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "___id": "T000002R050927", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Star#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "___id": "T000002R050928", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Star#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "___id": "T000002R050929", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Star#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "___id": "T000002R050930", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Star#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R050931", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Star#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R050932", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Star#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "___id": "T000002R050933", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Star#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R050934", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Star#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R050936", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Star#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "___id": "T000002R050937", "___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": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "geom", "longname": "Phaser.GameObjects.Triangle#geom", "kind": "member", "description": "The source Shape data. Typically a geometry object.\rYou should not manipulate this directly.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "readonly": true, "since": "3.13.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#geom", "inherited": true, "___id": "T000002R050941", "___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": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathData", "longname": "Phaser.GameObjects.Triangle#pathData", "kind": "member", "description": "Holds the polygon path data for filled rendering.", "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathData", "inherited": true, "___id": "T000002R050942", "___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": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "pathIndexes", "longname": "Phaser.GameObjects.Triangle#pathIndexes", "kind": "member", "description": "Holds the earcut polygon path index data for filled rendering.", "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#pathIndexes", "inherited": true, "___id": "T000002R050943", "___s": true }, { "comment": "/**\r\n * The fill color used by this Shape.\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": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillColor", "longname": "Phaser.GameObjects.Triangle#fillColor", "kind": "member", "description": "The fill color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillColor", "inherited": true, "___id": "T000002R050944", "___s": true }, { "comment": "/**\r\n * The fill alpha value used by this Shape.\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": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "fillAlpha", "longname": "Phaser.GameObjects.Triangle#fillAlpha", "kind": "member", "description": "The fill alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#fillAlpha", "inherited": true, "___id": "T000002R050945", "___s": true }, { "comment": "/**\r\n * The stroke color used by this Shape.\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": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeColor", "longname": "Phaser.GameObjects.Triangle#strokeColor", "kind": "member", "description": "The stroke color used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeColor", "inherited": true, "___id": "T000002R050946", "___s": true }, { "comment": "/**\r\n * The stroke alpha value used by this Shape.\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": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "strokeAlpha", "longname": "Phaser.GameObjects.Triangle#strokeAlpha", "kind": "member", "description": "The stroke alpha value used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#strokeAlpha", "inherited": true, "___id": "T000002R050947", "___s": true }, { "comment": "/**\r\n * The stroke line width used by this Shape.\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": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "lineWidth", "longname": "Phaser.GameObjects.Triangle#lineWidth", "kind": "member", "description": "The stroke line width used by this Shape.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#lineWidth", "inherited": true, "___id": "T000002R050948", "___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": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isFilled", "longname": "Phaser.GameObjects.Triangle#isFilled", "kind": "member", "description": "Controls if this Shape is filled or not.\rNote that some Shapes do not support being filled (such as Line shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isFilled", "inherited": true, "___id": "T000002R050949", "___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": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "isStroked", "longname": "Phaser.GameObjects.Triangle#isStroked", "kind": "member", "description": "Controls if this Shape is stroked or not.\rNote that some Shapes do not support being stroked (such as Iso Box shapes)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#isStroked", "inherited": true, "___id": "T000002R050950", "___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": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "closePath", "longname": "Phaser.GameObjects.Triangle#closePath", "kind": "member", "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)", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#closePath", "inherited": true, "___id": "T000002R050951", "___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": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Triangle#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#width", "inherited": true, "___id": "T000002R050953", "___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": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Triangle#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#height", "inherited": true, "___id": "T000002R050954", "___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": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setFillStyle", "longname": "Phaser.GameObjects.Triangle#setFillStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setFillStyle", "inherited": true, "___id": "T000002R050955", "___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": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setStrokeStyle", "longname": "Phaser.GameObjects.Triangle#setStrokeStyle", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setStrokeStyle", "inherited": true, "___id": "T000002R050956", "___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": 284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setClosePath", "longname": "Phaser.GameObjects.Triangle#setClosePath", "kind": "function", "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.", "since": "3.13.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Shape#setClosePath", "inherited": true, "___id": "T000002R050957", "___s": true }, { "comment": "/**\r\n * Sets the display size of this Shape.\r\n *\r\n * Calling this will adjust the scale.\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.\r\n * @param {number} height - The display height of this Shape.\r\n *\r\n * @return {this} This Shape instance.\r\n */", "meta": { "filename": "Shape.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Triangle#setDisplaySize", "kind": "function", "description": "Sets the display size of this Shape.\r\rCalling this will adjust the scale.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shape instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display width of this Shape.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display height of this Shape.", "name": "height" } ], "inherits": "Phaser.GameObjects.Shape#setDisplaySize", "inherited": true, "___id": "T000002R050959", "___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": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "preDestroy", "longname": "Phaser.GameObjects.Triangle#preDestroy", "kind": "function", "description": "Internal destroy handler, called as part of the destroy process.", "access": "protected", "since": "3.13.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#preDestroy", "inherited": true, "___id": "T000002R050960", "___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": 368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Triangle#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayWidth", "inherited": true, "___id": "T000002R050961", "___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": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Triangle#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Shape#displayHeight", "inherited": true, "___id": "T000002R050962", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Triangle#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R050964", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Triangle#displayList", "kind": "member", "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.", "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R050965", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Triangle#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R050966", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Triangle#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R050967", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Triangle#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R050968", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Triangle#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R050969", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Triangle#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R050970", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Triangle#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R050971", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Triangle#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R050972", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Triangle#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R050973", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Triangle#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R050974", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Triangle#input", "kind": "member", "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()`.", "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R050975", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Triangle#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R050976", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Triangle#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R050977", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Triangle#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R050978", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Triangle#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R050979", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Triangle#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R050980", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Triangle#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R050981", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Triangle#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R050982", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Triangle#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R050983", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Triangle#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R050984", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Triangle#getData", "kind": "function", "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.", "since": "3.0.0", "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R050985", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Triangle#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R050986", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Triangle#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R050987", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Triangle#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R050988", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Triangle#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R050989", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Triangle#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R050990", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Triangle#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R050991", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Triangle#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R050992", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Triangle#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R050993", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Triangle#getIndexList", "kind": "function", "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.", "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R050994", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Triangle#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R050995", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Triangle#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R050996", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Triangle#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R050997", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Triangle#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R050998", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Triangle#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R050999", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Triangle#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R051000", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Triangle#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R051001", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Triangle#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R051002", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Triangle#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R051003", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Triangle#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R051004", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Triangle#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R051005", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Triangle#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R051006", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Triangle#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R051007", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Triangle#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R051008", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Triangle#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R051009", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Triangle#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R051010", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Triangle#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R051012", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Triangle#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "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" } ], "___id": "T000002R051013", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Triangle#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R051014", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Triangle#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R051016", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Triangle#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "___id": "T000002R051017", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Triangle#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R051019", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Triangle#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "___id": "T000002R051020", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.Triangle#getCenter", "kind": "function", "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`.", "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]" } ], "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "___id": "T000002R051022", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.Triangle#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "___id": "T000002R051023", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.Triangle#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "___id": "T000002R051024", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.Triangle#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "___id": "T000002R051025", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.Triangle#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "___id": "T000002R051026", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.Triangle#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "___id": "T000002R051027", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.Triangle#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "___id": "T000002R051028", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.Triangle#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "___id": "T000002R051029", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.Triangle#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "___id": "T000002R051030", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.Triangle#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "___id": "T000002R051031", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Triangle#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R051032", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Triangle#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "___id": "T000002R051033", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Triangle#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "___id": "T000002R051034", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Triangle#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "___id": "T000002R051035", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Triangle#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "___id": "T000002R051036", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Triangle#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R051038", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Triangle#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R051039", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Triangle#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R051040", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Triangle#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R051041", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Triangle#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "___id": "T000002R051042", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Triangle#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R051043", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Triangle#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "___id": "T000002R051044", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Triangle#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R051045", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Triangle#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R051046", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Triangle#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R051047", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Triangle#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R051048", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Triangle#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "___id": "T000002R051049", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Triangle#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R051050", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Triangle#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R051051", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Triangle#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R051052", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Triangle#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R051053", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Triangle#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R051054", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Triangle#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R051055", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Triangle#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R051056", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Triangle#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R051057", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Triangle#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R051058", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Triangle#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "___id": "T000002R051059", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Triangle#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "___id": "T000002R051060", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Triangle#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "___id": "T000002R051061", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Triangle#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R051062", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Triangle#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "___id": "T000002R051063", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Triangle#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "___id": "T000002R051064", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Triangle#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R051065", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Triangle#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R051066", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Triangle#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R051067", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Triangle#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "___id": "T000002R051068", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Triangle#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R051069", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Triangle#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R051073", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Triangle#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R051074", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Triangle#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R051075", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Triangle#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R051076", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Triangle#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R051077", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Triangle#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R051078", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Triangle#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R051079", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Triangle#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R051080", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Triangle#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R051081", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Triangle#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "___id": "T000002R051082", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Triangle#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "___id": "T000002R051083", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Triangle#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "___id": "T000002R051084", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Triangle#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "___id": "T000002R051085", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Triangle#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "___id": "T000002R051086", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Triangle#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "___id": "T000002R051087", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Triangle#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "___id": "T000002R051088", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Triangle#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "___id": "T000002R051089", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Triangle#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "___id": "T000002R051090", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Triangle#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "___id": "T000002R051091", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Triangle#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R051092", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Triangle#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "___id": "T000002R051093", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Triangle#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "___id": "T000002R051094", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Triangle#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R051095", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Triangle#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R051097", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Triangle#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "___id": "T000002R051098", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Text#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R051099", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Text#displayList", "kind": "member", "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.", "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.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R051100", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Text#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R051101", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Text#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R051102", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Text#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R051103", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Text#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R051104", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Text#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R051105", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Text#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R051106", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Text#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R051107", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Text#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R051108", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Text#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R051109", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Text#input", "kind": "member", "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()`.", "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.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R051110", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Text#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R051111", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Text#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R051112", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Text#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R051113", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Text#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R051114", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Text#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R051115", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Text#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R051116", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Text#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R051117", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Text#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R051118", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Text#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R051119", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Text#getData", "kind": "function", "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.", "since": "3.0.0", "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.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R051120", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Text#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R051121", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Text#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R051122", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Text#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R051123", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Text#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R051124", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Text#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R051125", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Text#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R051126", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Text#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R051127", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Text#getIndexList", "kind": "function", "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.", "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.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R051128", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Text#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R051129", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Text#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R051130", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Text#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R051131", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Text#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R051132", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Text#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R051133", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Text#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R051134", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Text#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Text", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R051135", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Text#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R051136", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Text#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R051137", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Text#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R051138", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Text#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R051139", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Text#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R051140", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Text#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R051141", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Text#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R051142", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Text#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R051143", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Text#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R051144", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Text#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "___id": "T000002R051150", "___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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Text#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Alpha#setAlpha", "inherited": true, "___id": "T000002R051151", "___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 *\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Text#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alpha", "inherited": true, "___id": "T000002R051152", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.GameObjects.Text#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "___id": "T000002R051153", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.GameObjects.Text#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "___id": "T000002R051154", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.GameObjects.Text#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "___id": "T000002R051155", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.GameObjects.Text#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "___id": "T000002R051156", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Text#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R051158", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Text#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R051159", "___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": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Text#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#displayWidth", "inherited": true, "___id": "T000002R051160", "___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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Text#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#displayHeight", "inherited": true, "___id": "T000002R051161", "___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": 93, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.GameObjects.Text#setSize", "kind": "function", "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.", "since": "3.4.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ComputedSize#setSize", "inherited": true, "___id": "T000002R051162", "___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.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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Text#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.4.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ComputedSize#setDisplaySize", "inherited": true, "___id": "T000002R051163", "___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": 16, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "texture", "longname": "Phaser.GameObjects.Text#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Crop#texture", "inherited": true, "___id": "T000002R051164", "___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": 25, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "frame", "longname": "Phaser.GameObjects.Text#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Crop#frame", "inherited": true, "___id": "T000002R051165", "___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": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isCropped", "longname": "Phaser.GameObjects.Text#isCropped", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Crop#isCropped", "inherited": true, "___id": "T000002R051166", "___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 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 rect 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. 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.\r\n * @param {number} [width] - The width of the crop rectangle in pixels.\r\n * @param {number} [height] - The height of the crop rectangle in pixels.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Crop.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setCrop", "longname": "Phaser.GameObjects.Text#setCrop", "kind": "function", "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 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 rect 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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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. 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.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the crop rectangle in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the crop rectangle in pixels.", "name": "height" } ], "inherits": "Phaser.GameObjects.Components.Crop#setCrop", "inherited": true, "___id": "T000002R051167", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Text#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R051170", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Text#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R051171", "___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.Components.Flip#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipX", "longname": "Phaser.GameObjects.Text#flipX", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipX", "inherited": true, "___id": "T000002R051172", "___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.Components.Flip#flipY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipY", "longname": "Phaser.GameObjects.Text#flipY", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipY", "inherited": true, "___id": "T000002R051173", "___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 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 * @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": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipX", "longname": "Phaser.GameObjects.Text#toggleFlipX", "kind": "function", "description": "Toggles the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipX", "inherited": true, "___id": "T000002R051174", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipY", "longname": "Phaser.GameObjects.Text#toggleFlipY", "kind": "function", "description": "Toggles the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipY", "inherited": true, "___id": "T000002R051175", "___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 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 * @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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipX", "longname": "Phaser.GameObjects.Text#setFlipX", "kind": "function", "description": "Sets the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipX", "inherited": true, "___id": "T000002R051176", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\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": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipY", "longname": "Phaser.GameObjects.Text#setFlipY", "kind": "function", "description": "Sets the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipY", "inherited": true, "___id": "T000002R051177", "___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 inversed 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 horizontal 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": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlip", "longname": "Phaser.GameObjects.Text#setFlip", "kind": "function", "description": "Sets the horizontal and vertical flipped state of this Game Object.\r\rA Game Object that is flipped will render inversed 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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 horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlip", "inherited": true, "___id": "T000002R051178", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetFlip", "longname": "Phaser.GameObjects.Text#resetFlip", "kind": "function", "description": "Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#resetFlip", "inherited": true, "___id": "T000002R051179", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.Text#getCenter", "kind": "function", "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`.", "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]" } ], "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.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "___id": "T000002R051181", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.Text#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "___id": "T000002R051182", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.Text#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "___id": "T000002R051183", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.Text#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "___id": "T000002R051184", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.Text#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "___id": "T000002R051185", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.Text#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "___id": "T000002R051186", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.Text#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "___id": "T000002R051187", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.Text#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "___id": "T000002R051188", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.Text#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "___id": "T000002R051189", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.Text#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "___id": "T000002R051190", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Text#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R051191", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Text#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R051192", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Text#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R051193", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Text#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R051194", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Text#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R051195", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Text#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R051197", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Text#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R051198", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Text#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R051199", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Text#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R051200", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Text#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "___id": "T000002R051201", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Text#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R051202", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Text#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "___id": "T000002R051203", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Text#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R051204", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Text#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R051205", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Text#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R051206", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Text#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R051207", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Text#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "___id": "T000002R051208", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Text#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Text", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "___id": "T000002R051209", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Text#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "___id": "T000002R051210", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Text#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "___id": "T000002R051211", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Text#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R051212", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Text#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R051213", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Text#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R051214", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Text#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R051215", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Text#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R051216", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Text#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R051217", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Text#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R051218", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Text#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Text", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R051219", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Text#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Text", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R051220", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Text#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R051221", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Text#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R051222", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Text#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R051223", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Text#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R051224", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Text#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R051225", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Text#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R051226", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Text#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R051227", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertice 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": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopLeft", "longname": "Phaser.GameObjects.Text#tintTopLeft", "kind": "member", "description": "The tint value being applied to the top-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopLeft", "inherited": true, "___id": "T000002R051228", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-right vertice 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopRight", "longname": "Phaser.GameObjects.Text#tintTopRight", "kind": "member", "description": "The tint value being applied to the top-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopRight", "inherited": true, "___id": "T000002R051229", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-left vertice 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": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomLeft", "longname": "Phaser.GameObjects.Text#tintBottomLeft", "kind": "member", "description": "The tint value being applied to the bottom-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "inherited": true, "___id": "T000002R051230", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-right vertice 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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomRight", "longname": "Phaser.GameObjects.Text#tintBottomRight", "kind": "member", "description": "The tint value being applied to the bottom-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomRight", "inherited": true, "___id": "T000002R051231", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintFill", "longname": "Phaser.GameObjects.Text#tintFill", "kind": "member", "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.11.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintFill", "inherited": true, "___id": "T000002R051232", "___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 'additive',\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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearTint", "longname": "Phaser.GameObjects.Text#clearTint", "kind": "function", "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff and the tint type to 'additive',\rwhich results in no visible change to the texture.", "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.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#clearTint", "inherited": true, "___id": "T000002R051233", "___s": true }, { "comment": "/**\r\n * Sets an additive tint 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 * multiplying it by 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 * To swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.\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": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTint", "longname": "Phaser.GameObjects.Text#setTint", "kind": "function", "description": "Sets an additive tint on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by 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\rTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.", "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.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Tint#setTint", "inherited": true, "___id": "T000002R051234", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on this Game Object.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. You can provide either one color value, in which case the whole\r\n * Game Object will be rendered in that color. Or you can provide a color per corner. The colors\r\n * 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 * To swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintFill\r\n * @webglOnly\r\n * @since 3.11.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.\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": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTintFill", "longname": "Phaser.GameObjects.Text#setTintFill", "kind": "function", "description": "Sets a fill-based tint on this Game Object.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. You can provide either one color value, in which case the whole\rGame Object will be rendered in that color. Or you can provide a color per corner. The colors\rare 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\rTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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 not 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" } ], "inherits": "Phaser.GameObjects.Components.Tint#setTintFill", "inherited": true, "___id": "T000002R051235", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.\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": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tint", "longname": "Phaser.GameObjects.Text#tint", "kind": "member", "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tint", "inherited": true, "___id": "T000002R051236", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * It checks to see if the 4 tint properties are set to the value 0xffffff\r\n * and that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.\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": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isTinted", "longname": "Phaser.GameObjects.Text#isTinted", "kind": "member", "description": "Does this Game Object have a tint applied?\r\rIt checks to see if the 4 tint properties are set to the value 0xffffff\rand that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "readonly": true, "since": "3.11.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#isTinted", "inherited": true, "___id": "T000002R051237", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Text#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R051238", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Text#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R051242", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Text#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R051243", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Text#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R051244", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Text#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R051245", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Text#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R051246", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Text#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R051247", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Text#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R051248", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Text#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R051249", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Text#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R051250", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Text#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R051251", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Text#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R051252", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Text#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R051253", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Text#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R051254", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Text#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R051255", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Text#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R051256", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Text#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R051257", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Text#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R051258", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Text#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R051259", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Text#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R051260", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Text#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R051261", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Text#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R051262", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Text#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R051263", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Text#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R051264", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Text#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R051266", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Text#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Text", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R051267", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.TileSprite#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R051268", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.TileSprite#displayList", "kind": "member", "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.", "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.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R051269", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.TileSprite#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R051270", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.TileSprite#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R051271", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.TileSprite#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R051272", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.TileSprite#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R051273", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.TileSprite#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R051274", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.TileSprite#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R051275", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.TileSprite#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R051276", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.TileSprite#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R051277", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.TileSprite#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R051278", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.TileSprite#input", "kind": "member", "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()`.", "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.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R051279", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.TileSprite#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R051280", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.TileSprite#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R051281", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.TileSprite#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R051282", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.TileSprite#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R051283", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.TileSprite#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R051284", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.TileSprite#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R051285", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.TileSprite#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R051286", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.TileSprite#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R051287", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.TileSprite#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R051288", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.TileSprite#getData", "kind": "function", "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.", "since": "3.0.0", "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.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R051289", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.TileSprite#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R051290", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.TileSprite#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R051291", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.TileSprite#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R051292", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.TileSprite#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R051293", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.TileSprite#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R051294", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.TileSprite#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R051295", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.TileSprite#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R051296", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.TileSprite#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R051297", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.TileSprite#getIndexList", "kind": "function", "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.", "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.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R051298", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.TileSprite#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R051299", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.TileSprite#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R051300", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.TileSprite#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R051301", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.TileSprite#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R051302", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.TileSprite#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R051303", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.TileSprite#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R051304", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.TileSprite#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R051305", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.TileSprite#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R051306", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.TileSprite#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R051307", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.TileSprite#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R051308", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.TileSprite#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R051309", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.TileSprite#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R051310", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.TileSprite#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R051311", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.TileSprite#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R051312", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.TileSprite#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R051313", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.TileSprite#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R051314", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.TileSprite#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "___id": "T000002R051320", "___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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.TileSprite#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Alpha#setAlpha", "inherited": true, "___id": "T000002R051321", "___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 *\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.TileSprite#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alpha", "inherited": true, "___id": "T000002R051322", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.GameObjects.TileSprite#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "___id": "T000002R051323", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.GameObjects.TileSprite#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "___id": "T000002R051324", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.GameObjects.TileSprite#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "___id": "T000002R051325", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.GameObjects.TileSprite#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "___id": "T000002R051326", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.TileSprite#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R051328", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.TileSprite#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R051329", "___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": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.TileSprite#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#width", "inherited": true, "___id": "T000002R051330", "___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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.TileSprite#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#height", "inherited": true, "___id": "T000002R051331", "___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": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.TileSprite#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#displayWidth", "inherited": true, "___id": "T000002R051332", "___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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.TileSprite#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#displayHeight", "inherited": true, "___id": "T000002R051333", "___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": 93, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.GameObjects.TileSprite#setSize", "kind": "function", "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.", "since": "3.4.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ComputedSize#setSize", "inherited": true, "___id": "T000002R051334", "___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.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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.TileSprite#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.4.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ComputedSize#setDisplaySize", "inherited": true, "___id": "T000002R051335", "___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": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isCropped", "longname": "Phaser.GameObjects.TileSprite#isCropped", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Crop#isCropped", "inherited": true, "___id": "T000002R051336", "___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 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 rect 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. 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.\r\n * @param {number} [width] - The width of the crop rectangle in pixels.\r\n * @param {number} [height] - The height of the crop rectangle in pixels.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Crop.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setCrop", "longname": "Phaser.GameObjects.TileSprite#setCrop", "kind": "function", "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 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 rect 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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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. 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.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the crop rectangle in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the crop rectangle in pixels.", "name": "height" } ], "inherits": "Phaser.GameObjects.Components.Crop#setCrop", "inherited": true, "___id": "T000002R051337", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.TileSprite#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R051340", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.TileSprite#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R051341", "___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.Components.Flip#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipX", "longname": "Phaser.GameObjects.TileSprite#flipX", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipX", "inherited": true, "___id": "T000002R051342", "___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.Components.Flip#flipY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipY", "longname": "Phaser.GameObjects.TileSprite#flipY", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipY", "inherited": true, "___id": "T000002R051343", "___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 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 * @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": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipX", "longname": "Phaser.GameObjects.TileSprite#toggleFlipX", "kind": "function", "description": "Toggles the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipX", "inherited": true, "___id": "T000002R051344", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipY", "longname": "Phaser.GameObjects.TileSprite#toggleFlipY", "kind": "function", "description": "Toggles the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipY", "inherited": true, "___id": "T000002R051345", "___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 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 * @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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipX", "longname": "Phaser.GameObjects.TileSprite#setFlipX", "kind": "function", "description": "Sets the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipX", "inherited": true, "___id": "T000002R051346", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\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": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipY", "longname": "Phaser.GameObjects.TileSprite#setFlipY", "kind": "function", "description": "Sets the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipY", "inherited": true, "___id": "T000002R051347", "___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 inversed 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 horizontal 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": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlip", "longname": "Phaser.GameObjects.TileSprite#setFlip", "kind": "function", "description": "Sets the horizontal and vertical flipped state of this Game Object.\r\rA Game Object that is flipped will render inversed 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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 horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlip", "inherited": true, "___id": "T000002R051348", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetFlip", "longname": "Phaser.GameObjects.TileSprite#resetFlip", "kind": "function", "description": "Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#resetFlip", "inherited": true, "___id": "T000002R051349", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.TileSprite#getCenter", "kind": "function", "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`.", "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]" } ], "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.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "___id": "T000002R051351", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.TileSprite#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "___id": "T000002R051352", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.TileSprite#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "___id": "T000002R051353", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.TileSprite#getTopRight", "kind": "function", "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`.", "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]" } ], "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.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "___id": "T000002R051354", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.TileSprite#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "___id": "T000002R051355", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.TileSprite#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "___id": "T000002R051356", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.TileSprite#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "___id": "T000002R051357", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.TileSprite#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "___id": "T000002R051358", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.TileSprite#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "___id": "T000002R051359", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.TileSprite#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "___id": "T000002R051360", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.TileSprite#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R051361", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.TileSprite#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R051362", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.TileSprite#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R051363", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.TileSprite#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R051364", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.TileSprite#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R051365", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.TileSprite#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R051367", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.TileSprite#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R051368", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.TileSprite#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R051369", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.TileSprite#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R051370", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.TileSprite#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "___id": "T000002R051371", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.TileSprite#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R051372", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.TileSprite#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "___id": "T000002R051373", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.TileSprite#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R051374", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.TileSprite#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R051375", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.TileSprite#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R051376", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.TileSprite#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R051377", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.TileSprite#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "___id": "T000002R051378", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.TileSprite#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "___id": "T000002R051379", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.TileSprite#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "___id": "T000002R051380", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.TileSprite#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "___id": "T000002R051381", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.TileSprite#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R051382", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.TileSprite#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R051383", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.TileSprite#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R051384", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.TileSprite#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R051385", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.TileSprite#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R051386", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.TileSprite#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R051387", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.TileSprite#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R051388", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.TileSprite#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R051389", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.TileSprite#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R051390", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.TileSprite#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R051391", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.TileSprite#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R051392", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.TileSprite#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R051393", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.TileSprite#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R051394", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.TileSprite#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R051395", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.TileSprite#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R051396", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.TileSprite#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R051397", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertice 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": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopLeft", "longname": "Phaser.GameObjects.TileSprite#tintTopLeft", "kind": "member", "description": "The tint value being applied to the top-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopLeft", "inherited": true, "___id": "T000002R051398", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-right vertice 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopRight", "longname": "Phaser.GameObjects.TileSprite#tintTopRight", "kind": "member", "description": "The tint value being applied to the top-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopRight", "inherited": true, "___id": "T000002R051399", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-left vertice 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": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomLeft", "longname": "Phaser.GameObjects.TileSprite#tintBottomLeft", "kind": "member", "description": "The tint value being applied to the bottom-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "inherited": true, "___id": "T000002R051400", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-right vertice 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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomRight", "longname": "Phaser.GameObjects.TileSprite#tintBottomRight", "kind": "member", "description": "The tint value being applied to the bottom-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomRight", "inherited": true, "___id": "T000002R051401", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintFill", "longname": "Phaser.GameObjects.TileSprite#tintFill", "kind": "member", "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.11.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintFill", "inherited": true, "___id": "T000002R051402", "___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 'additive',\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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearTint", "longname": "Phaser.GameObjects.TileSprite#clearTint", "kind": "function", "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff and the tint type to 'additive',\rwhich results in no visible change to the texture.", "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.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#clearTint", "inherited": true, "___id": "T000002R051403", "___s": true }, { "comment": "/**\r\n * Sets an additive tint 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 * multiplying it by 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 * To swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.\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": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTint", "longname": "Phaser.GameObjects.TileSprite#setTint", "kind": "function", "description": "Sets an additive tint on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by 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\rTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.", "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.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Tint#setTint", "inherited": true, "___id": "T000002R051404", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on this Game Object.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. You can provide either one color value, in which case the whole\r\n * Game Object will be rendered in that color. Or you can provide a color per corner. The colors\r\n * 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 * To swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintFill\r\n * @webglOnly\r\n * @since 3.11.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.\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": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTintFill", "longname": "Phaser.GameObjects.TileSprite#setTintFill", "kind": "function", "description": "Sets a fill-based tint on this Game Object.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. You can provide either one color value, in which case the whole\rGame Object will be rendered in that color. Or you can provide a color per corner. The colors\rare 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\rTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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 not 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" } ], "inherits": "Phaser.GameObjects.Components.Tint#setTintFill", "inherited": true, "___id": "T000002R051405", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.\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": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tint", "longname": "Phaser.GameObjects.TileSprite#tint", "kind": "member", "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tint", "inherited": true, "___id": "T000002R051406", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * It checks to see if the 4 tint properties are set to the value 0xffffff\r\n * and that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.\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": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isTinted", "longname": "Phaser.GameObjects.TileSprite#isTinted", "kind": "member", "description": "Does this Game Object have a tint applied?\r\rIt checks to see if the 4 tint properties are set to the value 0xffffff\rand that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "readonly": true, "since": "3.11.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#isTinted", "inherited": true, "___id": "T000002R051407", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.TileSprite#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R051408", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.TileSprite#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R051412", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.TileSprite#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R051413", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.TileSprite#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R051414", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.TileSprite#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R051415", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.TileSprite#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R051416", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.TileSprite#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R051417", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.TileSprite#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R051418", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.TileSprite#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R051419", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.TileSprite#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R051420", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.TileSprite#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R051421", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.TileSprite#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R051422", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.TileSprite#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R051423", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.TileSprite#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R051424", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.TileSprite#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R051425", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.TileSprite#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R051426", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.TileSprite#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R051427", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.TileSprite#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R051428", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.TileSprite#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R051429", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.TileSprite#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R051430", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.TileSprite#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R051431", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.TileSprite#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R051432", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.TileSprite#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R051433", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.TileSprite#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R051434", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.TileSprite#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R051436", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.TileSprite#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R051437", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Video#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R051438", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Video#displayList", "kind": "member", "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.", "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.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R051439", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Video#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R051440", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Video#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R051441", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Video#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R051442", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Video#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R051443", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Video#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R051444", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Video#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R051445", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Video#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R051446", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Video#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R051447", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Video#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R051448", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Video#input", "kind": "member", "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()`.", "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.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R051449", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Video#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R051450", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Video#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R051451", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Video#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R051452", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Video#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R051453", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Video#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R051454", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Video#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R051455", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Video#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R051456", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Video#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R051457", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Video#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R051458", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Video#getData", "kind": "function", "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.", "since": "3.0.0", "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.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R051459", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Video#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R051460", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Video#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R051461", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Video#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R051462", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Video#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R051463", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Video#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R051464", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Video#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R051465", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Video#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R051466", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Video#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R051467", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Video#getIndexList", "kind": "function", "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.", "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.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R051468", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Video#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R051469", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Video#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R051470", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Video#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R051471", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Video#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R051472", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Video#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R051473", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Video#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R051474", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Video#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Video", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R051475", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Video#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R051476", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Video#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R051477", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Video#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R051478", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Video#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R051479", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Video#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R051480", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Video#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R051481", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Video#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R051482", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Video#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R051483", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Video#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R051484", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.GameObjects.Video#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "___id": "T000002R051490", "___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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.GameObjects.Video#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Alpha#setAlpha", "inherited": true, "___id": "T000002R051491", "___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 *\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.GameObjects.Video#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alpha", "inherited": true, "___id": "T000002R051492", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.GameObjects.Video#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "___id": "T000002R051493", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.GameObjects.Video#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "___id": "T000002R051494", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.GameObjects.Video#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "___id": "T000002R051495", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.GameObjects.Video#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "___id": "T000002R051496", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.GameObjects.Video#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R051498", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.GameObjects.Video#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R051499", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Video#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R051501", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Video#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R051502", "___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.Components.Flip#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipX", "longname": "Phaser.GameObjects.Video#flipX", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipX", "inherited": true, "___id": "T000002R051503", "___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 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 * @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": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipX", "longname": "Phaser.GameObjects.Video#toggleFlipX", "kind": "function", "description": "Toggles the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipX", "inherited": true, "___id": "T000002R051504", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipY", "longname": "Phaser.GameObjects.Video#toggleFlipY", "kind": "function", "description": "Toggles the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipY", "inherited": true, "___id": "T000002R051505", "___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 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 * @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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipX", "longname": "Phaser.GameObjects.Video#setFlipX", "kind": "function", "description": "Sets the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipX", "inherited": true, "___id": "T000002R051506", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\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": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipY", "longname": "Phaser.GameObjects.Video#setFlipY", "kind": "function", "description": "Sets the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipY", "inherited": true, "___id": "T000002R051507", "___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 inversed 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 horizontal 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": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlip", "longname": "Phaser.GameObjects.Video#setFlip", "kind": "function", "description": "Sets the horizontal and vertical flipped state of this Game Object.\r\rA Game Object that is flipped will render inversed 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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 horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlip", "inherited": true, "___id": "T000002R051508", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetFlip", "longname": "Phaser.GameObjects.Video#resetFlip", "kind": "function", "description": "Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#resetFlip", "inherited": true, "___id": "T000002R051509", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.Video#getCenter", "kind": "function", "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`.", "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]" } ], "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.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "___id": "T000002R051511", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.Video#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "___id": "T000002R051512", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.Video#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "___id": "T000002R051513", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.Video#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "___id": "T000002R051514", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.Video#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "___id": "T000002R051515", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.Video#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "___id": "T000002R051516", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.Video#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "___id": "T000002R051517", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.Video#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "___id": "T000002R051518", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.Video#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "___id": "T000002R051519", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.Video#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "___id": "T000002R051520", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.GameObjects.Video#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R051521", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.GameObjects.Video#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R051522", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.GameObjects.Video#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R051523", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.GameObjects.Video#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R051524", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.GameObjects.Video#createGeometryMask", "kind": "function", "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.", "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]" } ], "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.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R051525", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Video#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R051527", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Video#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R051528", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Video#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R051529", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Video#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R051530", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Video#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "___id": "T000002R051531", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Video#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R051532", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Video#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "___id": "T000002R051533", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Video#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R051534", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.GameObjects.Video#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R051535", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.GameObjects.Video#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R051536", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.GameObjects.Video#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R051537", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.GameObjects.Video#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "___id": "T000002R051538", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.GameObjects.Video#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Video", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "___id": "T000002R051539", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.GameObjects.Video#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "___id": "T000002R051540", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.GameObjects.Video#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "___id": "T000002R051541", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.GameObjects.Video#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R051542", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.GameObjects.Video#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R051543", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.GameObjects.Video#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R051544", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.GameObjects.Video#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R051545", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.GameObjects.Video#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R051546", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.GameObjects.Video#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R051547", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.GameObjects.Video#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R051548", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.GameObjects.Video#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Video", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R051549", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.GameObjects.Video#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Video", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R051550", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.GameObjects.Video#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R051551", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.GameObjects.Video#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R051552", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.GameObjects.Video#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R051553", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.GameObjects.Video#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R051554", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Video#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R051555", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Video#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R051556", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Video#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R051557", "___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": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.GameObjects.Video#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#width", "inherited": true, "___id": "T000002R051559", "___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": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.GameObjects.Video#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#height", "inherited": true, "___id": "T000002R051560", "___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": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.GameObjects.Video#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayWidth", "inherited": true, "___id": "T000002R051561", "___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": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.GameObjects.Video#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayHeight", "inherited": true, "___id": "T000002R051562", "___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": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSizeToFrame", "longname": "Phaser.GameObjects.Video#setSizeToFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setSizeToFrame", "inherited": true, "___id": "T000002R051563", "___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": 139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.GameObjects.Video#setSize", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setSize", "inherited": true, "___id": "T000002R051564", "___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.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": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.GameObjects.Video#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Size#setDisplaySize", "inherited": true, "___id": "T000002R051565", "___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": {} }, "name": "texture", "longname": "Phaser.GameObjects.Video#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#texture", "inherited": true, "___id": "T000002R051566", "___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": {} }, "name": "frame", "longname": "Phaser.GameObjects.Video#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#frame", "inherited": true, "___id": "T000002R051567", "___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": {} }, "name": "isCropped", "longname": "Phaser.GameObjects.Video#isCropped", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#isCropped", "inherited": true, "___id": "T000002R051568", "___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 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 rect 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. 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.\r\n * @param {number} [width] - The width of the crop rectangle in pixels.\r\n * @param {number} [height] - The height of the crop rectangle in pixels.\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": {} }, "name": "setCrop", "longname": "Phaser.GameObjects.Video#setCrop", "kind": "function", "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 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 rect 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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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. 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.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the crop rectangle in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the crop rectangle in pixels.", "name": "height" } ], "inherits": "Phaser.GameObjects.Components.TextureCrop#setCrop", "inherited": true, "___id": "T000002R051569", "___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": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.GameObjects.Video#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.TextureCrop#setTexture", "inherited": true, "___id": "T000002R051570", "___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": 128, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.GameObjects.Video#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.TextureCrop#setFrame", "inherited": true, "___id": "T000002R051571", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertice 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": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopLeft", "longname": "Phaser.GameObjects.Video#tintTopLeft", "kind": "member", "description": "The tint value being applied to the top-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopLeft", "inherited": true, "___id": "T000002R051573", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-right vertice 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopRight", "longname": "Phaser.GameObjects.Video#tintTopRight", "kind": "member", "description": "The tint value being applied to the top-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopRight", "inherited": true, "___id": "T000002R051574", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-left vertice 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": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomLeft", "longname": "Phaser.GameObjects.Video#tintBottomLeft", "kind": "member", "description": "The tint value being applied to the bottom-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "inherited": true, "___id": "T000002R051575", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-right vertice 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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomRight", "longname": "Phaser.GameObjects.Video#tintBottomRight", "kind": "member", "description": "The tint value being applied to the bottom-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomRight", "inherited": true, "___id": "T000002R051576", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintFill", "longname": "Phaser.GameObjects.Video#tintFill", "kind": "member", "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.11.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintFill", "inherited": true, "___id": "T000002R051577", "___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 'additive',\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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearTint", "longname": "Phaser.GameObjects.Video#clearTint", "kind": "function", "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff and the tint type to 'additive',\rwhich results in no visible change to the texture.", "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.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#clearTint", "inherited": true, "___id": "T000002R051578", "___s": true }, { "comment": "/**\r\n * Sets an additive tint 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 * multiplying it by 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 * To swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.\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": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTint", "longname": "Phaser.GameObjects.Video#setTint", "kind": "function", "description": "Sets an additive tint on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by 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\rTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.", "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.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Tint#setTint", "inherited": true, "___id": "T000002R051579", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on this Game Object.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. You can provide either one color value, in which case the whole\r\n * Game Object will be rendered in that color. Or you can provide a color per corner. The colors\r\n * 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 * To swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintFill\r\n * @webglOnly\r\n * @since 3.11.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.\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": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTintFill", "longname": "Phaser.GameObjects.Video#setTintFill", "kind": "function", "description": "Sets a fill-based tint on this Game Object.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. You can provide either one color value, in which case the whole\rGame Object will be rendered in that color. Or you can provide a color per corner. The colors\rare 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\rTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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 not 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" } ], "inherits": "Phaser.GameObjects.Components.Tint#setTintFill", "inherited": true, "___id": "T000002R051580", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.\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": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tint", "longname": "Phaser.GameObjects.Video#tint", "kind": "member", "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tint", "inherited": true, "___id": "T000002R051581", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * It checks to see if the 4 tint properties are set to the value 0xffffff\r\n * and that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.\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": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isTinted", "longname": "Phaser.GameObjects.Video#isTinted", "kind": "member", "description": "Does this Game Object have a tint applied?\r\rIt checks to see if the 4 tint properties are set to the value 0xffffff\rand that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "readonly": true, "since": "3.11.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#isTinted", "inherited": true, "___id": "T000002R051582", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Video#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R051583", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Video#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R051587", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Video#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R051588", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Video#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R051589", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Video#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R051590", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Video#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R051591", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Video#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R051592", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Video#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R051593", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Video#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R051594", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Video#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R051595", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Video#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R051596", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Video#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R051597", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Video#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R051598", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Video#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R051599", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Video#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R051600", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Video#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R051601", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Video#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R051602", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Video#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R051603", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Video#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R051604", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Video#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R051605", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Video#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R051606", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Video#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R051607", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Video#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R051608", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Video#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R051609", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Video#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Video", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R051611", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Video#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R051612", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.GameObjects.Zone#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R051613", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.GameObjects.Zone#displayList", "kind": "member", "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.", "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.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R051614", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.GameObjects.Zone#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R051615", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.GameObjects.Zone#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R051616", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.GameObjects.Zone#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R051617", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.GameObjects.Zone#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R051618", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.GameObjects.Zone#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R051619", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.GameObjects.Zone#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R051620", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.GameObjects.Zone#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R051621", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.GameObjects.Zone#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R051622", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.GameObjects.Zone#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R051623", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.GameObjects.Zone#input", "kind": "member", "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()`.", "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.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R051624", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.GameObjects.Zone#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R051625", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.GameObjects.Zone#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R051626", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.GameObjects.Zone#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R051627", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.GameObjects.Zone#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R051628", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.GameObjects.Zone#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R051629", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.GameObjects.Zone#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "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.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R051630", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.GameObjects.Zone#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R051631", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.GameObjects.Zone#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R051632", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.GameObjects.Zone#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R051633", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.GameObjects.Zone#getData", "kind": "function", "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.", "since": "3.0.0", "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.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R051634", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.GameObjects.Zone#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R051635", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.GameObjects.Zone#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R051636", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.GameObjects.Zone#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R051637", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.GameObjects.Zone#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R051638", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.GameObjects.Zone#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R051639", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.GameObjects.Zone#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R051640", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.GameObjects.Zone#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R051641", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.GameObjects.Zone#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R051642", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.GameObjects.Zone#getIndexList", "kind": "function", "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.", "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.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R051643", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.GameObjects.Zone#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R051644", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.GameObjects.Zone#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R051645", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.GameObjects.Zone#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R051646", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.GameObjects.Zone#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R051647", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.GameObjects.Zone#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "___id": "T000002R051648", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.GameObjects.Zone#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R051649", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.GameObjects.Zone#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R051650", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.GameObjects.Zone#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R051651", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.GameObjects.Zone#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R051652", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.GameObjects.Zone#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R051653", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.GameObjects.Zone#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R051654", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.GameObjects.Zone#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R051655", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.GameObjects.Zone#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R051656", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.GameObjects.Zone#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R051657", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.GameObjects.Zone#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R051658", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.GameObjects.Zone#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R051659", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.GameObjects.Zone#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R051661", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.GameObjects.Zone#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R051662", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.GameObjects.Zone#getCenter", "kind": "function", "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`.", "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]" } ], "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.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "___id": "T000002R051664", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.GameObjects.Zone#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "___id": "T000002R051665", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.GameObjects.Zone#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "___id": "T000002R051666", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.GameObjects.Zone#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "___id": "T000002R051667", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.GameObjects.Zone#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "___id": "T000002R051668", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.GameObjects.Zone#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "___id": "T000002R051669", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.GameObjects.Zone#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "___id": "T000002R051670", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.GameObjects.Zone#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "___id": "T000002R051671", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.GameObjects.Zone#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "___id": "T000002R051672", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.GameObjects.Zone#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "___id": "T000002R051673", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.GameObjects.Zone#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "___id": "T000002R051675", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.GameObjects.Zone#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "___id": "T000002R051676", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.GameObjects.Zone#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "___id": "T000002R051677", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.GameObjects.Zone#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "___id": "T000002R051678", "___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": {} }, "name": "setOrigin", "longname": "Phaser.GameObjects.Zone#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "___id": "T000002R051679", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.GameObjects.Zone#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R051680", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.GameObjects.Zone#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "___id": "T000002R051681", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.GameObjects.Zone#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R051682", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.GameObjects.Zone#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R051683", "___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": {} }, "name": "x", "longname": "Phaser.GameObjects.Zone#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R051687", "___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": {} }, "name": "y", "longname": "Phaser.GameObjects.Zone#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R051688", "___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": {} }, "name": "z", "longname": "Phaser.GameObjects.Zone#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R051689", "___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": {} }, "name": "w", "longname": "Phaser.GameObjects.Zone#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R051690", "___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": {} }, "name": "scale", "longname": "Phaser.GameObjects.Zone#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R051691", "___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": {} }, "name": "scaleX", "longname": "Phaser.GameObjects.Zone#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R051692", "___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": {} }, "name": "scaleY", "longname": "Phaser.GameObjects.Zone#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R051693", "___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": {} }, "name": "angle", "longname": "Phaser.GameObjects.Zone#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R051694", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.GameObjects.Zone#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R051695", "___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": {} }, "name": "setPosition", "longname": "Phaser.GameObjects.Zone#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R051696", "___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": {} }, "name": "copyPosition", "longname": "Phaser.GameObjects.Zone#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R051697", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.GameObjects.Zone#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R051698", "___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": {} }, "name": "setRotation", "longname": "Phaser.GameObjects.Zone#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R051699", "___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": {} }, "name": "setAngle", "longname": "Phaser.GameObjects.Zone#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R051700", "___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": {} }, "name": "setScale", "longname": "Phaser.GameObjects.Zone#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R051701", "___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": {} }, "name": "setX", "longname": "Phaser.GameObjects.Zone#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R051702", "___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": {} }, "name": "setY", "longname": "Phaser.GameObjects.Zone#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R051703", "___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": {} }, "name": "setZ", "longname": "Phaser.GameObjects.Zone#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R051704", "___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": {} }, "name": "setW", "longname": "Phaser.GameObjects.Zone#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R051705", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.GameObjects.Zone#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R051706", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.GameObjects.Zone#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R051707", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.GameObjects.Zone#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R051708", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.GameObjects.Zone#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R051709", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.GameObjects.Zone#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R051710", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.GameObjects.Zone#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R051711", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.GameObjects.Zone#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R051712", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.GameObjects.Zone#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R051714", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.GameObjects.Zone#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Zone", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R051715", "___s": true }, { "comment": "/**\r\n * The x component of this Vector.\r\n *\r\n * @name Phaser.Math.Vector3#x\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Vector3.js", "lineno": 33, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "x", "longname": "Phaser.Geom.Mesh.Vertex#x", "kind": "member", "description": "The x component of this Vector.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "inherits": "Phaser.Math.Vector3#x", "inherited": true, "___id": "T000002R051716", "___s": true }, { "comment": "/**\r\n * The y component of this Vector.\r\n *\r\n * @name Phaser.Math.Vector3#y\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Vector3.js", "lineno": 43, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "y", "longname": "Phaser.Geom.Mesh.Vertex#y", "kind": "member", "description": "The y component of this Vector.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "inherits": "Phaser.Math.Vector3#y", "inherited": true, "___id": "T000002R051717", "___s": true }, { "comment": "/**\r\n * The z component of this Vector.\r\n *\r\n * @name Phaser.Math.Vector3#z\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Vector3.js", "lineno": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "z", "longname": "Phaser.Geom.Mesh.Vertex#z", "kind": "member", "description": "The z component of this Vector.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "inherits": "Phaser.Math.Vector3#z", "inherited": true, "___id": "T000002R051718", "___s": true }, { "comment": "/**\r\n * Set this Vector to point up.\r\n *\r\n * Sets the y component of the vector to 1, and the others to 0.\r\n *\r\n * @method Phaser.Math.Vector3#up\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "up", "longname": "Phaser.Geom.Mesh.Vertex#up", "kind": "function", "description": "Set this Vector to point up.\r\rSets the y component of the vector to 1, and the others to 0.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "inherits": "Phaser.Math.Vector3#up", "inherited": true, "___id": "T000002R051719", "___s": true }, { "comment": "/**\r\n * Sets the components of this Vector to be the `Math.min` result from the given vector.\r\n *\r\n * @method Phaser.Math.Vector3#min\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Vector3} v - The Vector3 to check the minimum values against.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 96, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "min", "longname": "Phaser.Geom.Mesh.Vertex#min", "kind": "function", "description": "Sets the components of this Vector to be the `Math.min` result from the given vector.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The Vector3 to check the minimum values against.", "name": "v" } ], "inherits": "Phaser.Math.Vector3#min", "inherited": true, "___id": "T000002R051720", "___s": true }, { "comment": "/**\r\n * Sets the components of this Vector to be the `Math.max` result from the given vector.\r\n *\r\n * @method Phaser.Math.Vector3#max\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Vector3} v - The Vector3 to check the maximum values against.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 115, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "max", "longname": "Phaser.Geom.Mesh.Vertex#max", "kind": "function", "description": "Sets the components of this Vector to be the `Math.max` result from the given vector.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The Vector3 to check the maximum values against.", "name": "v" } ], "inherits": "Phaser.Math.Vector3#max", "inherited": true, "___id": "T000002R051721", "___s": true }, { "comment": "/**\r\n * Make a clone of this Vector3.\r\n *\r\n * @method Phaser.Math.Vector3#clone\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector3} A new Vector3 object containing this Vectors values.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 134, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "clone", "longname": "Phaser.Geom.Mesh.Vertex#clone", "kind": "function", "description": "Make a clone of this Vector3.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "A new Vector3 object containing this Vectors values." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "inherits": "Phaser.Math.Vector3#clone", "inherited": true, "___id": "T000002R051722", "___s": true }, { "comment": "/**\r\n * Adds the two given Vector3s and sets the results into this Vector3.\r\n *\r\n * @method Phaser.Math.Vector3#addVectors\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Vector3} a - The first Vector to add.\r\n * @param {Phaser.Math.Vector3} b - The second Vector to add.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 147, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "addVectors", "longname": "Phaser.Geom.Mesh.Vertex#addVectors", "kind": "function", "description": "Adds the two given Vector3s and sets the results into this Vector3.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The first Vector to add.", "name": "a" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The second Vector to add.", "name": "b" } ], "inherits": "Phaser.Math.Vector3#addVectors", "inherited": true, "___id": "T000002R051723", "___s": true }, { "comment": "/**\r\n * Calculate the cross (vector) product of two given Vectors.\r\n *\r\n * @method Phaser.Math.Vector3#crossVectors\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} a - The first Vector to multiply.\r\n * @param {Phaser.Math.Vector3} b - The second Vector to multiply.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "crossVectors", "longname": "Phaser.Geom.Mesh.Vertex#crossVectors", "kind": "function", "description": "Calculate the cross (vector) product of two given Vectors.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The first Vector to multiply.", "name": "a" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The second Vector to multiply.", "name": "b" } ], "inherits": "Phaser.Math.Vector3#crossVectors", "inherited": true, "___id": "T000002R051724", "___s": true }, { "comment": "/**\r\n * Check whether this Vector is equal to a given Vector.\r\n *\r\n * Performs a strict equality check against each Vector's components.\r\n *\r\n * @method Phaser.Math.Vector3#equals\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} v - The Vector3 to compare against.\r\n *\r\n * @return {boolean} True if the two vectors strictly match, otherwise false.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 194, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "equals", "longname": "Phaser.Geom.Mesh.Vertex#equals", "kind": "function", "description": "Check whether this Vector is equal to a given Vector.\r\rPerforms a strict equality check against each Vector's components.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the two vectors strictly match, otherwise false." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The Vector3 to compare against.", "name": "v" } ], "inherits": "Phaser.Math.Vector3#equals", "inherited": true, "___id": "T000002R051725", "___s": true }, { "comment": "/**\r\n * Copy the components of a given Vector into this Vector.\r\n *\r\n * @method Phaser.Math.Vector3#copy\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} src - The Vector to copy the components from.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 211, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "copy", "longname": "Phaser.Geom.Mesh.Vertex#copy", "kind": "function", "description": "Copy the components of a given Vector into this Vector.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" } ] } }, "description": "The Vector to copy the components from.", "name": "src" } ], "inherits": "Phaser.Math.Vector3#copy", "inherited": true, "___id": "T000002R051726", "___s": true }, { "comment": "/**\r\n * Set the `x`, `y`, and `z` components of this Vector to the given `x`, `y`, and `z` values.\r\n *\r\n * @method Phaser.Math.Vector3#set\r\n * @since 3.0.0\r\n *\r\n * @param {(number|object)} x - The x value to set for this Vector, or an object containing x, y and z components.\r\n * @param {number} [y] - The y value to set for this Vector.\r\n * @param {number} [z] - The z value to set for this Vector.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "set", "longname": "Phaser.Geom.Mesh.Vertex#set", "kind": "function", "description": "Set the `x`, `y`, and `z` components of this Vector to the given `x`, `y`, and `z` values.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "number", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The x value to set for this Vector, or an object containing x, y and z components.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y value to set for this Vector.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The z value to set for this Vector.", "name": "z" } ], "inherits": "Phaser.Math.Vector3#set", "inherited": true, "___id": "T000002R051727", "___s": true }, { "comment": "/**\r\n * Sets the components of this Vector3 from the position of the given Matrix4.\r\n *\r\n * @method Phaser.Math.Vector3#setFromMatrixPosition\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} mat4 - The Matrix4 to get the position from.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 260, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "setFromMatrixPosition", "longname": "Phaser.Geom.Mesh.Vertex#setFromMatrixPosition", "kind": "function", "description": "Sets the components of this Vector3 from the position of the given Matrix4.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to get the position from.", "name": "mat4" } ], "inherits": "Phaser.Math.Vector3#setFromMatrixPosition", "inherited": true, "___id": "T000002R051728", "___s": true }, { "comment": "/**\r\n * Sets the components of this Vector3 from the Matrix4 column specified.\r\n *\r\n * @method Phaser.Math.Vector3#setFromMatrixColumn\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} mat4 - The Matrix4 to get the column from.\r\n * @param {number} index - The column index.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 275, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "setFromMatrixColumn", "longname": "Phaser.Geom.Mesh.Vertex#setFromMatrixColumn", "kind": "function", "description": "Sets the components of this Vector3 from the Matrix4 column specified.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to get the column from.", "name": "mat4" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The column index.", "name": "index" } ], "inherits": "Phaser.Math.Vector3#setFromMatrixColumn", "inherited": true, "___id": "T000002R051729", "___s": true }, { "comment": "/**\r\n * Sets the components of this Vector3 from the given array, based on the offset.\r\n *\r\n * Vector3.x = array[offset]\r\n * Vector3.y = array[offset + 1]\r\n * Vector3.z = array[offset + 2]\r\n *\r\n * @method Phaser.Math.Vector3#fromArray\r\n * @since 3.50.0\r\n *\r\n * @param {number[]} array - The array of values to get this Vector from.\r\n * @param {number} [offset=0] - The offset index into the array.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 291, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "fromArray", "longname": "Phaser.Geom.Mesh.Vertex#fromArray", "kind": "function", "description": "Sets the components of this Vector3 from the given array, based on the offset.\r\rVector3.x = array[offset]\rVector3.y = array[offset + 1]\rVector3.z = array[offset + 2]", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The array of values to get this Vector from.", "name": "array" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The offset index into the array.", "name": "offset" } ], "inherits": "Phaser.Math.Vector3#fromArray", "inherited": true, "___id": "T000002R051730", "___s": true }, { "comment": "/**\r\n * Add a given Vector to this Vector. Addition is component-wise.\r\n *\r\n * @method Phaser.Math.Vector3#add\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - The Vector to add to this Vector.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 317, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "add", "longname": "Phaser.Geom.Mesh.Vertex#add", "kind": "function", "description": "Add a given Vector to this Vector. Addition is component-wise.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" } ] } }, "description": "The Vector to add to this Vector.", "name": "v" } ], "inherits": "Phaser.Math.Vector3#add", "inherited": true, "___id": "T000002R051731", "___s": true }, { "comment": "/**\r\n * Add the given value to each component of this Vector.\r\n *\r\n * @method Phaser.Math.Vector3#addScalar\r\n * @since 3.50.0\r\n *\r\n * @param {number} s - The amount to add to this Vector.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 336, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "addScalar", "longname": "Phaser.Geom.Mesh.Vertex#addScalar", "kind": "function", "description": "Add the given value to each component of this Vector.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to add to this Vector.", "name": "s" } ], "inherits": "Phaser.Math.Vector3#addScalar", "inherited": true, "___id": "T000002R051732", "___s": true }, { "comment": "/**\r\n * Add and scale a given Vector to this Vector. Addition is component-wise.\r\n *\r\n * @method Phaser.Math.Vector3#addScale\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - The Vector to add to this Vector.\r\n * @param {number} scale - The amount to scale `v` by.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 355, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "addScale", "longname": "Phaser.Geom.Mesh.Vertex#addScale", "kind": "function", "description": "Add and scale a given Vector to this Vector. Addition is component-wise.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" } ] } }, "description": "The Vector to add to this Vector.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to scale `v` by.", "name": "scale" } ], "inherits": "Phaser.Math.Vector3#addScale", "inherited": true, "___id": "T000002R051733", "___s": true }, { "comment": "/**\r\n * Subtract the given Vector from this Vector. Subtraction is component-wise.\r\n *\r\n * @method Phaser.Math.Vector3#subtract\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - The Vector to subtract from this Vector.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 375, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "subtract", "longname": "Phaser.Geom.Mesh.Vertex#subtract", "kind": "function", "description": "Subtract the given Vector from this Vector. Subtraction is component-wise.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" } ] } }, "description": "The Vector to subtract from this Vector.", "name": "v" } ], "inherits": "Phaser.Math.Vector3#subtract", "inherited": true, "___id": "T000002R051734", "___s": true }, { "comment": "/**\r\n * Perform a component-wise multiplication between this Vector and the given Vector.\r\n *\r\n * Multiplies this Vector by the given Vector.\r\n *\r\n * @method Phaser.Math.Vector3#multiply\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - The Vector to multiply this Vector by.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "multiply", "longname": "Phaser.Geom.Mesh.Vertex#multiply", "kind": "function", "description": "Perform a component-wise multiplication between this Vector and the given Vector.\r\rMultiplies this Vector by the given Vector.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" } ] } }, "description": "The Vector to multiply this Vector by.", "name": "v" } ], "inherits": "Phaser.Math.Vector3#multiply", "inherited": true, "___id": "T000002R051735", "___s": true }, { "comment": "/**\r\n * Scale this Vector by the given value.\r\n *\r\n * @method Phaser.Math.Vector3#scale\r\n * @since 3.0.0\r\n *\r\n * @param {number} scale - The value to scale this Vector by.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 415, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "scale", "longname": "Phaser.Geom.Mesh.Vertex#scale", "kind": "function", "description": "Scale this Vector by the given value.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to scale this Vector by.", "name": "scale" } ], "inherits": "Phaser.Math.Vector3#scale", "inherited": true, "___id": "T000002R051736", "___s": true }, { "comment": "/**\r\n * Perform a component-wise division between this Vector and the given Vector.\r\n *\r\n * Divides this Vector by the given Vector.\r\n *\r\n * @method Phaser.Math.Vector3#divide\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - The Vector to divide this Vector by.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 443, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "divide", "longname": "Phaser.Geom.Mesh.Vertex#divide", "kind": "function", "description": "Perform a component-wise division between this Vector and the given Vector.\r\rDivides this Vector by the given Vector.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" } ] } }, "description": "The Vector to divide this Vector by.", "name": "v" } ], "inherits": "Phaser.Math.Vector3#divide", "inherited": true, "___id": "T000002R051737", "___s": true }, { "comment": "/**\r\n * Negate the `x`, `y` and `z` components of this Vector.\r\n *\r\n * @method Phaser.Math.Vector3#negate\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "negate", "longname": "Phaser.Geom.Mesh.Vertex#negate", "kind": "function", "description": "Negate the `x`, `y` and `z` components of this Vector.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "inherits": "Phaser.Math.Vector3#negate", "inherited": true, "___id": "T000002R051738", "___s": true }, { "comment": "/**\r\n * Calculate the distance between this Vector and the given Vector.\r\n *\r\n * @method Phaser.Math.Vector3#distance\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - The Vector to calculate the distance to.\r\n *\r\n * @return {number} The distance from this Vector to the given Vector.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 481, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "distance", "longname": "Phaser.Geom.Mesh.Vertex#distance", "kind": "function", "description": "Calculate the distance between this Vector and the given Vector.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance from this Vector to the given Vector." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" } ] } }, "description": "The Vector to calculate the distance to.", "name": "v" } ], "inherits": "Phaser.Math.Vector3#distance", "inherited": true, "___id": "T000002R051739", "___s": true }, { "comment": "/**\r\n * Calculate the distance between this Vector and the given Vector, squared.\r\n *\r\n * @method Phaser.Math.Vector3#distanceSq\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector3)} v - The Vector to calculate the distance to.\r\n *\r\n * @return {number} The distance from this Vector to the given Vector, squared.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 500, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "distanceSq", "longname": "Phaser.Geom.Mesh.Vertex#distanceSq", "kind": "function", "description": "Calculate the distance between this Vector and the given Vector, squared.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance from this Vector to the given Vector, squared." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Phaser.Math.Vector3" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Math.Vector3" } ] } }, "description": "The Vector to calculate the distance to.", "name": "v" } ], "inherits": "Phaser.Math.Vector3#distanceSq", "inherited": true, "___id": "T000002R051740", "___s": true }, { "comment": "/**\r\n * Calculate the length (or magnitude) of this Vector.\r\n *\r\n * @method Phaser.Math.Vector3#length\r\n * @since 3.0.0\r\n *\r\n * @return {number} The length of this Vector.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 519, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "length", "longname": "Phaser.Geom.Mesh.Vertex#length", "kind": "function", "description": "Calculate the length (or magnitude) of this Vector.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length of this Vector." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "inherits": "Phaser.Math.Vector3#length", "inherited": true, "___id": "T000002R051741", "___s": true }, { "comment": "/**\r\n * Calculate the length of this Vector squared.\r\n *\r\n * @method Phaser.Math.Vector3#lengthSq\r\n * @since 3.0.0\r\n *\r\n * @return {number} The length of this Vector, squared.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 536, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "lengthSq", "longname": "Phaser.Geom.Mesh.Vertex#lengthSq", "kind": "function", "description": "Calculate the length of this Vector squared.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length of this Vector, squared." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "inherits": "Phaser.Math.Vector3#lengthSq", "inherited": true, "___id": "T000002R051742", "___s": true }, { "comment": "/**\r\n * Normalize this Vector.\r\n *\r\n * Makes the vector a unit length vector (magnitude of 1) in the same direction.\r\n *\r\n * @method Phaser.Math.Vector3#normalize\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 553, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "normalize", "longname": "Phaser.Geom.Mesh.Vertex#normalize", "kind": "function", "description": "Normalize this Vector.\r\rMakes the vector a unit length vector (magnitude of 1) in the same direction.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "inherits": "Phaser.Math.Vector3#normalize", "inherited": true, "___id": "T000002R051743", "___s": true }, { "comment": "/**\r\n * Calculate the dot product of this Vector and the given Vector.\r\n *\r\n * @method Phaser.Math.Vector3#dot\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} v - The Vector3 to dot product with this Vector3.\r\n *\r\n * @return {number} The dot product of this Vector and `v`.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 582, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "dot", "longname": "Phaser.Geom.Mesh.Vertex#dot", "kind": "function", "description": "Calculate the dot product of this Vector and the given Vector.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The dot product of this Vector and `v`." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The Vector3 to dot product with this Vector3.", "name": "v" } ], "inherits": "Phaser.Math.Vector3#dot", "inherited": true, "___id": "T000002R051744", "___s": true }, { "comment": "/**\r\n * Calculate the cross (vector) product of this Vector (which will be modified) and the given Vector.\r\n *\r\n * @method Phaser.Math.Vector3#cross\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} v - The Vector to cross product with.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 597, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "cross", "longname": "Phaser.Geom.Mesh.Vertex#cross", "kind": "function", "description": "Calculate the cross (vector) product of this Vector (which will be modified) and the given Vector.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The Vector to cross product with.", "name": "v" } ], "inherits": "Phaser.Math.Vector3#cross", "inherited": true, "___id": "T000002R051745", "___s": true }, { "comment": "/**\r\n * Linearly interpolate between this Vector and the given Vector.\r\n *\r\n * Interpolates this Vector towards the given Vector.\r\n *\r\n * @method Phaser.Math.Vector3#lerp\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector3} v - The Vector3 to interpolate towards.\r\n * @param {number} [t=0] - The interpolation percentage, between 0 and 1.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 623, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "lerp", "longname": "Phaser.Geom.Mesh.Vertex#lerp", "kind": "function", "description": "Linearly interpolate between this Vector and the given Vector.\r\rInterpolates this Vector towards the given Vector.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "The Vector3 to interpolate towards.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The interpolation percentage, between 0 and 1.", "name": "t" } ], "inherits": "Phaser.Math.Vector3#lerp", "inherited": true, "___id": "T000002R051746", "___s": true }, { "comment": "/**\r\n * Takes a Matrix3 and applies it to this Vector3.\r\n *\r\n * @method Phaser.Math.Vector3#applyMatrix3\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix3} mat3 - The Matrix3 to apply to this Vector3.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 651, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "applyMatrix3", "longname": "Phaser.Geom.Mesh.Vertex#applyMatrix3", "kind": "function", "description": "Takes a Matrix3 and applies it to this Vector3.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "The Matrix3 to apply to this Vector3.", "name": "mat3" } ], "inherits": "Phaser.Math.Vector3#applyMatrix3", "inherited": true, "___id": "T000002R051747", "___s": true }, { "comment": "/**\r\n * Takes a Matrix4 and applies it to this Vector3.\r\n *\r\n * @method Phaser.Math.Vector3#applyMatrix4\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} mat4 - The Matrix4 to apply to this Vector3.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 675, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "applyMatrix4", "longname": "Phaser.Geom.Mesh.Vertex#applyMatrix4", "kind": "function", "description": "Takes a Matrix4 and applies it to this Vector3.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to apply to this Vector3.", "name": "mat4" } ], "inherits": "Phaser.Math.Vector3#applyMatrix4", "inherited": true, "___id": "T000002R051748", "___s": true }, { "comment": "/**\r\n * Transform this Vector with the given Matrix.\r\n *\r\n * @method Phaser.Math.Vector3#transformMat3\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix3} mat - The Matrix3 to transform this Vector3 with.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 701, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "transformMat3", "longname": "Phaser.Geom.Mesh.Vertex#transformMat3", "kind": "function", "description": "Transform this Vector with the given Matrix.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Matrix3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix3" } }, "description": "The Matrix3 to transform this Vector3 with.", "name": "mat" } ], "inherits": "Phaser.Math.Vector3#transformMat3", "inherited": true, "___id": "T000002R051749", "___s": true }, { "comment": "/**\r\n * Transform this Vector with the given Matrix4.\r\n *\r\n * @method Phaser.Math.Vector3#transformMat4\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix4} mat - The Matrix4 to transform this Vector3 with.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 725, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "transformMat4", "longname": "Phaser.Geom.Mesh.Vertex#transformMat4", "kind": "function", "description": "Transform this Vector with the given Matrix4.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to transform this Vector3 with.", "name": "mat" } ], "inherits": "Phaser.Math.Vector3#transformMat4", "inherited": true, "___id": "T000002R051750", "___s": true }, { "comment": "/**\r\n * Transforms the coordinates of this Vector3 with the given Matrix4.\r\n *\r\n * @method Phaser.Math.Vector3#transformCoordinates\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix4} mat - The Matrix4 to transform this Vector3 with.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 749, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "transformCoordinates", "longname": "Phaser.Geom.Mesh.Vertex#transformCoordinates", "kind": "function", "description": "Transforms the coordinates of this Vector3 with the given Matrix4.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to transform this Vector3 with.", "name": "mat" } ], "inherits": "Phaser.Math.Vector3#transformCoordinates", "inherited": true, "___id": "T000002R051751", "___s": true }, { "comment": "/**\r\n * Transform this Vector with the given Quaternion.\r\n *\r\n * @method Phaser.Math.Vector3#transformQuat\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Quaternion} q - The Quaternion to transform this Vector with.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 778, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "transformQuat", "longname": "Phaser.Geom.Mesh.Vertex#transformQuat", "kind": "function", "description": "Transform this Vector with the given Quaternion.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Quaternion" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Quaternion" } }, "description": "The Quaternion to transform this Vector with.", "name": "q" } ], "inherits": "Phaser.Math.Vector3#transformQuat", "inherited": true, "___id": "T000002R051752", "___s": true }, { "comment": "/**\r\n * Multiplies this Vector3 by the specified matrix, applying a W divide. This is useful for projection,\r\n * e.g. unprojecting a 2D point into 3D space.\r\n *\r\n * @method Phaser.Math.Vector3#project\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Matrix4} mat - The Matrix4 to multiply this Vector3 with.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 813, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "project", "longname": "Phaser.Geom.Mesh.Vertex#project", "kind": "function", "description": "Multiplies this Vector3 by the specified matrix, applying a W divide. This is useful for projection,\re.g. unprojecting a 2D point into 3D space.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "The Matrix4 to multiply this Vector3 with.", "name": "mat" } ], "inherits": "Phaser.Math.Vector3#project", "inherited": true, "___id": "T000002R051753", "___s": true }, { "comment": "/**\r\n * Multiplies this Vector3 by the given view and projection matrices.\r\n *\r\n * @method Phaser.Math.Vector3#projectViewMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} viewMatrix - A View Matrix.\r\n * @param {Phaser.Math.Matrix4} projectionMatrix - A Projection Matrix.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 857, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "projectViewMatrix", "longname": "Phaser.Geom.Mesh.Vertex#projectViewMatrix", "kind": "function", "description": "Multiplies this Vector3 by the given view and projection matrices.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "A View Matrix.", "name": "viewMatrix" }, { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "A Projection Matrix.", "name": "projectionMatrix" } ], "inherits": "Phaser.Math.Vector3#projectViewMatrix", "inherited": true, "___id": "T000002R051754", "___s": true }, { "comment": "/**\r\n * Multiplies this Vector3 by the given inversed projection matrix and world matrix.\r\n *\r\n * @method Phaser.Math.Vector3#unprojectViewMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Math.Matrix4} projectionMatrix - An inversed Projection Matrix.\r\n * @param {Phaser.Math.Matrix4} worldMatrix - A World View Matrix.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 873, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "unprojectViewMatrix", "longname": "Phaser.Geom.Mesh.Vertex#unprojectViewMatrix", "kind": "function", "description": "Multiplies this Vector3 by the given inversed projection matrix and world matrix.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "An inversed Projection Matrix.", "name": "projectionMatrix" }, { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "A World View Matrix.", "name": "worldMatrix" } ], "inherits": "Phaser.Math.Vector3#unprojectViewMatrix", "inherited": true, "___id": "T000002R051755", "___s": true }, { "comment": "/**\r\n * Unproject this point from 2D space to 3D space.\r\n * The point should have its x and y properties set to\r\n * 2D screen space, and the z either at 0 (near plane)\r\n * or 1 (far plane). The provided matrix is assumed to already\r\n * be combined, i.e. projection * view * model.\r\n *\r\n * After this operation, this vector's (x, y, z) components will\r\n * represent the unprojected 3D coordinate.\r\n *\r\n * @method Phaser.Math.Vector3#unproject\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector4} viewport - Screen x, y, width and height in pixels.\r\n * @param {Phaser.Math.Matrix4} invProjectionView - Combined projection and view matrix.\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 889, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "unproject", "longname": "Phaser.Geom.Mesh.Vertex#unproject", "kind": "function", "description": "Unproject this point from 2D space to 3D space.\rThe point should have its x and y properties set to\r2D screen space, and the z either at 0 (near plane)\ror 1 (far plane). The provided matrix is assumed to already\rbe combined, i.e. projection * view * model.\r\rAfter this operation, this vector's (x, y, z) components will\rrepresent the unprojected 3D coordinate.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "Screen x, y, width and height in pixels.", "name": "viewport" }, { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "description": "Combined projection and view matrix.", "name": "invProjectionView" } ], "inherits": "Phaser.Math.Vector3#unproject", "inherited": true, "___id": "T000002R051756", "___s": true }, { "comment": "/**\r\n * Make this Vector the zero vector (0, 0, 0).\r\n *\r\n * @method Phaser.Math.Vector3#reset\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Math.Vector3} This Vector3.\r\n */", "meta": { "filename": "Vector3.js", "lineno": 925, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\math", "code": {} }, "name": "reset", "longname": "Phaser.Geom.Mesh.Vertex#reset", "kind": "function", "description": "Make this Vector the zero vector (0, 0, 0).", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "This Vector3." } ], "memberof": "Phaser.Geom.Mesh.Vertex", "scope": "instance", "inherits": "Phaser.Math.Vector3#reset", "inherited": true, "___id": "T000002R051757", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Input.Gamepad.Gamepad#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R051758", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Input.Gamepad.Gamepad#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Input.Gamepad.Gamepad", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R051759", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Input.Gamepad.Gamepad#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Input.Gamepad.Gamepad", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R051760", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Input.Gamepad.Gamepad#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Input.Gamepad.Gamepad", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R051761", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Input.Gamepad.Gamepad#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Input.Gamepad.Gamepad", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R051762", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Input.Gamepad.Gamepad#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Gamepad.Gamepad", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R051763", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Input.Gamepad.Gamepad#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Gamepad.Gamepad", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R051764", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Input.Gamepad.Gamepad#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Gamepad.Gamepad", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R051765", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Input.Gamepad.Gamepad#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Gamepad.Gamepad", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R051766", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Input.Gamepad.Gamepad#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Gamepad.Gamepad", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R051767", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Input.Gamepad.Gamepad#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Gamepad.Gamepad", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R051768", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Input.Gamepad.GamepadPlugin#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Input.Gamepad.GamepadPlugin", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R051769", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Input.Gamepad.GamepadPlugin#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R051770", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Input.Gamepad.GamepadPlugin#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R051771", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Input.Gamepad.GamepadPlugin#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R051772", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Input.Gamepad.GamepadPlugin#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R051773", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Input.Gamepad.GamepadPlugin#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R051774", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Input.Gamepad.GamepadPlugin#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R051775", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Input.Gamepad.GamepadPlugin#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R051776", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Input.Gamepad.GamepadPlugin#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R051777", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Input.Gamepad.GamepadPlugin#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R051778", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Input.InputPlugin#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Input.InputPlugin", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R051779", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Input.InputPlugin#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Input.InputPlugin", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R051780", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Input.InputPlugin#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Input.InputPlugin", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R051781", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Input.InputPlugin#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Input.InputPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R051782", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Input.InputPlugin#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.InputPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R051783", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Input.InputPlugin#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.InputPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R051784", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Input.InputPlugin#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.InputPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R051785", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Input.InputPlugin#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.InputPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R051786", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Input.InputPlugin#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.InputPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R051787", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Input.InputPlugin#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.InputPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R051788", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Input.Keyboard.KeyboardPlugin", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R051789", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R051790", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R051791", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R051792", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R051793", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R051794", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R051795", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R051796", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R051797", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R051798", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Input.Keyboard.Key#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.Key", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R051799", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Input.Keyboard.Key#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Input.Keyboard.Key", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R051800", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Input.Keyboard.Key#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Input.Keyboard.Key", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R051801", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Input.Keyboard.Key#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Input.Keyboard.Key", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R051802", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Input.Keyboard.Key#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Input.Keyboard.Key", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R051803", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Input.Keyboard.Key#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Keyboard.Key", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R051804", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Input.Keyboard.Key#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Keyboard.Key", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R051805", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Input.Keyboard.Key#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Keyboard.Key", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R051806", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Input.Keyboard.Key#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Keyboard.Key", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R051807", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Input.Keyboard.Key#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Keyboard.Key", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R051808", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Input.Keyboard.Key#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Input.Keyboard.Key", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R051809", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R051810", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R051811", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R051812", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R051813", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R051814", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R051815", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R051816", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R051817", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R051818", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R051819", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R051820", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R051821", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R051822", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R051823", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R051824", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R051825", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R051826", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R051827", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R051828", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R051829", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R051830", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R051831", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R051832", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R051833", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R051834", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R051835", "___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": 448, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToCache", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#addToCache", "kind": "function", "description": "Adds this file to its target cache upon successful loading and processing.\rThis method is often overridden by specific file types.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#addToCache", "inherited": true, "___id": "T000002R051836", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R051837", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.AnimationJSONFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AnimationJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R051838", "___s": true }, { "comment": "/**\r\n * A reference to the Loader that is going to load this file.\r\n *\r\n * @name Phaser.Loader.MultiFile#loader\r\n * @type {Phaser.Loader.LoaderPlugin}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.AsepriteFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#loader", "inherited": true, "___id": "T000002R051839", "___s": true }, { "comment": "/**\r\n * The file type string for sorting within the Loader.\r\n *\r\n * @name Phaser.Loader.MultiFile#type\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.AsepriteFile#type", "kind": "member", "description": "The file type string for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#type", "inherited": true, "___id": "T000002R051840", "___s": true }, { "comment": "/**\r\n * Unique cache key (unique within its file type)\r\n *\r\n * @name Phaser.Loader.MultiFile#key\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.AsepriteFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#key", "inherited": true, "___id": "T000002R051841", "___s": true }, { "comment": "/**\r\n * Array of files that make up this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#files\r\n * @type {Phaser.Loader.File[]}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "files", "longname": "Phaser.Loader.FileTypes.AsepriteFile#files", "kind": "member", "description": "Array of files that make up this MultiFile.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Loader.File", "type": "NameExpression" } ] } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#files", "inherited": true, "___id": "T000002R051843", "___s": true }, { "comment": "/**\r\n * The current state of the file. One of the FILE_CONST values.\r\n *\r\n * @name Phaser.Loader.MultiFile#state\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.AsepriteFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#state", "inherited": true, "___id": "T000002R051844", "___s": true }, { "comment": "/**\r\n * The completion status of this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#complete\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "complete", "longname": "Phaser.Loader.FileTypes.AsepriteFile#complete", "kind": "member", "description": "The completion status of this MultiFile.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#complete", "inherited": true, "___id": "T000002R051845", "___s": true }, { "comment": "/**\r\n * The number of files to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#pending\r\n * @type {number}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pending", "longname": "Phaser.Loader.FileTypes.AsepriteFile#pending", "kind": "member", "description": "The number of files to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pending", "inherited": true, "___id": "T000002R051846", "___s": true }, { "comment": "/**\r\n * The number of files that failed to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#failed\r\n * @type {number}\r\n * @default 0\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "failed", "longname": "Phaser.Loader.FileTypes.AsepriteFile#failed", "kind": "member", "description": "The number of files that failed to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#failed", "inherited": true, "___id": "T000002R051847", "___s": true }, { "comment": "/**\r\n * A storage container for transient data that the loading files need.\r\n *\r\n * @name Phaser.Loader.MultiFile#config\r\n * @type {any}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.AsepriteFile#config", "kind": "member", "description": "A storage container for transient data that the loading files need.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#config", "inherited": true, "___id": "T000002R051848", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders baseURL at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#baseURL\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "baseURL", "longname": "Phaser.Loader.FileTypes.AsepriteFile#baseURL", "kind": "member", "description": "A reference to the Loaders baseURL at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#baseURL", "inherited": true, "___id": "T000002R051849", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders path at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#path\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "path", "longname": "Phaser.Loader.FileTypes.AsepriteFile#path", "kind": "member", "description": "A reference to the Loaders path at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#path", "inherited": true, "___id": "T000002R051850", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders prefix at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#prefix\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "prefix", "longname": "Phaser.Loader.FileTypes.AsepriteFile#prefix", "kind": "member", "description": "A reference to the Loaders prefix at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#prefix", "inherited": true, "___id": "T000002R051851", "___s": true }, { "comment": "/**\r\n * Checks if this MultiFile is ready to process its children or not.\r\n *\r\n * @method Phaser.Loader.MultiFile#isReadyToProcess\r\n * @since 3.7.0\r\n *\r\n * @return {boolean} `true` if all children of this MultiFile have loaded, otherwise `false`.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "isReadyToProcess", "longname": "Phaser.Loader.FileTypes.AsepriteFile#isReadyToProcess", "kind": "function", "description": "Checks if this MultiFile is ready to process its children or not.", "since": "3.7.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if all children of this MultiFile have loaded, otherwise `false`." } ], "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#isReadyToProcess", "inherited": true, "___id": "T000002R051852", "___s": true }, { "comment": "/**\r\n * Adds another child to this MultiFile, increases the pending count and resets the completion status.\r\n *\r\n * @method Phaser.Loader.MultiFile#addToMultiFile\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} files - The File to add to this MultiFile.\r\n *\r\n * @return {Phaser.Loader.MultiFile} This MultiFile instance.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToMultiFile", "longname": "Phaser.Loader.FileTypes.AsepriteFile#addToMultiFile", "kind": "function", "description": "Adds another child to this MultiFile, increases the pending count and resets the completion status.", "since": "3.7.0", "returns": [ { "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile" } }, "description": "This MultiFile instance." } ], "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File to add to this MultiFile.", "name": "files" } ], "inherits": "Phaser.Loader.MultiFile#addToMultiFile", "inherited": true, "___id": "T000002R051853", "___s": true }, { "comment": "/**\r\n * Called by each File when it finishes loading.\r\n *\r\n * @method Phaser.Loader.MultiFile#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": "MultiFile.js", "lineno": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileComplete", "longname": "Phaser.Loader.FileTypes.AsepriteFile#onFileComplete", "kind": "function", "description": "Called by each File when it finishes loading.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has completed processing.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileComplete", "inherited": true, "___id": "T000002R051854", "___s": true }, { "comment": "/**\r\n * Called by each File that fails to load.\r\n *\r\n * @method Phaser.Loader.MultiFile#onFileFailed\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File that has failed to load.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileFailed", "longname": "Phaser.Loader.FileTypes.AsepriteFile#onFileFailed", "kind": "function", "description": "Called by each File that fails to load.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has failed to load.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileFailed", "inherited": true, "___id": "T000002R051855", "___s": true }, { "comment": "/**\r\n * Called once all children of this multi file have been added to their caches and is now\r\n * ready for deletion from the Loader.\r\n *\r\n * It will emit a `filecomplete` event from the LoaderPlugin.\r\n *\r\n * @method Phaser.Loader.MultiFile#pendingDestroy\r\n * @fires Phaser.Loader.Events#FILE_COMPLETE\r\n * @fires Phaser.Loader.Events#FILE_KEY_COMPLETE\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.AsepriteFile#pendingDestroy", "kind": "function", "description": "Called once all children of this multi file have been added to their caches and is now\rready for deletion from the Loader.\r\rIt will emit a `filecomplete` event from the LoaderPlugin.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pendingDestroy", "inherited": true, "___id": "T000002R051856", "___s": true }, { "comment": "/**\r\n * Destroy this Multi File and any references it holds.\r\n *\r\n * @method Phaser.Loader.MultiFile#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.AsepriteFile#destroy", "kind": "function", "description": "Destroy this Multi File and any references it holds.", "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.AsepriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#destroy", "inherited": true, "___id": "T000002R051857", "___s": true }, { "comment": "/**\r\n * A reference to the Loader that is going to load this file.\r\n *\r\n * @name Phaser.Loader.MultiFile#loader\r\n * @type {Phaser.Loader.LoaderPlugin}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#loader", "inherited": true, "___id": "T000002R051858", "___s": true }, { "comment": "/**\r\n * The file type string for sorting within the Loader.\r\n *\r\n * @name Phaser.Loader.MultiFile#type\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#type", "kind": "member", "description": "The file type string for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#type", "inherited": true, "___id": "T000002R051859", "___s": true }, { "comment": "/**\r\n * Unique cache key (unique within its file type)\r\n *\r\n * @name Phaser.Loader.MultiFile#key\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#key", "inherited": true, "___id": "T000002R051860", "___s": true }, { "comment": "/**\r\n * Array of files that make up this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#files\r\n * @type {Phaser.Loader.File[]}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "files", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#files", "kind": "member", "description": "Array of files that make up this MultiFile.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Loader.File", "type": "NameExpression" } ] } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#files", "inherited": true, "___id": "T000002R051862", "___s": true }, { "comment": "/**\r\n * The current state of the file. One of the FILE_CONST values.\r\n *\r\n * @name Phaser.Loader.MultiFile#state\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#state", "inherited": true, "___id": "T000002R051863", "___s": true }, { "comment": "/**\r\n * The completion status of this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#complete\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "complete", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#complete", "kind": "member", "description": "The completion status of this MultiFile.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#complete", "inherited": true, "___id": "T000002R051864", "___s": true }, { "comment": "/**\r\n * The number of files to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#pending\r\n * @type {number}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pending", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#pending", "kind": "member", "description": "The number of files to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pending", "inherited": true, "___id": "T000002R051865", "___s": true }, { "comment": "/**\r\n * The number of files that failed to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#failed\r\n * @type {number}\r\n * @default 0\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "failed", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#failed", "kind": "member", "description": "The number of files that failed to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#failed", "inherited": true, "___id": "T000002R051866", "___s": true }, { "comment": "/**\r\n * A storage container for transient data that the loading files need.\r\n *\r\n * @name Phaser.Loader.MultiFile#config\r\n * @type {any}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#config", "kind": "member", "description": "A storage container for transient data that the loading files need.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#config", "inherited": true, "___id": "T000002R051867", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders baseURL at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#baseURL\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "baseURL", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#baseURL", "kind": "member", "description": "A reference to the Loaders baseURL at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#baseURL", "inherited": true, "___id": "T000002R051868", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders path at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#path\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "path", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#path", "kind": "member", "description": "A reference to the Loaders path at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#path", "inherited": true, "___id": "T000002R051869", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders prefix at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#prefix\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "prefix", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#prefix", "kind": "member", "description": "A reference to the Loaders prefix at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#prefix", "inherited": true, "___id": "T000002R051870", "___s": true }, { "comment": "/**\r\n * Checks if this MultiFile is ready to process its children or not.\r\n *\r\n * @method Phaser.Loader.MultiFile#isReadyToProcess\r\n * @since 3.7.0\r\n *\r\n * @return {boolean} `true` if all children of this MultiFile have loaded, otherwise `false`.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "isReadyToProcess", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#isReadyToProcess", "kind": "function", "description": "Checks if this MultiFile is ready to process its children or not.", "since": "3.7.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if all children of this MultiFile have loaded, otherwise `false`." } ], "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#isReadyToProcess", "inherited": true, "___id": "T000002R051871", "___s": true }, { "comment": "/**\r\n * Adds another child to this MultiFile, increases the pending count and resets the completion status.\r\n *\r\n * @method Phaser.Loader.MultiFile#addToMultiFile\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} files - The File to add to this MultiFile.\r\n *\r\n * @return {Phaser.Loader.MultiFile} This MultiFile instance.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToMultiFile", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#addToMultiFile", "kind": "function", "description": "Adds another child to this MultiFile, increases the pending count and resets the completion status.", "since": "3.7.0", "returns": [ { "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile" } }, "description": "This MultiFile instance." } ], "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File to add to this MultiFile.", "name": "files" } ], "inherits": "Phaser.Loader.MultiFile#addToMultiFile", "inherited": true, "___id": "T000002R051872", "___s": true }, { "comment": "/**\r\n * Called by each File when it finishes loading.\r\n *\r\n * @method Phaser.Loader.MultiFile#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": "MultiFile.js", "lineno": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileComplete", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#onFileComplete", "kind": "function", "description": "Called by each File when it finishes loading.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has completed processing.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileComplete", "inherited": true, "___id": "T000002R051873", "___s": true }, { "comment": "/**\r\n * Called by each File that fails to load.\r\n *\r\n * @method Phaser.Loader.MultiFile#onFileFailed\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File that has failed to load.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileFailed", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#onFileFailed", "kind": "function", "description": "Called by each File that fails to load.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has failed to load.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileFailed", "inherited": true, "___id": "T000002R051874", "___s": true }, { "comment": "/**\r\n * Called once all children of this multi file have been added to their caches and is now\r\n * ready for deletion from the Loader.\r\n *\r\n * It will emit a `filecomplete` event from the LoaderPlugin.\r\n *\r\n * @method Phaser.Loader.MultiFile#pendingDestroy\r\n * @fires Phaser.Loader.Events#FILE_COMPLETE\r\n * @fires Phaser.Loader.Events#FILE_KEY_COMPLETE\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#pendingDestroy", "kind": "function", "description": "Called once all children of this multi file have been added to their caches and is now\rready for deletion from the Loader.\r\rIt will emit a `filecomplete` event from the LoaderPlugin.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pendingDestroy", "inherited": true, "___id": "T000002R051875", "___s": true }, { "comment": "/**\r\n * Destroy this Multi File and any references it holds.\r\n *\r\n * @method Phaser.Loader.MultiFile#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.AtlasJSONFile#destroy", "kind": "function", "description": "Destroy this Multi File and any references it holds.", "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.AtlasJSONFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#destroy", "inherited": true, "___id": "T000002R051876", "___s": true }, { "comment": "/**\r\n * A reference to the Loader that is going to load this file.\r\n *\r\n * @name Phaser.Loader.MultiFile#loader\r\n * @type {Phaser.Loader.LoaderPlugin}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#loader", "inherited": true, "___id": "T000002R051877", "___s": true }, { "comment": "/**\r\n * The file type string for sorting within the Loader.\r\n *\r\n * @name Phaser.Loader.MultiFile#type\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#type", "kind": "member", "description": "The file type string for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#type", "inherited": true, "___id": "T000002R051878", "___s": true }, { "comment": "/**\r\n * Unique cache key (unique within its file type)\r\n *\r\n * @name Phaser.Loader.MultiFile#key\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#key", "inherited": true, "___id": "T000002R051879", "___s": true }, { "comment": "/**\r\n * Array of files that make up this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#files\r\n * @type {Phaser.Loader.File[]}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "files", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#files", "kind": "member", "description": "Array of files that make up this MultiFile.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Loader.File", "type": "NameExpression" } ] } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#files", "inherited": true, "___id": "T000002R051881", "___s": true }, { "comment": "/**\r\n * The current state of the file. One of the FILE_CONST values.\r\n *\r\n * @name Phaser.Loader.MultiFile#state\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#state", "inherited": true, "___id": "T000002R051882", "___s": true }, { "comment": "/**\r\n * The completion status of this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#complete\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "complete", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#complete", "kind": "member", "description": "The completion status of this MultiFile.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#complete", "inherited": true, "___id": "T000002R051883", "___s": true }, { "comment": "/**\r\n * The number of files to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#pending\r\n * @type {number}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pending", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#pending", "kind": "member", "description": "The number of files to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pending", "inherited": true, "___id": "T000002R051884", "___s": true }, { "comment": "/**\r\n * The number of files that failed to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#failed\r\n * @type {number}\r\n * @default 0\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "failed", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#failed", "kind": "member", "description": "The number of files that failed to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#failed", "inherited": true, "___id": "T000002R051885", "___s": true }, { "comment": "/**\r\n * A storage container for transient data that the loading files need.\r\n *\r\n * @name Phaser.Loader.MultiFile#config\r\n * @type {any}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#config", "kind": "member", "description": "A storage container for transient data that the loading files need.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#config", "inherited": true, "___id": "T000002R051886", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders baseURL at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#baseURL\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "baseURL", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#baseURL", "kind": "member", "description": "A reference to the Loaders baseURL at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#baseURL", "inherited": true, "___id": "T000002R051887", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders path at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#path\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "path", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#path", "kind": "member", "description": "A reference to the Loaders path at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#path", "inherited": true, "___id": "T000002R051888", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders prefix at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#prefix\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "prefix", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#prefix", "kind": "member", "description": "A reference to the Loaders prefix at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#prefix", "inherited": true, "___id": "T000002R051889", "___s": true }, { "comment": "/**\r\n * Checks if this MultiFile is ready to process its children or not.\r\n *\r\n * @method Phaser.Loader.MultiFile#isReadyToProcess\r\n * @since 3.7.0\r\n *\r\n * @return {boolean} `true` if all children of this MultiFile have loaded, otherwise `false`.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "isReadyToProcess", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#isReadyToProcess", "kind": "function", "description": "Checks if this MultiFile is ready to process its children or not.", "since": "3.7.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if all children of this MultiFile have loaded, otherwise `false`." } ], "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#isReadyToProcess", "inherited": true, "___id": "T000002R051890", "___s": true }, { "comment": "/**\r\n * Adds another child to this MultiFile, increases the pending count and resets the completion status.\r\n *\r\n * @method Phaser.Loader.MultiFile#addToMultiFile\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} files - The File to add to this MultiFile.\r\n *\r\n * @return {Phaser.Loader.MultiFile} This MultiFile instance.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToMultiFile", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#addToMultiFile", "kind": "function", "description": "Adds another child to this MultiFile, increases the pending count and resets the completion status.", "since": "3.7.0", "returns": [ { "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile" } }, "description": "This MultiFile instance." } ], "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File to add to this MultiFile.", "name": "files" } ], "inherits": "Phaser.Loader.MultiFile#addToMultiFile", "inherited": true, "___id": "T000002R051891", "___s": true }, { "comment": "/**\r\n * Called by each File when it finishes loading.\r\n *\r\n * @method Phaser.Loader.MultiFile#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": "MultiFile.js", "lineno": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileComplete", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#onFileComplete", "kind": "function", "description": "Called by each File when it finishes loading.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has completed processing.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileComplete", "inherited": true, "___id": "T000002R051892", "___s": true }, { "comment": "/**\r\n * Called by each File that fails to load.\r\n *\r\n * @method Phaser.Loader.MultiFile#onFileFailed\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File that has failed to load.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileFailed", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#onFileFailed", "kind": "function", "description": "Called by each File that fails to load.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has failed to load.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileFailed", "inherited": true, "___id": "T000002R051893", "___s": true }, { "comment": "/**\r\n * Called once all children of this multi file have been added to their caches and is now\r\n * ready for deletion from the Loader.\r\n *\r\n * It will emit a `filecomplete` event from the LoaderPlugin.\r\n *\r\n * @method Phaser.Loader.MultiFile#pendingDestroy\r\n * @fires Phaser.Loader.Events#FILE_COMPLETE\r\n * @fires Phaser.Loader.Events#FILE_KEY_COMPLETE\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#pendingDestroy", "kind": "function", "description": "Called once all children of this multi file have been added to their caches and is now\rready for deletion from the Loader.\r\rIt will emit a `filecomplete` event from the LoaderPlugin.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pendingDestroy", "inherited": true, "___id": "T000002R051894", "___s": true }, { "comment": "/**\r\n * Destroy this Multi File and any references it holds.\r\n *\r\n * @method Phaser.Loader.MultiFile#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#destroy", "kind": "function", "description": "Destroy this Multi File and any references it holds.", "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#destroy", "inherited": true, "___id": "T000002R051895", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.AudioFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R051896", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.AudioFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R051897", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.AudioFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R051898", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.AudioFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R051899", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.AudioFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R051900", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.AudioFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R051901", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.AudioFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R051902", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.AudioFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R051903", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.AudioFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R051904", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.AudioFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R051905", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.AudioFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R051906", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.AudioFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R051907", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.AudioFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R051908", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.AudioFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R051909", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.AudioFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R051910", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.AudioFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R051911", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.AudioFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R051912", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.AudioFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R051913", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.AudioFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R051914", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.AudioFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R051915", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.AudioFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R051916", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.AudioFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R051917", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.AudioFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R051918", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.AudioFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R051919", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.AudioFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R051920", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.AudioFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R051921", "___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": 448, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToCache", "longname": "Phaser.Loader.FileTypes.AudioFile#addToCache", "kind": "function", "description": "Adds this file to its target cache upon successful loading and processing.\rThis method is often overridden by specific file types.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#addToCache", "inherited": true, "___id": "T000002R051922", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.AudioFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R051923", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.AudioFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R051924", "___s": true }, { "comment": "/**\r\n * A reference to the Loader that is going to load this file.\r\n *\r\n * @name Phaser.Loader.MultiFile#loader\r\n * @type {Phaser.Loader.LoaderPlugin}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#loader", "inherited": true, "___id": "T000002R051925", "___s": true }, { "comment": "/**\r\n * The file type string for sorting within the Loader.\r\n *\r\n * @name Phaser.Loader.MultiFile#type\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#type", "kind": "member", "description": "The file type string for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#type", "inherited": true, "___id": "T000002R051926", "___s": true }, { "comment": "/**\r\n * Unique cache key (unique within its file type)\r\n *\r\n * @name Phaser.Loader.MultiFile#key\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#key", "inherited": true, "___id": "T000002R051927", "___s": true }, { "comment": "/**\r\n * Array of files that make up this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#files\r\n * @type {Phaser.Loader.File[]}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "files", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#files", "kind": "member", "description": "Array of files that make up this MultiFile.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Loader.File", "type": "NameExpression" } ] } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#files", "inherited": true, "___id": "T000002R051929", "___s": true }, { "comment": "/**\r\n * The current state of the file. One of the FILE_CONST values.\r\n *\r\n * @name Phaser.Loader.MultiFile#state\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#state", "inherited": true, "___id": "T000002R051930", "___s": true }, { "comment": "/**\r\n * The completion status of this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#complete\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "complete", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#complete", "kind": "member", "description": "The completion status of this MultiFile.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#complete", "inherited": true, "___id": "T000002R051931", "___s": true }, { "comment": "/**\r\n * The number of files to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#pending\r\n * @type {number}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pending", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#pending", "kind": "member", "description": "The number of files to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pending", "inherited": true, "___id": "T000002R051932", "___s": true }, { "comment": "/**\r\n * The number of files that failed to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#failed\r\n * @type {number}\r\n * @default 0\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "failed", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#failed", "kind": "member", "description": "The number of files that failed to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#failed", "inherited": true, "___id": "T000002R051933", "___s": true }, { "comment": "/**\r\n * A storage container for transient data that the loading files need.\r\n *\r\n * @name Phaser.Loader.MultiFile#config\r\n * @type {any}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#config", "kind": "member", "description": "A storage container for transient data that the loading files need.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#config", "inherited": true, "___id": "T000002R051934", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders baseURL at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#baseURL\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "baseURL", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#baseURL", "kind": "member", "description": "A reference to the Loaders baseURL at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#baseURL", "inherited": true, "___id": "T000002R051935", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders path at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#path\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "path", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#path", "kind": "member", "description": "A reference to the Loaders path at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#path", "inherited": true, "___id": "T000002R051936", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders prefix at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#prefix\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "prefix", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#prefix", "kind": "member", "description": "A reference to the Loaders prefix at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#prefix", "inherited": true, "___id": "T000002R051937", "___s": true }, { "comment": "/**\r\n * Checks if this MultiFile is ready to process its children or not.\r\n *\r\n * @method Phaser.Loader.MultiFile#isReadyToProcess\r\n * @since 3.7.0\r\n *\r\n * @return {boolean} `true` if all children of this MultiFile have loaded, otherwise `false`.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "isReadyToProcess", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#isReadyToProcess", "kind": "function", "description": "Checks if this MultiFile is ready to process its children or not.", "since": "3.7.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if all children of this MultiFile have loaded, otherwise `false`." } ], "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#isReadyToProcess", "inherited": true, "___id": "T000002R051938", "___s": true }, { "comment": "/**\r\n * Adds another child to this MultiFile, increases the pending count and resets the completion status.\r\n *\r\n * @method Phaser.Loader.MultiFile#addToMultiFile\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} files - The File to add to this MultiFile.\r\n *\r\n * @return {Phaser.Loader.MultiFile} This MultiFile instance.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToMultiFile", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#addToMultiFile", "kind": "function", "description": "Adds another child to this MultiFile, increases the pending count and resets the completion status.", "since": "3.7.0", "returns": [ { "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile" } }, "description": "This MultiFile instance." } ], "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File to add to this MultiFile.", "name": "files" } ], "inherits": "Phaser.Loader.MultiFile#addToMultiFile", "inherited": true, "___id": "T000002R051939", "___s": true }, { "comment": "/**\r\n * Called by each File that fails to load.\r\n *\r\n * @method Phaser.Loader.MultiFile#onFileFailed\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File that has failed to load.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileFailed", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#onFileFailed", "kind": "function", "description": "Called by each File that fails to load.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has failed to load.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileFailed", "inherited": true, "___id": "T000002R051940", "___s": true }, { "comment": "/**\r\n * Called once all children of this multi file have been added to their caches and is now\r\n * ready for deletion from the Loader.\r\n *\r\n * It will emit a `filecomplete` event from the LoaderPlugin.\r\n *\r\n * @method Phaser.Loader.MultiFile#pendingDestroy\r\n * @fires Phaser.Loader.Events#FILE_COMPLETE\r\n * @fires Phaser.Loader.Events#FILE_KEY_COMPLETE\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#pendingDestroy", "kind": "function", "description": "Called once all children of this multi file have been added to their caches and is now\rready for deletion from the Loader.\r\rIt will emit a `filecomplete` event from the LoaderPlugin.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pendingDestroy", "inherited": true, "___id": "T000002R051941", "___s": true }, { "comment": "/**\r\n * Destroy this Multi File and any references it holds.\r\n *\r\n * @method Phaser.Loader.MultiFile#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.AudioSpriteFile#destroy", "kind": "function", "description": "Destroy this Multi File and any references it holds.", "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.AudioSpriteFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#destroy", "inherited": true, "___id": "T000002R051942", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.BinaryFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R051943", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.BinaryFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R051944", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.BinaryFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R051945", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.BinaryFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R051946", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.BinaryFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R051947", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.BinaryFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R051948", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.BinaryFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R051949", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.BinaryFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R051950", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.BinaryFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R051951", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.BinaryFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R051952", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.BinaryFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R051953", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.BinaryFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R051954", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.BinaryFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R051955", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.BinaryFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R051956", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.BinaryFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R051957", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.BinaryFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R051958", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.BinaryFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R051959", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.BinaryFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R051960", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.BinaryFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R051961", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.BinaryFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R051962", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.BinaryFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R051963", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.BinaryFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R051964", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.BinaryFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R051965", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.BinaryFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R051966", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.BinaryFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R051967", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.BinaryFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R051968", "___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": 448, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToCache", "longname": "Phaser.Loader.FileTypes.BinaryFile#addToCache", "kind": "function", "description": "Adds this file to its target cache upon successful loading and processing.\rThis method is often overridden by specific file types.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#addToCache", "inherited": true, "___id": "T000002R051969", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.BinaryFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R051970", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.BinaryFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BinaryFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R051971", "___s": true }, { "comment": "/**\r\n * A reference to the Loader that is going to load this file.\r\n *\r\n * @name Phaser.Loader.MultiFile#loader\r\n * @type {Phaser.Loader.LoaderPlugin}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#loader", "inherited": true, "___id": "T000002R051972", "___s": true }, { "comment": "/**\r\n * The file type string for sorting within the Loader.\r\n *\r\n * @name Phaser.Loader.MultiFile#type\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#type", "kind": "member", "description": "The file type string for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#type", "inherited": true, "___id": "T000002R051973", "___s": true }, { "comment": "/**\r\n * Unique cache key (unique within its file type)\r\n *\r\n * @name Phaser.Loader.MultiFile#key\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#key", "inherited": true, "___id": "T000002R051974", "___s": true }, { "comment": "/**\r\n * Array of files that make up this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#files\r\n * @type {Phaser.Loader.File[]}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "files", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#files", "kind": "member", "description": "Array of files that make up this MultiFile.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Loader.File", "type": "NameExpression" } ] } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#files", "inherited": true, "___id": "T000002R051976", "___s": true }, { "comment": "/**\r\n * The current state of the file. One of the FILE_CONST values.\r\n *\r\n * @name Phaser.Loader.MultiFile#state\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#state", "inherited": true, "___id": "T000002R051977", "___s": true }, { "comment": "/**\r\n * The completion status of this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#complete\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "complete", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#complete", "kind": "member", "description": "The completion status of this MultiFile.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#complete", "inherited": true, "___id": "T000002R051978", "___s": true }, { "comment": "/**\r\n * The number of files to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#pending\r\n * @type {number}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pending", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#pending", "kind": "member", "description": "The number of files to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pending", "inherited": true, "___id": "T000002R051979", "___s": true }, { "comment": "/**\r\n * The number of files that failed to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#failed\r\n * @type {number}\r\n * @default 0\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "failed", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#failed", "kind": "member", "description": "The number of files that failed to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#failed", "inherited": true, "___id": "T000002R051980", "___s": true }, { "comment": "/**\r\n * A storage container for transient data that the loading files need.\r\n *\r\n * @name Phaser.Loader.MultiFile#config\r\n * @type {any}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#config", "kind": "member", "description": "A storage container for transient data that the loading files need.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#config", "inherited": true, "___id": "T000002R051981", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders baseURL at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#baseURL\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "baseURL", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#baseURL", "kind": "member", "description": "A reference to the Loaders baseURL at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#baseURL", "inherited": true, "___id": "T000002R051982", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders path at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#path\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "path", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#path", "kind": "member", "description": "A reference to the Loaders path at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#path", "inherited": true, "___id": "T000002R051983", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders prefix at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#prefix\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "prefix", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#prefix", "kind": "member", "description": "A reference to the Loaders prefix at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#prefix", "inherited": true, "___id": "T000002R051984", "___s": true }, { "comment": "/**\r\n * Checks if this MultiFile is ready to process its children or not.\r\n *\r\n * @method Phaser.Loader.MultiFile#isReadyToProcess\r\n * @since 3.7.0\r\n *\r\n * @return {boolean} `true` if all children of this MultiFile have loaded, otherwise `false`.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "isReadyToProcess", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#isReadyToProcess", "kind": "function", "description": "Checks if this MultiFile is ready to process its children or not.", "since": "3.7.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if all children of this MultiFile have loaded, otherwise `false`." } ], "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#isReadyToProcess", "inherited": true, "___id": "T000002R051985", "___s": true }, { "comment": "/**\r\n * Adds another child to this MultiFile, increases the pending count and resets the completion status.\r\n *\r\n * @method Phaser.Loader.MultiFile#addToMultiFile\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} files - The File to add to this MultiFile.\r\n *\r\n * @return {Phaser.Loader.MultiFile} This MultiFile instance.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToMultiFile", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#addToMultiFile", "kind": "function", "description": "Adds another child to this MultiFile, increases the pending count and resets the completion status.", "since": "3.7.0", "returns": [ { "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile" } }, "description": "This MultiFile instance." } ], "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File to add to this MultiFile.", "name": "files" } ], "inherits": "Phaser.Loader.MultiFile#addToMultiFile", "inherited": true, "___id": "T000002R051986", "___s": true }, { "comment": "/**\r\n * Called by each File when it finishes loading.\r\n *\r\n * @method Phaser.Loader.MultiFile#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": "MultiFile.js", "lineno": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileComplete", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#onFileComplete", "kind": "function", "description": "Called by each File when it finishes loading.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has completed processing.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileComplete", "inherited": true, "___id": "T000002R051987", "___s": true }, { "comment": "/**\r\n * Called by each File that fails to load.\r\n *\r\n * @method Phaser.Loader.MultiFile#onFileFailed\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File that has failed to load.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileFailed", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#onFileFailed", "kind": "function", "description": "Called by each File that fails to load.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has failed to load.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileFailed", "inherited": true, "___id": "T000002R051988", "___s": true }, { "comment": "/**\r\n * Called once all children of this multi file have been added to their caches and is now\r\n * ready for deletion from the Loader.\r\n *\r\n * It will emit a `filecomplete` event from the LoaderPlugin.\r\n *\r\n * @method Phaser.Loader.MultiFile#pendingDestroy\r\n * @fires Phaser.Loader.Events#FILE_COMPLETE\r\n * @fires Phaser.Loader.Events#FILE_KEY_COMPLETE\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#pendingDestroy", "kind": "function", "description": "Called once all children of this multi file have been added to their caches and is now\rready for deletion from the Loader.\r\rIt will emit a `filecomplete` event from the LoaderPlugin.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pendingDestroy", "inherited": true, "___id": "T000002R051989", "___s": true }, { "comment": "/**\r\n * Destroy this Multi File and any references it holds.\r\n *\r\n * @method Phaser.Loader.MultiFile#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.BitmapFontFile#destroy", "kind": "function", "description": "Destroy this Multi File and any references it holds.", "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.BitmapFontFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#destroy", "inherited": true, "___id": "T000002R051990", "___s": true }, { "comment": "/**\r\n * A reference to the Loader that is going to load this file.\r\n *\r\n * @name Phaser.Loader.MultiFile#loader\r\n * @type {Phaser.Loader.LoaderPlugin}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#loader", "inherited": true, "___id": "T000002R051991", "___s": true }, { "comment": "/**\r\n * The file type string for sorting within the Loader.\r\n *\r\n * @name Phaser.Loader.MultiFile#type\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#type", "kind": "member", "description": "The file type string for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#type", "inherited": true, "___id": "T000002R051992", "___s": true }, { "comment": "/**\r\n * Unique cache key (unique within its file type)\r\n *\r\n * @name Phaser.Loader.MultiFile#key\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#key", "inherited": true, "___id": "T000002R051993", "___s": true }, { "comment": "/**\r\n * Array of files that make up this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#files\r\n * @type {Phaser.Loader.File[]}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "files", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#files", "kind": "member", "description": "Array of files that make up this MultiFile.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Loader.File", "type": "NameExpression" } ] } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#files", "inherited": true, "___id": "T000002R051995", "___s": true }, { "comment": "/**\r\n * The current state of the file. One of the FILE_CONST values.\r\n *\r\n * @name Phaser.Loader.MultiFile#state\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#state", "inherited": true, "___id": "T000002R051996", "___s": true }, { "comment": "/**\r\n * The completion status of this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#complete\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "complete", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#complete", "kind": "member", "description": "The completion status of this MultiFile.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#complete", "inherited": true, "___id": "T000002R051997", "___s": true }, { "comment": "/**\r\n * The number of files to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#pending\r\n * @type {number}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pending", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#pending", "kind": "member", "description": "The number of files to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pending", "inherited": true, "___id": "T000002R051998", "___s": true }, { "comment": "/**\r\n * The number of files that failed to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#failed\r\n * @type {number}\r\n * @default 0\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "failed", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#failed", "kind": "member", "description": "The number of files that failed to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#failed", "inherited": true, "___id": "T000002R051999", "___s": true }, { "comment": "/**\r\n * A storage container for transient data that the loading files need.\r\n *\r\n * @name Phaser.Loader.MultiFile#config\r\n * @type {any}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#config", "kind": "member", "description": "A storage container for transient data that the loading files need.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#config", "inherited": true, "___id": "T000002R052000", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders baseURL at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#baseURL\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "baseURL", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#baseURL", "kind": "member", "description": "A reference to the Loaders baseURL at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#baseURL", "inherited": true, "___id": "T000002R052001", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders path at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#path\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "path", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#path", "kind": "member", "description": "A reference to the Loaders path at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#path", "inherited": true, "___id": "T000002R052002", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders prefix at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#prefix\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "prefix", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#prefix", "kind": "member", "description": "A reference to the Loaders prefix at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#prefix", "inherited": true, "___id": "T000002R052003", "___s": true }, { "comment": "/**\r\n * Checks if this MultiFile is ready to process its children or not.\r\n *\r\n * @method Phaser.Loader.MultiFile#isReadyToProcess\r\n * @since 3.7.0\r\n *\r\n * @return {boolean} `true` if all children of this MultiFile have loaded, otherwise `false`.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "isReadyToProcess", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#isReadyToProcess", "kind": "function", "description": "Checks if this MultiFile is ready to process its children or not.", "since": "3.7.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if all children of this MultiFile have loaded, otherwise `false`." } ], "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#isReadyToProcess", "inherited": true, "___id": "T000002R052004", "___s": true }, { "comment": "/**\r\n * Adds another child to this MultiFile, increases the pending count and resets the completion status.\r\n *\r\n * @method Phaser.Loader.MultiFile#addToMultiFile\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} files - The File to add to this MultiFile.\r\n *\r\n * @return {Phaser.Loader.MultiFile} This MultiFile instance.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToMultiFile", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#addToMultiFile", "kind": "function", "description": "Adds another child to this MultiFile, increases the pending count and resets the completion status.", "since": "3.7.0", "returns": [ { "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile" } }, "description": "This MultiFile instance." } ], "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File to add to this MultiFile.", "name": "files" } ], "inherits": "Phaser.Loader.MultiFile#addToMultiFile", "inherited": true, "___id": "T000002R052005", "___s": true }, { "comment": "/**\r\n * Called by each File that fails to load.\r\n *\r\n * @method Phaser.Loader.MultiFile#onFileFailed\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File that has failed to load.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileFailed", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#onFileFailed", "kind": "function", "description": "Called by each File that fails to load.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has failed to load.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileFailed", "inherited": true, "___id": "T000002R052006", "___s": true }, { "comment": "/**\r\n * Called once all children of this multi file have been added to their caches and is now\r\n * ready for deletion from the Loader.\r\n *\r\n * It will emit a `filecomplete` event from the LoaderPlugin.\r\n *\r\n * @method Phaser.Loader.MultiFile#pendingDestroy\r\n * @fires Phaser.Loader.Events#FILE_COMPLETE\r\n * @fires Phaser.Loader.Events#FILE_KEY_COMPLETE\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#pendingDestroy", "kind": "function", "description": "Called once all children of this multi file have been added to their caches and is now\rready for deletion from the Loader.\r\rIt will emit a `filecomplete` event from the LoaderPlugin.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pendingDestroy", "inherited": true, "___id": "T000002R052007", "___s": true }, { "comment": "/**\r\n * Destroy this Multi File and any references it holds.\r\n *\r\n * @method Phaser.Loader.MultiFile#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#destroy", "kind": "function", "description": "Destroy this Multi File and any references it holds.", "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#destroy", "inherited": true, "___id": "T000002R052008", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.CSSFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052009", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.CSSFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052010", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.CSSFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052011", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.CSSFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052012", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.CSSFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052013", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.CSSFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052014", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.CSSFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052015", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.CSSFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052016", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.CSSFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052017", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.CSSFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052018", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.CSSFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052019", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.CSSFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052020", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.CSSFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052021", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.CSSFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052022", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.CSSFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052023", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.CSSFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052024", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.CSSFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052025", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.CSSFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052026", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.CSSFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052027", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.CSSFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052028", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.CSSFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052029", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.CSSFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052030", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.CSSFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052031", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.CSSFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052032", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.CSSFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052033", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.CSSFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052034", "___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": 448, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToCache", "longname": "Phaser.Loader.FileTypes.CSSFile#addToCache", "kind": "function", "description": "Adds this file to its target cache upon successful loading and processing.\rThis method is often overridden by specific file types.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#addToCache", "inherited": true, "___id": "T000002R052035", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.CSSFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052036", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.CSSFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.CSSFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052037", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.GLSLFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052038", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.GLSLFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052039", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.GLSLFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052040", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.GLSLFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052041", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.GLSLFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052042", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.GLSLFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052043", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.GLSLFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052044", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.GLSLFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052045", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.GLSLFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052046", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.GLSLFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052047", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.GLSLFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052048", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.GLSLFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052049", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.GLSLFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052050", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.GLSLFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052051", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.GLSLFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052052", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.GLSLFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052053", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.GLSLFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052054", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.GLSLFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052055", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.GLSLFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052056", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.GLSLFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052057", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.GLSLFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052058", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.GLSLFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052059", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.GLSLFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052060", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.GLSLFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052061", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.GLSLFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052062", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.GLSLFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052063", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.GLSLFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052064", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.GLSLFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.GLSLFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052065", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052066", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052067", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052068", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052069", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052070", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052071", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052072", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052073", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052074", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052075", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052076", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052077", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052078", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052079", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052080", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052081", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052082", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052083", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052084", "___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": 378, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcess", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#onProcess", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcess", "inherited": true, "___id": "T000002R052085", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052086", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052087", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052088", "___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": 448, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToCache", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#addToCache", "kind": "function", "description": "Adds this file to its target cache upon successful loading and processing.\rThis method is often overridden by specific file types.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#addToCache", "inherited": true, "___id": "T000002R052089", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052090", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.HTML5AudioFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTML5AudioFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052091", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.HTMLFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052092", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.HTMLFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052093", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.HTMLFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052094", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.HTMLFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052095", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.HTMLFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052096", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.HTMLFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052097", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.HTMLFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052098", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.HTMLFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052099", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.HTMLFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052100", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.HTMLFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052101", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.HTMLFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052102", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.HTMLFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052103", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.HTMLFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052104", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.HTMLFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052105", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.HTMLFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052106", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.HTMLFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052107", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.HTMLFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052108", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.HTMLFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052109", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.HTMLFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052110", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.HTMLFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052111", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.HTMLFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052112", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.HTMLFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052113", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.HTMLFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052114", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.HTMLFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052115", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.HTMLFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052116", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.HTMLFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052117", "___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": 448, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToCache", "longname": "Phaser.Loader.FileTypes.HTMLFile#addToCache", "kind": "function", "description": "Adds this file to its target cache upon successful loading and processing.\rThis method is often overridden by specific file types.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#addToCache", "inherited": true, "___id": "T000002R052118", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.HTMLFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052119", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.HTMLFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052120", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052121", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052122", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052123", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052124", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052125", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052126", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052127", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052128", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052129", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052130", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052131", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052132", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052133", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052134", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052135", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052136", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052137", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052138", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052139", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052140", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052141", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052142", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052143", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052144", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052145", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052146", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052147", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.HTMLTextureFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.HTMLTextureFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052148", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.ImageFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052149", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.ImageFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052150", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.ImageFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052151", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.ImageFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052152", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.ImageFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052153", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.ImageFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052154", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.ImageFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052155", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.ImageFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052156", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.ImageFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052157", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.ImageFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052158", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.ImageFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052159", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.ImageFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052160", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.ImageFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052161", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.ImageFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052162", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.ImageFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052163", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.ImageFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052164", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.ImageFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052165", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.ImageFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052166", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.ImageFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052167", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.ImageFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052168", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.ImageFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052169", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.ImageFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052170", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.ImageFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052171", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.ImageFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052172", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.ImageFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052173", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.ImageFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052174", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.ImageFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052175", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.ImageFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ImageFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052176", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.JSONFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052177", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.JSONFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052178", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.JSONFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052179", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.JSONFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052180", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.JSONFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052181", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.JSONFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052182", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.JSONFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052183", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.JSONFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052184", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.JSONFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052185", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.JSONFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052186", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.JSONFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052187", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.JSONFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052188", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.JSONFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052189", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.JSONFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052190", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.JSONFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052191", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.JSONFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052192", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.JSONFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052193", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.JSONFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052194", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.JSONFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052195", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.JSONFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052196", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.JSONFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052197", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.JSONFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052198", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.JSONFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052199", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.JSONFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052200", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.JSONFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052201", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.JSONFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052202", "___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": 448, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToCache", "longname": "Phaser.Loader.FileTypes.JSONFile#addToCache", "kind": "function", "description": "Adds this file to its target cache upon successful loading and processing.\rThis method is often overridden by specific file types.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#addToCache", "inherited": true, "___id": "T000002R052203", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.JSONFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052204", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.JSONFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.JSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052205", "___s": true }, { "comment": "/**\r\n * A reference to the Loader that is going to load this file.\r\n *\r\n * @name Phaser.Loader.MultiFile#loader\r\n * @type {Phaser.Loader.LoaderPlugin}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#loader", "inherited": true, "___id": "T000002R052206", "___s": true }, { "comment": "/**\r\n * The file type string for sorting within the Loader.\r\n *\r\n * @name Phaser.Loader.MultiFile#type\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#type", "kind": "member", "description": "The file type string for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#type", "inherited": true, "___id": "T000002R052207", "___s": true }, { "comment": "/**\r\n * Unique cache key (unique within its file type)\r\n *\r\n * @name Phaser.Loader.MultiFile#key\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#key", "inherited": true, "___id": "T000002R052208", "___s": true }, { "comment": "/**\r\n * Array of files that make up this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#files\r\n * @type {Phaser.Loader.File[]}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "files", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#files", "kind": "member", "description": "Array of files that make up this MultiFile.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Loader.File", "type": "NameExpression" } ] } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#files", "inherited": true, "___id": "T000002R052210", "___s": true }, { "comment": "/**\r\n * The current state of the file. One of the FILE_CONST values.\r\n *\r\n * @name Phaser.Loader.MultiFile#state\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#state", "inherited": true, "___id": "T000002R052211", "___s": true }, { "comment": "/**\r\n * The completion status of this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#complete\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "complete", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#complete", "kind": "member", "description": "The completion status of this MultiFile.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#complete", "inherited": true, "___id": "T000002R052212", "___s": true }, { "comment": "/**\r\n * The number of files to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#pending\r\n * @type {number}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pending", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#pending", "kind": "member", "description": "The number of files to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pending", "inherited": true, "___id": "T000002R052213", "___s": true }, { "comment": "/**\r\n * The number of files that failed to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#failed\r\n * @type {number}\r\n * @default 0\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "failed", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#failed", "kind": "member", "description": "The number of files that failed to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#failed", "inherited": true, "___id": "T000002R052214", "___s": true }, { "comment": "/**\r\n * A storage container for transient data that the loading files need.\r\n *\r\n * @name Phaser.Loader.MultiFile#config\r\n * @type {any}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#config", "kind": "member", "description": "A storage container for transient data that the loading files need.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#config", "inherited": true, "___id": "T000002R052215", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders baseURL at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#baseURL\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "baseURL", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#baseURL", "kind": "member", "description": "A reference to the Loaders baseURL at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#baseURL", "inherited": true, "___id": "T000002R052216", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders path at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#path\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "path", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#path", "kind": "member", "description": "A reference to the Loaders path at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#path", "inherited": true, "___id": "T000002R052217", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders prefix at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#prefix\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "prefix", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#prefix", "kind": "member", "description": "A reference to the Loaders prefix at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#prefix", "inherited": true, "___id": "T000002R052218", "___s": true }, { "comment": "/**\r\n * Checks if this MultiFile is ready to process its children or not.\r\n *\r\n * @method Phaser.Loader.MultiFile#isReadyToProcess\r\n * @since 3.7.0\r\n *\r\n * @return {boolean} `true` if all children of this MultiFile have loaded, otherwise `false`.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "isReadyToProcess", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#isReadyToProcess", "kind": "function", "description": "Checks if this MultiFile is ready to process its children or not.", "since": "3.7.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if all children of this MultiFile have loaded, otherwise `false`." } ], "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#isReadyToProcess", "inherited": true, "___id": "T000002R052219", "___s": true }, { "comment": "/**\r\n * Adds another child to this MultiFile, increases the pending count and resets the completion status.\r\n *\r\n * @method Phaser.Loader.MultiFile#addToMultiFile\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} files - The File to add to this MultiFile.\r\n *\r\n * @return {Phaser.Loader.MultiFile} This MultiFile instance.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToMultiFile", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#addToMultiFile", "kind": "function", "description": "Adds another child to this MultiFile, increases the pending count and resets the completion status.", "since": "3.7.0", "returns": [ { "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile" } }, "description": "This MultiFile instance." } ], "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File to add to this MultiFile.", "name": "files" } ], "inherits": "Phaser.Loader.MultiFile#addToMultiFile", "inherited": true, "___id": "T000002R052220", "___s": true }, { "comment": "/**\r\n * Called by each File that fails to load.\r\n *\r\n * @method Phaser.Loader.MultiFile#onFileFailed\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File that has failed to load.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileFailed", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#onFileFailed", "kind": "function", "description": "Called by each File that fails to load.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has failed to load.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileFailed", "inherited": true, "___id": "T000002R052221", "___s": true }, { "comment": "/**\r\n * Called once all children of this multi file have been added to their caches and is now\r\n * ready for deletion from the Loader.\r\n *\r\n * It will emit a `filecomplete` event from the LoaderPlugin.\r\n *\r\n * @method Phaser.Loader.MultiFile#pendingDestroy\r\n * @fires Phaser.Loader.Events#FILE_COMPLETE\r\n * @fires Phaser.Loader.Events#FILE_KEY_COMPLETE\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#pendingDestroy", "kind": "function", "description": "Called once all children of this multi file have been added to their caches and is now\rready for deletion from the Loader.\r\rIt will emit a `filecomplete` event from the LoaderPlugin.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pendingDestroy", "inherited": true, "___id": "T000002R052222", "___s": true }, { "comment": "/**\r\n * Destroy this Multi File and any references it holds.\r\n *\r\n * @method Phaser.Loader.MultiFile#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.MultiAtlasFile#destroy", "kind": "function", "description": "Destroy this Multi File and any references it holds.", "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.MultiAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#destroy", "inherited": true, "___id": "T000002R052223", "___s": true }, { "comment": "/**\r\n * A reference to the Loader that is going to load this file.\r\n *\r\n * @name Phaser.Loader.MultiFile#loader\r\n * @type {Phaser.Loader.LoaderPlugin}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#loader", "inherited": true, "___id": "T000002R052224", "___s": true }, { "comment": "/**\r\n * The file type string for sorting within the Loader.\r\n *\r\n * @name Phaser.Loader.MultiFile#type\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#type", "kind": "member", "description": "The file type string for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#type", "inherited": true, "___id": "T000002R052225", "___s": true }, { "comment": "/**\r\n * Unique cache key (unique within its file type)\r\n *\r\n * @name Phaser.Loader.MultiFile#key\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#key", "inherited": true, "___id": "T000002R052226", "___s": true }, { "comment": "/**\r\n * Array of files that make up this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#files\r\n * @type {Phaser.Loader.File[]}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "files", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#files", "kind": "member", "description": "Array of files that make up this MultiFile.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Loader.File", "type": "NameExpression" } ] } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#files", "inherited": true, "___id": "T000002R052228", "___s": true }, { "comment": "/**\r\n * The current state of the file. One of the FILE_CONST values.\r\n *\r\n * @name Phaser.Loader.MultiFile#state\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#state", "inherited": true, "___id": "T000002R052229", "___s": true }, { "comment": "/**\r\n * The completion status of this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#complete\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "complete", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#complete", "kind": "member", "description": "The completion status of this MultiFile.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#complete", "inherited": true, "___id": "T000002R052230", "___s": true }, { "comment": "/**\r\n * The number of files to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#pending\r\n * @type {number}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pending", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#pending", "kind": "member", "description": "The number of files to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pending", "inherited": true, "___id": "T000002R052231", "___s": true }, { "comment": "/**\r\n * The number of files that failed to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#failed\r\n * @type {number}\r\n * @default 0\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "failed", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#failed", "kind": "member", "description": "The number of files that failed to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#failed", "inherited": true, "___id": "T000002R052232", "___s": true }, { "comment": "/**\r\n * A storage container for transient data that the loading files need.\r\n *\r\n * @name Phaser.Loader.MultiFile#config\r\n * @type {any}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#config", "kind": "member", "description": "A storage container for transient data that the loading files need.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#config", "inherited": true, "___id": "T000002R052233", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders baseURL at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#baseURL\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "baseURL", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#baseURL", "kind": "member", "description": "A reference to the Loaders baseURL at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#baseURL", "inherited": true, "___id": "T000002R052234", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders path at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#path\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "path", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#path", "kind": "member", "description": "A reference to the Loaders path at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#path", "inherited": true, "___id": "T000002R052235", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders prefix at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#prefix\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "prefix", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#prefix", "kind": "member", "description": "A reference to the Loaders prefix at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#prefix", "inherited": true, "___id": "T000002R052236", "___s": true }, { "comment": "/**\r\n * Checks if this MultiFile is ready to process its children or not.\r\n *\r\n * @method Phaser.Loader.MultiFile#isReadyToProcess\r\n * @since 3.7.0\r\n *\r\n * @return {boolean} `true` if all children of this MultiFile have loaded, otherwise `false`.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "isReadyToProcess", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#isReadyToProcess", "kind": "function", "description": "Checks if this MultiFile is ready to process its children or not.", "since": "3.7.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if all children of this MultiFile have loaded, otherwise `false`." } ], "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#isReadyToProcess", "inherited": true, "___id": "T000002R052237", "___s": true }, { "comment": "/**\r\n * Adds another child to this MultiFile, increases the pending count and resets the completion status.\r\n *\r\n * @method Phaser.Loader.MultiFile#addToMultiFile\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} files - The File to add to this MultiFile.\r\n *\r\n * @return {Phaser.Loader.MultiFile} This MultiFile instance.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToMultiFile", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#addToMultiFile", "kind": "function", "description": "Adds another child to this MultiFile, increases the pending count and resets the completion status.", "since": "3.7.0", "returns": [ { "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile" } }, "description": "This MultiFile instance." } ], "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File to add to this MultiFile.", "name": "files" } ], "inherits": "Phaser.Loader.MultiFile#addToMultiFile", "inherited": true, "___id": "T000002R052238", "___s": true }, { "comment": "/**\r\n * Called by each File when it finishes loading.\r\n *\r\n * @method Phaser.Loader.MultiFile#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": "MultiFile.js", "lineno": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileComplete", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#onFileComplete", "kind": "function", "description": "Called by each File when it finishes loading.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has completed processing.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileComplete", "inherited": true, "___id": "T000002R052239", "___s": true }, { "comment": "/**\r\n * Called by each File that fails to load.\r\n *\r\n * @method Phaser.Loader.MultiFile#onFileFailed\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File that has failed to load.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileFailed", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#onFileFailed", "kind": "function", "description": "Called by each File that fails to load.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has failed to load.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileFailed", "inherited": true, "___id": "T000002R052240", "___s": true }, { "comment": "/**\r\n * Called once all children of this multi file have been added to their caches and is now\r\n * ready for deletion from the Loader.\r\n *\r\n * It will emit a `filecomplete` event from the LoaderPlugin.\r\n *\r\n * @method Phaser.Loader.MultiFile#pendingDestroy\r\n * @fires Phaser.Loader.Events#FILE_COMPLETE\r\n * @fires Phaser.Loader.Events#FILE_KEY_COMPLETE\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#pendingDestroy", "kind": "function", "description": "Called once all children of this multi file have been added to their caches and is now\rready for deletion from the Loader.\r\rIt will emit a `filecomplete` event from the LoaderPlugin.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pendingDestroy", "inherited": true, "___id": "T000002R052241", "___s": true }, { "comment": "/**\r\n * Destroy this Multi File and any references it holds.\r\n *\r\n * @method Phaser.Loader.MultiFile#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.MultiScriptFile#destroy", "kind": "function", "description": "Destroy this Multi File and any references it holds.", "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.MultiScriptFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#destroy", "inherited": true, "___id": "T000002R052242", "___s": true }, { "comment": "/**\r\n * A reference to the Loader that is going to load this file.\r\n *\r\n * @name Phaser.Loader.MultiFile#loader\r\n * @type {Phaser.Loader.LoaderPlugin}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.OBJFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#loader", "inherited": true, "___id": "T000002R052243", "___s": true }, { "comment": "/**\r\n * The file type string for sorting within the Loader.\r\n *\r\n * @name Phaser.Loader.MultiFile#type\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.OBJFile#type", "kind": "member", "description": "The file type string for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#type", "inherited": true, "___id": "T000002R052244", "___s": true }, { "comment": "/**\r\n * Unique cache key (unique within its file type)\r\n *\r\n * @name Phaser.Loader.MultiFile#key\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.OBJFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#key", "inherited": true, "___id": "T000002R052245", "___s": true }, { "comment": "/**\r\n * Array of files that make up this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#files\r\n * @type {Phaser.Loader.File[]}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "files", "longname": "Phaser.Loader.FileTypes.OBJFile#files", "kind": "member", "description": "Array of files that make up this MultiFile.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Loader.File", "type": "NameExpression" } ] } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#files", "inherited": true, "___id": "T000002R052247", "___s": true }, { "comment": "/**\r\n * The current state of the file. One of the FILE_CONST values.\r\n *\r\n * @name Phaser.Loader.MultiFile#state\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.OBJFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#state", "inherited": true, "___id": "T000002R052248", "___s": true }, { "comment": "/**\r\n * The completion status of this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#complete\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "complete", "longname": "Phaser.Loader.FileTypes.OBJFile#complete", "kind": "member", "description": "The completion status of this MultiFile.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#complete", "inherited": true, "___id": "T000002R052249", "___s": true }, { "comment": "/**\r\n * The number of files to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#pending\r\n * @type {number}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pending", "longname": "Phaser.Loader.FileTypes.OBJFile#pending", "kind": "member", "description": "The number of files to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pending", "inherited": true, "___id": "T000002R052250", "___s": true }, { "comment": "/**\r\n * The number of files that failed to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#failed\r\n * @type {number}\r\n * @default 0\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "failed", "longname": "Phaser.Loader.FileTypes.OBJFile#failed", "kind": "member", "description": "The number of files that failed to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#failed", "inherited": true, "___id": "T000002R052251", "___s": true }, { "comment": "/**\r\n * A storage container for transient data that the loading files need.\r\n *\r\n * @name Phaser.Loader.MultiFile#config\r\n * @type {any}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.OBJFile#config", "kind": "member", "description": "A storage container for transient data that the loading files need.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#config", "inherited": true, "___id": "T000002R052252", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders baseURL at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#baseURL\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "baseURL", "longname": "Phaser.Loader.FileTypes.OBJFile#baseURL", "kind": "member", "description": "A reference to the Loaders baseURL at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#baseURL", "inherited": true, "___id": "T000002R052253", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders path at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#path\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "path", "longname": "Phaser.Loader.FileTypes.OBJFile#path", "kind": "member", "description": "A reference to the Loaders path at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#path", "inherited": true, "___id": "T000002R052254", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders prefix at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#prefix\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "prefix", "longname": "Phaser.Loader.FileTypes.OBJFile#prefix", "kind": "member", "description": "A reference to the Loaders prefix at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#prefix", "inherited": true, "___id": "T000002R052255", "___s": true }, { "comment": "/**\r\n * Checks if this MultiFile is ready to process its children or not.\r\n *\r\n * @method Phaser.Loader.MultiFile#isReadyToProcess\r\n * @since 3.7.0\r\n *\r\n * @return {boolean} `true` if all children of this MultiFile have loaded, otherwise `false`.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "isReadyToProcess", "longname": "Phaser.Loader.FileTypes.OBJFile#isReadyToProcess", "kind": "function", "description": "Checks if this MultiFile is ready to process its children or not.", "since": "3.7.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if all children of this MultiFile have loaded, otherwise `false`." } ], "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#isReadyToProcess", "inherited": true, "___id": "T000002R052256", "___s": true }, { "comment": "/**\r\n * Adds another child to this MultiFile, increases the pending count and resets the completion status.\r\n *\r\n * @method Phaser.Loader.MultiFile#addToMultiFile\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} files - The File to add to this MultiFile.\r\n *\r\n * @return {Phaser.Loader.MultiFile} This MultiFile instance.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToMultiFile", "longname": "Phaser.Loader.FileTypes.OBJFile#addToMultiFile", "kind": "function", "description": "Adds another child to this MultiFile, increases the pending count and resets the completion status.", "since": "3.7.0", "returns": [ { "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile" } }, "description": "This MultiFile instance." } ], "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File to add to this MultiFile.", "name": "files" } ], "inherits": "Phaser.Loader.MultiFile#addToMultiFile", "inherited": true, "___id": "T000002R052257", "___s": true }, { "comment": "/**\r\n * Called by each File when it finishes loading.\r\n *\r\n * @method Phaser.Loader.MultiFile#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": "MultiFile.js", "lineno": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileComplete", "longname": "Phaser.Loader.FileTypes.OBJFile#onFileComplete", "kind": "function", "description": "Called by each File when it finishes loading.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has completed processing.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileComplete", "inherited": true, "___id": "T000002R052258", "___s": true }, { "comment": "/**\r\n * Called by each File that fails to load.\r\n *\r\n * @method Phaser.Loader.MultiFile#onFileFailed\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File that has failed to load.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileFailed", "longname": "Phaser.Loader.FileTypes.OBJFile#onFileFailed", "kind": "function", "description": "Called by each File that fails to load.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has failed to load.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileFailed", "inherited": true, "___id": "T000002R052259", "___s": true }, { "comment": "/**\r\n * Called once all children of this multi file have been added to their caches and is now\r\n * ready for deletion from the Loader.\r\n *\r\n * It will emit a `filecomplete` event from the LoaderPlugin.\r\n *\r\n * @method Phaser.Loader.MultiFile#pendingDestroy\r\n * @fires Phaser.Loader.Events#FILE_COMPLETE\r\n * @fires Phaser.Loader.Events#FILE_KEY_COMPLETE\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.OBJFile#pendingDestroy", "kind": "function", "description": "Called once all children of this multi file have been added to their caches and is now\rready for deletion from the Loader.\r\rIt will emit a `filecomplete` event from the LoaderPlugin.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pendingDestroy", "inherited": true, "___id": "T000002R052260", "___s": true }, { "comment": "/**\r\n * Destroy this Multi File and any references it holds.\r\n *\r\n * @method Phaser.Loader.MultiFile#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.OBJFile#destroy", "kind": "function", "description": "Destroy this Multi File and any references it holds.", "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.OBJFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#destroy", "inherited": true, "___id": "T000002R052261", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.PackFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052262", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.PackFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052263", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.PackFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052264", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.PackFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052265", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.PackFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052266", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.PackFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052267", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.PackFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052268", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.PackFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052269", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.PackFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052270", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.PackFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052271", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.PackFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052272", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.PackFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052273", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.PackFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052274", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.PackFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052275", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.PackFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052276", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.PackFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052277", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.PackFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052278", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.PackFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052279", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.PackFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052280", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.PackFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052281", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.PackFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052282", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.PackFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052283", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.PackFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052284", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.PackFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052285", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.PackFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052286", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.PackFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052287", "___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": 448, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToCache", "longname": "Phaser.Loader.FileTypes.PackFile#addToCache", "kind": "function", "description": "Adds this file to its target cache upon successful loading and processing.\rThis method is often overridden by specific file types.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#addToCache", "inherited": true, "___id": "T000002R052288", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.PackFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052289", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.PackFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.PackFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052290", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.PluginFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052291", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.PluginFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052292", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.PluginFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052293", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.PluginFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052294", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.PluginFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052295", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.PluginFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052296", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.PluginFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052297", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.PluginFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052298", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.PluginFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052299", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.PluginFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052300", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.PluginFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052301", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.PluginFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052302", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.PluginFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052303", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.PluginFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052304", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.PluginFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052305", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.PluginFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052306", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.PluginFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052307", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.PluginFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052308", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.PluginFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052309", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.PluginFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052310", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.PluginFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052311", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.PluginFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052312", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.PluginFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052313", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.PluginFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052314", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.PluginFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052315", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.PluginFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052316", "___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": 448, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToCache", "longname": "Phaser.Loader.FileTypes.PluginFile#addToCache", "kind": "function", "description": "Adds this file to its target cache upon successful loading and processing.\rThis method is often overridden by specific file types.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#addToCache", "inherited": true, "___id": "T000002R052317", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.PluginFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052318", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.PluginFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.PluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052319", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.SceneFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052320", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.SceneFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052321", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.SceneFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052322", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.SceneFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052323", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.SceneFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052324", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.SceneFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052325", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.SceneFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052326", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.SceneFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052327", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.SceneFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052328", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.SceneFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052329", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.SceneFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052330", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.SceneFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052331", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.SceneFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052332", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.SceneFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052333", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.SceneFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052334", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.SceneFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052335", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.SceneFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052336", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.SceneFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052337", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.SceneFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052338", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.SceneFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052339", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.SceneFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052340", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.SceneFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052341", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.SceneFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052342", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.SceneFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052343", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.SceneFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052344", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.SceneFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052345", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.SceneFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052346", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.SceneFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SceneFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052347", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052348", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052349", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052350", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052351", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052352", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052353", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052354", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052355", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052356", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052357", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052358", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052359", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052360", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052361", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052362", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052363", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052364", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052365", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052366", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052367", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052368", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052369", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052370", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052371", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052372", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052373", "___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": 448, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToCache", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#addToCache", "kind": "function", "description": "Adds this file to its target cache upon successful loading and processing.\rThis method is often overridden by specific file types.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#addToCache", "inherited": true, "___id": "T000002R052374", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052375", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.ScenePluginFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ScenePluginFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052376", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.ScriptFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052377", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.ScriptFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052378", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.ScriptFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052379", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.ScriptFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052380", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.ScriptFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052381", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.ScriptFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052382", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.ScriptFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052383", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.ScriptFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052384", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.ScriptFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052385", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.ScriptFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052386", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.ScriptFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052387", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.ScriptFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052388", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.ScriptFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052389", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.ScriptFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052390", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.ScriptFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052391", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.ScriptFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052392", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.ScriptFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052393", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.ScriptFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052394", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.ScriptFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052395", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.ScriptFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052396", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.ScriptFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052397", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.ScriptFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052398", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.ScriptFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052399", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.ScriptFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052400", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.ScriptFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052401", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.ScriptFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052402", "___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": 448, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToCache", "longname": "Phaser.Loader.FileTypes.ScriptFile#addToCache", "kind": "function", "description": "Adds this file to its target cache upon successful loading and processing.\rThis method is often overridden by specific file types.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#addToCache", "inherited": true, "___id": "T000002R052403", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.ScriptFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052404", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.ScriptFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.ScriptFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052405", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052406", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052407", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052408", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052409", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052410", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052411", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052412", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052413", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052414", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052415", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052416", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052417", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052418", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052419", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052420", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052421", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052422", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052423", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052424", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052425", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052426", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052427", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052428", "___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": 378, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcess", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#onProcess", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcess", "inherited": true, "___id": "T000002R052429", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052430", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052431", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052432", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052433", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.SpriteSheetFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SpriteSheetFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052434", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.SVGFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052435", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.SVGFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052436", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.SVGFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052437", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.SVGFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052438", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.SVGFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052439", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.SVGFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052440", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.SVGFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052441", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.SVGFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052442", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.SVGFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052443", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.SVGFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052444", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.SVGFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052445", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.SVGFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052446", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.SVGFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052447", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.SVGFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052448", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.SVGFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052449", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.SVGFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052450", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.SVGFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052451", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.SVGFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052452", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.SVGFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052453", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.SVGFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052454", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.SVGFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052455", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.SVGFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052456", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.SVGFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052457", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.SVGFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052458", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.SVGFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052459", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.SVGFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052460", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.SVGFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052461", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.SVGFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.SVGFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052462", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.TextFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052463", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.TextFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052464", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.TextFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052465", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.TextFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052466", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.TextFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052467", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.TextFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052468", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.TextFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052469", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.TextFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052470", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.TextFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052471", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.TextFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052472", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.TextFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052473", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.TextFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052474", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.TextFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052475", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.TextFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052476", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.TextFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052477", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.TextFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052478", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.TextFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052479", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.TextFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052480", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.TextFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052481", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.TextFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052482", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.TextFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052483", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.TextFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052484", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.TextFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052485", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.TextFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052486", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.TextFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052487", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.TextFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052488", "___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": 448, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToCache", "longname": "Phaser.Loader.FileTypes.TextFile#addToCache", "kind": "function", "description": "Adds this file to its target cache upon successful loading and processing.\rThis method is often overridden by specific file types.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#addToCache", "inherited": true, "___id": "T000002R052489", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.TextFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052490", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.TextFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TextFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052491", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052492", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052493", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052494", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052495", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052496", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052497", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052498", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052499", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052500", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052501", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052502", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052503", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052504", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052505", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052506", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052507", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052508", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052509", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052510", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052511", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052512", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052513", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052514", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052515", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052516", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052517", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052518", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.TilemapCSVFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapCSVFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052519", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052520", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052521", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052522", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052523", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052524", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052525", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052526", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052527", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052528", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052529", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052530", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052531", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052532", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052533", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052534", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052535", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052536", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052537", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052538", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052539", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052540", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052541", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052542", "___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": 378, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcess", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#onProcess", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcess", "inherited": true, "___id": "T000002R052543", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052544", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052545", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052546", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052547", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.TilemapImpactFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapImpactFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052548", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052549", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052550", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052551", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052552", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052553", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052554", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052555", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052556", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052557", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052558", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052559", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052560", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052561", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052562", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052563", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052564", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052565", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052566", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052567", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052568", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052569", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052570", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052571", "___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": 378, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcess", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#onProcess", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcess", "inherited": true, "___id": "T000002R052572", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052573", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052574", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052575", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052576", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.TilemapJSONFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.TilemapJSONFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052577", "___s": true }, { "comment": "/**\r\n * A reference to the Loader that is going to load this file.\r\n *\r\n * @name Phaser.Loader.MultiFile#loader\r\n * @type {Phaser.Loader.LoaderPlugin}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#loader", "inherited": true, "___id": "T000002R052578", "___s": true }, { "comment": "/**\r\n * The file type string for sorting within the Loader.\r\n *\r\n * @name Phaser.Loader.MultiFile#type\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#type", "kind": "member", "description": "The file type string for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#type", "inherited": true, "___id": "T000002R052579", "___s": true }, { "comment": "/**\r\n * Unique cache key (unique within its file type)\r\n *\r\n * @name Phaser.Loader.MultiFile#key\r\n * @type {string}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#key", "inherited": true, "___id": "T000002R052580", "___s": true }, { "comment": "/**\r\n * Array of files that make up this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#files\r\n * @type {Phaser.Loader.File[]}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "files", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#files", "kind": "member", "description": "Array of files that make up this MultiFile.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Loader.File", "type": "NameExpression" } ] } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#files", "inherited": true, "___id": "T000002R052582", "___s": true }, { "comment": "/**\r\n * The current state of the file. One of the FILE_CONST values.\r\n *\r\n * @name Phaser.Loader.MultiFile#state\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#state", "inherited": true, "___id": "T000002R052583", "___s": true }, { "comment": "/**\r\n * The completion status of this MultiFile.\r\n *\r\n * @name Phaser.Loader.MultiFile#complete\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "complete", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#complete", "kind": "member", "description": "The completion status of this MultiFile.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#complete", "inherited": true, "___id": "T000002R052584", "___s": true }, { "comment": "/**\r\n * The number of files to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#pending\r\n * @type {number}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pending", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#pending", "kind": "member", "description": "The number of files to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pending", "inherited": true, "___id": "T000002R052585", "___s": true }, { "comment": "/**\r\n * The number of files that failed to load.\r\n *\r\n * @name Phaser.Loader.MultiFile#failed\r\n * @type {number}\r\n * @default 0\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "failed", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#failed", "kind": "member", "description": "The number of files that failed to load.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#failed", "inherited": true, "___id": "T000002R052586", "___s": true }, { "comment": "/**\r\n * A storage container for transient data that the loading files need.\r\n *\r\n * @name Phaser.Loader.MultiFile#config\r\n * @type {any}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#config", "kind": "member", "description": "A storage container for transient data that the loading files need.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#config", "inherited": true, "___id": "T000002R052587", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders baseURL at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#baseURL\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "baseURL", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#baseURL", "kind": "member", "description": "A reference to the Loaders baseURL at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#baseURL", "inherited": true, "___id": "T000002R052588", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders path at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#path\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "path", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#path", "kind": "member", "description": "A reference to the Loaders path at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#path", "inherited": true, "___id": "T000002R052589", "___s": true }, { "comment": "/**\r\n * A reference to the Loaders prefix at the time this MultiFile was created.\r\n * Used to populate child-files.\r\n *\r\n * @name Phaser.Loader.MultiFile#prefix\r\n * @type {string}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "prefix", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#prefix", "kind": "member", "description": "A reference to the Loaders prefix at the time this MultiFile was created.\rUsed to populate child-files.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#prefix", "inherited": true, "___id": "T000002R052590", "___s": true }, { "comment": "/**\r\n * Checks if this MultiFile is ready to process its children or not.\r\n *\r\n * @method Phaser.Loader.MultiFile#isReadyToProcess\r\n * @since 3.7.0\r\n *\r\n * @return {boolean} `true` if all children of this MultiFile have loaded, otherwise `false`.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "isReadyToProcess", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#isReadyToProcess", "kind": "function", "description": "Checks if this MultiFile is ready to process its children or not.", "since": "3.7.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if all children of this MultiFile have loaded, otherwise `false`." } ], "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#isReadyToProcess", "inherited": true, "___id": "T000002R052591", "___s": true }, { "comment": "/**\r\n * Adds another child to this MultiFile, increases the pending count and resets the completion status.\r\n *\r\n * @method Phaser.Loader.MultiFile#addToMultiFile\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} files - The File to add to this MultiFile.\r\n *\r\n * @return {Phaser.Loader.MultiFile} This MultiFile instance.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToMultiFile", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#addToMultiFile", "kind": "function", "description": "Adds another child to this MultiFile, increases the pending count and resets the completion status.", "since": "3.7.0", "returns": [ { "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile" } }, "description": "This MultiFile instance." } ], "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File to add to this MultiFile.", "name": "files" } ], "inherits": "Phaser.Loader.MultiFile#addToMultiFile", "inherited": true, "___id": "T000002R052592", "___s": true }, { "comment": "/**\r\n * Called by each File when it finishes loading.\r\n *\r\n * @method Phaser.Loader.MultiFile#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": "MultiFile.js", "lineno": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileComplete", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#onFileComplete", "kind": "function", "description": "Called by each File when it finishes loading.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has completed processing.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileComplete", "inherited": true, "___id": "T000002R052593", "___s": true }, { "comment": "/**\r\n * Called by each File that fails to load.\r\n *\r\n * @method Phaser.Loader.MultiFile#onFileFailed\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File that has failed to load.\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onFileFailed", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#onFileFailed", "kind": "function", "description": "Called by each File that fails to load.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has failed to load.", "name": "file" } ], "inherits": "Phaser.Loader.MultiFile#onFileFailed", "inherited": true, "___id": "T000002R052594", "___s": true }, { "comment": "/**\r\n * Called once all children of this multi file have been added to their caches and is now\r\n * ready for deletion from the Loader.\r\n *\r\n * It will emit a `filecomplete` event from the LoaderPlugin.\r\n *\r\n * @method Phaser.Loader.MultiFile#pendingDestroy\r\n * @fires Phaser.Loader.Events#FILE_COMPLETE\r\n * @fires Phaser.Loader.Events#FILE_KEY_COMPLETE\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#pendingDestroy", "kind": "function", "description": "Called once all children of this multi file have been added to their caches and is now\rready for deletion from the Loader.\r\rIt will emit a `filecomplete` event from the LoaderPlugin.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#pendingDestroy", "inherited": true, "___id": "T000002R052595", "___s": true }, { "comment": "/**\r\n * Destroy this Multi File and any references it holds.\r\n *\r\n * @method Phaser.Loader.MultiFile#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "MultiFile.js", "lineno": 285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.UnityAtlasFile#destroy", "kind": "function", "description": "Destroy this Multi File and any references it holds.", "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.UnityAtlasFile", "scope": "instance", "inherits": "Phaser.Loader.MultiFile#destroy", "inherited": true, "___id": "T000002R052596", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.VideoFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052597", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.VideoFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052598", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.VideoFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052599", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.VideoFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052600", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.VideoFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052601", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.VideoFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052602", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.VideoFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052603", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.VideoFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052604", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.VideoFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052605", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.VideoFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052606", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.VideoFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052607", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.VideoFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052608", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.VideoFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052609", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.VideoFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052610", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.VideoFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052611", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.VideoFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052612", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.VideoFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052613", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.VideoFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052614", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.VideoFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052615", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.VideoFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052616", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.VideoFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052617", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.VideoFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052618", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.VideoFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052619", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.VideoFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052620", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.VideoFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052621", "___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": 448, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToCache", "longname": "Phaser.Loader.FileTypes.VideoFile#addToCache", "kind": "function", "description": "Adds this file to its target cache upon successful loading and processing.\rThis method is often overridden by specific file types.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#addToCache", "inherited": true, "___id": "T000002R052622", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.VideoFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052623", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.VideoFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.VideoFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052624", "___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": 35, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "loader", "longname": "Phaser.Loader.FileTypes.XMLFile#loader", "kind": "member", "description": "A reference to the Loader that is going to load this file.", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#loader", "inherited": true, "___id": "T000002R052625", "___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": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "cache", "longname": "Phaser.Loader.FileTypes.XMLFile#cache", "kind": "member", "description": "A reference to the Cache, or Texture Manager, that is going to store this file if it loads.", "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.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#cache", "inherited": true, "___id": "T000002R052626", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "type", "longname": "Phaser.Loader.FileTypes.XMLFile#type", "kind": "member", "description": "The file type string (image, json, etc) for sorting within the Loader.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#type", "inherited": true, "___id": "T000002R052627", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "key", "longname": "Phaser.Loader.FileTypes.XMLFile#key", "kind": "member", "description": "Unique cache key (unique within its file type)", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#key", "inherited": true, "___id": "T000002R052628", "___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": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "url", "longname": "Phaser.Loader.FileTypes.XMLFile#url", "kind": "member", "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.", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#url", "inherited": true, "___id": "T000002R052629", "___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": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "src", "longname": "Phaser.Loader.FileTypes.XMLFile#src", "kind": "member", "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#src", "inherited": true, "___id": "T000002R052630", "___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": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrSettings", "longname": "Phaser.Loader.FileTypes.XMLFile#xhrSettings", "kind": "member", "description": "The merged XHRSettings for this file.", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrSettings", "inherited": true, "___id": "T000002R052631", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "xhrLoader", "longname": "Phaser.Loader.FileTypes.XMLFile#xhrLoader", "kind": "member", "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#xhrLoader", "inherited": true, "___id": "T000002R052632", "___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": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "state", "longname": "Phaser.Loader.FileTypes.XMLFile#state", "kind": "member", "description": "The current state of the file. One of the FILE_CONST values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#state", "inherited": true, "___id": "T000002R052633", "___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": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesTotal", "longname": "Phaser.Loader.FileTypes.XMLFile#bytesTotal", "kind": "member", "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesTotal", "inherited": true, "___id": "T000002R052634", "___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": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "bytesLoaded", "longname": "Phaser.Loader.FileTypes.XMLFile#bytesLoaded", "kind": "member", "description": "Updated as the file loads.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#bytesLoaded", "inherited": true, "___id": "T000002R052635", "___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": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "percentComplete", "longname": "Phaser.Loader.FileTypes.XMLFile#percentComplete", "kind": "member", "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#percentComplete", "inherited": true, "___id": "T000002R052636", "___s": true }, { "comment": "/**\r\n * For CORs based loading.\r\n * If this is undefined then the File will check BaseLoader.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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "crossOrigin", "longname": "Phaser.Loader.FileTypes.XMLFile#crossOrigin", "kind": "member", "description": "For CORs based loading.\rIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#crossOrigin", "inherited": true, "___id": "T000002R052637", "___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": 197, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "data", "longname": "Phaser.Loader.FileTypes.XMLFile#data", "kind": "member", "description": "The processed file data, stored here after the file has loaded.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#data", "inherited": true, "___id": "T000002R052638", "___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": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "config", "longname": "Phaser.Loader.FileTypes.XMLFile#config", "kind": "member", "description": "A config object that can be used by file types to store transitional data.", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#config", "inherited": true, "___id": "T000002R052639", "___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": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "multiFile", "longname": "Phaser.Loader.FileTypes.XMLFile#multiFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#multiFile", "inherited": true, "___id": "T000002R052640", "___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": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "linkFile", "longname": "Phaser.Loader.FileTypes.XMLFile#linkFile", "kind": "member", "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.", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#linkFile", "inherited": true, "___id": "T000002R052641", "___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": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "setLink", "longname": "Phaser.Loader.FileTypes.XMLFile#setLink", "kind": "function", "description": "Links this File with another, so they depend upon each other for loading and processing.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "inherits": "Phaser.Loader.File#setLink", "inherited": true, "___id": "T000002R052642", "___s": true }, { "comment": "/**\r\n * Resets the XHRLoader instance this file is using.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "resetXHR", "longname": "Phaser.Loader.FileTypes.XMLFile#resetXHR", "kind": "function", "description": "Resets the XHRLoader instance this file is using.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#resetXHR", "inherited": true, "___id": "T000002R052643", "___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": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "load", "longname": "Phaser.Loader.FileTypes.XMLFile#load", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#load", "inherited": true, "___id": "T000002R052644", "___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": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onLoad", "longname": "Phaser.Loader.FileTypes.XMLFile#onLoad", "kind": "function", "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "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" } ], "inherits": "Phaser.Loader.File#onLoad", "inherited": true, "___id": "T000002R052645", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading, is sent a DOM ProgressEvent.\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 onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 340, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onError", "longname": "Phaser.Loader.FileTypes.XMLFile#onError", "kind": "function", "description": "Called if the file errors while loading, is sent a DOM ProgressEvent.", "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "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 error.", "name": "event" } ], "inherits": "Phaser.Loader.File#onError", "inherited": true, "___id": "T000002R052646", "___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": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProgress", "longname": "Phaser.Loader.FileTypes.XMLFile#onProgress", "kind": "function", "description": "Called during the file load progress. Is sent a DOM ProgressEvent.", "fires": [ "Phaser.Loader.Events#event:FILE_PROGRESS" ], "since": "3.0.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "params": [ { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "inherits": "Phaser.Loader.File#onProgress", "inherited": true, "___id": "T000002R052647", "___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": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessComplete", "longname": "Phaser.Loader.FileTypes.XMLFile#onProcessComplete", "kind": "function", "description": "Called when the File has completed processing.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessComplete", "inherited": true, "___id": "T000002R052648", "___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": 411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "onProcessError", "longname": "Phaser.Loader.FileTypes.XMLFile#onProcessError", "kind": "function", "description": "Called when the File has completed processing but it generated an error.\rChecks on the state of its multifile, if set.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#onProcessError", "inherited": true, "___id": "T000002R052649", "___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": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "hasCacheConflict", "longname": "Phaser.Loader.FileTypes.XMLFile#hasCacheConflict", "kind": "function", "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.", "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.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#hasCacheConflict", "inherited": true, "___id": "T000002R052650", "___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": 448, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "addToCache", "longname": "Phaser.Loader.FileTypes.XMLFile#addToCache", "kind": "function", "description": "Adds this file to its target cache upon successful loading and processing.\rThis method is often overridden by specific file types.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#addToCache", "inherited": true, "___id": "T000002R052651", "___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": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "pendingDestroy", "longname": "Phaser.Loader.FileTypes.XMLFile#pendingDestroy", "kind": "function", "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.", "fires": [ "Phaser.Loader.Events#event:FILE_COMPLETE", "Phaser.Loader.Events#event:FILE_KEY_COMPLETE" ], "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#pendingDestroy", "inherited": true, "___id": "T000002R052652", "___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": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "name": "destroy", "longname": "Phaser.Loader.FileTypes.XMLFile#destroy", "kind": "function", "description": "Destroy this File and any references it holds.", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.XMLFile", "scope": "instance", "inherits": "Phaser.Loader.File#destroy", "inherited": true, "___id": "T000002R052653", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Loader.LoaderPlugin#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Loader.LoaderPlugin", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R052654", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Loader.LoaderPlugin#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Loader.LoaderPlugin", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R052655", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Loader.LoaderPlugin#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Loader.LoaderPlugin", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R052656", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Loader.LoaderPlugin#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Loader.LoaderPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R052657", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Loader.LoaderPlugin#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Loader.LoaderPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R052658", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Loader.LoaderPlugin#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Loader.LoaderPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R052659", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Loader.LoaderPlugin#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Loader.LoaderPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R052660", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Loader.LoaderPlugin#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Loader.LoaderPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R052661", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Loader.LoaderPlugin#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Loader.LoaderPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R052662", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Loader.LoaderPlugin#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Loader.LoaderPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R052663", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.FacebookInstantGamesPlugin#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.FacebookInstantGamesPlugin", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R052664", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.FacebookInstantGamesPlugin#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.FacebookInstantGamesPlugin", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R052665", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.FacebookInstantGamesPlugin#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R052666", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.FacebookInstantGamesPlugin#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R052667", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.FacebookInstantGamesPlugin#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R052668", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.FacebookInstantGamesPlugin#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R052669", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.FacebookInstantGamesPlugin#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R052670", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.FacebookInstantGamesPlugin#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R052671", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.FacebookInstantGamesPlugin#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R052672", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.FacebookInstantGamesPlugin#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R052673", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.FacebookInstantGamesPlugin#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.FacebookInstantGamesPlugin", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R052674", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.Physics.Arcade.Image#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R052678", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.Physics.Arcade.Image#displayList", "kind": "member", "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.", "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R052679", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.Physics.Arcade.Image#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R052680", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.Physics.Arcade.Image#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R052681", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.Physics.Arcade.Image#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R052682", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.Physics.Arcade.Image#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R052683", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.Physics.Arcade.Image#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R052684", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.Physics.Arcade.Image#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R052685", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.Physics.Arcade.Image#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R052686", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.Physics.Arcade.Image#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R052687", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.Physics.Arcade.Image#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R052688", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.Physics.Arcade.Image#input", "kind": "member", "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()`.", "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R052689", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.Physics.Arcade.Image#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R052690", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.Physics.Arcade.Image#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R052691", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.Physics.Arcade.Image#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R052692", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.Physics.Arcade.Image#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R052693", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.Physics.Arcade.Image#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "since": "3.0.0", "see": [ "Phaser.Data.DataManager" ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R052694", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.Physics.Arcade.Image#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R052695", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.Physics.Arcade.Image#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R052696", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.Physics.Arcade.Image#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R052697", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.Physics.Arcade.Image#getData", "kind": "function", "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.", "since": "3.0.0", "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R052698", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.Physics.Arcade.Image#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R052699", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.Physics.Arcade.Image#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R052700", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.Physics.Arcade.Image#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R052701", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.Physics.Arcade.Image#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R052702", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.Physics.Arcade.Image#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R052703", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.Physics.Arcade.Image#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R052704", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.Physics.Arcade.Image#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R052705", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.Physics.Arcade.Image#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R052706", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.Physics.Arcade.Image#getIndexList", "kind": "function", "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.", "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R052707", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.Physics.Arcade.Image#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R052708", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.Physics.Arcade.Image#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R052709", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.Physics.Arcade.Image#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R052710", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.Physics.Arcade.Image#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R052711", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.Physics.Arcade.Image#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R052712", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Physics.Arcade.Image#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R052713", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Physics.Arcade.Image#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R052714", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Physics.Arcade.Image#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R052715", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Physics.Arcade.Image#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R052716", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Physics.Arcade.Image#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R052717", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Physics.Arcade.Image#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R052718", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Physics.Arcade.Image#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R052719", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Physics.Arcade.Image#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R052720", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Physics.Arcade.Image#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R052721", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Physics.Arcade.Image#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R052722", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Physics.Arcade.Image#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R052723", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.Physics.Arcade.Image#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#clearAlpha", "___id": "T000002R052729", "___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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.Physics.Arcade.Image#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#setAlpha", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Alpha#setAlpha", "___id": "T000002R052730", "___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 *\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.Physics.Arcade.Image#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alpha", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alpha", "___id": "T000002R052731", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.Physics.Arcade.Image#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "___id": "T000002R052732", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.Physics.Arcade.Image#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "___id": "T000002R052733", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.Physics.Arcade.Image#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "___id": "T000002R052734", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.Physics.Arcade.Image#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "___id": "T000002R052735", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.Physics.Arcade.Image#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "overrides": "Phaser.GameObjects.Components.BlendMode#blendMode", "___id": "T000002R052737", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.Physics.Arcade.Image#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "___id": "T000002R052738", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.Physics.Arcade.Image#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "overrides": "Phaser.GameObjects.Components.Depth#depth", "___id": "T000002R052740", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.Physics.Arcade.Image#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Depth#setDepth", "___id": "T000002R052741", "___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.Components.Flip#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipX", "longname": "Phaser.Physics.Arcade.Image#flipX", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#flipX", "___id": "T000002R052742", "___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.Components.Flip#flipY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipY", "longname": "Phaser.Physics.Arcade.Image#flipY", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#flipY", "___id": "T000002R052743", "___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 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 * @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": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipX", "longname": "Phaser.Physics.Arcade.Image#toggleFlipX", "kind": "function", "description": "Toggles the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#toggleFlipX", "___id": "T000002R052744", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipY", "longname": "Phaser.Physics.Arcade.Image#toggleFlipY", "kind": "function", "description": "Toggles the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#toggleFlipY", "___id": "T000002R052745", "___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 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 * @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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipX", "longname": "Phaser.Physics.Arcade.Image#setFlipX", "kind": "function", "description": "Sets the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlipX", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Flip#setFlipX", "___id": "T000002R052746", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\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": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipY", "longname": "Phaser.Physics.Arcade.Image#setFlipY", "kind": "function", "description": "Sets the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlipY", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Flip#setFlipY", "___id": "T000002R052747", "___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 inversed 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 horizontal 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": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlip", "longname": "Phaser.Physics.Arcade.Image#setFlip", "kind": "function", "description": "Sets the horizontal and vertical flipped state of this Game Object.\r\rA Game Object that is flipped will render inversed 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlip", "inherited": true, "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 horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "overrides": "Phaser.GameObjects.Components.Flip#setFlip", "___id": "T000002R052748", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetFlip", "longname": "Phaser.Physics.Arcade.Image#resetFlip", "kind": "function", "description": "Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#resetFlip", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#resetFlip", "___id": "T000002R052749", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.Physics.Arcade.Image#getCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getCenter", "___id": "T000002R052751", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.Physics.Arcade.Image#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "___id": "T000002R052752", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.Physics.Arcade.Image#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "___id": "T000002R052753", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.Physics.Arcade.Image#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getTopRight", "___id": "T000002R052754", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.Physics.Arcade.Image#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "___id": "T000002R052755", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.Physics.Arcade.Image#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "___id": "T000002R052756", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.Physics.Arcade.Image#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "___id": "T000002R052757", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.Physics.Arcade.Image#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "___id": "T000002R052758", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.Physics.Arcade.Image#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "___id": "T000002R052759", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.Physics.Arcade.Image#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getBounds", "___id": "T000002R052760", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.Physics.Arcade.Image#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "overrides": "Phaser.GameObjects.Components.Mask#mask", "___id": "T000002R052761", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.Physics.Arcade.Image#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "overrides": "Phaser.GameObjects.Components.Mask#setMask", "___id": "T000002R052762", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.Physics.Arcade.Image#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "overrides": "Phaser.GameObjects.Components.Mask#clearMask", "___id": "T000002R052763", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.Physics.Arcade.Image#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "overrides": "Phaser.GameObjects.Components.Mask#createBitmapMask", "___id": "T000002R052764", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.Physics.Arcade.Image#createGeometryMask", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } }, "description": "This Geometry Mask that was created." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Mask#createGeometryMask", "___id": "T000002R052765", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.Physics.Arcade.Image#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#originX", "___id": "T000002R052767", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.Physics.Arcade.Image#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#originY", "___id": "T000002R052768", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.Physics.Arcade.Image#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#displayOriginX", "___id": "T000002R052769", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.Physics.Arcade.Image#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#displayOriginY", "___id": "T000002R052770", "___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": {} }, "name": "setOrigin", "longname": "Phaser.Physics.Arcade.Image#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Origin#setOrigin", "___id": "T000002R052771", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.Physics.Arcade.Image#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "___id": "T000002R052772", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.Physics.Arcade.Image#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "___id": "T000002R052773", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.Physics.Arcade.Image#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "___id": "T000002R052774", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.Physics.Arcade.Image#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "overrides": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "___id": "T000002R052775", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.Physics.Arcade.Image#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "overrides": "Phaser.GameObjects.Components.Pipeline#pipeline", "___id": "T000002R052776", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.Physics.Arcade.Image#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "overrides": "Phaser.GameObjects.Components.Pipeline#pipelineData", "___id": "T000002R052777", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.Physics.Arcade.Image#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "overrides": "Phaser.GameObjects.Components.Pipeline#initPipeline", "___id": "T000002R052778", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.Physics.Arcade.Image#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "overrides": "Phaser.GameObjects.Components.Pipeline#setPipeline", "___id": "T000002R052779", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.Physics.Arcade.Image#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "___id": "T000002R052780", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.Physics.Arcade.Image#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "overrides": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "___id": "T000002R052781", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.Physics.Arcade.Image#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "overrides": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "___id": "T000002R052782", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.Physics.Arcade.Image#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "___id": "T000002R052783", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.Physics.Arcade.Image#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "___id": "T000002R052784", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.Physics.Arcade.Image#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "___id": "T000002R052785", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.Physics.Arcade.Image#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#preFX", "___id": "T000002R052786", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.Physics.Arcade.Image#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#postFX", "___id": "T000002R052787", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.Physics.Arcade.Image#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "___id": "T000002R052788", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.Physics.Arcade.Image#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "___id": "T000002R052789", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.Physics.Arcade.Image#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "___id": "T000002R052790", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.Physics.Arcade.Image#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "___id": "T000002R052791", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.Physics.Arcade.Image#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "___id": "T000002R052792", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.Physics.Arcade.Image#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "___id": "T000002R052793", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.Physics.Arcade.Image#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#clearFX", "___id": "T000002R052794", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.Physics.Arcade.Image#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "overrides": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "___id": "T000002R052795", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.Physics.Arcade.Image#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "overrides": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "___id": "T000002R052796", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.Physics.Arcade.Image#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "___id": "T000002R052797", "___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": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.Physics.Arcade.Image#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#width", "inherited": true, "overrides": "Phaser.GameObjects.Components.Size#width", "___id": "T000002R052799", "___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": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.Physics.Arcade.Image#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#height", "inherited": true, "overrides": "Phaser.GameObjects.Components.Size#height", "___id": "T000002R052800", "___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": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.Physics.Arcade.Image#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayWidth", "inherited": true, "overrides": "Phaser.GameObjects.Components.Size#displayWidth", "___id": "T000002R052801", "___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": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.Physics.Arcade.Image#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayHeight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Size#displayHeight", "___id": "T000002R052802", "___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": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSizeToFrame", "longname": "Phaser.Physics.Arcade.Image#setSizeToFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setSizeToFrame", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Size#setSizeToFrame", "___id": "T000002R052803", "___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": 139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.Physics.Arcade.Image#setSize", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setSize", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Size#setSize", "___id": "T000002R052804", "___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.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": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.Physics.Arcade.Image#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setDisplaySize", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Size#setDisplaySize", "___id": "T000002R052805", "___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": {} }, "name": "texture", "longname": "Phaser.Physics.Arcade.Image#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#texture", "inherited": true, "overrides": "Phaser.GameObjects.Components.Texture#texture", "___id": "T000002R052806", "___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": {} }, "name": "frame", "longname": "Phaser.Physics.Arcade.Image#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#frame", "inherited": true, "overrides": "Phaser.GameObjects.Components.Texture#frame", "___id": "T000002R052807", "___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": {} }, "name": "isCropped", "longname": "Phaser.Physics.Arcade.Image#isCropped", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.11.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#isCropped", "inherited": true, "overrides": "Phaser.GameObjects.Components.Texture#isCropped", "___id": "T000002R052808", "___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 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 rect 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. 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.\r\n * @param {number} [width] - The width of the crop rectangle in pixels.\r\n * @param {number} [height] - The height of the crop rectangle in pixels.\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": {} }, "name": "setCrop", "longname": "Phaser.Physics.Arcade.Image#setCrop", "kind": "function", "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 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 rect 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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setCrop", "inherited": true, "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. 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.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the crop rectangle in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the crop rectangle in pixels.", "name": "height" } ], "___id": "T000002R052809", "___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": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.Physics.Arcade.Image#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setTexture", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Texture#setTexture", "___id": "T000002R052810", "___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": 128, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.Physics.Arcade.Image#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setFrame", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Texture#setFrame", "___id": "T000002R052811", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertice 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": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopLeft", "longname": "Phaser.Physics.Arcade.Image#tintTopLeft", "kind": "member", "description": "The tint value being applied to the top-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopLeft", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintTopLeft", "___id": "T000002R052813", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-right vertice 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopRight", "longname": "Phaser.Physics.Arcade.Image#tintTopRight", "kind": "member", "description": "The tint value being applied to the top-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopRight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintTopRight", "___id": "T000002R052814", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-left vertice 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": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomLeft", "longname": "Phaser.Physics.Arcade.Image#tintBottomLeft", "kind": "member", "description": "The tint value being applied to the bottom-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "___id": "T000002R052815", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-right vertice 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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomRight", "longname": "Phaser.Physics.Arcade.Image#tintBottomRight", "kind": "member", "description": "The tint value being applied to the bottom-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomRight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintBottomRight", "___id": "T000002R052816", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintFill", "longname": "Phaser.Physics.Arcade.Image#tintFill", "kind": "member", "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.11.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintFill", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintFill", "___id": "T000002R052817", "___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 'additive',\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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearTint", "longname": "Phaser.Physics.Arcade.Image#clearTint", "kind": "function", "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff and the tint type to 'additive',\rwhich results in no visible change to the texture.", "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#clearTint", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#clearTint", "___id": "T000002R052818", "___s": true }, { "comment": "/**\r\n * Sets an additive tint 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 * multiplying it by 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 * To swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.\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": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTint", "longname": "Phaser.Physics.Arcade.Image#setTint", "kind": "function", "description": "Sets an additive tint on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by 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\rTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.", "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#setTint", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Tint#setTint", "___id": "T000002R052819", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on this Game Object.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. You can provide either one color value, in which case the whole\r\n * Game Object will be rendered in that color. Or you can provide a color per corner. The colors\r\n * 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 * To swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintFill\r\n * @webglOnly\r\n * @since 3.11.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.\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": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTintFill", "longname": "Phaser.Physics.Arcade.Image#setTintFill", "kind": "function", "description": "Sets a fill-based tint on this Game Object.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. You can provide either one color value, in which case the whole\rGame Object will be rendered in that color. Or you can provide a color per corner. The colors\rare 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\rTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#setTintFill", "inherited": true, "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 not 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" } ], "overrides": "Phaser.GameObjects.Components.Tint#setTintFill", "___id": "T000002R052820", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.\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": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tint", "longname": "Phaser.Physics.Arcade.Image#tint", "kind": "member", "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tint", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tint", "___id": "T000002R052821", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * It checks to see if the 4 tint properties are set to the value 0xffffff\r\n * and that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.\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": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isTinted", "longname": "Phaser.Physics.Arcade.Image#isTinted", "kind": "member", "description": "Does this Game Object have a tint applied?\r\rIt checks to see if the 4 tint properties are set to the value 0xffffff\rand that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "readonly": true, "since": "3.11.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#isTinted", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#isTinted", "___id": "T000002R052822", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.Physics.Arcade.Image#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "___id": "T000002R052823", "___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": {} }, "name": "x", "longname": "Phaser.Physics.Arcade.Image#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#x", "___id": "T000002R052827", "___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": {} }, "name": "y", "longname": "Phaser.Physics.Arcade.Image#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#y", "___id": "T000002R052828", "___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": {} }, "name": "z", "longname": "Phaser.Physics.Arcade.Image#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#z", "___id": "T000002R052829", "___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": {} }, "name": "w", "longname": "Phaser.Physics.Arcade.Image#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#w", "___id": "T000002R052830", "___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": {} }, "name": "scale", "longname": "Phaser.Physics.Arcade.Image#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#scale", "___id": "T000002R052831", "___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": {} }, "name": "scaleX", "longname": "Phaser.Physics.Arcade.Image#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#scaleX", "___id": "T000002R052832", "___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": {} }, "name": "scaleY", "longname": "Phaser.Physics.Arcade.Image#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#scaleY", "___id": "T000002R052833", "___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": {} }, "name": "angle", "longname": "Phaser.Physics.Arcade.Image#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#angle", "___id": "T000002R052834", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.Physics.Arcade.Image#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#rotation", "___id": "T000002R052835", "___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": {} }, "name": "setPosition", "longname": "Phaser.Physics.Arcade.Image#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#setPosition", "___id": "T000002R052836", "___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": {} }, "name": "copyPosition", "longname": "Phaser.Physics.Arcade.Image#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#copyPosition", "___id": "T000002R052837", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.Physics.Arcade.Image#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#setRandomPosition", "___id": "T000002R052838", "___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": {} }, "name": "setRotation", "longname": "Phaser.Physics.Arcade.Image#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "overrides": "Phaser.GameObjects.Components.Transform#setRotation", "___id": "T000002R052839", "___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": {} }, "name": "setAngle", "longname": "Phaser.Physics.Arcade.Image#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "overrides": "Phaser.GameObjects.Components.Transform#setAngle", "___id": "T000002R052840", "___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": {} }, "name": "setScale", "longname": "Phaser.Physics.Arcade.Image#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#setScale", "___id": "T000002R052841", "___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": {} }, "name": "setX", "longname": "Phaser.Physics.Arcade.Image#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Transform#setX", "___id": "T000002R052842", "___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": {} }, "name": "setY", "longname": "Phaser.Physics.Arcade.Image#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Transform#setY", "___id": "T000002R052843", "___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": {} }, "name": "setZ", "longname": "Phaser.Physics.Arcade.Image#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Transform#setZ", "___id": "T000002R052844", "___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": {} }, "name": "setW", "longname": "Phaser.Physics.Arcade.Image#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Transform#setW", "___id": "T000002R052845", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.Physics.Arcade.Image#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "___id": "T000002R052846", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.Physics.Arcade.Image#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "___id": "T000002R052847", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.Physics.Arcade.Image#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#getLocalPoint", "___id": "T000002R052848", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.Physics.Arcade.Image#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#getParentRotation", "___id": "T000002R052849", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.Physics.Arcade.Image#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "overrides": "Phaser.GameObjects.Components.Visible#visible", "___id": "T000002R052851", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.Physics.Arcade.Image#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Visible#setVisible", "___id": "T000002R052852", "___s": true }, { "comment": "/**\r\n * Sets the body's horizontal and vertical acceleration. If the vertical acceleration value is not provided, the vertical acceleration is set to the same value as the horizontal acceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Acceleration#setAcceleration\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal acceleration\r\n * @param {number} [y=x] - The vertical acceleration\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Acceleration.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setAcceleration", "longname": "Phaser.Physics.Arcade.Image#setAcceleration", "kind": "function", "description": "Sets the body's horizontal and vertical acceleration. If the vertical acceleration value is not provided, the vertical acceleration is set to the same value as the horizontal acceleration.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal acceleration", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical acceleration", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Acceleration#setAcceleration", "inherited": true, "___id": "T000002R052853", "___s": true }, { "comment": "/**\r\n * Sets the body's horizontal acceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Acceleration#setAccelerationX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The horizontal acceleration\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Acceleration.js", "lineno": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setAccelerationX", "longname": "Phaser.Physics.Arcade.Image#setAccelerationX", "kind": "function", "description": "Sets the body's horizontal acceleration.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal acceleration", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Acceleration#setAccelerationX", "inherited": true, "___id": "T000002R052854", "___s": true }, { "comment": "/**\r\n * Sets the body's vertical acceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Acceleration#setAccelerationY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The vertical acceleration\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Acceleration.js", "lineno": 50, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setAccelerationY", "longname": "Phaser.Physics.Arcade.Image#setAccelerationY", "kind": "function", "description": "Sets the body's vertical acceleration.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical acceleration", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Acceleration#setAccelerationY", "inherited": true, "___id": "T000002R052855", "___s": true }, { "comment": "/**\r\n * Sets the angular velocity of the body.\r\n *\r\n * In Arcade Physics, bodies cannot rotate. They are always axis-aligned.\r\n * However, they can have angular motion, which is passed on to the Game Object bound to the body,\r\n * causing them to visually rotate, even though the body remains axis-aligned.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Angular#setAngularVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of angular velocity.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Angular.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setAngularVelocity", "longname": "Phaser.Physics.Arcade.Image#setAngularVelocity", "kind": "function", "description": "Sets the angular velocity of the body.\r\rIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\rHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\rcausing them to visually rotate, even though the body remains axis-aligned.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of angular velocity.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Angular#setAngularVelocity", "inherited": true, "___id": "T000002R052856", "___s": true }, { "comment": "/**\r\n * Sets the angular acceleration of the body.\r\n *\r\n * In Arcade Physics, bodies cannot rotate. They are always axis-aligned.\r\n * However, they can have angular motion, which is passed on to the Game Object bound to the body,\r\n * causing them to visually rotate, even though the body remains axis-aligned.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Angular#setAngularAcceleration\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of angular acceleration.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Angular.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setAngularAcceleration", "longname": "Phaser.Physics.Arcade.Image#setAngularAcceleration", "kind": "function", "description": "Sets the angular acceleration of the body.\r\rIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\rHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\rcausing them to visually rotate, even though the body remains axis-aligned.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of angular acceleration.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Angular#setAngularAcceleration", "inherited": true, "___id": "T000002R052857", "___s": true }, { "comment": "/**\r\n * Sets the angular drag of the body. Drag is applied to the current velocity, providing a form of deceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Angular#setAngularDrag\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of drag.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Angular.js", "lineno": 57, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setAngularDrag", "longname": "Phaser.Physics.Arcade.Image#setAngularDrag", "kind": "function", "description": "Sets the angular drag of the body. Drag is applied to the current velocity, providing a form of deceleration.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of drag.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Angular#setAngularDrag", "inherited": true, "___id": "T000002R052858", "___s": true }, { "comment": "/**\r\n * Sets the bounce values of this body.\r\n *\r\n * Bounce is the amount of restitution, or elasticity, the body has when it collides with another object.\r\n * A value of 1 means that it will retain its full velocity after the rebound. A value of 0 means it will not rebound at all.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Bounce#setBounce\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.\r\n * @param {number} [y=x] - The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Bounce.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setBounce", "longname": "Phaser.Physics.Arcade.Image#setBounce", "kind": "function", "description": "Sets the bounce values of this body.\r\rBounce is the amount of restitution, or elasticity, the body has when it collides with another object.\rA value of 1 means that it will retain its full velocity after the rebound. A value of 0 means it will not rebound at all.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Bounce#setBounce", "inherited": true, "___id": "T000002R052859", "___s": true }, { "comment": "/**\r\n * Sets the horizontal bounce value for this body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Bounce#setBounceX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Bounce.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setBounceX", "longname": "Phaser.Physics.Arcade.Image#setBounceX", "kind": "function", "description": "Sets the horizontal bounce value for this body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Bounce#setBounceX", "inherited": true, "___id": "T000002R052860", "___s": true }, { "comment": "/**\r\n * Sets the vertical bounce value for this body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Bounce#setBounceY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Bounce.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setBounceY", "longname": "Phaser.Physics.Arcade.Image#setBounceY", "kind": "function", "description": "Sets the vertical bounce value for this body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Bounce#setBounceY", "inherited": true, "___id": "T000002R052861", "___s": true }, { "comment": "/**\r\n * Sets whether this Body collides with the world boundary.\r\n *\r\n * Optionally also sets the World Bounce values. If the `Body.worldBounce` is null, it's set to a new Phaser.Math.Vector2 first.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Bounce#setCollideWorldBounds\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [value=true] - `true` if this body should collide with the world bounds, otherwise `false`.\r\n * @param {number} [bounceX] - If given this will be replace the `worldBounce.x` value.\r\n * @param {number} [bounceY] - If given this will be replace the `worldBounce.y` value.\r\n * @param {boolean} [onWorldBounds] - If given this replaces the Body's `onWorldBounds` value.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Bounce.js", "lineno": 70, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCollideWorldBounds", "longname": "Phaser.Physics.Arcade.Image#setCollideWorldBounds", "kind": "function", "description": "Sets whether this Body collides with the world boundary.\r\rOptionally also sets the World Bounce values. If the `Body.worldBounce` is null, it's set to a new Phaser.Math.Vector2 first.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if this body should collide with the world bounds, otherwise `false`.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If given this will be replace the `worldBounce.x` value.", "name": "bounceX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If given this will be replace the `worldBounce.y` value.", "name": "bounceY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If given this replaces the Body's `onWorldBounds` value.", "name": "onWorldBounds" } ], "inherits": "Phaser.Physics.Arcade.Components.Bounce#setCollideWorldBounds", "inherited": true, "___id": "T000002R052862", "___s": true }, { "comment": "/**\r\n * Sets the Collision Category that this Arcade Physics Body\r\n * will use in order to determine what it can collide with.\r\n *\r\n * It can only have one single category assigned to it.\r\n *\r\n * If you wish to reset the collision category and mask, call\r\n * the `resetCollisionCategory` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#setCollisionCategory\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCollisionCategory", "longname": "Phaser.Physics.Arcade.Image#setCollisionCategory", "kind": "function", "description": "Sets the Collision Category that this Arcade Physics Body\rwill use in order to determine what it can collide with.\r\rIt can only have one single category assigned to it.\r\rIf you wish to reset the collision category and mask, call\rthe `resetCollisionCategory` method.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#setCollisionCategory", "inherited": true, "___id": "T000002R052863", "___s": true }, { "comment": "/**\r\n * Checks to see if the given Collision Category will collide with\r\n * this Arcade Physics object or not.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#willCollideWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - Collision category value to test.\r\n *\r\n * @return {boolean} `true` if the given category will collide with this object, otherwise `false`.\r\n */", "meta": { "filename": "Collision.js", "lineno": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "willCollideWith", "longname": "Phaser.Physics.Arcade.Image#willCollideWith", "kind": "function", "description": "Checks to see if the given Collision Category will collide with\rthis Arcade Physics object or not.", "since": "3.61.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given category will collide with this object, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Collision category value to test.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#willCollideWith", "inherited": true, "___id": "T000002R052864", "___s": true }, { "comment": "/**\r\n * Adds the given Collision Category to the list of those that this\r\n * Arcade Physics Body will collide with.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#addCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category to add.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 60, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "addCollidesWith", "longname": "Phaser.Physics.Arcade.Image#addCollidesWith", "kind": "function", "description": "Adds the given Collision Category to the list of those that this\rArcade Physics Body will collide with.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category to add.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#addCollidesWith", "inherited": true, "___id": "T000002R052865", "___s": true }, { "comment": "/**\r\n * Removes the given Collision Category from the list of those that this\r\n * Arcade Physics Body will collide with.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#removeCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category to add.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "removeCollidesWith", "longname": "Phaser.Physics.Arcade.Image#removeCollidesWith", "kind": "function", "description": "Removes the given Collision Category from the list of those that this\rArcade Physics Body will collide with.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category to add.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#removeCollidesWith", "inherited": true, "___id": "T000002R052866", "___s": true }, { "comment": "/**\r\n * Sets all of the Collision Categories that this Arcade Physics Body\r\n * will collide with. You can either pass a single category value, or\r\n * an array of them.\r\n *\r\n * Calling this method will reset all of the collision categories,\r\n * so only those passed to this method are enabled.\r\n *\r\n * If you wish to add a new category to the existing mask, call\r\n * the `addCollisionCategory` method.\r\n *\r\n * If you wish to reset the collision category and mask, call\r\n * the `resetCollisionCategory` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#setCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {(number|number[])} categories - The collision category to collide with, or an array of them.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCollidesWith", "longname": "Phaser.Physics.Arcade.Image#setCollidesWith", "kind": "function", "description": "Sets all of the Collision Categories that this Arcade Physics Body\rwill collide with. You can either pass a single category value, or\ran array of them.\r\rCalling this method will reset all of the collision categories,\rso only those passed to this method are enabled.\r\rIf you wish to add a new category to the existing mask, call\rthe `addCollisionCategory` method.\r\rIf you wish to reset the collision category and mask, call\rthe `resetCollisionCategory` method.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "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" } ] } ] } }, "description": "The collision category to collide with, or an array of them.", "name": "categories" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#setCollidesWith", "inherited": true, "___id": "T000002R052867", "___s": true }, { "comment": "/**\r\n * Resets the Collision Category and Mask back to the defaults,\r\n * which is to collide with everything.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#resetCollisionCategory\r\n * @since 3.61.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "resetCollisionCategory", "longname": "Phaser.Physics.Arcade.Image#resetCollisionCategory", "kind": "function", "description": "Resets the Collision Category and Mask back to the defaults,\rwhich is to collide with everything.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.Physics.Arcade.Components.Collision#resetCollisionCategory", "inherited": true, "___id": "T000002R052868", "___s": true }, { "comment": "/**\r\n * Sets the debug values of this body.\r\n *\r\n * Bodies will only draw their debug if debug has been enabled for Arcade Physics as a whole.\r\n * Note that there is a performance cost in drawing debug displays. It should never be used in production.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Debug#setDebug\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} showBody - Set to `true` to have this body render its outline to the debug display.\r\n * @param {boolean} showVelocity - Set to `true` to have this body render a velocity marker to the debug display.\r\n * @param {number} bodyColor - The color of the body outline when rendered to the debug display.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Debug.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setDebug", "longname": "Phaser.Physics.Arcade.Image#setDebug", "kind": "function", "description": "Sets the debug values of this body.\r\rBodies will only draw their debug if debug has been enabled for Arcade Physics as a whole.\rNote that there is a performance cost in drawing debug displays. It should never be used in production.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to `true` to have this body render its outline to the debug display.", "name": "showBody" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to `true` to have this body render a velocity marker to the debug display.", "name": "showVelocity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The color of the body outline when rendered to the debug display.", "name": "bodyColor" } ], "inherits": "Phaser.Physics.Arcade.Components.Debug#setDebug", "inherited": true, "___id": "T000002R052869", "___s": true }, { "comment": "/**\r\n * Sets the color of the body outline when it renders to the debug display.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Debug#setDebugBodyColor\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The color of the body outline when rendered to the debug display.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Debug.js", "lineno": 39, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setDebugBodyColor", "longname": "Phaser.Physics.Arcade.Image#setDebugBodyColor", "kind": "function", "description": "Sets the color of the body outline when it renders to the debug display.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The color of the body outline when rendered to the debug display.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Debug#setDebugBodyColor", "inherited": true, "___id": "T000002R052870", "___s": true }, { "comment": "/**\r\n * Set to `true` to have this body render its outline to the debug display.\r\n *\r\n * @name Phaser.Physics.Arcade.Components.Debug#debugShowBody\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Debug.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "debugShowBody", "longname": "Phaser.Physics.Arcade.Image#debugShowBody", "kind": "member", "description": "Set to `true` to have this body render its outline to the debug display.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.Physics.Arcade.Components.Debug#debugShowBody", "inherited": true, "___id": "T000002R052871", "___s": true }, { "comment": "/**\r\n * Set to `true` to have this body render a velocity marker to the debug display.\r\n *\r\n * @name Phaser.Physics.Arcade.Components.Debug#debugShowVelocity\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Debug.js", "lineno": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "debugShowVelocity", "longname": "Phaser.Physics.Arcade.Image#debugShowVelocity", "kind": "member", "description": "Set to `true` to have this body render a velocity marker to the debug display.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.Physics.Arcade.Components.Debug#debugShowVelocity", "inherited": true, "___id": "T000002R052872", "___s": true }, { "comment": "/**\r\n * The color of the body outline when it renders to the debug display.\r\n *\r\n * @name Phaser.Physics.Arcade.Components.Debug#debugBodyColor\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Debug.js", "lineno": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "debugBodyColor", "longname": "Phaser.Physics.Arcade.Image#debugBodyColor", "kind": "member", "description": "The color of the body outline when it renders to the debug display.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.Physics.Arcade.Components.Debug#debugBodyColor", "inherited": true, "___id": "T000002R052873", "___s": true }, { "comment": "/**\r\n * Sets the body's horizontal and vertical drag. If the vertical drag value is not provided, the vertical drag is set to the same value as the horizontal drag.\r\n *\r\n * Drag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\r\n * It is the absolute loss of velocity due to movement, in pixels per second squared.\r\n * The x and y components are applied separately.\r\n *\r\n * When `useDamping` is true, this is 1 minus the damping factor.\r\n * A value of 1 means the Body loses no velocity.\r\n * A value of 0.95 means the Body loses 5% of its velocity per step.\r\n * A value of 0.5 means the Body loses 50% of its velocity per step.\r\n *\r\n * Drag is applied only when `acceleration` is zero.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Drag#setDrag\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The amount of horizontal drag to apply.\r\n * @param {number} [y=x] - The amount of vertical drag to apply.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Drag.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setDrag", "longname": "Phaser.Physics.Arcade.Image#setDrag", "kind": "function", "description": "Sets the body's horizontal and vertical drag. If the vertical drag value is not provided, the vertical drag is set to the same value as the horizontal drag.\r\rDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\rIt is the absolute loss of velocity due to movement, in pixels per second squared.\rThe x and y components are applied separately.\r\rWhen `useDamping` is true, this is 1 minus the damping factor.\rA value of 1 means the Body loses no velocity.\rA value of 0.95 means the Body loses 5% of its velocity per step.\rA value of 0.5 means the Body loses 50% of its velocity per step.\r\rDrag is applied only when `acceleration` is zero.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of horizontal drag to apply.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The amount of vertical drag to apply.", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Drag#setDrag", "inherited": true, "___id": "T000002R052874", "___s": true }, { "comment": "/**\r\n * Sets the body's horizontal drag.\r\n *\r\n * Drag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\r\n * It is the absolute loss of velocity due to movement, in pixels per second squared.\r\n * The x and y components are applied separately.\r\n *\r\n * When `useDamping` is true, this is 1 minus the damping factor.\r\n * A value of 1 means the Body loses no velocity.\r\n * A value of 0.95 means the Body loses 5% of its velocity per step.\r\n * A value of 0.5 means the Body loses 50% of its velocity per step.\r\n *\r\n * Drag is applied only when `acceleration` is zero.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Drag#setDragX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of horizontal drag to apply.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Drag.js", "lineno": 44, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setDragX", "longname": "Phaser.Physics.Arcade.Image#setDragX", "kind": "function", "description": "Sets the body's horizontal drag.\r\rDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\rIt is the absolute loss of velocity due to movement, in pixels per second squared.\rThe x and y components are applied separately.\r\rWhen `useDamping` is true, this is 1 minus the damping factor.\rA value of 1 means the Body loses no velocity.\rA value of 0.95 means the Body loses 5% of its velocity per step.\rA value of 0.5 means the Body loses 50% of its velocity per step.\r\rDrag is applied only when `acceleration` is zero.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of horizontal drag to apply.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Drag#setDragX", "inherited": true, "___id": "T000002R052875", "___s": true }, { "comment": "/**\r\n * Sets the body's vertical drag.\r\n *\r\n * Drag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\r\n * It is the absolute loss of velocity due to movement, in pixels per second squared.\r\n * The x and y components are applied separately.\r\n *\r\n * When `useDamping` is true, this is 1 minus the damping factor.\r\n * A value of 1 means the Body loses no velocity.\r\n * A value of 0.95 means the Body loses 5% of its velocity per step.\r\n * A value of 0.5 means the Body loses 50% of its velocity per step.\r\n *\r\n * Drag is applied only when `acceleration` is zero.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Drag#setDragY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of vertical drag to apply.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Drag.js", "lineno": 72, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setDragY", "longname": "Phaser.Physics.Arcade.Image#setDragY", "kind": "function", "description": "Sets the body's vertical drag.\r\rDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\rIt is the absolute loss of velocity due to movement, in pixels per second squared.\rThe x and y components are applied separately.\r\rWhen `useDamping` is true, this is 1 minus the damping factor.\rA value of 1 means the Body loses no velocity.\rA value of 0.95 means the Body loses 5% of its velocity per step.\rA value of 0.5 means the Body loses 50% of its velocity per step.\r\rDrag is applied only when `acceleration` is zero.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of vertical drag to apply.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Drag#setDragY", "inherited": true, "___id": "T000002R052876", "___s": true }, { "comment": "/**\r\n * If this Body is using `drag` for deceleration this function controls how the drag is applied.\r\n * If set to `true` drag will use a damping effect rather than a linear approach. If you are\r\n * creating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\r\n * the game Asteroids) then you will get a far smoother and more visually correct deceleration\r\n * by using damping, avoiding the axis-drift that is prone with linear deceleration.\r\n *\r\n * If you enable this property then you should use far smaller `drag` values than with linear, as\r\n * they are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow\r\n * deceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Drag#setDamping\r\n * @since 3.10.0\r\n *\r\n * @param {boolean} value - `true` to use damping for deceleration, or `false` to use linear deceleration.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Drag.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setDamping", "longname": "Phaser.Physics.Arcade.Image#setDamping", "kind": "function", "description": "If this Body is using `drag` for deceleration this function controls how the drag is applied.\rIf set to `true` drag will use a damping effect rather than a linear approach. If you are\rcreating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\rthe game Asteroids) then you will get a far smoother and more visually correct deceleration\rby using damping, avoiding the axis-drift that is prone with linear deceleration.\r\rIf you enable this property then you should use far smaller `drag` values than with linear, as\rthey are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow\rdeceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.", "since": "3.10.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to use damping for deceleration, or `false` to use linear deceleration.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Drag#setDamping", "inherited": true, "___id": "T000002R052877", "___s": true }, { "comment": "/**\r\n * Sets whether this Body should calculate its velocity based on its change in\r\n * position every frame. The default, which is to not do this, means that you\r\n * make this Body move by setting the velocity directly. However, if you are\r\n * trying to move this Body via a Tween, or have it follow a Path, then you\r\n * should enable this instead. This will allow it to still collide with other\r\n * bodies, something that isn't possible if you're just changing its position directly.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Enable#setDirectControl\r\n * @since 3.61.0\r\n *\r\n * @param {boolean} [value=true] - `true` if the Body calculate velocity based on changes in position, otherwise `false`.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Enable.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setDirectControl", "longname": "Phaser.Physics.Arcade.Image#setDirectControl", "kind": "function", "description": "Sets whether this Body should calculate its velocity based on its change in\rposition every frame. The default, which is to not do this, means that you\rmake this Body move by setting the velocity directly. However, if you are\rtrying to move this Body via a Tween, or have it follow a Path, then you\rshould enable this instead. This will allow it to still collide with other\rbodies, something that isn't possible if you're just changing its position directly.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if the Body calculate velocity based on changes in position, otherwise `false`.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Enable#setDirectControl", "inherited": true, "___id": "T000002R052878", "___s": true }, { "comment": "/**\r\n * Enables this Game Object's Body.\r\n * If you reset the Body you must also pass `x` and `y`.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Enable#enableBody\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [reset] - Also reset the Body and place the Game Object at (x, y).\r\n * @param {number} [x] - The horizontal position to place the Game Object, if `reset` is true.\r\n * @param {number} [y] - The horizontal position to place the Game Object, if `reset` is true.\r\n * @param {boolean} [enableGameObject] - Also set this Game Object's `active` to true.\r\n * @param {boolean} [showGameObject] - Also set this Game Object's `visible` to true.\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.Body#enable\r\n * @see Phaser.Physics.Arcade.StaticBody#enable\r\n * @see Phaser.Physics.Arcade.Body#reset\r\n * @see Phaser.Physics.Arcade.StaticBody#reset\r\n * @see Phaser.GameObjects.GameObject#active\r\n * @see Phaser.GameObjects.GameObject#visible\r\n */", "meta": { "filename": "Enable.js", "lineno": 37, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "enableBody", "longname": "Phaser.Physics.Arcade.Image#enableBody", "kind": "function", "description": "Enables this Game Object's Body.\rIf you reset the Body you must also pass `x` and `y`.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.Body#enable", "Phaser.Physics.Arcade.StaticBody#enable", "Phaser.Physics.Arcade.Body#reset", "Phaser.Physics.Arcade.StaticBody#reset", "Phaser.GameObjects.GameObject#active", "Phaser.GameObjects.GameObject#visible" ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Also reset the Body and place the Game Object at (x, y).", "name": "reset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position to place the Game Object, if `reset` is true.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position to place the Game Object, if `reset` is true.", "name": "y" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Also set this Game Object's `active` to true.", "name": "enableGameObject" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Also set this Game Object's `visible` to true.", "name": "showGameObject" } ], "inherits": "Phaser.Physics.Arcade.Components.Enable#enableBody", "inherited": true, "___id": "T000002R052879", "___s": true }, { "comment": "/**\r\n * Stops and disables this Game Object's Body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Enable#disableBody\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [disableGameObject=false] - Also set this Game Object's `active` to false.\r\n * @param {boolean} [hideGameObject=false] - Also set this Game Object's `visible` to false.\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.Body#enable\r\n * @see Phaser.Physics.Arcade.StaticBody#enable\r\n * @see Phaser.GameObjects.GameObject#active\r\n * @see Phaser.GameObjects.GameObject#visible\r\n */", "meta": { "filename": "Enable.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "disableBody", "longname": "Phaser.Physics.Arcade.Image#disableBody", "kind": "function", "description": "Stops and disables this Game Object's Body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.Body#enable", "Phaser.Physics.Arcade.StaticBody#enable", "Phaser.GameObjects.GameObject#active", "Phaser.GameObjects.GameObject#visible" ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Also set this Game Object's `active` to false.", "name": "disableGameObject" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Also set this Game Object's `visible` to false.", "name": "hideGameObject" } ], "inherits": "Phaser.Physics.Arcade.Components.Enable#disableBody", "inherited": true, "___id": "T000002R052880", "___s": true }, { "comment": "/**\r\n * Syncs the Body's position and size with its parent Game Object.\r\n * You don't need to call this for Dynamic Bodies, as it happens automatically.\r\n * But for Static bodies it's a useful way of modifying the position of a Static Body\r\n * in the Physics World, based on its Game Object.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Enable#refreshBody\r\n * @since 3.1.0\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.StaticBody#updateFromGameObject\r\n */", "meta": { "filename": "Enable.js", "lineno": 119, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "refreshBody", "longname": "Phaser.Physics.Arcade.Image#refreshBody", "kind": "function", "description": "Syncs the Body's position and size with its parent Game Object.\rYou don't need to call this for Dynamic Bodies, as it happens automatically.\rBut for Static bodies it's a useful way of modifying the position of a Static Body\rin the Physics World, based on its Game Object.", "since": "3.1.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.StaticBody#updateFromGameObject" ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "inherits": "Phaser.Physics.Arcade.Components.Enable#refreshBody", "inherited": true, "___id": "T000002R052881", "___s": true }, { "comment": "/**\r\n * Sets the friction of this game object's physics body.\r\n * In Arcade Physics, friction is a special case of motion transfer from an \"immovable\" body to a riding body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Friction#setFriction\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The amount of horizontal friction to apply, [0, 1].\r\n * @param {number} [y=x] - The amount of vertical friction to apply, [0, 1].\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.Body#friction\r\n */", "meta": { "filename": "Friction.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setFriction", "longname": "Phaser.Physics.Arcade.Image#setFriction", "kind": "function", "description": "Sets the friction of this game object's physics body.\rIn Arcade Physics, friction is a special case of motion transfer from an \"immovable\" body to a riding body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.Body#friction" ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of horizontal friction to apply, [0, 1].", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The amount of vertical friction to apply, [0, 1].", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Friction#setFriction", "inherited": true, "___id": "T000002R052882", "___s": true }, { "comment": "/**\r\n * Sets the horizontal friction of this game object's physics body.\r\n * This can move a riding body horizontally when it collides with this one on the vertical axis.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Friction#setFrictionX\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The amount of friction to apply, [0, 1].\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.Body#friction\r\n */", "meta": { "filename": "Friction.js", "lineno": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setFrictionX", "longname": "Phaser.Physics.Arcade.Image#setFrictionX", "kind": "function", "description": "Sets the horizontal friction of this game object's physics body.\rThis can move a riding body horizontally when it collides with this one on the vertical axis.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.Body#friction" ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of friction to apply, [0, 1].", "name": "x" } ], "inherits": "Phaser.Physics.Arcade.Components.Friction#setFrictionX", "inherited": true, "___id": "T000002R052883", "___s": true }, { "comment": "/**\r\n * Sets the vertical friction of this game object's physics body.\r\n * This can move a riding body vertically when it collides with this one on the horizontal axis.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Friction#setFrictionY\r\n * @since 3.0.0\r\n *\r\n * @param {number} y - The amount of friction to apply, [0, 1].\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.Body#friction\r\n */", "meta": { "filename": "Friction.js", "lineno": 60, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setFrictionY", "longname": "Phaser.Physics.Arcade.Image#setFrictionY", "kind": "function", "description": "Sets the vertical friction of this game object's physics body.\rThis can move a riding body vertically when it collides with this one on the horizontal axis.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.Body#friction" ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of friction to apply, [0, 1].", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Friction#setFrictionY", "inherited": true, "___id": "T000002R052884", "___s": true }, { "comment": "/**\r\n * Set the X and Y values of the gravitational pull to act upon this Arcade Physics Game Object. Values can be positive or negative. Larger values result in a stronger effect.\r\n *\r\n * If only one value is provided, this value will be used for both the X and Y axis.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Gravity#setGravity\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The gravitational force to be applied to the X-axis.\r\n * @param {number} [y=x] - The gravitational force to be applied to the Y-axis. If this is not specified, the X value will be used.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Gravity.js", "lineno": 16, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setGravity", "longname": "Phaser.Physics.Arcade.Image#setGravity", "kind": "function", "description": "Set the X and Y values of the gravitational pull to act upon this Arcade Physics Game Object. Values can be positive or negative. Larger values result in a stronger effect.\r\rIf only one value is provided, this value will be used for both the X and Y axis.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The gravitational force to be applied to the X-axis.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The gravitational force to be applied to the Y-axis. If this is not specified, the X value will be used.", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Gravity#setGravity", "inherited": true, "___id": "T000002R052885", "___s": true }, { "comment": "/**\r\n * Set the gravitational force to be applied to the X axis. Value can be positive or negative. Larger values result in a stronger effect.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Gravity#setGravityX\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The gravitational force to be applied to the X-axis.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Gravity.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setGravityX", "longname": "Phaser.Physics.Arcade.Image#setGravityX", "kind": "function", "description": "Set the gravitational force to be applied to the X axis. Value can be positive or negative. Larger values result in a stronger effect.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The gravitational force to be applied to the X-axis.", "name": "x" } ], "inherits": "Phaser.Physics.Arcade.Components.Gravity#setGravityX", "inherited": true, "___id": "T000002R052886", "___s": true }, { "comment": "/**\r\n * Set the gravitational force to be applied to the Y axis. Value can be positive or negative. Larger values result in a stronger effect.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Gravity#setGravityY\r\n * @since 3.0.0\r\n *\r\n * @param {number} y - The gravitational force to be applied to the Y-axis.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Gravity.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setGravityY", "longname": "Phaser.Physics.Arcade.Image#setGravityY", "kind": "function", "description": "Set the gravitational force to be applied to the Y axis. Value can be positive or negative. Larger values result in a stronger effect.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The gravitational force to be applied to the Y-axis.", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Gravity#setGravityY", "inherited": true, "___id": "T000002R052887", "___s": true }, { "comment": "/**\r\n * Sets if this Body can be separated during collisions with other bodies.\r\n *\r\n * When a body is immovable it means it won't move at all, not even to separate it from collision\r\n * overlap. If you just wish to prevent a body from being knocked around by other bodies, see\r\n * the `setPushable` method instead.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Immovable#setImmovable\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [value=true] - Sets if this body will be separated during collisions with other bodies.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Immovable.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setImmovable", "longname": "Phaser.Physics.Arcade.Image#setImmovable", "kind": "function", "description": "Sets if this Body can be separated during collisions with other bodies.\r\rWhen a body is immovable it means it won't move at all, not even to separate it from collision\roverlap. If you just wish to prevent a body from being knocked around by other bodies, see\rthe `setPushable` method instead.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Sets if this body will be separated during collisions with other bodies.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Immovable#setImmovable", "inherited": true, "___id": "T000002R052888", "___s": true }, { "comment": "/**\r\n * Sets the mass of the physics body\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Mass#setMass\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - New value for the mass of the body.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Mass.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setMass", "longname": "Phaser.Physics.Arcade.Image#setMass", "kind": "function", "description": "Sets the mass of the physics body", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "New value for the mass of the body.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Mass#setMass", "inherited": true, "___id": "T000002R052889", "___s": true }, { "comment": "/**\r\n * Sets if this Body can be pushed by another Body.\r\n *\r\n * A body that cannot be pushed will reflect back all of the velocity it is given to the\r\n * colliding body. If that body is also not pushable, then the separation will be split\r\n * between them evenly.\r\n *\r\n * If you want your body to never move or seperate at all, see the `setImmovable` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Pushable#setPushable\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [value=true] - Sets if this body can be pushed by collisions with another Body.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Pushable.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setPushable", "longname": "Phaser.Physics.Arcade.Image#setPushable", "kind": "function", "description": "Sets if this Body can be pushed by another Body.\r\rA body that cannot be pushed will reflect back all of the velocity it is given to the\rcolliding body. If that body is also not pushable, then the separation will be split\rbetween them evenly.\r\rIf you want your body to never move or seperate at all, see the `setImmovable` method.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Sets if this body can be pushed by collisions with another Body.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Pushable#setPushable", "inherited": true, "___id": "T000002R052890", "___s": true }, { "comment": "/**\n * Sets the body offset. This allows you to adjust the difference between the center of the body\n * and the x and y coordinates of the parent Game Object.\n *\n * @method Phaser.Physics.Arcade.Components.Size#setOffset\n * @since 3.0.0\n *\n * @param {number} x - The amount to offset the body from the parent Game Object along the x-axis.\n * @param {number} [y=x] - The amount to offset the body from the parent Game Object along the y-axis. Defaults to the value given for the x-axis.\n *\n * @return {this} This Game Object.\n */", "meta": { "filename": "Size.js", "lineno": 16, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setOffset", "longname": "Phaser.Physics.Arcade.Image#setOffset", "kind": "function", "description": "Sets the body offset. This allows you to adjust the difference between the center of the body\nand the x and y coordinates of the parent Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to offset the body from the parent Game Object along the x-axis.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The amount to offset the body from the parent Game Object along the y-axis. Defaults to the value given for the x-axis.", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Size#setOffset", "inherited": true, "___id": "T000002R052891", "___s": true }, { "comment": "/**\n * Sets the size of this physics body. Setting the size does not adjust the dimensions of the parent Game Object.\n *\n * @method Phaser.Physics.Arcade.Components.Size#setBodySize\n * @since 3.24.0\n *\n * @param {number} width - The new width of the physics body, in pixels.\n * @param {number} height - The new height of the physics body, in pixels.\n * @param {boolean} [center=true] - Should the body be re-positioned so its center aligns with the parent Game Object?\n *\n * @return {this} This Game Object.\n */", "meta": { "filename": "Size.js", "lineno": 57, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setBodySize", "longname": "Phaser.Physics.Arcade.Image#setBodySize", "kind": "function", "description": "Sets the size of this physics body. Setting the size does not adjust the dimensions of the parent Game Object.", "since": "3.24.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the physics body, in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of the physics body, in pixels.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the body be re-positioned so its center aligns with the parent Game Object?", "name": "center" } ], "inherits": "Phaser.Physics.Arcade.Components.Size#setBodySize", "inherited": true, "___id": "T000002R052892", "___s": true }, { "comment": "/**\n * Sets this physics body to use a circle for collision instead of a rectangle.\n *\n * @method Phaser.Physics.Arcade.Components.Size#setCircle\n * @since 3.0.0\n *\n * @param {number} radius - The radius of the physics body, in pixels.\n * @param {number} [offsetX] - The amount to offset the body from the parent Game Object along the x-axis.\n * @param {number} [offsetY] - The amount to offset the body from the parent Game Object along the y-axis.\n *\n * @return {this} This Game Object.\n */", "meta": { "filename": "Size.js", "lineno": 76, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCircle", "longname": "Phaser.Physics.Arcade.Image#setCircle", "kind": "function", "description": "Sets this physics body to use a circle for collision instead of a rectangle.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the physics body, in pixels.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount to offset the body from the parent Game Object along the x-axis.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount to offset the body from the parent Game Object along the y-axis.", "name": "offsetY" } ], "inherits": "Phaser.Physics.Arcade.Components.Size#setCircle", "inherited": true, "___id": "T000002R052893", "___s": true }, { "comment": "/**\r\n * Sets the velocity of the Body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Velocity#setVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal velocity of the body. Positive values move the body to the right, while negative values move it to the left.\r\n * @param {number} [y=x] - The vertical velocity of the body. Positive values move the body down, while negative values move it up.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setVelocity", "longname": "Phaser.Physics.Arcade.Image#setVelocity", "kind": "function", "description": "Sets the velocity of the Body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal velocity of the body. Positive values move the body to the right, while negative values move it to the left.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical velocity of the body. Positive values move the body down, while negative values move it up.", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Velocity#setVelocity", "inherited": true, "___id": "T000002R052894", "___s": true }, { "comment": "/**\r\n * Sets the horizontal component of the body's velocity.\r\n *\r\n * Positive values move the body to the right, while negative values move it to the left.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Velocity#setVelocityX\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The new horizontal velocity.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 35, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setVelocityX", "longname": "Phaser.Physics.Arcade.Image#setVelocityX", "kind": "function", "description": "Sets the horizontal component of the body's velocity.\r\rPositive values move the body to the right, while negative values move it to the left.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new horizontal velocity.", "name": "x" } ], "inherits": "Phaser.Physics.Arcade.Components.Velocity#setVelocityX", "inherited": true, "___id": "T000002R052895", "___s": true }, { "comment": "/**\r\n * Sets the vertical component of the body's velocity.\r\n *\r\n * Positive values move the body down, while negative values move it up.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Velocity#setVelocityY\r\n * @since 3.0.0\r\n *\r\n * @param {number} y - The new vertical velocity of the body.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setVelocityY", "longname": "Phaser.Physics.Arcade.Image#setVelocityY", "kind": "function", "description": "Sets the vertical component of the body's velocity.\r\rPositive values move the body down, while negative values move it up.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new vertical velocity of the body.", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Velocity#setVelocityY", "inherited": true, "___id": "T000002R052896", "___s": true }, { "comment": "/**\r\n * Sets the maximum velocity of the body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Velocity#setMaxVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The new maximum horizontal velocity.\r\n * @param {number} [y=x] - The new maximum vertical velocity.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 73, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setMaxVelocity", "longname": "Phaser.Physics.Arcade.Image#setMaxVelocity", "kind": "function", "description": "Sets the maximum velocity of the body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new maximum horizontal velocity.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The new maximum vertical velocity.", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Velocity#setMaxVelocity", "inherited": true, "___id": "T000002R052897", "___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": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "anims", "longname": "Phaser.Physics.Arcade.Sprite#anims", "kind": "member", "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.", "type": { "names": [ "Phaser.Animations.AnimationState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationState" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Sprite#anims", "inherited": true, "___id": "T000002R052899", "___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": 125, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "preUpdate", "longname": "Phaser.Physics.Arcade.Sprite#preUpdate", "kind": "function", "description": "Update this Sprite's animations.", "access": "protected", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#preUpdate", "inherited": true, "___id": "T000002R052900", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "play", "longname": "Phaser.Physics.Arcade.Sprite#play", "kind": "function", "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.", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#play", "inherited": true, "___id": "T000002R052901", "___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": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "playReverse", "longname": "Phaser.Physics.Arcade.Sprite#playReverse", "kind": "function", "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.", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#playReverse", "inherited": true, "___id": "T000002R052902", "___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": 270, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "playAfterDelay", "longname": "Phaser.Physics.Arcade.Sprite#playAfterDelay", "kind": "function", "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'.", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#playAfterDelay", "inherited": true, "___id": "T000002R052903", "___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": 300, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "playAfterRepeat", "longname": "Phaser.Physics.Arcade.Sprite#playAfterRepeat", "kind": "function", "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.", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#playAfterRepeat", "inherited": true, "___id": "T000002R052904", "___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": 327, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "chain", "longname": "Phaser.Physics.Arcade.Sprite#chain", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#chain", "inherited": true, "___id": "T000002R052905", "___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": 359, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "stop", "longname": "Phaser.Physics.Arcade.Sprite#stop", "kind": "function", "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.", "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Sprite#stop", "inherited": true, "___id": "T000002R052906", "___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": 377, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "stopAfterDelay", "longname": "Phaser.Physics.Arcade.Sprite#stopAfterDelay", "kind": "function", "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.", "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.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of milliseconds to wait before stopping this animation.", "name": "delay" } ], "inherits": "Phaser.GameObjects.Sprite#stopAfterDelay", "inherited": true, "___id": "T000002R052907", "___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": 400, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "stopAfterRepeat", "longname": "Phaser.Physics.Arcade.Sprite#stopAfterRepeat", "kind": "function", "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.", "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.Physics.Arcade.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#stopAfterRepeat", "inherited": true, "___id": "T000002R052908", "___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": 423, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "stopOnFrame", "longname": "Phaser.Physics.Arcade.Sprite#stopOnFrame", "kind": "function", "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.", "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.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The frame to check before stopping this animation.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Sprite#stopOnFrame", "inherited": true, "___id": "T000002R052909", "___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": 447, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "toJSON", "longname": "Phaser.Physics.Arcade.Sprite#toJSON", "kind": "function", "description": "Build a JSON representation of this Sprite.", "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Sprite#toJSON", "inherited": true, "___id": "T000002R052910", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.Physics.Arcade.Sprite#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R052914", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.Physics.Arcade.Sprite#displayList", "kind": "member", "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.", "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R052915", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.Physics.Arcade.Sprite#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R052916", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.Physics.Arcade.Sprite#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R052917", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.Physics.Arcade.Sprite#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R052918", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.Physics.Arcade.Sprite#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R052919", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.Physics.Arcade.Sprite#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R052920", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.Physics.Arcade.Sprite#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R052921", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.Physics.Arcade.Sprite#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R052922", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.Physics.Arcade.Sprite#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R052923", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.Physics.Arcade.Sprite#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R052924", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.Physics.Arcade.Sprite#input", "kind": "member", "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()`.", "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R052925", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.Physics.Arcade.Sprite#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R052926", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.Physics.Arcade.Sprite#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R052927", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.Physics.Arcade.Sprite#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R052928", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.Physics.Arcade.Sprite#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R052929", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.Physics.Arcade.Sprite#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "since": "3.0.0", "see": [ "Phaser.Data.DataManager" ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R052930", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.Physics.Arcade.Sprite#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R052931", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.Physics.Arcade.Sprite#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R052932", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.Physics.Arcade.Sprite#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R052933", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.Physics.Arcade.Sprite#getData", "kind": "function", "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.", "since": "3.0.0", "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R052934", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.Physics.Arcade.Sprite#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R052935", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.Physics.Arcade.Sprite#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R052936", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.Physics.Arcade.Sprite#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R052937", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.Physics.Arcade.Sprite#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R052938", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.Physics.Arcade.Sprite#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R052939", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.Physics.Arcade.Sprite#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R052940", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.Physics.Arcade.Sprite#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R052941", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.Physics.Arcade.Sprite#getIndexList", "kind": "function", "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.", "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R052942", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.Physics.Arcade.Sprite#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R052943", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.Physics.Arcade.Sprite#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R052944", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.Physics.Arcade.Sprite#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R052945", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.Physics.Arcade.Sprite#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R052946", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.Physics.Arcade.Sprite#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R052947", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Physics.Arcade.Sprite#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R052948", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Physics.Arcade.Sprite#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R052949", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Physics.Arcade.Sprite#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R052950", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Physics.Arcade.Sprite#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R052951", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Physics.Arcade.Sprite#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R052952", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Physics.Arcade.Sprite#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R052953", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Physics.Arcade.Sprite#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R052954", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Physics.Arcade.Sprite#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R052955", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Physics.Arcade.Sprite#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R052956", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Physics.Arcade.Sprite#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R052957", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Physics.Arcade.Sprite#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R052958", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.Physics.Arcade.Sprite#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#clearAlpha", "___id": "T000002R052964", "___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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.Physics.Arcade.Sprite#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#setAlpha", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Alpha#setAlpha", "___id": "T000002R052965", "___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 *\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.Physics.Arcade.Sprite#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alpha", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alpha", "___id": "T000002R052966", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.Physics.Arcade.Sprite#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "___id": "T000002R052967", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.Physics.Arcade.Sprite#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "___id": "T000002R052968", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.Physics.Arcade.Sprite#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "___id": "T000002R052969", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.Physics.Arcade.Sprite#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "___id": "T000002R052970", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.Physics.Arcade.Sprite#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "overrides": "Phaser.GameObjects.Components.BlendMode#blendMode", "___id": "T000002R052972", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.Physics.Arcade.Sprite#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "___id": "T000002R052973", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.Physics.Arcade.Sprite#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "overrides": "Phaser.GameObjects.Components.Depth#depth", "___id": "T000002R052975", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.Physics.Arcade.Sprite#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Depth#setDepth", "___id": "T000002R052976", "___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.Components.Flip#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipX", "longname": "Phaser.Physics.Arcade.Sprite#flipX", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#flipX", "___id": "T000002R052977", "___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.Components.Flip#flipY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipY", "longname": "Phaser.Physics.Arcade.Sprite#flipY", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#flipY", "___id": "T000002R052978", "___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 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 * @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": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipX", "longname": "Phaser.Physics.Arcade.Sprite#toggleFlipX", "kind": "function", "description": "Toggles the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#toggleFlipX", "___id": "T000002R052979", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipY", "longname": "Phaser.Physics.Arcade.Sprite#toggleFlipY", "kind": "function", "description": "Toggles the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#toggleFlipY", "___id": "T000002R052980", "___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 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 * @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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipX", "longname": "Phaser.Physics.Arcade.Sprite#setFlipX", "kind": "function", "description": "Sets the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlipX", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Flip#setFlipX", "___id": "T000002R052981", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\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": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipY", "longname": "Phaser.Physics.Arcade.Sprite#setFlipY", "kind": "function", "description": "Sets the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlipY", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Flip#setFlipY", "___id": "T000002R052982", "___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 inversed 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 horizontal 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": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlip", "longname": "Phaser.Physics.Arcade.Sprite#setFlip", "kind": "function", "description": "Sets the horizontal and vertical flipped state of this Game Object.\r\rA Game Object that is flipped will render inversed 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlip", "inherited": true, "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 horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "overrides": "Phaser.GameObjects.Components.Flip#setFlip", "___id": "T000002R052983", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetFlip", "longname": "Phaser.Physics.Arcade.Sprite#resetFlip", "kind": "function", "description": "Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#resetFlip", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#resetFlip", "___id": "T000002R052984", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.Physics.Arcade.Sprite#getCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getCenter", "___id": "T000002R052986", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.Physics.Arcade.Sprite#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "___id": "T000002R052987", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.Physics.Arcade.Sprite#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "___id": "T000002R052988", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.Physics.Arcade.Sprite#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getTopRight", "___id": "T000002R052989", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.Physics.Arcade.Sprite#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "___id": "T000002R052990", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.Physics.Arcade.Sprite#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "___id": "T000002R052991", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.Physics.Arcade.Sprite#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "___id": "T000002R052992", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.Physics.Arcade.Sprite#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "___id": "T000002R052993", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.Physics.Arcade.Sprite#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "___id": "T000002R052994", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.Physics.Arcade.Sprite#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getBounds", "___id": "T000002R052995", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.Physics.Arcade.Sprite#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "overrides": "Phaser.GameObjects.Components.Mask#mask", "___id": "T000002R052996", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.Physics.Arcade.Sprite#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "overrides": "Phaser.GameObjects.Components.Mask#setMask", "___id": "T000002R052997", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.Physics.Arcade.Sprite#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "overrides": "Phaser.GameObjects.Components.Mask#clearMask", "___id": "T000002R052998", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.Physics.Arcade.Sprite#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "overrides": "Phaser.GameObjects.Components.Mask#createBitmapMask", "___id": "T000002R052999", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.Physics.Arcade.Sprite#createGeometryMask", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } }, "description": "This Geometry Mask that was created." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Mask#createGeometryMask", "___id": "T000002R053000", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.Physics.Arcade.Sprite#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#originX", "___id": "T000002R053002", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.Physics.Arcade.Sprite#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#originY", "___id": "T000002R053003", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.Physics.Arcade.Sprite#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#displayOriginX", "___id": "T000002R053004", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.Physics.Arcade.Sprite#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#displayOriginY", "___id": "T000002R053005", "___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": {} }, "name": "setOrigin", "longname": "Phaser.Physics.Arcade.Sprite#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Origin#setOrigin", "___id": "T000002R053006", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.Physics.Arcade.Sprite#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "___id": "T000002R053007", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.Physics.Arcade.Sprite#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "___id": "T000002R053008", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.Physics.Arcade.Sprite#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "___id": "T000002R053009", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.Physics.Arcade.Sprite#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "overrides": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "___id": "T000002R053010", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.Physics.Arcade.Sprite#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "overrides": "Phaser.GameObjects.Components.Pipeline#pipeline", "___id": "T000002R053011", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.Physics.Arcade.Sprite#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "overrides": "Phaser.GameObjects.Components.Pipeline#pipelineData", "___id": "T000002R053012", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.Physics.Arcade.Sprite#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "overrides": "Phaser.GameObjects.Components.Pipeline#initPipeline", "___id": "T000002R053013", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.Physics.Arcade.Sprite#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "overrides": "Phaser.GameObjects.Components.Pipeline#setPipeline", "___id": "T000002R053014", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.Physics.Arcade.Sprite#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "___id": "T000002R053015", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.Physics.Arcade.Sprite#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "overrides": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "___id": "T000002R053016", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.Physics.Arcade.Sprite#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "overrides": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "___id": "T000002R053017", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.Physics.Arcade.Sprite#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "___id": "T000002R053018", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.Physics.Arcade.Sprite#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "___id": "T000002R053019", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.Physics.Arcade.Sprite#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "___id": "T000002R053020", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.Physics.Arcade.Sprite#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#preFX", "___id": "T000002R053021", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.Physics.Arcade.Sprite#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#postFX", "___id": "T000002R053022", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.Physics.Arcade.Sprite#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "___id": "T000002R053023", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.Physics.Arcade.Sprite#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "___id": "T000002R053024", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.Physics.Arcade.Sprite#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "___id": "T000002R053025", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.Physics.Arcade.Sprite#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "___id": "T000002R053026", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.Physics.Arcade.Sprite#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "___id": "T000002R053027", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.Physics.Arcade.Sprite#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "___id": "T000002R053028", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.Physics.Arcade.Sprite#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#clearFX", "___id": "T000002R053029", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.Physics.Arcade.Sprite#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "overrides": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "___id": "T000002R053030", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.Physics.Arcade.Sprite#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "overrides": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "___id": "T000002R053031", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.Physics.Arcade.Sprite#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "___id": "T000002R053032", "___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": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.Physics.Arcade.Sprite#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#width", "inherited": true, "overrides": "Phaser.GameObjects.Components.Size#width", "___id": "T000002R053034", "___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": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.Physics.Arcade.Sprite#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#height", "inherited": true, "overrides": "Phaser.GameObjects.Components.Size#height", "___id": "T000002R053035", "___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": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.Physics.Arcade.Sprite#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayWidth", "inherited": true, "overrides": "Phaser.GameObjects.Components.Size#displayWidth", "___id": "T000002R053036", "___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": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.Physics.Arcade.Sprite#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayHeight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Size#displayHeight", "___id": "T000002R053037", "___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": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSizeToFrame", "longname": "Phaser.Physics.Arcade.Sprite#setSizeToFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setSizeToFrame", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Size#setSizeToFrame", "___id": "T000002R053038", "___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": 139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.Physics.Arcade.Sprite#setSize", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setSize", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Size#setSize", "___id": "T000002R053039", "___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.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": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.Physics.Arcade.Sprite#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setDisplaySize", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Size#setDisplaySize", "___id": "T000002R053040", "___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": {} }, "name": "texture", "longname": "Phaser.Physics.Arcade.Sprite#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#texture", "inherited": true, "overrides": "Phaser.GameObjects.Components.Texture#texture", "___id": "T000002R053041", "___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": {} }, "name": "frame", "longname": "Phaser.Physics.Arcade.Sprite#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#frame", "inherited": true, "overrides": "Phaser.GameObjects.Components.Texture#frame", "___id": "T000002R053042", "___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": {} }, "name": "isCropped", "longname": "Phaser.Physics.Arcade.Sprite#isCropped", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.11.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#isCropped", "inherited": true, "overrides": "Phaser.GameObjects.Components.Texture#isCropped", "___id": "T000002R053043", "___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 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 rect 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. 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.\r\n * @param {number} [width] - The width of the crop rectangle in pixels.\r\n * @param {number} [height] - The height of the crop rectangle in pixels.\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": {} }, "name": "setCrop", "longname": "Phaser.Physics.Arcade.Sprite#setCrop", "kind": "function", "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 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 rect 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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setCrop", "inherited": true, "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. 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.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the crop rectangle in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the crop rectangle in pixels.", "name": "height" } ], "___id": "T000002R053044", "___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": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.Physics.Arcade.Sprite#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setTexture", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Texture#setTexture", "___id": "T000002R053045", "___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": 128, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.Physics.Arcade.Sprite#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setFrame", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Texture#setFrame", "___id": "T000002R053046", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertice 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": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopLeft", "longname": "Phaser.Physics.Arcade.Sprite#tintTopLeft", "kind": "member", "description": "The tint value being applied to the top-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopLeft", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintTopLeft", "___id": "T000002R053048", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-right vertice 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopRight", "longname": "Phaser.Physics.Arcade.Sprite#tintTopRight", "kind": "member", "description": "The tint value being applied to the top-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopRight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintTopRight", "___id": "T000002R053049", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-left vertice 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": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomLeft", "longname": "Phaser.Physics.Arcade.Sprite#tintBottomLeft", "kind": "member", "description": "The tint value being applied to the bottom-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "___id": "T000002R053050", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-right vertice 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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomRight", "longname": "Phaser.Physics.Arcade.Sprite#tintBottomRight", "kind": "member", "description": "The tint value being applied to the bottom-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomRight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintBottomRight", "___id": "T000002R053051", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintFill", "longname": "Phaser.Physics.Arcade.Sprite#tintFill", "kind": "member", "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.11.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintFill", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintFill", "___id": "T000002R053052", "___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 'additive',\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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearTint", "longname": "Phaser.Physics.Arcade.Sprite#clearTint", "kind": "function", "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff and the tint type to 'additive',\rwhich results in no visible change to the texture.", "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#clearTint", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#clearTint", "___id": "T000002R053053", "___s": true }, { "comment": "/**\r\n * Sets an additive tint 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 * multiplying it by 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 * To swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.\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": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTint", "longname": "Phaser.Physics.Arcade.Sprite#setTint", "kind": "function", "description": "Sets an additive tint on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by 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\rTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.", "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#setTint", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Tint#setTint", "___id": "T000002R053054", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on this Game Object.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. You can provide either one color value, in which case the whole\r\n * Game Object will be rendered in that color. Or you can provide a color per corner. The colors\r\n * 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 * To swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintFill\r\n * @webglOnly\r\n * @since 3.11.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.\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": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTintFill", "longname": "Phaser.Physics.Arcade.Sprite#setTintFill", "kind": "function", "description": "Sets a fill-based tint on this Game Object.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. You can provide either one color value, in which case the whole\rGame Object will be rendered in that color. Or you can provide a color per corner. The colors\rare 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\rTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#setTintFill", "inherited": true, "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 not 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" } ], "overrides": "Phaser.GameObjects.Components.Tint#setTintFill", "___id": "T000002R053055", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.\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": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tint", "longname": "Phaser.Physics.Arcade.Sprite#tint", "kind": "member", "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tint", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tint", "___id": "T000002R053056", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * It checks to see if the 4 tint properties are set to the value 0xffffff\r\n * and that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.\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": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isTinted", "longname": "Phaser.Physics.Arcade.Sprite#isTinted", "kind": "member", "description": "Does this Game Object have a tint applied?\r\rIt checks to see if the 4 tint properties are set to the value 0xffffff\rand that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "readonly": true, "since": "3.11.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#isTinted", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#isTinted", "___id": "T000002R053057", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.Physics.Arcade.Sprite#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "___id": "T000002R053058", "___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": {} }, "name": "x", "longname": "Phaser.Physics.Arcade.Sprite#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#x", "___id": "T000002R053062", "___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": {} }, "name": "y", "longname": "Phaser.Physics.Arcade.Sprite#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#y", "___id": "T000002R053063", "___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": {} }, "name": "z", "longname": "Phaser.Physics.Arcade.Sprite#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#z", "___id": "T000002R053064", "___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": {} }, "name": "w", "longname": "Phaser.Physics.Arcade.Sprite#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#w", "___id": "T000002R053065", "___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": {} }, "name": "scale", "longname": "Phaser.Physics.Arcade.Sprite#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#scale", "___id": "T000002R053066", "___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": {} }, "name": "scaleX", "longname": "Phaser.Physics.Arcade.Sprite#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#scaleX", "___id": "T000002R053067", "___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": {} }, "name": "scaleY", "longname": "Phaser.Physics.Arcade.Sprite#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#scaleY", "___id": "T000002R053068", "___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": {} }, "name": "angle", "longname": "Phaser.Physics.Arcade.Sprite#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#angle", "___id": "T000002R053069", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.Physics.Arcade.Sprite#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#rotation", "___id": "T000002R053070", "___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": {} }, "name": "setPosition", "longname": "Phaser.Physics.Arcade.Sprite#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#setPosition", "___id": "T000002R053071", "___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": {} }, "name": "copyPosition", "longname": "Phaser.Physics.Arcade.Sprite#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#copyPosition", "___id": "T000002R053072", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.Physics.Arcade.Sprite#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#setRandomPosition", "___id": "T000002R053073", "___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": {} }, "name": "setRotation", "longname": "Phaser.Physics.Arcade.Sprite#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "overrides": "Phaser.GameObjects.Components.Transform#setRotation", "___id": "T000002R053074", "___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": {} }, "name": "setAngle", "longname": "Phaser.Physics.Arcade.Sprite#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "overrides": "Phaser.GameObjects.Components.Transform#setAngle", "___id": "T000002R053075", "___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": {} }, "name": "setScale", "longname": "Phaser.Physics.Arcade.Sprite#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#setScale", "___id": "T000002R053076", "___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": {} }, "name": "setX", "longname": "Phaser.Physics.Arcade.Sprite#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Transform#setX", "___id": "T000002R053077", "___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": {} }, "name": "setY", "longname": "Phaser.Physics.Arcade.Sprite#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Transform#setY", "___id": "T000002R053078", "___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": {} }, "name": "setZ", "longname": "Phaser.Physics.Arcade.Sprite#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Transform#setZ", "___id": "T000002R053079", "___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": {} }, "name": "setW", "longname": "Phaser.Physics.Arcade.Sprite#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Transform#setW", "___id": "T000002R053080", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.Physics.Arcade.Sprite#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "___id": "T000002R053081", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.Physics.Arcade.Sprite#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "___id": "T000002R053082", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.Physics.Arcade.Sprite#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#getLocalPoint", "___id": "T000002R053083", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.Physics.Arcade.Sprite#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#getParentRotation", "___id": "T000002R053084", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.Physics.Arcade.Sprite#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "overrides": "Phaser.GameObjects.Components.Visible#visible", "___id": "T000002R053086", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.Physics.Arcade.Sprite#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Visible#setVisible", "___id": "T000002R053087", "___s": true }, { "comment": "/**\r\n * Sets the body's horizontal and vertical acceleration. If the vertical acceleration value is not provided, the vertical acceleration is set to the same value as the horizontal acceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Acceleration#setAcceleration\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal acceleration\r\n * @param {number} [y=x] - The vertical acceleration\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Acceleration.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setAcceleration", "longname": "Phaser.Physics.Arcade.Sprite#setAcceleration", "kind": "function", "description": "Sets the body's horizontal and vertical acceleration. If the vertical acceleration value is not provided, the vertical acceleration is set to the same value as the horizontal acceleration.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal acceleration", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical acceleration", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Acceleration#setAcceleration", "inherited": true, "___id": "T000002R053088", "___s": true }, { "comment": "/**\r\n * Sets the body's horizontal acceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Acceleration#setAccelerationX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The horizontal acceleration\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Acceleration.js", "lineno": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setAccelerationX", "longname": "Phaser.Physics.Arcade.Sprite#setAccelerationX", "kind": "function", "description": "Sets the body's horizontal acceleration.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal acceleration", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Acceleration#setAccelerationX", "inherited": true, "___id": "T000002R053089", "___s": true }, { "comment": "/**\r\n * Sets the body's vertical acceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Acceleration#setAccelerationY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The vertical acceleration\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Acceleration.js", "lineno": 50, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setAccelerationY", "longname": "Phaser.Physics.Arcade.Sprite#setAccelerationY", "kind": "function", "description": "Sets the body's vertical acceleration.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical acceleration", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Acceleration#setAccelerationY", "inherited": true, "___id": "T000002R053090", "___s": true }, { "comment": "/**\r\n * Sets the angular velocity of the body.\r\n *\r\n * In Arcade Physics, bodies cannot rotate. They are always axis-aligned.\r\n * However, they can have angular motion, which is passed on to the Game Object bound to the body,\r\n * causing them to visually rotate, even though the body remains axis-aligned.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Angular#setAngularVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of angular velocity.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Angular.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setAngularVelocity", "longname": "Phaser.Physics.Arcade.Sprite#setAngularVelocity", "kind": "function", "description": "Sets the angular velocity of the body.\r\rIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\rHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\rcausing them to visually rotate, even though the body remains axis-aligned.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of angular velocity.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Angular#setAngularVelocity", "inherited": true, "___id": "T000002R053091", "___s": true }, { "comment": "/**\r\n * Sets the angular acceleration of the body.\r\n *\r\n * In Arcade Physics, bodies cannot rotate. They are always axis-aligned.\r\n * However, they can have angular motion, which is passed on to the Game Object bound to the body,\r\n * causing them to visually rotate, even though the body remains axis-aligned.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Angular#setAngularAcceleration\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of angular acceleration.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Angular.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setAngularAcceleration", "longname": "Phaser.Physics.Arcade.Sprite#setAngularAcceleration", "kind": "function", "description": "Sets the angular acceleration of the body.\r\rIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\rHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\rcausing them to visually rotate, even though the body remains axis-aligned.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of angular acceleration.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Angular#setAngularAcceleration", "inherited": true, "___id": "T000002R053092", "___s": true }, { "comment": "/**\r\n * Sets the angular drag of the body. Drag is applied to the current velocity, providing a form of deceleration.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Angular#setAngularDrag\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of drag.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Angular.js", "lineno": 57, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setAngularDrag", "longname": "Phaser.Physics.Arcade.Sprite#setAngularDrag", "kind": "function", "description": "Sets the angular drag of the body. Drag is applied to the current velocity, providing a form of deceleration.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of drag.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Angular#setAngularDrag", "inherited": true, "___id": "T000002R053093", "___s": true }, { "comment": "/**\r\n * Sets the bounce values of this body.\r\n *\r\n * Bounce is the amount of restitution, or elasticity, the body has when it collides with another object.\r\n * A value of 1 means that it will retain its full velocity after the rebound. A value of 0 means it will not rebound at all.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Bounce#setBounce\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.\r\n * @param {number} [y=x] - The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Bounce.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setBounce", "longname": "Phaser.Physics.Arcade.Sprite#setBounce", "kind": "function", "description": "Sets the bounce values of this body.\r\rBounce is the amount of restitution, or elasticity, the body has when it collides with another object.\rA value of 1 means that it will retain its full velocity after the rebound. A value of 0 means it will not rebound at all.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Bounce#setBounce", "inherited": true, "___id": "T000002R053094", "___s": true }, { "comment": "/**\r\n * Sets the horizontal bounce value for this body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Bounce#setBounceX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Bounce.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setBounceX", "longname": "Phaser.Physics.Arcade.Sprite#setBounceX", "kind": "function", "description": "Sets the horizontal bounce value for this body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Bounce#setBounceX", "inherited": true, "___id": "T000002R053095", "___s": true }, { "comment": "/**\r\n * Sets the vertical bounce value for this body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Bounce#setBounceY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Bounce.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setBounceY", "longname": "Phaser.Physics.Arcade.Sprite#setBounceY", "kind": "function", "description": "Sets the vertical bounce value for this body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Bounce#setBounceY", "inherited": true, "___id": "T000002R053096", "___s": true }, { "comment": "/**\r\n * Sets whether this Body collides with the world boundary.\r\n *\r\n * Optionally also sets the World Bounce values. If the `Body.worldBounce` is null, it's set to a new Phaser.Math.Vector2 first.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Bounce#setCollideWorldBounds\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [value=true] - `true` if this body should collide with the world bounds, otherwise `false`.\r\n * @param {number} [bounceX] - If given this will be replace the `worldBounce.x` value.\r\n * @param {number} [bounceY] - If given this will be replace the `worldBounce.y` value.\r\n * @param {boolean} [onWorldBounds] - If given this replaces the Body's `onWorldBounds` value.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Bounce.js", "lineno": 70, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCollideWorldBounds", "longname": "Phaser.Physics.Arcade.Sprite#setCollideWorldBounds", "kind": "function", "description": "Sets whether this Body collides with the world boundary.\r\rOptionally also sets the World Bounce values. If the `Body.worldBounce` is null, it's set to a new Phaser.Math.Vector2 first.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if this body should collide with the world bounds, otherwise `false`.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If given this will be replace the `worldBounce.x` value.", "name": "bounceX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If given this will be replace the `worldBounce.y` value.", "name": "bounceY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If given this replaces the Body's `onWorldBounds` value.", "name": "onWorldBounds" } ], "inherits": "Phaser.Physics.Arcade.Components.Bounce#setCollideWorldBounds", "inherited": true, "___id": "T000002R053097", "___s": true }, { "comment": "/**\r\n * Sets the Collision Category that this Arcade Physics Body\r\n * will use in order to determine what it can collide with.\r\n *\r\n * It can only have one single category assigned to it.\r\n *\r\n * If you wish to reset the collision category and mask, call\r\n * the `resetCollisionCategory` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#setCollisionCategory\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCollisionCategory", "longname": "Phaser.Physics.Arcade.Sprite#setCollisionCategory", "kind": "function", "description": "Sets the Collision Category that this Arcade Physics Body\rwill use in order to determine what it can collide with.\r\rIt can only have one single category assigned to it.\r\rIf you wish to reset the collision category and mask, call\rthe `resetCollisionCategory` method.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#setCollisionCategory", "inherited": true, "___id": "T000002R053098", "___s": true }, { "comment": "/**\r\n * Checks to see if the given Collision Category will collide with\r\n * this Arcade Physics object or not.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#willCollideWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - Collision category value to test.\r\n *\r\n * @return {boolean} `true` if the given category will collide with this object, otherwise `false`.\r\n */", "meta": { "filename": "Collision.js", "lineno": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "willCollideWith", "longname": "Phaser.Physics.Arcade.Sprite#willCollideWith", "kind": "function", "description": "Checks to see if the given Collision Category will collide with\rthis Arcade Physics object or not.", "since": "3.61.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given category will collide with this object, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Collision category value to test.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#willCollideWith", "inherited": true, "___id": "T000002R053099", "___s": true }, { "comment": "/**\r\n * Adds the given Collision Category to the list of those that this\r\n * Arcade Physics Body will collide with.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#addCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category to add.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 60, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "addCollidesWith", "longname": "Phaser.Physics.Arcade.Sprite#addCollidesWith", "kind": "function", "description": "Adds the given Collision Category to the list of those that this\rArcade Physics Body will collide with.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category to add.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#addCollidesWith", "inherited": true, "___id": "T000002R053100", "___s": true }, { "comment": "/**\r\n * Removes the given Collision Category from the list of those that this\r\n * Arcade Physics Body will collide with.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#removeCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category to add.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "removeCollidesWith", "longname": "Phaser.Physics.Arcade.Sprite#removeCollidesWith", "kind": "function", "description": "Removes the given Collision Category from the list of those that this\rArcade Physics Body will collide with.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category to add.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#removeCollidesWith", "inherited": true, "___id": "T000002R053101", "___s": true }, { "comment": "/**\r\n * Sets all of the Collision Categories that this Arcade Physics Body\r\n * will collide with. You can either pass a single category value, or\r\n * an array of them.\r\n *\r\n * Calling this method will reset all of the collision categories,\r\n * so only those passed to this method are enabled.\r\n *\r\n * If you wish to add a new category to the existing mask, call\r\n * the `addCollisionCategory` method.\r\n *\r\n * If you wish to reset the collision category and mask, call\r\n * the `resetCollisionCategory` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#setCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {(number|number[])} categories - The collision category to collide with, or an array of them.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCollidesWith", "longname": "Phaser.Physics.Arcade.Sprite#setCollidesWith", "kind": "function", "description": "Sets all of the Collision Categories that this Arcade Physics Body\rwill collide with. You can either pass a single category value, or\ran array of them.\r\rCalling this method will reset all of the collision categories,\rso only those passed to this method are enabled.\r\rIf you wish to add a new category to the existing mask, call\rthe `addCollisionCategory` method.\r\rIf you wish to reset the collision category and mask, call\rthe `resetCollisionCategory` method.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "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" } ] } ] } }, "description": "The collision category to collide with, or an array of them.", "name": "categories" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#setCollidesWith", "inherited": true, "___id": "T000002R053102", "___s": true }, { "comment": "/**\r\n * Resets the Collision Category and Mask back to the defaults,\r\n * which is to collide with everything.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#resetCollisionCategory\r\n * @since 3.61.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "resetCollisionCategory", "longname": "Phaser.Physics.Arcade.Sprite#resetCollisionCategory", "kind": "function", "description": "Resets the Collision Category and Mask back to the defaults,\rwhich is to collide with everything.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.Physics.Arcade.Components.Collision#resetCollisionCategory", "inherited": true, "___id": "T000002R053103", "___s": true }, { "comment": "/**\r\n * Sets the debug values of this body.\r\n *\r\n * Bodies will only draw their debug if debug has been enabled for Arcade Physics as a whole.\r\n * Note that there is a performance cost in drawing debug displays. It should never be used in production.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Debug#setDebug\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} showBody - Set to `true` to have this body render its outline to the debug display.\r\n * @param {boolean} showVelocity - Set to `true` to have this body render a velocity marker to the debug display.\r\n * @param {number} bodyColor - The color of the body outline when rendered to the debug display.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Debug.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setDebug", "longname": "Phaser.Physics.Arcade.Sprite#setDebug", "kind": "function", "description": "Sets the debug values of this body.\r\rBodies will only draw their debug if debug has been enabled for Arcade Physics as a whole.\rNote that there is a performance cost in drawing debug displays. It should never be used in production.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to `true` to have this body render its outline to the debug display.", "name": "showBody" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to `true` to have this body render a velocity marker to the debug display.", "name": "showVelocity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The color of the body outline when rendered to the debug display.", "name": "bodyColor" } ], "inherits": "Phaser.Physics.Arcade.Components.Debug#setDebug", "inherited": true, "___id": "T000002R053104", "___s": true }, { "comment": "/**\r\n * Sets the color of the body outline when it renders to the debug display.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Debug#setDebugBodyColor\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The color of the body outline when rendered to the debug display.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Debug.js", "lineno": 39, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setDebugBodyColor", "longname": "Phaser.Physics.Arcade.Sprite#setDebugBodyColor", "kind": "function", "description": "Sets the color of the body outline when it renders to the debug display.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The color of the body outline when rendered to the debug display.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Debug#setDebugBodyColor", "inherited": true, "___id": "T000002R053105", "___s": true }, { "comment": "/**\r\n * Set to `true` to have this body render its outline to the debug display.\r\n *\r\n * @name Phaser.Physics.Arcade.Components.Debug#debugShowBody\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Debug.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "debugShowBody", "longname": "Phaser.Physics.Arcade.Sprite#debugShowBody", "kind": "member", "description": "Set to `true` to have this body render its outline to the debug display.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.Physics.Arcade.Components.Debug#debugShowBody", "inherited": true, "___id": "T000002R053106", "___s": true }, { "comment": "/**\r\n * Set to `true` to have this body render a velocity marker to the debug display.\r\n *\r\n * @name Phaser.Physics.Arcade.Components.Debug#debugShowVelocity\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Debug.js", "lineno": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "debugShowVelocity", "longname": "Phaser.Physics.Arcade.Sprite#debugShowVelocity", "kind": "member", "description": "Set to `true` to have this body render a velocity marker to the debug display.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.Physics.Arcade.Components.Debug#debugShowVelocity", "inherited": true, "___id": "T000002R053107", "___s": true }, { "comment": "/**\r\n * The color of the body outline when it renders to the debug display.\r\n *\r\n * @name Phaser.Physics.Arcade.Components.Debug#debugBodyColor\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Debug.js", "lineno": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "debugBodyColor", "longname": "Phaser.Physics.Arcade.Sprite#debugBodyColor", "kind": "member", "description": "The color of the body outline when it renders to the debug display.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.Physics.Arcade.Components.Debug#debugBodyColor", "inherited": true, "___id": "T000002R053108", "___s": true }, { "comment": "/**\r\n * Sets the body's horizontal and vertical drag. If the vertical drag value is not provided, the vertical drag is set to the same value as the horizontal drag.\r\n *\r\n * Drag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\r\n * It is the absolute loss of velocity due to movement, in pixels per second squared.\r\n * The x and y components are applied separately.\r\n *\r\n * When `useDamping` is true, this is 1 minus the damping factor.\r\n * A value of 1 means the Body loses no velocity.\r\n * A value of 0.95 means the Body loses 5% of its velocity per step.\r\n * A value of 0.5 means the Body loses 50% of its velocity per step.\r\n *\r\n * Drag is applied only when `acceleration` is zero.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Drag#setDrag\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The amount of horizontal drag to apply.\r\n * @param {number} [y=x] - The amount of vertical drag to apply.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Drag.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setDrag", "longname": "Phaser.Physics.Arcade.Sprite#setDrag", "kind": "function", "description": "Sets the body's horizontal and vertical drag. If the vertical drag value is not provided, the vertical drag is set to the same value as the horizontal drag.\r\rDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\rIt is the absolute loss of velocity due to movement, in pixels per second squared.\rThe x and y components are applied separately.\r\rWhen `useDamping` is true, this is 1 minus the damping factor.\rA value of 1 means the Body loses no velocity.\rA value of 0.95 means the Body loses 5% of its velocity per step.\rA value of 0.5 means the Body loses 50% of its velocity per step.\r\rDrag is applied only when `acceleration` is zero.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of horizontal drag to apply.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The amount of vertical drag to apply.", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Drag#setDrag", "inherited": true, "___id": "T000002R053109", "___s": true }, { "comment": "/**\r\n * Sets the body's horizontal drag.\r\n *\r\n * Drag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\r\n * It is the absolute loss of velocity due to movement, in pixels per second squared.\r\n * The x and y components are applied separately.\r\n *\r\n * When `useDamping` is true, this is 1 minus the damping factor.\r\n * A value of 1 means the Body loses no velocity.\r\n * A value of 0.95 means the Body loses 5% of its velocity per step.\r\n * A value of 0.5 means the Body loses 50% of its velocity per step.\r\n *\r\n * Drag is applied only when `acceleration` is zero.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Drag#setDragX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of horizontal drag to apply.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Drag.js", "lineno": 44, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setDragX", "longname": "Phaser.Physics.Arcade.Sprite#setDragX", "kind": "function", "description": "Sets the body's horizontal drag.\r\rDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\rIt is the absolute loss of velocity due to movement, in pixels per second squared.\rThe x and y components are applied separately.\r\rWhen `useDamping` is true, this is 1 minus the damping factor.\rA value of 1 means the Body loses no velocity.\rA value of 0.95 means the Body loses 5% of its velocity per step.\rA value of 0.5 means the Body loses 50% of its velocity per step.\r\rDrag is applied only when `acceleration` is zero.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of horizontal drag to apply.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Drag#setDragX", "inherited": true, "___id": "T000002R053110", "___s": true }, { "comment": "/**\r\n * Sets the body's vertical drag.\r\n *\r\n * Drag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\r\n * It is the absolute loss of velocity due to movement, in pixels per second squared.\r\n * The x and y components are applied separately.\r\n *\r\n * When `useDamping` is true, this is 1 minus the damping factor.\r\n * A value of 1 means the Body loses no velocity.\r\n * A value of 0.95 means the Body loses 5% of its velocity per step.\r\n * A value of 0.5 means the Body loses 50% of its velocity per step.\r\n *\r\n * Drag is applied only when `acceleration` is zero.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Drag#setDragY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of vertical drag to apply.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Drag.js", "lineno": 72, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setDragY", "longname": "Phaser.Physics.Arcade.Sprite#setDragY", "kind": "function", "description": "Sets the body's vertical drag.\r\rDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\rIt is the absolute loss of velocity due to movement, in pixels per second squared.\rThe x and y components are applied separately.\r\rWhen `useDamping` is true, this is 1 minus the damping factor.\rA value of 1 means the Body loses no velocity.\rA value of 0.95 means the Body loses 5% of its velocity per step.\rA value of 0.5 means the Body loses 50% of its velocity per step.\r\rDrag is applied only when `acceleration` is zero.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of vertical drag to apply.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Drag#setDragY", "inherited": true, "___id": "T000002R053111", "___s": true }, { "comment": "/**\r\n * If this Body is using `drag` for deceleration this function controls how the drag is applied.\r\n * If set to `true` drag will use a damping effect rather than a linear approach. If you are\r\n * creating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\r\n * the game Asteroids) then you will get a far smoother and more visually correct deceleration\r\n * by using damping, avoiding the axis-drift that is prone with linear deceleration.\r\n *\r\n * If you enable this property then you should use far smaller `drag` values than with linear, as\r\n * they are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow\r\n * deceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Drag#setDamping\r\n * @since 3.10.0\r\n *\r\n * @param {boolean} value - `true` to use damping for deceleration, or `false` to use linear deceleration.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Drag.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setDamping", "longname": "Phaser.Physics.Arcade.Sprite#setDamping", "kind": "function", "description": "If this Body is using `drag` for deceleration this function controls how the drag is applied.\rIf set to `true` drag will use a damping effect rather than a linear approach. If you are\rcreating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\rthe game Asteroids) then you will get a far smoother and more visually correct deceleration\rby using damping, avoiding the axis-drift that is prone with linear deceleration.\r\rIf you enable this property then you should use far smaller `drag` values than with linear, as\rthey are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow\rdeceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.", "since": "3.10.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to use damping for deceleration, or `false` to use linear deceleration.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Drag#setDamping", "inherited": true, "___id": "T000002R053112", "___s": true }, { "comment": "/**\r\n * Sets whether this Body should calculate its velocity based on its change in\r\n * position every frame. The default, which is to not do this, means that you\r\n * make this Body move by setting the velocity directly. However, if you are\r\n * trying to move this Body via a Tween, or have it follow a Path, then you\r\n * should enable this instead. This will allow it to still collide with other\r\n * bodies, something that isn't possible if you're just changing its position directly.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Enable#setDirectControl\r\n * @since 3.61.0\r\n *\r\n * @param {boolean} [value=true] - `true` if the Body calculate velocity based on changes in position, otherwise `false`.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Enable.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setDirectControl", "longname": "Phaser.Physics.Arcade.Sprite#setDirectControl", "kind": "function", "description": "Sets whether this Body should calculate its velocity based on its change in\rposition every frame. The default, which is to not do this, means that you\rmake this Body move by setting the velocity directly. However, if you are\rtrying to move this Body via a Tween, or have it follow a Path, then you\rshould enable this instead. This will allow it to still collide with other\rbodies, something that isn't possible if you're just changing its position directly.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "`true` if the Body calculate velocity based on changes in position, otherwise `false`.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Enable#setDirectControl", "inherited": true, "___id": "T000002R053113", "___s": true }, { "comment": "/**\r\n * Enables this Game Object's Body.\r\n * If you reset the Body you must also pass `x` and `y`.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Enable#enableBody\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [reset] - Also reset the Body and place the Game Object at (x, y).\r\n * @param {number} [x] - The horizontal position to place the Game Object, if `reset` is true.\r\n * @param {number} [y] - The horizontal position to place the Game Object, if `reset` is true.\r\n * @param {boolean} [enableGameObject] - Also set this Game Object's `active` to true.\r\n * @param {boolean} [showGameObject] - Also set this Game Object's `visible` to true.\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.Body#enable\r\n * @see Phaser.Physics.Arcade.StaticBody#enable\r\n * @see Phaser.Physics.Arcade.Body#reset\r\n * @see Phaser.Physics.Arcade.StaticBody#reset\r\n * @see Phaser.GameObjects.GameObject#active\r\n * @see Phaser.GameObjects.GameObject#visible\r\n */", "meta": { "filename": "Enable.js", "lineno": 37, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "enableBody", "longname": "Phaser.Physics.Arcade.Sprite#enableBody", "kind": "function", "description": "Enables this Game Object's Body.\rIf you reset the Body you must also pass `x` and `y`.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.Body#enable", "Phaser.Physics.Arcade.StaticBody#enable", "Phaser.Physics.Arcade.Body#reset", "Phaser.Physics.Arcade.StaticBody#reset", "Phaser.GameObjects.GameObject#active", "Phaser.GameObjects.GameObject#visible" ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Also reset the Body and place the Game Object at (x, y).", "name": "reset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position to place the Game Object, if `reset` is true.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position to place the Game Object, if `reset` is true.", "name": "y" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Also set this Game Object's `active` to true.", "name": "enableGameObject" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Also set this Game Object's `visible` to true.", "name": "showGameObject" } ], "inherits": "Phaser.Physics.Arcade.Components.Enable#enableBody", "inherited": true, "___id": "T000002R053114", "___s": true }, { "comment": "/**\r\n * Stops and disables this Game Object's Body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Enable#disableBody\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [disableGameObject=false] - Also set this Game Object's `active` to false.\r\n * @param {boolean} [hideGameObject=false] - Also set this Game Object's `visible` to false.\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.Body#enable\r\n * @see Phaser.Physics.Arcade.StaticBody#enable\r\n * @see Phaser.GameObjects.GameObject#active\r\n * @see Phaser.GameObjects.GameObject#visible\r\n */", "meta": { "filename": "Enable.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "disableBody", "longname": "Phaser.Physics.Arcade.Sprite#disableBody", "kind": "function", "description": "Stops and disables this Game Object's Body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.Body#enable", "Phaser.Physics.Arcade.StaticBody#enable", "Phaser.GameObjects.GameObject#active", "Phaser.GameObjects.GameObject#visible" ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Also set this Game Object's `active` to false.", "name": "disableGameObject" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Also set this Game Object's `visible` to false.", "name": "hideGameObject" } ], "inherits": "Phaser.Physics.Arcade.Components.Enable#disableBody", "inherited": true, "___id": "T000002R053115", "___s": true }, { "comment": "/**\r\n * Syncs the Body's position and size with its parent Game Object.\r\n * You don't need to call this for Dynamic Bodies, as it happens automatically.\r\n * But for Static bodies it's a useful way of modifying the position of a Static Body\r\n * in the Physics World, based on its Game Object.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Enable#refreshBody\r\n * @since 3.1.0\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.StaticBody#updateFromGameObject\r\n */", "meta": { "filename": "Enable.js", "lineno": 119, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "refreshBody", "longname": "Phaser.Physics.Arcade.Sprite#refreshBody", "kind": "function", "description": "Syncs the Body's position and size with its parent Game Object.\rYou don't need to call this for Dynamic Bodies, as it happens automatically.\rBut for Static bodies it's a useful way of modifying the position of a Static Body\rin the Physics World, based on its Game Object.", "since": "3.1.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.StaticBody#updateFromGameObject" ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "inherits": "Phaser.Physics.Arcade.Components.Enable#refreshBody", "inherited": true, "___id": "T000002R053116", "___s": true }, { "comment": "/**\r\n * Sets the friction of this game object's physics body.\r\n * In Arcade Physics, friction is a special case of motion transfer from an \"immovable\" body to a riding body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Friction#setFriction\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The amount of horizontal friction to apply, [0, 1].\r\n * @param {number} [y=x] - The amount of vertical friction to apply, [0, 1].\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.Body#friction\r\n */", "meta": { "filename": "Friction.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setFriction", "longname": "Phaser.Physics.Arcade.Sprite#setFriction", "kind": "function", "description": "Sets the friction of this game object's physics body.\rIn Arcade Physics, friction is a special case of motion transfer from an \"immovable\" body to a riding body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.Body#friction" ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of horizontal friction to apply, [0, 1].", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The amount of vertical friction to apply, [0, 1].", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Friction#setFriction", "inherited": true, "___id": "T000002R053117", "___s": true }, { "comment": "/**\r\n * Sets the horizontal friction of this game object's physics body.\r\n * This can move a riding body horizontally when it collides with this one on the vertical axis.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Friction#setFrictionX\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The amount of friction to apply, [0, 1].\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.Body#friction\r\n */", "meta": { "filename": "Friction.js", "lineno": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setFrictionX", "longname": "Phaser.Physics.Arcade.Sprite#setFrictionX", "kind": "function", "description": "Sets the horizontal friction of this game object's physics body.\rThis can move a riding body horizontally when it collides with this one on the vertical axis.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.Body#friction" ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of friction to apply, [0, 1].", "name": "x" } ], "inherits": "Phaser.Physics.Arcade.Components.Friction#setFrictionX", "inherited": true, "___id": "T000002R053118", "___s": true }, { "comment": "/**\r\n * Sets the vertical friction of this game object's physics body.\r\n * This can move a riding body vertically when it collides with this one on the horizontal axis.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Friction#setFrictionY\r\n * @since 3.0.0\r\n *\r\n * @param {number} y - The amount of friction to apply, [0, 1].\r\n *\r\n * @return {this} This Game Object.\r\n *\r\n * @see Phaser.Physics.Arcade.Body#friction\r\n */", "meta": { "filename": "Friction.js", "lineno": 60, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setFrictionY", "longname": "Phaser.Physics.Arcade.Sprite#setFrictionY", "kind": "function", "description": "Sets the vertical friction of this game object's physics body.\rThis can move a riding body vertically when it collides with this one on the horizontal axis.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "see": [ "Phaser.Physics.Arcade.Body#friction" ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of friction to apply, [0, 1].", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Friction#setFrictionY", "inherited": true, "___id": "T000002R053119", "___s": true }, { "comment": "/**\r\n * Set the X and Y values of the gravitational pull to act upon this Arcade Physics Game Object. Values can be positive or negative. Larger values result in a stronger effect.\r\n *\r\n * If only one value is provided, this value will be used for both the X and Y axis.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Gravity#setGravity\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The gravitational force to be applied to the X-axis.\r\n * @param {number} [y=x] - The gravitational force to be applied to the Y-axis. If this is not specified, the X value will be used.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Gravity.js", "lineno": 16, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setGravity", "longname": "Phaser.Physics.Arcade.Sprite#setGravity", "kind": "function", "description": "Set the X and Y values of the gravitational pull to act upon this Arcade Physics Game Object. Values can be positive or negative. Larger values result in a stronger effect.\r\rIf only one value is provided, this value will be used for both the X and Y axis.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The gravitational force to be applied to the X-axis.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The gravitational force to be applied to the Y-axis. If this is not specified, the X value will be used.", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Gravity#setGravity", "inherited": true, "___id": "T000002R053120", "___s": true }, { "comment": "/**\r\n * Set the gravitational force to be applied to the X axis. Value can be positive or negative. Larger values result in a stronger effect.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Gravity#setGravityX\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The gravitational force to be applied to the X-axis.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Gravity.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setGravityX", "longname": "Phaser.Physics.Arcade.Sprite#setGravityX", "kind": "function", "description": "Set the gravitational force to be applied to the X axis. Value can be positive or negative. Larger values result in a stronger effect.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The gravitational force to be applied to the X-axis.", "name": "x" } ], "inherits": "Phaser.Physics.Arcade.Components.Gravity#setGravityX", "inherited": true, "___id": "T000002R053121", "___s": true }, { "comment": "/**\r\n * Set the gravitational force to be applied to the Y axis. Value can be positive or negative. Larger values result in a stronger effect.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Gravity#setGravityY\r\n * @since 3.0.0\r\n *\r\n * @param {number} y - The gravitational force to be applied to the Y-axis.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Gravity.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setGravityY", "longname": "Phaser.Physics.Arcade.Sprite#setGravityY", "kind": "function", "description": "Set the gravitational force to be applied to the Y axis. Value can be positive or negative. Larger values result in a stronger effect.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The gravitational force to be applied to the Y-axis.", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Gravity#setGravityY", "inherited": true, "___id": "T000002R053122", "___s": true }, { "comment": "/**\r\n * Sets if this Body can be separated during collisions with other bodies.\r\n *\r\n * When a body is immovable it means it won't move at all, not even to separate it from collision\r\n * overlap. If you just wish to prevent a body from being knocked around by other bodies, see\r\n * the `setPushable` method instead.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Immovable#setImmovable\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [value=true] - Sets if this body will be separated during collisions with other bodies.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Immovable.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setImmovable", "longname": "Phaser.Physics.Arcade.Sprite#setImmovable", "kind": "function", "description": "Sets if this Body can be separated during collisions with other bodies.\r\rWhen a body is immovable it means it won't move at all, not even to separate it from collision\roverlap. If you just wish to prevent a body from being knocked around by other bodies, see\rthe `setPushable` method instead.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Sets if this body will be separated during collisions with other bodies.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Immovable#setImmovable", "inherited": true, "___id": "T000002R053123", "___s": true }, { "comment": "/**\r\n * Sets the mass of the physics body\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Mass#setMass\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - New value for the mass of the body.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Mass.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setMass", "longname": "Phaser.Physics.Arcade.Sprite#setMass", "kind": "function", "description": "Sets the mass of the physics body", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "New value for the mass of the body.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Mass#setMass", "inherited": true, "___id": "T000002R053124", "___s": true }, { "comment": "/**\r\n * Sets if this Body can be pushed by another Body.\r\n *\r\n * A body that cannot be pushed will reflect back all of the velocity it is given to the\r\n * colliding body. If that body is also not pushable, then the separation will be split\r\n * between them evenly.\r\n *\r\n * If you want your body to never move or seperate at all, see the `setImmovable` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Pushable#setPushable\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [value=true] - Sets if this body can be pushed by collisions with another Body.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Pushable.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setPushable", "longname": "Phaser.Physics.Arcade.Sprite#setPushable", "kind": "function", "description": "Sets if this Body can be pushed by another Body.\r\rA body that cannot be pushed will reflect back all of the velocity it is given to the\rcolliding body. If that body is also not pushable, then the separation will be split\rbetween them evenly.\r\rIf you want your body to never move or seperate at all, see the `setImmovable` method.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Sets if this body can be pushed by collisions with another Body.", "name": "value" } ], "inherits": "Phaser.Physics.Arcade.Components.Pushable#setPushable", "inherited": true, "___id": "T000002R053125", "___s": true }, { "comment": "/**\n * Sets the body offset. This allows you to adjust the difference between the center of the body\n * and the x and y coordinates of the parent Game Object.\n *\n * @method Phaser.Physics.Arcade.Components.Size#setOffset\n * @since 3.0.0\n *\n * @param {number} x - The amount to offset the body from the parent Game Object along the x-axis.\n * @param {number} [y=x] - The amount to offset the body from the parent Game Object along the y-axis. Defaults to the value given for the x-axis.\n *\n * @return {this} This Game Object.\n */", "meta": { "filename": "Size.js", "lineno": 16, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setOffset", "longname": "Phaser.Physics.Arcade.Sprite#setOffset", "kind": "function", "description": "Sets the body offset. This allows you to adjust the difference between the center of the body\nand the x and y coordinates of the parent Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to offset the body from the parent Game Object along the x-axis.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The amount to offset the body from the parent Game Object along the y-axis. Defaults to the value given for the x-axis.", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Size#setOffset", "inherited": true, "___id": "T000002R053126", "___s": true }, { "comment": "/**\n * Sets the size of this physics body. Setting the size does not adjust the dimensions of the parent Game Object.\n *\n * @method Phaser.Physics.Arcade.Components.Size#setBodySize\n * @since 3.24.0\n *\n * @param {number} width - The new width of the physics body, in pixels.\n * @param {number} height - The new height of the physics body, in pixels.\n * @param {boolean} [center=true] - Should the body be re-positioned so its center aligns with the parent Game Object?\n *\n * @return {this} This Game Object.\n */", "meta": { "filename": "Size.js", "lineno": 57, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setBodySize", "longname": "Phaser.Physics.Arcade.Sprite#setBodySize", "kind": "function", "description": "Sets the size of this physics body. Setting the size does not adjust the dimensions of the parent Game Object.", "since": "3.24.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the physics body, in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of the physics body, in pixels.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the body be re-positioned so its center aligns with the parent Game Object?", "name": "center" } ], "inherits": "Phaser.Physics.Arcade.Components.Size#setBodySize", "inherited": true, "___id": "T000002R053127", "___s": true }, { "comment": "/**\n * Sets this physics body to use a circle for collision instead of a rectangle.\n *\n * @method Phaser.Physics.Arcade.Components.Size#setCircle\n * @since 3.0.0\n *\n * @param {number} radius - The radius of the physics body, in pixels.\n * @param {number} [offsetX] - The amount to offset the body from the parent Game Object along the x-axis.\n * @param {number} [offsetY] - The amount to offset the body from the parent Game Object along the y-axis.\n *\n * @return {this} This Game Object.\n */", "meta": { "filename": "Size.js", "lineno": 76, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCircle", "longname": "Phaser.Physics.Arcade.Sprite#setCircle", "kind": "function", "description": "Sets this physics body to use a circle for collision instead of a rectangle.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the physics body, in pixels.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount to offset the body from the parent Game Object along the x-axis.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount to offset the body from the parent Game Object along the y-axis.", "name": "offsetY" } ], "inherits": "Phaser.Physics.Arcade.Components.Size#setCircle", "inherited": true, "___id": "T000002R053128", "___s": true }, { "comment": "/**\r\n * Sets the velocity of the Body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Velocity#setVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal velocity of the body. Positive values move the body to the right, while negative values move it to the left.\r\n * @param {number} [y=x] - The vertical velocity of the body. Positive values move the body down, while negative values move it up.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setVelocity", "longname": "Phaser.Physics.Arcade.Sprite#setVelocity", "kind": "function", "description": "Sets the velocity of the Body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal velocity of the body. Positive values move the body to the right, while negative values move it to the left.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical velocity of the body. Positive values move the body down, while negative values move it up.", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Velocity#setVelocity", "inherited": true, "___id": "T000002R053129", "___s": true }, { "comment": "/**\r\n * Sets the horizontal component of the body's velocity.\r\n *\r\n * Positive values move the body to the right, while negative values move it to the left.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Velocity#setVelocityX\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The new horizontal velocity.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 35, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setVelocityX", "longname": "Phaser.Physics.Arcade.Sprite#setVelocityX", "kind": "function", "description": "Sets the horizontal component of the body's velocity.\r\rPositive values move the body to the right, while negative values move it to the left.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new horizontal velocity.", "name": "x" } ], "inherits": "Phaser.Physics.Arcade.Components.Velocity#setVelocityX", "inherited": true, "___id": "T000002R053130", "___s": true }, { "comment": "/**\r\n * Sets the vertical component of the body's velocity.\r\n *\r\n * Positive values move the body down, while negative values move it up.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Velocity#setVelocityY\r\n * @since 3.0.0\r\n *\r\n * @param {number} y - The new vertical velocity of the body.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setVelocityY", "longname": "Phaser.Physics.Arcade.Sprite#setVelocityY", "kind": "function", "description": "Sets the vertical component of the body's velocity.\r\rPositive values move the body down, while negative values move it up.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new vertical velocity of the body.", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Velocity#setVelocityY", "inherited": true, "___id": "T000002R053131", "___s": true }, { "comment": "/**\r\n * Sets the maximum velocity of the body.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Velocity#setMaxVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The new maximum horizontal velocity.\r\n * @param {number} [y=x] - The new maximum vertical velocity.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 73, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setMaxVelocity", "longname": "Phaser.Physics.Arcade.Sprite#setMaxVelocity", "kind": "function", "description": "Sets the maximum velocity of the body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new maximum horizontal velocity.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The new maximum vertical velocity.", "name": "y" } ], "inherits": "Phaser.Physics.Arcade.Components.Velocity#setMaxVelocity", "inherited": true, "___id": "T000002R053132", "___s": true }, { "comment": "/**\r\n * Sets the Collision Category that this Arcade Physics Body\r\n * will use in order to determine what it can collide with.\r\n *\r\n * It can only have one single category assigned to it.\r\n *\r\n * If you wish to reset the collision category and mask, call\r\n * the `resetCollisionCategory` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#setCollisionCategory\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCollisionCategory", "longname": "Phaser.Physics.Arcade.Body#setCollisionCategory", "kind": "function", "description": "Sets the Collision Category that this Arcade Physics Body\rwill use in order to determine what it can collide with.\r\rIt can only have one single category assigned to it.\r\rIf you wish to reset the collision category and mask, call\rthe `resetCollisionCategory` method.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Body", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#setCollisionCategory", "inherited": true, "___id": "T000002R053133", "___s": true }, { "comment": "/**\r\n * Checks to see if the given Collision Category will collide with\r\n * this Arcade Physics object or not.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#willCollideWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - Collision category value to test.\r\n *\r\n * @return {boolean} `true` if the given category will collide with this object, otherwise `false`.\r\n */", "meta": { "filename": "Collision.js", "lineno": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "willCollideWith", "longname": "Phaser.Physics.Arcade.Body#willCollideWith", "kind": "function", "description": "Checks to see if the given Collision Category will collide with\rthis Arcade Physics object or not.", "since": "3.61.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given category will collide with this object, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade.Body", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Collision category value to test.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#willCollideWith", "inherited": true, "___id": "T000002R053134", "___s": true }, { "comment": "/**\r\n * Adds the given Collision Category to the list of those that this\r\n * Arcade Physics Body will collide with.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#addCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category to add.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 60, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "addCollidesWith", "longname": "Phaser.Physics.Arcade.Body#addCollidesWith", "kind": "function", "description": "Adds the given Collision Category to the list of those that this\rArcade Physics Body will collide with.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Body", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category to add.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#addCollidesWith", "inherited": true, "___id": "T000002R053135", "___s": true }, { "comment": "/**\r\n * Removes the given Collision Category from the list of those that this\r\n * Arcade Physics Body will collide with.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#removeCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category to add.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "removeCollidesWith", "longname": "Phaser.Physics.Arcade.Body#removeCollidesWith", "kind": "function", "description": "Removes the given Collision Category from the list of those that this\rArcade Physics Body will collide with.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Body", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category to add.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#removeCollidesWith", "inherited": true, "___id": "T000002R053136", "___s": true }, { "comment": "/**\r\n * Sets all of the Collision Categories that this Arcade Physics Body\r\n * will collide with. You can either pass a single category value, or\r\n * an array of them.\r\n *\r\n * Calling this method will reset all of the collision categories,\r\n * so only those passed to this method are enabled.\r\n *\r\n * If you wish to add a new category to the existing mask, call\r\n * the `addCollisionCategory` method.\r\n *\r\n * If you wish to reset the collision category and mask, call\r\n * the `resetCollisionCategory` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#setCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {(number|number[])} categories - The collision category to collide with, or an array of them.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCollidesWith", "longname": "Phaser.Physics.Arcade.Body#setCollidesWith", "kind": "function", "description": "Sets all of the Collision Categories that this Arcade Physics Body\rwill collide with. You can either pass a single category value, or\ran array of them.\r\rCalling this method will reset all of the collision categories,\rso only those passed to this method are enabled.\r\rIf you wish to add a new category to the existing mask, call\rthe `addCollisionCategory` method.\r\rIf you wish to reset the collision category and mask, call\rthe `resetCollisionCategory` method.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Body", "scope": "instance", "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" } ] } ] } }, "description": "The collision category to collide with, or an array of them.", "name": "categories" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#setCollidesWith", "inherited": true, "___id": "T000002R053137", "___s": true }, { "comment": "/**\r\n * Resets the Collision Category and Mask back to the defaults,\r\n * which is to collide with everything.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#resetCollisionCategory\r\n * @since 3.61.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "resetCollisionCategory", "longname": "Phaser.Physics.Arcade.Body#resetCollisionCategory", "kind": "function", "description": "Resets the Collision Category and Mask back to the defaults,\rwhich is to collide with everything.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Body", "scope": "instance", "inherits": "Phaser.Physics.Arcade.Components.Collision#resetCollisionCategory", "inherited": true, "___id": "T000002R053138", "___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": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "scene", "longname": "Phaser.Physics.Arcade.Group#scene", "kind": "member", "description": "This scene this group belongs to.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#scene", "inherited": true, "___id": "T000002R053139", "___s": true }, { "comment": "/**\r\n * Members of this group.\r\n *\r\n * @name Phaser.GameObjects.Group#children\r\n * @type {Phaser.Structs.Set.}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Group.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "children", "longname": "Phaser.Physics.Arcade.Group#children", "kind": "member", "description": "Members of this group.", "type": { "names": [ "Phaser.Structs.Set." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.Set" }, "applications": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#children", "inherited": true, "___id": "T000002R053140", "___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": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "isParent", "longname": "Phaser.Physics.Arcade.Group#isParent", "kind": "member", "description": "A flag identifying this object as a group.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#isParent", "inherited": true, "___id": "T000002R053141", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "name", "longname": "Phaser.Physics.Arcade.Group#name", "kind": "member", "description": "The name of this group.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.18.0", "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#name", "inherited": true, "___id": "T000002R053142", "___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": 147, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "active", "longname": "Phaser.Physics.Arcade.Group#active", "kind": "member", "description": "Whether this group runs its {@link Phaser.GameObjects.Group#preUpdate} method (which may update any members).", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#active", "inherited": true, "___id": "T000002R053143", "___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": 156, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "maxSize", "longname": "Phaser.Physics.Arcade.Group#maxSize", "kind": "member", "description": "The maximum size of this group, if used as a pool. -1 is no limit.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "defaultvalue": "-1", "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#maxSize", "inherited": true, "___id": "T000002R053144", "___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": 166, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "defaultKey", "longname": "Phaser.Physics.Arcade.Group#defaultKey", "kind": "member", "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}.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#defaultKey", "inherited": true, "___id": "T000002R053145", "___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": 178, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "defaultFrame", "longname": "Phaser.Physics.Arcade.Group#defaultFrame", "kind": "member", "description": "A default texture frame to use when creating new group members.", "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#defaultFrame", "inherited": true, "___id": "T000002R053146", "___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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "runChildUpdate", "longname": "Phaser.Physics.Arcade.Group#runChildUpdate", "kind": "member", "description": "Whether to call the update method of any members.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "see": [ "Phaser.GameObjects.Group#preUpdate" ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#runChildUpdate", "inherited": true, "___id": "T000002R053147", "___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": 198, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "createCallback", "longname": "Phaser.Physics.Arcade.Group#createCallback", "kind": "member", "description": "A function to be called when adding or creating group members.", "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.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#createCallback", "inherited": true, "___id": "T000002R053148", "___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": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "removeCallback", "longname": "Phaser.Physics.Arcade.Group#removeCallback", "kind": "member", "description": "A function to be called when removing group members.", "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.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#removeCallback", "inherited": true, "___id": "T000002R053149", "___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": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "createMultipleCallback", "longname": "Phaser.Physics.Arcade.Group#createMultipleCallback", "kind": "member", "description": "A function to be called when creating several group members at once.", "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.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#createMultipleCallback", "inherited": true, "___id": "T000002R053150", "___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": 273, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "create", "longname": "Phaser.Physics.Arcade.Group#create", "kind": "function", "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}.", "since": "3.0.0", "returns": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The new Game Object (usually a Sprite, etc.)." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#create", "inherited": true, "___id": "T000002R053153", "___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": 318, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "createMultiple", "longname": "Phaser.Physics.Arcade.Group#createMultiple", "kind": "function", "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}.", "since": "3.0.0", "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.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#createMultiple", "inherited": true, "___id": "T000002R053154", "___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": 359, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "createFromConfig", "longname": "Phaser.Physics.Arcade.Group#createFromConfig", "kind": "function", "description": "A helper for {@link Phaser.GameObjects.Group#createMultiple}.", "since": "3.0.0", "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.Physics.Arcade.Group", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Group.GroupCreateConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupCreateConfig" } }, "description": "Creation settings.", "name": "options" } ], "inherits": "Phaser.GameObjects.Group#createFromConfig", "inherited": true, "___id": "T000002R053155", "___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": 545, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "preUpdate", "longname": "Phaser.Physics.Arcade.Group#preUpdate", "kind": "function", "description": "Updates any group members, if {@link Phaser.GameObjects.Group#runChildUpdate} is enabled.", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#preUpdate", "inherited": true, "___id": "T000002R053156", "___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": 575, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "add", "longname": "Phaser.Physics.Arcade.Group#add", "kind": "function", "description": "Adds a Game Object to this group.\r\rCalls {@link Phaser.GameObjects.Group#createCallback}.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#add", "inherited": true, "___id": "T000002R053157", "___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": 620, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "addMultiple", "longname": "Phaser.Physics.Arcade.Group#addMultiple", "kind": "function", "description": "Adds several Game Objects to this group.\r\rCalls {@link Phaser.GameObjects.Group#createCallback}.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This group." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#addMultiple", "inherited": true, "___id": "T000002R053158", "___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": 648, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "remove", "longname": "Phaser.Physics.Arcade.Group#remove", "kind": "function", "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}.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#remove", "inherited": true, "___id": "T000002R053159", "___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": 699, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "clear", "longname": "Phaser.Physics.Arcade.Group#clear", "kind": "function", "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}.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This group." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#clear", "inherited": true, "___id": "T000002R053160", "___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": 741, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "contains", "longname": "Phaser.Physics.Arcade.Group#contains", "kind": "function", "description": "Tests if a Game Object is a member of this group.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object is a member of this group." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A Game Object.", "name": "child" } ], "inherits": "Phaser.GameObjects.Group#contains", "inherited": true, "___id": "T000002R053161", "___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": 756, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getChildren", "longname": "Phaser.Physics.Arcade.Group#getChildren", "kind": "function", "description": "All members of the group.", "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.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#getChildren", "inherited": true, "___id": "T000002R053162", "___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}\r\n */", "meta": { "filename": "Group.js", "lineno": 769, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getLength", "longname": "Phaser.Physics.Arcade.Group#getLength", "kind": "function", "description": "The number of members of the group.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } } } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#getLength", "inherited": true, "___id": "T000002R053163", "___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": 782, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getMatching", "longname": "Phaser.Physics.Arcade.Group#getMatching", "kind": "function", "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.", "since": "3.50.0", "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.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#getMatching", "inherited": true, "___id": "T000002R053164", "___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": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getFirst", "longname": "Phaser.Physics.Arcade.Group#getFirst", "kind": "function", "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.", "since": "3.0.0", "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.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#getFirst", "inherited": true, "___id": "T000002R053165", "___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 first matching group member, or a newly created member, or null.\r\n */", "meta": { "filename": "Group.js", "lineno": 831, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getFirstNth", "longname": "Phaser.Physics.Arcade.Group#getFirstNth", "kind": "function", "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.", "since": "3.6.0", "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.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#getFirstNth", "inherited": true, "___id": "T000002R053166", "___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 first matching group member, or a newly created member, or null.\r\n */", "meta": { "filename": "Group.js", "lineno": 857, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getLast", "longname": "Phaser.Physics.Arcade.Group#getLast", "kind": "function", "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.", "since": "3.6.0", "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.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#getLast", "inherited": true, "___id": "T000002R053167", "___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 first matching group member, or a newly created member, or null.\r\n */", "meta": { "filename": "Group.js", "lineno": 882, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getLastNth", "longname": "Phaser.Physics.Arcade.Group#getLastNth", "kind": "function", "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.", "since": "3.6.0", "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.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#getLastNth", "inherited": true, "___id": "T000002R053168", "___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": 1011, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "get", "longname": "Phaser.Physics.Arcade.Group#get", "kind": "function", "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.", "since": "3.0.0", "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.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#get", "inherited": true, "___id": "T000002R053170", "___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": 1035, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getFirstAlive", "longname": "Phaser.Physics.Arcade.Group#getFirstAlive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The first active group member, or a newly created member, or null." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#getFirstAlive", "inherited": true, "___id": "T000002R053171", "___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": 1059, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getFirstDead", "longname": "Phaser.Physics.Arcade.Group#getFirstDead", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The first inactive group member, or a newly created member, or null." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#getFirstDead", "inherited": true, "___id": "T000002R053172", "___s": true }, { "comment": "/**\r\n * {@link Phaser.GameObjects.Components.Animation#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": 1084, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "playAnimation", "longname": "Phaser.Physics.Arcade.Group#playAnimation", "kind": "function", "description": "{@link Phaser.GameObjects.Components.Animation#play Plays} an animation for all members of this group.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#playAnimation", "inherited": true, "___id": "T000002R053173", "___s": true }, { "comment": "/**\r\n * Whether this group's size 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": 1102, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "isFull", "longname": "Phaser.Physics.Arcade.Group#isFull", "kind": "function", "description": "Whether this group's size at its {@link Phaser.GameObjects.Group#maxSize maximum}.", "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.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#isFull", "inherited": true, "___id": "T000002R053174", "___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": 1122, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "countActive", "longname": "Phaser.Physics.Arcade.Group#countActive", "kind": "function", "description": "Counts the number of active (or inactive) group members.", "since": "3.0.0", "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.Physics.Arcade.Group", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Count active (true) or inactive (false) group members.", "name": "value" } ], "inherits": "Phaser.GameObjects.Group#countActive", "inherited": true, "___id": "T000002R053175", "___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": 1149, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getTotalUsed", "longname": "Phaser.Physics.Arcade.Group#getTotalUsed", "kind": "function", "description": "Counts the number of in-use (active) group members.", "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.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#getTotalUsed", "inherited": true, "___id": "T000002R053176", "___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 numbers; or a large number (if maxSize is -1).\r\n */", "meta": { "filename": "Group.js", "lineno": 1162, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getTotalFree", "longname": "Phaser.Physics.Arcade.Group#getTotalFree", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "maxSize minus the number of active group numbers; or a large number (if maxSize is -1)." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#getTotalFree", "inherited": true, "___id": "T000002R053177", "___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": 1180, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setActive", "longname": "Phaser.Physics.Arcade.Group#setActive", "kind": "function", "description": "Sets the `active` property of this Group.\rWhen active, this Group runs its `preUpdate` method.", "since": "3.24.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if this Group should be set as active, false if not.", "name": "value" } ], "inherits": "Phaser.GameObjects.Group#setActive", "inherited": true, "___id": "T000002R053178", "___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": 1198, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setName", "longname": "Phaser.Physics.Arcade.Group#setName", "kind": "function", "description": "Sets the `name` property of this Group.\rThe `name` property is not populated by Phaser and is presented for your own use.", "since": "3.24.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Group.", "name": "value" } ], "inherits": "Phaser.GameObjects.Group#setName", "inherited": true, "___id": "T000002R053179", "___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": 1216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "propertyValueSet", "longname": "Phaser.Physics.Arcade.Group#propertyValueSet", "kind": "function", "description": "Sets the property as defined in `key` of each group member to the given value.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#propertyValueSet", "inherited": true, "___id": "T000002R053180", "___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 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": 1237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "propertyValueInc", "longname": "Phaser.Physics.Arcade.Group#propertyValueInc", "kind": "function", "description": "Adds the given value to the property as defined in `key` of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#propertyValueInc", "inherited": true, "___id": "T000002R053181", "___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": 1258, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setX", "longname": "Phaser.Physics.Arcade.Group#setX", "kind": "function", "description": "Sets the x of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setX", "inherited": true, "___id": "T000002R053182", "___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": 1276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setY", "longname": "Phaser.Physics.Arcade.Group#setY", "kind": "function", "description": "Sets the y of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setY", "inherited": true, "___id": "T000002R053183", "___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": 1294, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setXY", "longname": "Phaser.Physics.Arcade.Group#setXY", "kind": "function", "description": "Sets the x, y of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setXY", "inherited": true, "___id": "T000002R053184", "___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": 1314, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "incX", "longname": "Phaser.Physics.Arcade.Group#incX", "kind": "function", "description": "Adds the given value to the x of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#incX", "inherited": true, "___id": "T000002R053185", "___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": 1332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "incY", "longname": "Phaser.Physics.Arcade.Group#incY", "kind": "function", "description": "Adds the given value to the y of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#incY", "inherited": true, "___id": "T000002R053186", "___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": 1350, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "incXY", "longname": "Phaser.Physics.Arcade.Group#incXY", "kind": "function", "description": "Adds the given value to the x, y of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#incXY", "inherited": true, "___id": "T000002R053187", "___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": 1370, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "shiftPosition", "longname": "Phaser.Physics.Arcade.Group#shiftPosition", "kind": "function", "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.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#shiftPosition", "inherited": true, "___id": "T000002R053188", "___s": true }, { "comment": "/**\r\n * Sets 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 set the angle to, 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": 1392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "angle", "longname": "Phaser.Physics.Arcade.Group#angle", "kind": "function", "description": "Sets the angle of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the angle to, 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" } ], "inherits": "Phaser.GameObjects.Group#angle", "inherited": true, "___id": "T000002R053189", "___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": 1410, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "rotate", "longname": "Phaser.Physics.Arcade.Group#rotate", "kind": "function", "description": "Sets the rotation of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#rotate", "inherited": true, "___id": "T000002R053190", "___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": 1428, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "rotateAround", "longname": "Phaser.Physics.Arcade.Group#rotateAround", "kind": "function", "description": "Rotates each group member around the given point by the given angle.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#rotateAround", "inherited": true, "___id": "T000002R053191", "___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": 1446, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "rotateAroundDistance", "longname": "Phaser.Physics.Arcade.Group#rotateAroundDistance", "kind": "function", "description": "Rotates each group member around the given point by the given angle and distance.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#rotateAroundDistance", "inherited": true, "___id": "T000002R053192", "___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": 1465, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setAlpha", "longname": "Phaser.Physics.Arcade.Group#setAlpha", "kind": "function", "description": "Sets the alpha of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setAlpha", "inherited": true, "___id": "T000002R053193", "___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": 1483, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setTint", "longname": "Phaser.Physics.Arcade.Group#setTint", "kind": "function", "description": "Sets the tint of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setTint", "inherited": true, "___id": "T000002R053194", "___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": 1503, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setOrigin", "longname": "Phaser.Physics.Arcade.Group#setOrigin", "kind": "function", "description": "Sets the originX, originY of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setOrigin", "inherited": true, "___id": "T000002R053195", "___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": 1523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "scaleX", "longname": "Phaser.Physics.Arcade.Group#scaleX", "kind": "function", "description": "Sets the scaleX of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#scaleX", "inherited": true, "___id": "T000002R053196", "___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": 1541, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "scaleY", "longname": "Phaser.Physics.Arcade.Group#scaleY", "kind": "function", "description": "Sets the scaleY of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#scaleY", "inherited": true, "___id": "T000002R053197", "___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 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 *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1559, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "scaleXY", "longname": "Phaser.Physics.Arcade.Group#scaleXY", "kind": "function", "description": "Sets the scaleX, scaleY of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "params": [ { "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" } ], "inherits": "Phaser.GameObjects.Group#scaleXY", "inherited": true, "___id": "T000002R053198", "___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": 1579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setDepth", "longname": "Phaser.Physics.Arcade.Group#setDepth", "kind": "function", "description": "Sets the depth of each group member.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setDepth", "inherited": true, "___id": "T000002R053199", "___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 amount to set the property to.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1597, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setBlendMode", "longname": "Phaser.Physics.Arcade.Group#setBlendMode", "kind": "function", "description": "Sets the blendMode of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the property to.", "name": "value" } ], "inherits": "Phaser.GameObjects.Group#setBlendMode", "inherited": true, "___id": "T000002R053200", "___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": 1614, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setHitArea", "longname": "Phaser.Physics.Arcade.Group#setHitArea", "kind": "function", "description": "Passes all group members to the Input Manager to enable them for input with identical areas and callbacks.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setHitArea", "inherited": true, "___id": "T000002R053201", "___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": 1632, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "shuffle", "longname": "Phaser.Physics.Arcade.Group#shuffle", "kind": "function", "description": "Shuffles the group members in place.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#shuffle", "inherited": true, "___id": "T000002R053202", "___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": 1647, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "kill", "longname": "Phaser.Physics.Arcade.Group#kill", "kind": "function", "description": "Deactivates a member of this group.", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A member of this group.", "name": "gameObject" } ], "inherits": "Phaser.GameObjects.Group#kill", "inherited": true, "___id": "T000002R053203", "___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": 1663, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "killAndHide", "longname": "Phaser.Physics.Arcade.Group#killAndHide", "kind": "function", "description": "Deactivates and hides a member of this group.", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A member of this group.", "name": "gameObject" } ], "inherits": "Phaser.GameObjects.Group#killAndHide", "inherited": true, "___id": "T000002R053204", "___s": true }, { "comment": "/**\r\n * Sets the visible 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": 1680, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setVisible", "longname": "Phaser.Physics.Arcade.Group#setVisible", "kind": "function", "description": "Sets the visible of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setVisible", "inherited": true, "___id": "T000002R053205", "___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": 1699, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "toggleVisible", "longname": "Phaser.Physics.Arcade.Group#toggleVisible", "kind": "function", "description": "Toggles (flips) the visible state of each member of this group.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.GameObjects.Group#toggleVisible", "inherited": true, "___id": "T000002R053206", "___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": 1714, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "destroy", "longname": "Phaser.Physics.Arcade.Group#destroy", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#destroy", "inherited": true, "___id": "T000002R053207", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Physics.Arcade.Group#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R053208", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Physics.Arcade.Group#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R053209", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Physics.Arcade.Group#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R053210", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Physics.Arcade.Group#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R053211", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Physics.Arcade.Group#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R053212", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Physics.Arcade.Group#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R053213", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Physics.Arcade.Group#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R053214", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Physics.Arcade.Group#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R053215", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Physics.Arcade.Group#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R053216", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Physics.Arcade.Group#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R053217", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Physics.Arcade.Group#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R053218", "___s": true }, { "comment": "/**\r\n * Sets the Collision Category that this Arcade Physics Body\r\n * will use in order to determine what it can collide with.\r\n *\r\n * It can only have one single category assigned to it.\r\n *\r\n * If you wish to reset the collision category and mask, call\r\n * the `resetCollisionCategory` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#setCollisionCategory\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCollisionCategory", "longname": "Phaser.Physics.Arcade.Group#setCollisionCategory", "kind": "function", "description": "Sets the Collision Category that this Arcade Physics Body\rwill use in order to determine what it can collide with.\r\rIt can only have one single category assigned to it.\r\rIf you wish to reset the collision category and mask, call\rthe `resetCollisionCategory` method.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#setCollisionCategory", "inherited": true, "___id": "T000002R053219", "___s": true }, { "comment": "/**\r\n * Checks to see if the given Collision Category will collide with\r\n * this Arcade Physics object or not.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#willCollideWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - Collision category value to test.\r\n *\r\n * @return {boolean} `true` if the given category will collide with this object, otherwise `false`.\r\n */", "meta": { "filename": "Collision.js", "lineno": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "willCollideWith", "longname": "Phaser.Physics.Arcade.Group#willCollideWith", "kind": "function", "description": "Checks to see if the given Collision Category will collide with\rthis Arcade Physics object or not.", "since": "3.61.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given category will collide with this object, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Collision category value to test.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#willCollideWith", "inherited": true, "___id": "T000002R053220", "___s": true }, { "comment": "/**\r\n * Adds the given Collision Category to the list of those that this\r\n * Arcade Physics Body will collide with.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#addCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category to add.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 60, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "addCollidesWith", "longname": "Phaser.Physics.Arcade.Group#addCollidesWith", "kind": "function", "description": "Adds the given Collision Category to the list of those that this\rArcade Physics Body will collide with.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category to add.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#addCollidesWith", "inherited": true, "___id": "T000002R053221", "___s": true }, { "comment": "/**\r\n * Removes the given Collision Category from the list of those that this\r\n * Arcade Physics Body will collide with.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#removeCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category to add.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "removeCollidesWith", "longname": "Phaser.Physics.Arcade.Group#removeCollidesWith", "kind": "function", "description": "Removes the given Collision Category from the list of those that this\rArcade Physics Body will collide with.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category to add.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#removeCollidesWith", "inherited": true, "___id": "T000002R053222", "___s": true }, { "comment": "/**\r\n * Sets all of the Collision Categories that this Arcade Physics Body\r\n * will collide with. You can either pass a single category value, or\r\n * an array of them.\r\n *\r\n * Calling this method will reset all of the collision categories,\r\n * so only those passed to this method are enabled.\r\n *\r\n * If you wish to add a new category to the existing mask, call\r\n * the `addCollisionCategory` method.\r\n *\r\n * If you wish to reset the collision category and mask, call\r\n * the `resetCollisionCategory` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#setCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {(number|number[])} categories - The collision category to collide with, or an array of them.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCollidesWith", "longname": "Phaser.Physics.Arcade.Group#setCollidesWith", "kind": "function", "description": "Sets all of the Collision Categories that this Arcade Physics Body\rwill collide with. You can either pass a single category value, or\ran array of them.\r\rCalling this method will reset all of the collision categories,\rso only those passed to this method are enabled.\r\rIf you wish to add a new category to the existing mask, call\rthe `addCollisionCategory` method.\r\rIf you wish to reset the collision category and mask, call\rthe `resetCollisionCategory` method.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "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" } ] } ] } }, "description": "The collision category to collide with, or an array of them.", "name": "categories" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#setCollidesWith", "inherited": true, "___id": "T000002R053223", "___s": true }, { "comment": "/**\r\n * Resets the Collision Category and Mask back to the defaults,\r\n * which is to collide with everything.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#resetCollisionCategory\r\n * @since 3.61.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "resetCollisionCategory", "longname": "Phaser.Physics.Arcade.Group#resetCollisionCategory", "kind": "function", "description": "Resets the Collision Category and Mask back to the defaults,\rwhich is to collide with everything.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.Group", "scope": "instance", "inherits": "Phaser.Physics.Arcade.Components.Collision#resetCollisionCategory", "inherited": true, "___id": "T000002R053224", "___s": true }, { "comment": "/**\r\n * Sets the Collision Category that this Arcade Physics Body\r\n * will use in order to determine what it can collide with.\r\n *\r\n * It can only have one single category assigned to it.\r\n *\r\n * If you wish to reset the collision category and mask, call\r\n * the `resetCollisionCategory` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#setCollisionCategory\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCollisionCategory", "longname": "Phaser.Physics.Arcade.StaticBody#setCollisionCategory", "kind": "function", "description": "Sets the Collision Category that this Arcade Physics Body\rwill use in order to determine what it can collide with.\r\rIt can only have one single category assigned to it.\r\rIf you wish to reset the collision category and mask, call\rthe `resetCollisionCategory` method.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#setCollisionCategory", "inherited": true, "___id": "T000002R053225", "___s": true }, { "comment": "/**\r\n * Checks to see if the given Collision Category will collide with\r\n * this Arcade Physics object or not.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#willCollideWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - Collision category value to test.\r\n *\r\n * @return {boolean} `true` if the given category will collide with this object, otherwise `false`.\r\n */", "meta": { "filename": "Collision.js", "lineno": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "willCollideWith", "longname": "Phaser.Physics.Arcade.StaticBody#willCollideWith", "kind": "function", "description": "Checks to see if the given Collision Category will collide with\rthis Arcade Physics object or not.", "since": "3.61.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given category will collide with this object, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Collision category value to test.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#willCollideWith", "inherited": true, "___id": "T000002R053226", "___s": true }, { "comment": "/**\r\n * Adds the given Collision Category to the list of those that this\r\n * Arcade Physics Body will collide with.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#addCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category to add.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 60, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "addCollidesWith", "longname": "Phaser.Physics.Arcade.StaticBody#addCollidesWith", "kind": "function", "description": "Adds the given Collision Category to the list of those that this\rArcade Physics Body will collide with.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category to add.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#addCollidesWith", "inherited": true, "___id": "T000002R053227", "___s": true }, { "comment": "/**\r\n * Removes the given Collision Category from the list of those that this\r\n * Arcade Physics Body will collide with.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#removeCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category to add.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "removeCollidesWith", "longname": "Phaser.Physics.Arcade.StaticBody#removeCollidesWith", "kind": "function", "description": "Removes the given Collision Category from the list of those that this\rArcade Physics Body will collide with.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category to add.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#removeCollidesWith", "inherited": true, "___id": "T000002R053228", "___s": true }, { "comment": "/**\r\n * Sets all of the Collision Categories that this Arcade Physics Body\r\n * will collide with. You can either pass a single category value, or\r\n * an array of them.\r\n *\r\n * Calling this method will reset all of the collision categories,\r\n * so only those passed to this method are enabled.\r\n *\r\n * If you wish to add a new category to the existing mask, call\r\n * the `addCollisionCategory` method.\r\n *\r\n * If you wish to reset the collision category and mask, call\r\n * the `resetCollisionCategory` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#setCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {(number|number[])} categories - The collision category to collide with, or an array of them.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCollidesWith", "longname": "Phaser.Physics.Arcade.StaticBody#setCollidesWith", "kind": "function", "description": "Sets all of the Collision Categories that this Arcade Physics Body\rwill collide with. You can either pass a single category value, or\ran array of them.\r\rCalling this method will reset all of the collision categories,\rso only those passed to this method are enabled.\r\rIf you wish to add a new category to the existing mask, call\rthe `addCollisionCategory` method.\r\rIf you wish to reset the collision category and mask, call\rthe `resetCollisionCategory` method.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "scope": "instance", "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" } ] } ] } }, "description": "The collision category to collide with, or an array of them.", "name": "categories" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#setCollidesWith", "inherited": true, "___id": "T000002R053229", "___s": true }, { "comment": "/**\r\n * Resets the Collision Category and Mask back to the defaults,\r\n * which is to collide with everything.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#resetCollisionCategory\r\n * @since 3.61.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "resetCollisionCategory", "longname": "Phaser.Physics.Arcade.StaticBody#resetCollisionCategory", "kind": "function", "description": "Resets the Collision Category and Mask back to the defaults,\rwhich is to collide with everything.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.StaticBody", "scope": "instance", "inherits": "Phaser.Physics.Arcade.Components.Collision#resetCollisionCategory", "inherited": true, "___id": "T000002R053230", "___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": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "scene", "longname": "Phaser.Physics.Arcade.StaticGroup#scene", "kind": "member", "description": "This scene this group belongs to.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#scene", "inherited": true, "___id": "T000002R053231", "___s": true }, { "comment": "/**\r\n * Members of this group.\r\n *\r\n * @name Phaser.GameObjects.Group#children\r\n * @type {Phaser.Structs.Set.}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Group.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "children", "longname": "Phaser.Physics.Arcade.StaticGroup#children", "kind": "member", "description": "Members of this group.", "type": { "names": [ "Phaser.Structs.Set." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.Set" }, "applications": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#children", "inherited": true, "___id": "T000002R053232", "___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": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "isParent", "longname": "Phaser.Physics.Arcade.StaticGroup#isParent", "kind": "member", "description": "A flag identifying this object as a group.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#isParent", "inherited": true, "___id": "T000002R053233", "___s": true }, { "comment": "/**\r\n * The class to create new group members from.\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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "classType", "longname": "Phaser.Physics.Arcade.StaticGroup#classType", "kind": "member", "description": "The class to create new group members from.", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.0.0", "defaultvalue": "Phaser.GameObjects.Sprite", "see": [ "Phaser.Types.GameObjects.Group.GroupClassTypeConstructor" ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#classType", "inherited": true, "___id": "T000002R053234", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "name", "longname": "Phaser.Physics.Arcade.StaticGroup#name", "kind": "member", "description": "The name of this group.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.18.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#name", "inherited": true, "___id": "T000002R053235", "___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": 147, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "active", "longname": "Phaser.Physics.Arcade.StaticGroup#active", "kind": "member", "description": "Whether this group runs its {@link Phaser.GameObjects.Group#preUpdate} method (which may update any members).", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#active", "inherited": true, "___id": "T000002R053236", "___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": 156, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "maxSize", "longname": "Phaser.Physics.Arcade.StaticGroup#maxSize", "kind": "member", "description": "The maximum size of this group, if used as a pool. -1 is no limit.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "defaultvalue": "-1", "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#maxSize", "inherited": true, "___id": "T000002R053237", "___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": 166, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "defaultKey", "longname": "Phaser.Physics.Arcade.StaticGroup#defaultKey", "kind": "member", "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}.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#defaultKey", "inherited": true, "___id": "T000002R053238", "___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": 178, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "defaultFrame", "longname": "Phaser.Physics.Arcade.StaticGroup#defaultFrame", "kind": "member", "description": "A default texture frame to use when creating new group members.", "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#defaultFrame", "inherited": true, "___id": "T000002R053239", "___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": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "runChildUpdate", "longname": "Phaser.Physics.Arcade.StaticGroup#runChildUpdate", "kind": "member", "description": "Whether to call the update method of any members.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "see": [ "Phaser.GameObjects.Group#preUpdate" ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#runChildUpdate", "inherited": true, "___id": "T000002R053240", "___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": 198, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "createCallback", "longname": "Phaser.Physics.Arcade.StaticGroup#createCallback", "kind": "member", "description": "A function to be called when adding or creating group members.", "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.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#createCallback", "inherited": true, "___id": "T000002R053241", "___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": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "removeCallback", "longname": "Phaser.Physics.Arcade.StaticGroup#removeCallback", "kind": "member", "description": "A function to be called when removing group members.", "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.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#removeCallback", "inherited": true, "___id": "T000002R053242", "___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": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "createMultipleCallback", "longname": "Phaser.Physics.Arcade.StaticGroup#createMultipleCallback", "kind": "member", "description": "A function to be called when creating several group members at once.", "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.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#createMultipleCallback", "inherited": true, "___id": "T000002R053243", "___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": 273, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "create", "longname": "Phaser.Physics.Arcade.StaticGroup#create", "kind": "function", "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}.", "since": "3.0.0", "returns": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The new Game Object (usually a Sprite, etc.)." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#create", "inherited": true, "___id": "T000002R053246", "___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": 318, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "createMultiple", "longname": "Phaser.Physics.Arcade.StaticGroup#createMultiple", "kind": "function", "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}.", "since": "3.0.0", "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.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#createMultiple", "inherited": true, "___id": "T000002R053247", "___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": 359, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "createFromConfig", "longname": "Phaser.Physics.Arcade.StaticGroup#createFromConfig", "kind": "function", "description": "A helper for {@link Phaser.GameObjects.Group#createMultiple}.", "since": "3.0.0", "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.Physics.Arcade.StaticGroup", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Group.GroupCreateConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupCreateConfig" } }, "description": "Creation settings.", "name": "options" } ], "inherits": "Phaser.GameObjects.Group#createFromConfig", "inherited": true, "___id": "T000002R053248", "___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": 545, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "preUpdate", "longname": "Phaser.Physics.Arcade.StaticGroup#preUpdate", "kind": "function", "description": "Updates any group members, if {@link Phaser.GameObjects.Group#runChildUpdate} is enabled.", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#preUpdate", "inherited": true, "___id": "T000002R053249", "___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": 575, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "add", "longname": "Phaser.Physics.Arcade.StaticGroup#add", "kind": "function", "description": "Adds a Game Object to this group.\r\rCalls {@link Phaser.GameObjects.Group#createCallback}.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#add", "inherited": true, "___id": "T000002R053250", "___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": 620, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "addMultiple", "longname": "Phaser.Physics.Arcade.StaticGroup#addMultiple", "kind": "function", "description": "Adds several Game Objects to this group.\r\rCalls {@link Phaser.GameObjects.Group#createCallback}.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This group." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#addMultiple", "inherited": true, "___id": "T000002R053251", "___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": 648, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "remove", "longname": "Phaser.Physics.Arcade.StaticGroup#remove", "kind": "function", "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}.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#remove", "inherited": true, "___id": "T000002R053252", "___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": 699, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "clear", "longname": "Phaser.Physics.Arcade.StaticGroup#clear", "kind": "function", "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}.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This group." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#clear", "inherited": true, "___id": "T000002R053253", "___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": 741, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "contains", "longname": "Phaser.Physics.Arcade.StaticGroup#contains", "kind": "function", "description": "Tests if a Game Object is a member of this group.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object is a member of this group." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A Game Object.", "name": "child" } ], "inherits": "Phaser.GameObjects.Group#contains", "inherited": true, "___id": "T000002R053254", "___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": 756, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getChildren", "longname": "Phaser.Physics.Arcade.StaticGroup#getChildren", "kind": "function", "description": "All members of the group.", "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.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#getChildren", "inherited": true, "___id": "T000002R053255", "___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}\r\n */", "meta": { "filename": "Group.js", "lineno": 769, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getLength", "longname": "Phaser.Physics.Arcade.StaticGroup#getLength", "kind": "function", "description": "The number of members of the group.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } } } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#getLength", "inherited": true, "___id": "T000002R053256", "___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": 782, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getMatching", "longname": "Phaser.Physics.Arcade.StaticGroup#getMatching", "kind": "function", "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.", "since": "3.50.0", "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.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#getMatching", "inherited": true, "___id": "T000002R053257", "___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": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getFirst", "longname": "Phaser.Physics.Arcade.StaticGroup#getFirst", "kind": "function", "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.", "since": "3.0.0", "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.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#getFirst", "inherited": true, "___id": "T000002R053258", "___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 first matching group member, or a newly created member, or null.\r\n */", "meta": { "filename": "Group.js", "lineno": 831, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getFirstNth", "longname": "Phaser.Physics.Arcade.StaticGroup#getFirstNth", "kind": "function", "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.", "since": "3.6.0", "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.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#getFirstNth", "inherited": true, "___id": "T000002R053259", "___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 first matching group member, or a newly created member, or null.\r\n */", "meta": { "filename": "Group.js", "lineno": 857, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getLast", "longname": "Phaser.Physics.Arcade.StaticGroup#getLast", "kind": "function", "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.", "since": "3.6.0", "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.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#getLast", "inherited": true, "___id": "T000002R053260", "___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 first matching group member, or a newly created member, or null.\r\n */", "meta": { "filename": "Group.js", "lineno": 882, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getLastNth", "longname": "Phaser.Physics.Arcade.StaticGroup#getLastNth", "kind": "function", "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.", "since": "3.6.0", "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.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#getLastNth", "inherited": true, "___id": "T000002R053261", "___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": 1011, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "get", "longname": "Phaser.Physics.Arcade.StaticGroup#get", "kind": "function", "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.", "since": "3.0.0", "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.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#get", "inherited": true, "___id": "T000002R053263", "___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": 1035, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getFirstAlive", "longname": "Phaser.Physics.Arcade.StaticGroup#getFirstAlive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The first active group member, or a newly created member, or null." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#getFirstAlive", "inherited": true, "___id": "T000002R053264", "___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": 1059, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getFirstDead", "longname": "Phaser.Physics.Arcade.StaticGroup#getFirstDead", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The first inactive group member, or a newly created member, or null." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#getFirstDead", "inherited": true, "___id": "T000002R053265", "___s": true }, { "comment": "/**\r\n * {@link Phaser.GameObjects.Components.Animation#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": 1084, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "playAnimation", "longname": "Phaser.Physics.Arcade.StaticGroup#playAnimation", "kind": "function", "description": "{@link Phaser.GameObjects.Components.Animation#play Plays} an animation for all members of this group.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#playAnimation", "inherited": true, "___id": "T000002R053266", "___s": true }, { "comment": "/**\r\n * Whether this group's size 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": 1102, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "isFull", "longname": "Phaser.Physics.Arcade.StaticGroup#isFull", "kind": "function", "description": "Whether this group's size at its {@link Phaser.GameObjects.Group#maxSize maximum}.", "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.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#isFull", "inherited": true, "___id": "T000002R053267", "___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": 1122, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "countActive", "longname": "Phaser.Physics.Arcade.StaticGroup#countActive", "kind": "function", "description": "Counts the number of active (or inactive) group members.", "since": "3.0.0", "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.Physics.Arcade.StaticGroup", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Count active (true) or inactive (false) group members.", "name": "value" } ], "inherits": "Phaser.GameObjects.Group#countActive", "inherited": true, "___id": "T000002R053268", "___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": 1149, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getTotalUsed", "longname": "Phaser.Physics.Arcade.StaticGroup#getTotalUsed", "kind": "function", "description": "Counts the number of in-use (active) group members.", "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.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#getTotalUsed", "inherited": true, "___id": "T000002R053269", "___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 numbers; or a large number (if maxSize is -1).\r\n */", "meta": { "filename": "Group.js", "lineno": 1162, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "getTotalFree", "longname": "Phaser.Physics.Arcade.StaticGroup#getTotalFree", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "maxSize minus the number of active group numbers; or a large number (if maxSize is -1)." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#getTotalFree", "inherited": true, "___id": "T000002R053270", "___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": 1180, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setActive", "longname": "Phaser.Physics.Arcade.StaticGroup#setActive", "kind": "function", "description": "Sets the `active` property of this Group.\rWhen active, this Group runs its `preUpdate` method.", "since": "3.24.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if this Group should be set as active, false if not.", "name": "value" } ], "inherits": "Phaser.GameObjects.Group#setActive", "inherited": true, "___id": "T000002R053271", "___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": 1198, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setName", "longname": "Phaser.Physics.Arcade.StaticGroup#setName", "kind": "function", "description": "Sets the `name` property of this Group.\rThe `name` property is not populated by Phaser and is presented for your own use.", "since": "3.24.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Group.", "name": "value" } ], "inherits": "Phaser.GameObjects.Group#setName", "inherited": true, "___id": "T000002R053272", "___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": 1216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "propertyValueSet", "longname": "Phaser.Physics.Arcade.StaticGroup#propertyValueSet", "kind": "function", "description": "Sets the property as defined in `key` of each group member to the given value.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#propertyValueSet", "inherited": true, "___id": "T000002R053273", "___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 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": 1237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "propertyValueInc", "longname": "Phaser.Physics.Arcade.StaticGroup#propertyValueInc", "kind": "function", "description": "Adds the given value to the property as defined in `key` of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#propertyValueInc", "inherited": true, "___id": "T000002R053274", "___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": 1258, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setX", "longname": "Phaser.Physics.Arcade.StaticGroup#setX", "kind": "function", "description": "Sets the x of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setX", "inherited": true, "___id": "T000002R053275", "___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": 1276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setY", "longname": "Phaser.Physics.Arcade.StaticGroup#setY", "kind": "function", "description": "Sets the y of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setY", "inherited": true, "___id": "T000002R053276", "___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": 1294, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setXY", "longname": "Phaser.Physics.Arcade.StaticGroup#setXY", "kind": "function", "description": "Sets the x, y of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setXY", "inherited": true, "___id": "T000002R053277", "___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": 1314, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "incX", "longname": "Phaser.Physics.Arcade.StaticGroup#incX", "kind": "function", "description": "Adds the given value to the x of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#incX", "inherited": true, "___id": "T000002R053278", "___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": 1332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "incY", "longname": "Phaser.Physics.Arcade.StaticGroup#incY", "kind": "function", "description": "Adds the given value to the y of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#incY", "inherited": true, "___id": "T000002R053279", "___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": 1350, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "incXY", "longname": "Phaser.Physics.Arcade.StaticGroup#incXY", "kind": "function", "description": "Adds the given value to the x, y of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#incXY", "inherited": true, "___id": "T000002R053280", "___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": 1370, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "shiftPosition", "longname": "Phaser.Physics.Arcade.StaticGroup#shiftPosition", "kind": "function", "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.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#shiftPosition", "inherited": true, "___id": "T000002R053281", "___s": true }, { "comment": "/**\r\n * Sets 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 set the angle to, 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": 1392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "angle", "longname": "Phaser.Physics.Arcade.StaticGroup#angle", "kind": "function", "description": "Sets the angle of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the angle to, 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" } ], "inherits": "Phaser.GameObjects.Group#angle", "inherited": true, "___id": "T000002R053282", "___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": 1410, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "rotate", "longname": "Phaser.Physics.Arcade.StaticGroup#rotate", "kind": "function", "description": "Sets the rotation of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#rotate", "inherited": true, "___id": "T000002R053283", "___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": 1428, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "rotateAround", "longname": "Phaser.Physics.Arcade.StaticGroup#rotateAround", "kind": "function", "description": "Rotates each group member around the given point by the given angle.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#rotateAround", "inherited": true, "___id": "T000002R053284", "___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": 1446, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "rotateAroundDistance", "longname": "Phaser.Physics.Arcade.StaticGroup#rotateAroundDistance", "kind": "function", "description": "Rotates each group member around the given point by the given angle and distance.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#rotateAroundDistance", "inherited": true, "___id": "T000002R053285", "___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": 1465, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setAlpha", "longname": "Phaser.Physics.Arcade.StaticGroup#setAlpha", "kind": "function", "description": "Sets the alpha of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setAlpha", "inherited": true, "___id": "T000002R053286", "___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": 1483, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setTint", "longname": "Phaser.Physics.Arcade.StaticGroup#setTint", "kind": "function", "description": "Sets the tint of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setTint", "inherited": true, "___id": "T000002R053287", "___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": 1503, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setOrigin", "longname": "Phaser.Physics.Arcade.StaticGroup#setOrigin", "kind": "function", "description": "Sets the originX, originY of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setOrigin", "inherited": true, "___id": "T000002R053288", "___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": 1523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "scaleX", "longname": "Phaser.Physics.Arcade.StaticGroup#scaleX", "kind": "function", "description": "Sets the scaleX of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#scaleX", "inherited": true, "___id": "T000002R053289", "___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": 1541, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "scaleY", "longname": "Phaser.Physics.Arcade.StaticGroup#scaleY", "kind": "function", "description": "Sets the scaleY of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#scaleY", "inherited": true, "___id": "T000002R053290", "___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 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 *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1559, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "scaleXY", "longname": "Phaser.Physics.Arcade.StaticGroup#scaleXY", "kind": "function", "description": "Sets the scaleX, scaleY of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "params": [ { "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" } ], "inherits": "Phaser.GameObjects.Group#scaleXY", "inherited": true, "___id": "T000002R053291", "___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": 1579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setDepth", "longname": "Phaser.Physics.Arcade.StaticGroup#setDepth", "kind": "function", "description": "Sets the depth of each group member.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setDepth", "inherited": true, "___id": "T000002R053292", "___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 amount to set the property to.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1597, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setBlendMode", "longname": "Phaser.Physics.Arcade.StaticGroup#setBlendMode", "kind": "function", "description": "Sets the blendMode of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the property to.", "name": "value" } ], "inherits": "Phaser.GameObjects.Group#setBlendMode", "inherited": true, "___id": "T000002R053293", "___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": 1614, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setHitArea", "longname": "Phaser.Physics.Arcade.StaticGroup#setHitArea", "kind": "function", "description": "Passes all group members to the Input Manager to enable them for input with identical areas and callbacks.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setHitArea", "inherited": true, "___id": "T000002R053294", "___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": 1632, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "shuffle", "longname": "Phaser.Physics.Arcade.StaticGroup#shuffle", "kind": "function", "description": "Shuffles the group members in place.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#shuffle", "inherited": true, "___id": "T000002R053295", "___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": 1647, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "kill", "longname": "Phaser.Physics.Arcade.StaticGroup#kill", "kind": "function", "description": "Deactivates a member of this group.", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A member of this group.", "name": "gameObject" } ], "inherits": "Phaser.GameObjects.Group#kill", "inherited": true, "___id": "T000002R053296", "___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": 1663, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "killAndHide", "longname": "Phaser.Physics.Arcade.StaticGroup#killAndHide", "kind": "function", "description": "Deactivates and hides a member of this group.", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A member of this group.", "name": "gameObject" } ], "inherits": "Phaser.GameObjects.Group#killAndHide", "inherited": true, "___id": "T000002R053297", "___s": true }, { "comment": "/**\r\n * Sets the visible 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": 1680, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "setVisible", "longname": "Phaser.Physics.Arcade.StaticGroup#setVisible", "kind": "function", "description": "Sets the visible of each group member.", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#setVisible", "inherited": true, "___id": "T000002R053298", "___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": 1699, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "toggleVisible", "longname": "Phaser.Physics.Arcade.StaticGroup#toggleVisible", "kind": "function", "description": "Toggles (flips) the visible state of each member of this group.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.GameObjects.Group#toggleVisible", "inherited": true, "___id": "T000002R053299", "___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": 1714, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "name": "destroy", "longname": "Phaser.Physics.Arcade.StaticGroup#destroy", "kind": "function", "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.", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Group#destroy", "inherited": true, "___id": "T000002R053300", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Physics.Arcade.StaticGroup#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R053301", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Physics.Arcade.StaticGroup#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R053302", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Physics.Arcade.StaticGroup#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R053303", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Physics.Arcade.StaticGroup#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R053304", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Physics.Arcade.StaticGroup#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R053305", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Physics.Arcade.StaticGroup#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R053306", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Physics.Arcade.StaticGroup#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R053307", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Physics.Arcade.StaticGroup#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R053308", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Physics.Arcade.StaticGroup#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R053309", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Physics.Arcade.StaticGroup#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R053310", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Physics.Arcade.StaticGroup#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R053311", "___s": true }, { "comment": "/**\r\n * Sets the Collision Category that this Arcade Physics Body\r\n * will use in order to determine what it can collide with.\r\n *\r\n * It can only have one single category assigned to it.\r\n *\r\n * If you wish to reset the collision category and mask, call\r\n * the `resetCollisionCategory` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#setCollisionCategory\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCollisionCategory", "longname": "Phaser.Physics.Arcade.StaticGroup#setCollisionCategory", "kind": "function", "description": "Sets the Collision Category that this Arcade Physics Body\rwill use in order to determine what it can collide with.\r\rIt can only have one single category assigned to it.\r\rIf you wish to reset the collision category and mask, call\rthe `resetCollisionCategory` method.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#setCollisionCategory", "inherited": true, "___id": "T000002R053312", "___s": true }, { "comment": "/**\r\n * Checks to see if the given Collision Category will collide with\r\n * this Arcade Physics object or not.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#willCollideWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - Collision category value to test.\r\n *\r\n * @return {boolean} `true` if the given category will collide with this object, otherwise `false`.\r\n */", "meta": { "filename": "Collision.js", "lineno": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "willCollideWith", "longname": "Phaser.Physics.Arcade.StaticGroup#willCollideWith", "kind": "function", "description": "Checks to see if the given Collision Category will collide with\rthis Arcade Physics object or not.", "since": "3.61.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given category will collide with this object, otherwise `false`." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Collision category value to test.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#willCollideWith", "inherited": true, "___id": "T000002R053313", "___s": true }, { "comment": "/**\r\n * Adds the given Collision Category to the list of those that this\r\n * Arcade Physics Body will collide with.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#addCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category to add.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 60, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "addCollidesWith", "longname": "Phaser.Physics.Arcade.StaticGroup#addCollidesWith", "kind": "function", "description": "Adds the given Collision Category to the list of those that this\rArcade Physics Body will collide with.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category to add.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#addCollidesWith", "inherited": true, "___id": "T000002R053314", "___s": true }, { "comment": "/**\r\n * Removes the given Collision Category from the list of those that this\r\n * Arcade Physics Body will collide with.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#removeCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category to add.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "removeCollidesWith", "longname": "Phaser.Physics.Arcade.StaticGroup#removeCollidesWith", "kind": "function", "description": "Removes the given Collision Category from the list of those that this\rArcade Physics Body will collide with.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category to add.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#removeCollidesWith", "inherited": true, "___id": "T000002R053315", "___s": true }, { "comment": "/**\r\n * Sets all of the Collision Categories that this Arcade Physics Body\r\n * will collide with. You can either pass a single category value, or\r\n * an array of them.\r\n *\r\n * Calling this method will reset all of the collision categories,\r\n * so only those passed to this method are enabled.\r\n *\r\n * If you wish to add a new category to the existing mask, call\r\n * the `addCollisionCategory` method.\r\n *\r\n * If you wish to reset the collision category and mask, call\r\n * the `resetCollisionCategory` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#setCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {(number|number[])} categories - The collision category to collide with, or an array of them.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCollidesWith", "longname": "Phaser.Physics.Arcade.StaticGroup#setCollidesWith", "kind": "function", "description": "Sets all of the Collision Categories that this Arcade Physics Body\rwill collide with. You can either pass a single category value, or\ran array of them.\r\rCalling this method will reset all of the collision categories,\rso only those passed to this method are enabled.\r\rIf you wish to add a new category to the existing mask, call\rthe `addCollisionCategory` method.\r\rIf you wish to reset the collision category and mask, call\rthe `resetCollisionCategory` method.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "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" } ] } ] } }, "description": "The collision category to collide with, or an array of them.", "name": "categories" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#setCollidesWith", "inherited": true, "___id": "T000002R053316", "___s": true }, { "comment": "/**\r\n * Resets the Collision Category and Mask back to the defaults,\r\n * which is to collide with everything.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#resetCollisionCategory\r\n * @since 3.61.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "resetCollisionCategory", "longname": "Phaser.Physics.Arcade.StaticGroup#resetCollisionCategory", "kind": "function", "description": "Resets the Collision Category and Mask back to the defaults,\rwhich is to collide with everything.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Arcade.StaticGroup", "scope": "instance", "inherits": "Phaser.Physics.Arcade.Components.Collision#resetCollisionCategory", "inherited": true, "___id": "T000002R053317", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Physics.Arcade.World#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Physics.Arcade.World", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R053318", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Physics.Arcade.World#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Physics.Arcade.World", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R053319", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Physics.Arcade.World#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Physics.Arcade.World", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R053320", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Physics.Arcade.World#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Physics.Arcade.World", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R053321", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Physics.Arcade.World#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.World", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R053322", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Physics.Arcade.World#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.World", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R053323", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Physics.Arcade.World#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.World", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R053324", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Physics.Arcade.World#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.World", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R053325", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Physics.Arcade.World#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.World", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R053326", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Physics.Arcade.World#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Arcade.World", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R053327", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.Physics.Matter.Image#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R053330", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.Physics.Matter.Image#displayList", "kind": "member", "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.", "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R053331", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.Physics.Matter.Image#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R053332", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.Physics.Matter.Image#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R053333", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.Physics.Matter.Image#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R053334", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.Physics.Matter.Image#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R053335", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.Physics.Matter.Image#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R053336", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.Physics.Matter.Image#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R053337", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.Physics.Matter.Image#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R053338", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.Physics.Matter.Image#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R053339", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.Physics.Matter.Image#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R053340", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.Physics.Matter.Image#input", "kind": "member", "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()`.", "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R053341", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.Physics.Matter.Image#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R053342", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.Physics.Matter.Image#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R053343", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.Physics.Matter.Image#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R053344", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.Physics.Matter.Image#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R053345", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.Physics.Matter.Image#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R053346", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.Physics.Matter.Image#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "since": "3.0.0", "see": [ "Phaser.Data.DataManager" ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R053347", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.Physics.Matter.Image#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R053348", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.Physics.Matter.Image#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R053349", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.Physics.Matter.Image#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R053350", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.Physics.Matter.Image#getData", "kind": "function", "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.", "since": "3.0.0", "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R053351", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.Physics.Matter.Image#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R053352", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.Physics.Matter.Image#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R053353", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.Physics.Matter.Image#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R053354", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.Physics.Matter.Image#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R053355", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.Physics.Matter.Image#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R053356", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.Physics.Matter.Image#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R053357", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.Physics.Matter.Image#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R053358", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.Physics.Matter.Image#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R053359", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.Physics.Matter.Image#getIndexList", "kind": "function", "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.", "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R053360", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.Physics.Matter.Image#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R053361", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.Physics.Matter.Image#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R053362", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.Physics.Matter.Image#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R053363", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.Physics.Matter.Image#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R053364", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.Physics.Matter.Image#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R053365", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Physics.Matter.Image#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R053366", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Physics.Matter.Image#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R053367", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Physics.Matter.Image#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R053368", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Physics.Matter.Image#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R053369", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Physics.Matter.Image#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R053370", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Physics.Matter.Image#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R053371", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Physics.Matter.Image#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R053372", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Physics.Matter.Image#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R053373", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Physics.Matter.Image#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R053374", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Physics.Matter.Image#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R053375", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Physics.Matter.Image#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R053376", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.Physics.Matter.Image#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#clearAlpha", "___id": "T000002R053382", "___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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.Physics.Matter.Image#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#setAlpha", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Alpha#setAlpha", "___id": "T000002R053383", "___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 *\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.Physics.Matter.Image#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alpha", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alpha", "___id": "T000002R053384", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.Physics.Matter.Image#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "___id": "T000002R053385", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.Physics.Matter.Image#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "___id": "T000002R053386", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.Physics.Matter.Image#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "___id": "T000002R053387", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.Physics.Matter.Image#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "___id": "T000002R053388", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.Physics.Matter.Image#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "overrides": "Phaser.GameObjects.Components.BlendMode#blendMode", "___id": "T000002R053390", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.Physics.Matter.Image#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "___id": "T000002R053391", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.Physics.Matter.Image#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "overrides": "Phaser.GameObjects.Components.Depth#depth", "___id": "T000002R053393", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.Physics.Matter.Image#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Depth#setDepth", "___id": "T000002R053394", "___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.Components.Flip#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipX", "longname": "Phaser.Physics.Matter.Image#flipX", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#flipX", "___id": "T000002R053395", "___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.Components.Flip#flipY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipY", "longname": "Phaser.Physics.Matter.Image#flipY", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#flipY", "___id": "T000002R053396", "___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 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 * @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": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipX", "longname": "Phaser.Physics.Matter.Image#toggleFlipX", "kind": "function", "description": "Toggles the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#toggleFlipX", "___id": "T000002R053397", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipY", "longname": "Phaser.Physics.Matter.Image#toggleFlipY", "kind": "function", "description": "Toggles the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#toggleFlipY", "___id": "T000002R053398", "___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 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 * @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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipX", "longname": "Phaser.Physics.Matter.Image#setFlipX", "kind": "function", "description": "Sets the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlipX", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Flip#setFlipX", "___id": "T000002R053399", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\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": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipY", "longname": "Phaser.Physics.Matter.Image#setFlipY", "kind": "function", "description": "Sets the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlipY", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Flip#setFlipY", "___id": "T000002R053400", "___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 inversed 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 horizontal 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": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlip", "longname": "Phaser.Physics.Matter.Image#setFlip", "kind": "function", "description": "Sets the horizontal and vertical flipped state of this Game Object.\r\rA Game Object that is flipped will render inversed 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlip", "inherited": true, "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 horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "overrides": "Phaser.GameObjects.Components.Flip#setFlip", "___id": "T000002R053401", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetFlip", "longname": "Phaser.Physics.Matter.Image#resetFlip", "kind": "function", "description": "Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#resetFlip", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#resetFlip", "___id": "T000002R053402", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.Physics.Matter.Image#getCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getCenter", "___id": "T000002R053404", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.Physics.Matter.Image#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "___id": "T000002R053405", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.Physics.Matter.Image#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "___id": "T000002R053406", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.Physics.Matter.Image#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getTopRight", "___id": "T000002R053407", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.Physics.Matter.Image#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "___id": "T000002R053408", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.Physics.Matter.Image#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "___id": "T000002R053409", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.Physics.Matter.Image#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "___id": "T000002R053410", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.Physics.Matter.Image#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "___id": "T000002R053411", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.Physics.Matter.Image#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "___id": "T000002R053412", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.Physics.Matter.Image#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getBounds", "___id": "T000002R053413", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.Physics.Matter.Image#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "overrides": "Phaser.GameObjects.Components.Mask#mask", "___id": "T000002R053414", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.Physics.Matter.Image#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "overrides": "Phaser.GameObjects.Components.Mask#setMask", "___id": "T000002R053415", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.Physics.Matter.Image#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "overrides": "Phaser.GameObjects.Components.Mask#clearMask", "___id": "T000002R053416", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.Physics.Matter.Image#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "overrides": "Phaser.GameObjects.Components.Mask#createBitmapMask", "___id": "T000002R053417", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.Physics.Matter.Image#createGeometryMask", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } }, "description": "This Geometry Mask that was created." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Mask#createGeometryMask", "___id": "T000002R053418", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.Physics.Matter.Image#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#originX", "___id": "T000002R053420", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.Physics.Matter.Image#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#originY", "___id": "T000002R053421", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.Physics.Matter.Image#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#displayOriginX", "___id": "T000002R053422", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.Physics.Matter.Image#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#displayOriginY", "___id": "T000002R053423", "___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": {} }, "name": "setOrigin", "longname": "Phaser.Physics.Matter.Image#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Origin#setOrigin", "___id": "T000002R053424", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.Physics.Matter.Image#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "___id": "T000002R053425", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.Physics.Matter.Image#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "___id": "T000002R053426", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.Physics.Matter.Image#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "___id": "T000002R053427", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.Physics.Matter.Image#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "overrides": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "___id": "T000002R053428", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.Physics.Matter.Image#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "overrides": "Phaser.GameObjects.Components.Pipeline#pipeline", "___id": "T000002R053429", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.Physics.Matter.Image#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "overrides": "Phaser.GameObjects.Components.Pipeline#pipelineData", "___id": "T000002R053430", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.Physics.Matter.Image#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "overrides": "Phaser.GameObjects.Components.Pipeline#initPipeline", "___id": "T000002R053431", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.Physics.Matter.Image#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "overrides": "Phaser.GameObjects.Components.Pipeline#setPipeline", "___id": "T000002R053432", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.Physics.Matter.Image#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "___id": "T000002R053433", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.Physics.Matter.Image#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "overrides": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "___id": "T000002R053434", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.Physics.Matter.Image#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "overrides": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "___id": "T000002R053435", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.Physics.Matter.Image#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "___id": "T000002R053436", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.Physics.Matter.Image#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "___id": "T000002R053437", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.Physics.Matter.Image#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "___id": "T000002R053438", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.Physics.Matter.Image#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#preFX", "___id": "T000002R053439", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.Physics.Matter.Image#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#postFX", "___id": "T000002R053440", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.Physics.Matter.Image#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "___id": "T000002R053441", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.Physics.Matter.Image#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "___id": "T000002R053442", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.Physics.Matter.Image#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "___id": "T000002R053443", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.Physics.Matter.Image#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "___id": "T000002R053444", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.Physics.Matter.Image#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "___id": "T000002R053445", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.Physics.Matter.Image#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "___id": "T000002R053446", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.Physics.Matter.Image#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#clearFX", "___id": "T000002R053447", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.Physics.Matter.Image#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "overrides": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "___id": "T000002R053448", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.Physics.Matter.Image#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "overrides": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "___id": "T000002R053449", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.Physics.Matter.Image#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "___id": "T000002R053450", "___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": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.Physics.Matter.Image#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#width", "inherited": true, "overrides": "Phaser.GameObjects.Components.Size#width", "___id": "T000002R053452", "___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": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.Physics.Matter.Image#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#height", "inherited": true, "overrides": "Phaser.GameObjects.Components.Size#height", "___id": "T000002R053453", "___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": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.Physics.Matter.Image#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayWidth", "inherited": true, "overrides": "Phaser.GameObjects.Components.Size#displayWidth", "___id": "T000002R053454", "___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": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.Physics.Matter.Image#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayHeight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Size#displayHeight", "___id": "T000002R053455", "___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": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSizeToFrame", "longname": "Phaser.Physics.Matter.Image#setSizeToFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setSizeToFrame", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Size#setSizeToFrame", "___id": "T000002R053456", "___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": 139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.Physics.Matter.Image#setSize", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setSize", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Size#setSize", "___id": "T000002R053457", "___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.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": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.Physics.Matter.Image#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setDisplaySize", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Size#setDisplaySize", "___id": "T000002R053458", "___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": {} }, "name": "texture", "longname": "Phaser.Physics.Matter.Image#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#texture", "inherited": true, "overrides": "Phaser.GameObjects.Components.Texture#texture", "___id": "T000002R053459", "___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": {} }, "name": "frame", "longname": "Phaser.Physics.Matter.Image#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#frame", "inherited": true, "overrides": "Phaser.GameObjects.Components.Texture#frame", "___id": "T000002R053460", "___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": {} }, "name": "isCropped", "longname": "Phaser.Physics.Matter.Image#isCropped", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.11.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#isCropped", "inherited": true, "overrides": "Phaser.GameObjects.Components.Texture#isCropped", "___id": "T000002R053461", "___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 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 rect 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. 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.\r\n * @param {number} [width] - The width of the crop rectangle in pixels.\r\n * @param {number} [height] - The height of the crop rectangle in pixels.\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": {} }, "name": "setCrop", "longname": "Phaser.Physics.Matter.Image#setCrop", "kind": "function", "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 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 rect 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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setCrop", "inherited": true, "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. 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.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the crop rectangle in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the crop rectangle in pixels.", "name": "height" } ], "___id": "T000002R053462", "___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": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.Physics.Matter.Image#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setTexture", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Texture#setTexture", "___id": "T000002R053463", "___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": 128, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.Physics.Matter.Image#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setFrame", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Texture#setFrame", "___id": "T000002R053464", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertice 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": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopLeft", "longname": "Phaser.Physics.Matter.Image#tintTopLeft", "kind": "member", "description": "The tint value being applied to the top-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopLeft", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintTopLeft", "___id": "T000002R053466", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-right vertice 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopRight", "longname": "Phaser.Physics.Matter.Image#tintTopRight", "kind": "member", "description": "The tint value being applied to the top-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopRight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintTopRight", "___id": "T000002R053467", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-left vertice 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": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomLeft", "longname": "Phaser.Physics.Matter.Image#tintBottomLeft", "kind": "member", "description": "The tint value being applied to the bottom-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "___id": "T000002R053468", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-right vertice 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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomRight", "longname": "Phaser.Physics.Matter.Image#tintBottomRight", "kind": "member", "description": "The tint value being applied to the bottom-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomRight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintBottomRight", "___id": "T000002R053469", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintFill", "longname": "Phaser.Physics.Matter.Image#tintFill", "kind": "member", "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.11.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintFill", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintFill", "___id": "T000002R053470", "___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 'additive',\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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearTint", "longname": "Phaser.Physics.Matter.Image#clearTint", "kind": "function", "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff and the tint type to 'additive',\rwhich results in no visible change to the texture.", "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#clearTint", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#clearTint", "___id": "T000002R053471", "___s": true }, { "comment": "/**\r\n * Sets an additive tint 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 * multiplying it by 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 * To swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.\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": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTint", "longname": "Phaser.Physics.Matter.Image#setTint", "kind": "function", "description": "Sets an additive tint on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by 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\rTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.", "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#setTint", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Tint#setTint", "___id": "T000002R053472", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on this Game Object.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. You can provide either one color value, in which case the whole\r\n * Game Object will be rendered in that color. Or you can provide a color per corner. The colors\r\n * 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 * To swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintFill\r\n * @webglOnly\r\n * @since 3.11.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.\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": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTintFill", "longname": "Phaser.Physics.Matter.Image#setTintFill", "kind": "function", "description": "Sets a fill-based tint on this Game Object.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. You can provide either one color value, in which case the whole\rGame Object will be rendered in that color. Or you can provide a color per corner. The colors\rare 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\rTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#setTintFill", "inherited": true, "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 not 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" } ], "overrides": "Phaser.GameObjects.Components.Tint#setTintFill", "___id": "T000002R053473", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.\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": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tint", "longname": "Phaser.Physics.Matter.Image#tint", "kind": "member", "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tint", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tint", "___id": "T000002R053474", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * It checks to see if the 4 tint properties are set to the value 0xffffff\r\n * and that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.\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": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isTinted", "longname": "Phaser.Physics.Matter.Image#isTinted", "kind": "member", "description": "Does this Game Object have a tint applied?\r\rIt checks to see if the 4 tint properties are set to the value 0xffffff\rand that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "readonly": true, "since": "3.11.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#isTinted", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#isTinted", "___id": "T000002R053475", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.Physics.Matter.Image#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "___id": "T000002R053476", "___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": {} }, "name": "x", "longname": "Phaser.Physics.Matter.Image#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#x", "___id": "T000002R053480", "___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": {} }, "name": "y", "longname": "Phaser.Physics.Matter.Image#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#y", "___id": "T000002R053481", "___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": {} }, "name": "z", "longname": "Phaser.Physics.Matter.Image#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#z", "___id": "T000002R053482", "___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": {} }, "name": "w", "longname": "Phaser.Physics.Matter.Image#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#w", "___id": "T000002R053483", "___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": {} }, "name": "scale", "longname": "Phaser.Physics.Matter.Image#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#scale", "___id": "T000002R053484", "___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": {} }, "name": "scaleX", "longname": "Phaser.Physics.Matter.Image#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#scaleX", "___id": "T000002R053485", "___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": {} }, "name": "scaleY", "longname": "Phaser.Physics.Matter.Image#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#scaleY", "___id": "T000002R053486", "___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": {} }, "name": "angle", "longname": "Phaser.Physics.Matter.Image#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#angle", "___id": "T000002R053487", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.Physics.Matter.Image#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#rotation", "___id": "T000002R053488", "___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": {} }, "name": "setPosition", "longname": "Phaser.Physics.Matter.Image#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#setPosition", "___id": "T000002R053489", "___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": {} }, "name": "copyPosition", "longname": "Phaser.Physics.Matter.Image#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#copyPosition", "___id": "T000002R053490", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.Physics.Matter.Image#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#setRandomPosition", "___id": "T000002R053491", "___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": {} }, "name": "setRotation", "longname": "Phaser.Physics.Matter.Image#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "overrides": "Phaser.GameObjects.Components.Transform#setRotation", "___id": "T000002R053492", "___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": {} }, "name": "setAngle", "longname": "Phaser.Physics.Matter.Image#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "overrides": "Phaser.GameObjects.Components.Transform#setAngle", "___id": "T000002R053493", "___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": {} }, "name": "setScale", "longname": "Phaser.Physics.Matter.Image#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#setScale", "___id": "T000002R053494", "___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": {} }, "name": "setX", "longname": "Phaser.Physics.Matter.Image#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Transform#setX", "___id": "T000002R053495", "___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": {} }, "name": "setY", "longname": "Phaser.Physics.Matter.Image#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Transform#setY", "___id": "T000002R053496", "___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": {} }, "name": "setZ", "longname": "Phaser.Physics.Matter.Image#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Transform#setZ", "___id": "T000002R053497", "___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": {} }, "name": "setW", "longname": "Phaser.Physics.Matter.Image#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Transform#setW", "___id": "T000002R053498", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.Physics.Matter.Image#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "___id": "T000002R053499", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.Physics.Matter.Image#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "___id": "T000002R053500", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.Physics.Matter.Image#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#getLocalPoint", "___id": "T000002R053501", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.Physics.Matter.Image#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#getParentRotation", "___id": "T000002R053502", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.Physics.Matter.Image#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "overrides": "Phaser.GameObjects.Components.Visible#visible", "___id": "T000002R053504", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.Physics.Matter.Image#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Visible#setVisible", "___id": "T000002R053505", "___s": true }, { "comment": "/**\r\n * Sets the restitution on the physics object.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Bounce#setBounce\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - A Number that defines the restitution (elasticity) of the body. The value is always positive and is in the range (0, 1). A value of 0 means collisions may be perfectly inelastic and no bouncing may occur. A value of 0.8 means the body may bounce back with approximately 80% of its kinetic energy. Note that collision response is based on pairs of bodies, and that restitution values are combined with the following formula: `Math.max(bodyA.restitution, bodyB.restitution)`\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Bounce.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setBounce", "longname": "Phaser.Physics.Matter.Image#setBounce", "kind": "function", "description": "Sets the restitution on the physics object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A Number that defines the restitution (elasticity) of the body. The value is always positive and is in the range (0, 1). A value of 0 means collisions may be perfectly inelastic and no bouncing may occur. A value of 0.8 means the body may bounce back with approximately 80% of its kinetic energy. Note that collision response is based on pairs of bodies, and that restitution values are combined with the following formula: `Math.max(bodyA.restitution, bodyB.restitution)`", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Bounce#setBounce", "inherited": true, "___id": "T000002R053506", "___s": true }, { "comment": "/**\r\n * Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31.\r\n * Two bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\r\n * categories are included in their collision masks (see {@link #setCollidesWith}).\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setCollisionCategory\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - Unique category bitfield.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setCollisionCategory", "longname": "Phaser.Physics.Matter.Image#setCollisionCategory", "kind": "function", "description": "Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31.\rTwo bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\rcategories are included in their collision masks (see {@link #setCollidesWith}).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Unique category bitfield.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setCollisionCategory", "inherited": true, "___id": "T000002R053507", "___s": true }, { "comment": "/**\r\n * Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values,\r\n * they will collide according to the usual rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\r\n * If two Matter Bodies have the same positive value, they will always collide; if they have the same negative value,\r\n * they will never collide.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setCollisionGroup\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - Unique group index.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setCollisionGroup", "longname": "Phaser.Physics.Matter.Image#setCollisionGroup", "kind": "function", "description": "Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values,\rthey will collide according to the usual rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\rIf two Matter Bodies have the same positive value, they will always collide; if they have the same negative value,\rthey will never collide.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Unique group index.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setCollisionGroup", "inherited": true, "___id": "T000002R053508", "___s": true }, { "comment": "/**\r\n * Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only\r\n * collide if each one includes the other's category in its mask based on a bitwise AND, i.e. `(categoryA & maskB) !== 0`\r\n * and `(categoryB & maskA) !== 0` are both true.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setCollidesWith\r\n * @since 3.0.0\r\n *\r\n * @param {(number|number[])} categories - A unique category bitfield, or an array of them.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setCollidesWith", "longname": "Phaser.Physics.Matter.Image#setCollidesWith", "kind": "function", "description": "Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only\rcollide if each one includes the other's category in its mask based on a bitwise AND, i.e. `(categoryA & maskB) !== 0`\rand `(categoryB & maskA) !== 0` are both true.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "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" } ] } ] } }, "description": "A unique category bitfield, or an array of them.", "name": "categories" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setCollidesWith", "inherited": true, "___id": "T000002R053509", "___s": true }, { "comment": "/**\r\n * The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\n *\r\n * This does not change the bodies collision category, group or filter. Those must be set in addition\r\n * to the callback.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setOnCollide\r\n * @since 3.22.0\r\n *\r\n * @param {function} callback - The callback to invoke when this body starts colliding with another.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 87, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setOnCollide", "longname": "Phaser.Physics.Matter.Image#setOnCollide", "kind": "function", "description": "The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\rThis does not change the bodies collision category, group or filter. Those must be set in addition\rto the callback.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke when this body starts colliding with another.", "name": "callback" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setOnCollide", "inherited": true, "___id": "T000002R053510", "___s": true }, { "comment": "/**\r\n * The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\n *\r\n * This does not change the bodies collision category, group or filter. Those must be set in addition\r\n * to the callback.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setOnCollideEnd\r\n * @since 3.22.0\r\n *\r\n * @param {function} callback - The callback to invoke when this body stops colliding with another.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setOnCollideEnd", "longname": "Phaser.Physics.Matter.Image#setOnCollideEnd", "kind": "function", "description": "The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\rThis does not change the bodies collision category, group or filter. Those must be set in addition\rto the callback.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke when this body stops colliding with another.", "name": "callback" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setOnCollideEnd", "inherited": true, "___id": "T000002R053511", "___s": true }, { "comment": "/**\r\n * The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\n *\r\n * This does not change the bodies collision category, group or filter. Those must be set in addition\r\n * to the callback.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setOnCollideActive\r\n * @since 3.22.0\r\n *\r\n * @param {function} callback - The callback to invoke for the duration of this body colliding with another.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 127, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setOnCollideActive", "longname": "Phaser.Physics.Matter.Image#setOnCollideActive", "kind": "function", "description": "The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\rThis does not change the bodies collision category, group or filter. Those must be set in addition\rto the callback.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke for the duration of this body colliding with another.", "name": "callback" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setOnCollideActive", "inherited": true, "___id": "T000002R053512", "___s": true }, { "comment": "/**\r\n * The callback is sent a reference to the other body, along with a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\n *\r\n * This does not change the bodies collision category, group or filter. Those must be set in addition\r\n * to the callback.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setOnCollideWith\r\n * @since 3.22.0\r\n *\r\n * @param {(MatterJS.Body|MatterJS.Body[])} body - The body, or an array of bodies, to test for collisions with.\r\n * @param {function} callback - The callback to invoke when this body collides with the given body or bodies.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 147, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setOnCollideWith", "longname": "Phaser.Physics.Matter.Image#setOnCollideWith", "kind": "function", "description": "The callback is sent a reference to the other body, along with a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\rThis does not change the bodies collision category, group or filter. Those must be set in addition\rto the callback.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "MatterJS.Body", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "MatterJS.Body" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.Body", "type": "NameExpression" } ] } ] } }, "description": "The body, or an array of bodies, to test for collisions with.", "name": "body" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke when this body collides with the given body or bodies.", "name": "callback" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setOnCollideWith", "inherited": true, "___id": "T000002R053513", "___s": true }, { "comment": "/**\r\n * Applies a force to a body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#applyForce\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector2} force - A Vector that specifies the force to apply.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "applyForce", "longname": "Phaser.Physics.Matter.Image#applyForce", "kind": "function", "description": "Applies a force to a body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector that specifies the force to apply.", "name": "force" } ], "inherits": "Phaser.Physics.Matter.Components.Force#applyForce", "inherited": true, "___id": "T000002R053514", "___s": true }, { "comment": "/**\r\n * Applies a force to a body from a given position.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#applyForceFrom\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector2} position - The position in which the force comes from.\r\n * @param {Phaser.Math.Vector2} force - A Vector that specifies the force to apply.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 38, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "applyForceFrom", "longname": "Phaser.Physics.Matter.Image#applyForceFrom", "kind": "function", "description": "Applies a force to a body from a given position.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The position in which the force comes from.", "name": "position" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector that specifies the force to apply.", "name": "force" } ], "inherits": "Phaser.Physics.Matter.Components.Force#applyForceFrom", "inherited": true, "___id": "T000002R053515", "___s": true }, { "comment": "/**\r\n * Apply thrust to the forward position of the body.\r\n *\r\n * Use very small values, such as 0.1, depending on the mass and required speed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#thrust\r\n * @since 3.0.0\r\n *\r\n * @param {number} speed - A speed value to be applied to a directional force.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "thrust", "longname": "Phaser.Physics.Matter.Image#thrust", "kind": "function", "description": "Apply thrust to the forward position of the body.\r\rUse very small values, such as 0.1, depending on the mass and required speed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A speed value to be applied to a directional force.", "name": "speed" } ], "inherits": "Phaser.Physics.Matter.Components.Force#thrust", "inherited": true, "___id": "T000002R053516", "___s": true }, { "comment": "/**\r\n * Apply thrust to the left position of the body.\r\n *\r\n * Use very small values, such as 0.1, depending on the mass and required speed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#thrustLeft\r\n * @since 3.0.0\r\n *\r\n * @param {number} speed - A speed value to be applied to a directional force.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "thrustLeft", "longname": "Phaser.Physics.Matter.Image#thrustLeft", "kind": "function", "description": "Apply thrust to the left position of the body.\r\rUse very small values, such as 0.1, depending on the mass and required speed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A speed value to be applied to a directional force.", "name": "speed" } ], "inherits": "Phaser.Physics.Matter.Components.Force#thrustLeft", "inherited": true, "___id": "T000002R053517", "___s": true }, { "comment": "/**\r\n * Apply thrust to the right position of the body.\r\n *\r\n * Use very small values, such as 0.1, depending on the mass and required speed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#thrustRight\r\n * @since 3.0.0\r\n *\r\n * @param {number} speed - A speed value to be applied to a directional force.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 102, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "thrustRight", "longname": "Phaser.Physics.Matter.Image#thrustRight", "kind": "function", "description": "Apply thrust to the right position of the body.\r\rUse very small values, such as 0.1, depending on the mass and required speed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A speed value to be applied to a directional force.", "name": "speed" } ], "inherits": "Phaser.Physics.Matter.Components.Force#thrustRight", "inherited": true, "___id": "T000002R053518", "___s": true }, { "comment": "/**\r\n * Apply thrust to the back position of the body.\r\n *\r\n * Use very small values, such as 0.1, depending on the mass and required speed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#thrustBack\r\n * @since 3.0.0\r\n *\r\n * @param {number} speed - A speed value to be applied to a directional force.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 125, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "thrustBack", "longname": "Phaser.Physics.Matter.Image#thrustBack", "kind": "function", "description": "Apply thrust to the back position of the body.\r\rUse very small values, such as 0.1, depending on the mass and required speed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A speed value to be applied to a directional force.", "name": "speed" } ], "inherits": "Phaser.Physics.Matter.Components.Force#thrustBack", "inherited": true, "___id": "T000002R053519", "___s": true }, { "comment": "/**\r\n * Sets new friction values for this Game Object's Matter Body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Friction#setFriction\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.\r\n * @param {number} [air] - If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.\r\n * @param {number} [fstatic] - If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never \"stick\" when it is nearly stationary.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Friction.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setFriction", "longname": "Phaser.Physics.Matter.Image#setFriction", "kind": "function", "description": "Sets new friction values for this Game Object's Matter Body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.", "name": "air" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never \"stick\" when it is nearly stationary.", "name": "fstatic" } ], "inherits": "Phaser.Physics.Matter.Components.Friction#setFriction", "inherited": true, "___id": "T000002R053520", "___s": true }, { "comment": "/**\r\n * Sets a new air resistance for this Game Object's Matter Body.\r\n * A value of 0 means the Body will never slow as it moves through space.\r\n * The higher the value, the faster a Body slows when moving through space.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Friction#setFrictionAir\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new air resistance for the Body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Friction.js", "lineno": 44, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setFrictionAir", "longname": "Phaser.Physics.Matter.Image#setFrictionAir", "kind": "function", "description": "Sets a new air resistance for this Game Object's Matter Body.\rA value of 0 means the Body will never slow as it moves through space.\rThe higher the value, the faster a Body slows when moving through space.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new air resistance for the Body.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Friction#setFrictionAir", "inherited": true, "___id": "T000002R053521", "___s": true }, { "comment": "/**\r\n * Sets a new static friction for this Game Object's Matter Body.\r\n * A value of 0 means the Body will never \"stick\" when it is nearly stationary.\r\n * The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Friction#setFrictionStatic\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new static friction for the Body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Friction.js", "lineno": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setFrictionStatic", "longname": "Phaser.Physics.Matter.Image#setFrictionStatic", "kind": "function", "description": "Sets a new static friction for this Game Object's Matter Body.\rA value of 0 means the Body will never \"stick\" when it is nearly stationary.\rThe higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new static friction for the Body.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Friction#setFrictionStatic", "inherited": true, "___id": "T000002R053522", "___s": true }, { "comment": "/**\r\n * A togglable function for ignoring world gravity in real-time on the current body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - Set to true to ignore the effect of world gravity, or false to not ignore it.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Gravity.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setIgnoreGravity", "longname": "Phaser.Physics.Matter.Image#setIgnoreGravity", "kind": "function", "description": "A togglable function for ignoring world gravity in real-time on the current body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true to ignore the effect of world gravity, or false to not ignore it.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity", "inherited": true, "___id": "T000002R053523", "___s": true }, { "comment": "/**\r\n * Sets the mass of the Game Object's Matter Body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Mass#setMass\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new mass of the body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mass.js", "lineno": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setMass", "longname": "Phaser.Physics.Matter.Image#setMass", "kind": "function", "description": "Sets the mass of the Game Object's Matter Body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new mass of the body.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Mass#setMass", "inherited": true, "___id": "T000002R053524", "___s": true }, { "comment": "/**\r\n * Sets density of the body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Mass#setDensity\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new density of the body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mass.js", "lineno": 35, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setDensity", "longname": "Phaser.Physics.Matter.Image#setDensity", "kind": "function", "description": "Sets density of the body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new density of the body.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Mass#setDensity", "inherited": true, "___id": "T000002R053525", "___s": true }, { "comment": "/**\r\n * The body's center of mass.\r\n *\r\n * Calling this creates a new `Vector2 each time to avoid mutation.\r\n *\r\n * If you only need to read the value and won't change it, you can get it from `GameObject.body.centerOfMass`.\r\n *\r\n * @name Phaser.Physics.Matter.Components.Mass#centerOfMass\r\n * @type {Phaser.Math.Vector2}\r\n * @readonly\r\n * @since 3.10.0\r\n *\r\n * @return {Phaser.Math.Vector2} The center of mass.\r\n */", "meta": { "filename": "Mass.js", "lineno": 52, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "centerOfMass", "longname": "Phaser.Physics.Matter.Image#centerOfMass", "kind": "member", "description": "The body's center of mass.\r\rCalling this creates a new `Vector2 each time to avoid mutation.\r\rIf you only need to read the value and won't change it, you can get it from `GameObject.body.centerOfMass`.", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "readonly": true, "since": "3.10.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The center of mass." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Mass#centerOfMass", "inherited": true, "___id": "T000002R053526", "___s": true }, { "comment": "/**\r\n * Set the body belonging to this Game Object to be a sensor.\r\n * Sensors trigger collision events, but don't react with colliding body physically.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sensor#setSensor\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to set the body as a sensor, or `false` to disable it.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sensor.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setSensor", "longname": "Phaser.Physics.Matter.Image#setSensor", "kind": "function", "description": "Set the body belonging to this Game Object to be a sensor.\rSensors trigger collision events, but don't react with colliding body physically.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to set the body as a sensor, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Sensor#setSensor", "inherited": true, "___id": "T000002R053527", "___s": true }, { "comment": "/**\r\n * Is the body belonging to this Game Object a sensor or not?\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sensor#isSensor\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if the body is a sensor, otherwise `false`.\r\n */", "meta": { "filename": "Sensor.js", "lineno": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "isSensor", "longname": "Phaser.Physics.Matter.Image#isSensor", "kind": "function", "description": "Is the body belonging to this Game Object a sensor or not?", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the body is a sensor, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Sensor#isSensor", "inherited": true, "___id": "T000002R053528", "___s": true }, { "comment": "/**\r\n * Set this Game Objects Matter physics body to be a rectangle shape.\r\n *\r\n * Calling this methods resets all previous properties you may have set on the body, including\r\n * plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setRectangle\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 23, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setRectangle", "longname": "Phaser.Physics.Matter.Image#setRectangle", "kind": "function", "description": "Set this Game Objects Matter physics body to be a rectangle shape.\r\rCalling this methods resets all previous properties you may have set on the body, including\rplugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "inherits": "Phaser.Physics.Matter.Components.SetBody#setRectangle", "inherited": true, "___id": "T000002R053529", "___s": true }, { "comment": "/**\r\n * Set this Game Objects Matter physics body to be a circle shape.\r\n *\r\n * Calling this methods resets all previous properties you may have set on the body, including\r\n * plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setCircle\r\n * @since 3.0.0\r\n *\r\n * @param {number} radius - The radius of the circle.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setCircle", "longname": "Phaser.Physics.Matter.Image#setCircle", "kind": "function", "description": "Set this Game Objects Matter physics body to be a circle shape.\r\rCalling this methods resets all previous properties you may have set on the body, including\rplugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the circle.", "name": "radius" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "inherits": "Phaser.Physics.Matter.Components.SetBody#setCircle", "inherited": true, "___id": "T000002R053530", "___s": true }, { "comment": "/**\r\n * Set this Game Objects Matter physics body to be a polygon shape.\r\n *\r\n * Calling this methods resets all previous properties you may have set on the body, including\r\n * plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setPolygon\r\n * @since 3.0.0\r\n *\r\n * @param {number} radius - The \"radius\" of the polygon, i.e. the distance from its center to any vertex. This is also the radius of its circumcircle.\r\n * @param {number} sides - The number of sides the polygon will have.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setPolygon", "longname": "Phaser.Physics.Matter.Image#setPolygon", "kind": "function", "description": "Set this Game Objects Matter physics body to be a polygon shape.\r\rCalling this methods resets all previous properties you may have set on the body, including\rplugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The \"radius\" of the polygon, i.e. the distance from its center to any vertex. This is also the radius of its circumcircle.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of sides the polygon will have.", "name": "sides" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "inherits": "Phaser.Physics.Matter.Components.SetBody#setPolygon", "inherited": true, "___id": "T000002R053531", "___s": true }, { "comment": "/**\r\n * Set this Game Objects Matter physics body to be a trapezoid shape.\r\n *\r\n * Calling this methods resets all previous properties you may have set on the body, including\r\n * plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setTrapezoid\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The width of the trapezoid Body.\r\n * @param {number} height - The height of the trapezoid Body.\r\n * @param {number} slope - The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 82, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setTrapezoid", "longname": "Phaser.Physics.Matter.Image#setTrapezoid", "kind": "function", "description": "Set this Game Objects Matter physics body to be a trapezoid shape.\r\rCalling this methods resets all previous properties you may have set on the body, including\rplugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the trapezoid Body.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the trapezoid Body.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.", "name": "slope" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "inherits": "Phaser.Physics.Matter.Components.SetBody#setTrapezoid", "inherited": true, "___id": "T000002R053532", "___s": true }, { "comment": "/**\r\n * Set this Game Object to use the given existing Matter Body.\r\n *\r\n * The body is first removed from the world before being added to this Game Object.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setExistingBody\r\n * @since 3.0.0\r\n *\r\n * @param {MatterJS.BodyType} body - The Body this Game Object should use.\r\n * @param {boolean} [addToWorld=true] - Should the body be immediately added to the World?\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setExistingBody", "longname": "Phaser.Physics.Matter.Image#setExistingBody", "kind": "function", "description": "Set this Game Object to use the given existing Matter Body.\r\rThe body is first removed from the world before being added to this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The Body this Game Object should use.", "name": "body" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the body be immediately added to the World?", "name": "addToWorld" } ], "inherits": "Phaser.Physics.Matter.Components.SetBody#setExistingBody", "inherited": true, "___id": "T000002R053533", "___s": true }, { "comment": "/**\r\n * Set this Game Object to create and use a new Body based on the configuration object given.\r\n *\r\n * Calling this methods resets all previous properties you may have set on the body, including\r\n * plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setBody\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Physics.Matter.MatterSetBodyConfig)} config - Either a string, such as `circle`, or a Matter Set Body Configuration object.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 175, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setBody", "longname": "Phaser.Physics.Matter.Image#setBody", "kind": "function", "description": "Set this Game Object to create and use a new Body based on the configuration object given.\r\rCalling this methods resets all previous properties you may have set on the body, including\rplugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Types.Physics.Matter.MatterSetBodyConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterSetBodyConfig" } ] } }, "description": "Either a string, such as `circle`, or a Matter Set Body Configuration object.", "name": "config" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "inherits": "Phaser.Physics.Matter.Components.SetBody#setBody", "inherited": true, "___id": "T000002R053534", "___s": true }, { "comment": "/**\r\n * Sets this Body to sleep.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setToSleep\r\n * @since 3.22.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setToSleep", "longname": "Phaser.Physics.Matter.Image#setToSleep", "kind": "function", "description": "Sets this Body to sleep.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Sleep#setToSleep", "inherited": true, "___id": "T000002R053535", "___s": true }, { "comment": "/**\r\n * Wakes this Body if asleep.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setAwake\r\n * @since 3.22.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setAwake", "longname": "Phaser.Physics.Matter.Image#setAwake", "kind": "function", "description": "Wakes this Body if asleep.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Sleep#setAwake", "inherited": true, "___id": "T000002R053536", "___s": true }, { "comment": "/**\r\n * Sets the number of updates in which this body must have near-zero velocity before it is set as sleeping (if sleeping is enabled by the engine).\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setSleepThreshold\r\n * @since 3.0.0\r\n *\r\n * @param {number} [value=60] - A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setSleepThreshold", "longname": "Phaser.Physics.Matter.Image#setSleepThreshold", "kind": "function", "description": "Sets the number of updates in which this body must have near-zero velocity before it is set as sleeping (if sleeping is enabled by the engine).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 60, "description": "A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Sleep#setSleepThreshold", "inherited": true, "___id": "T000002R053537", "___s": true }, { "comment": "/**\r\n * Enable sleep and wake events for this body.\r\n *\r\n * By default when a body goes to sleep, or wakes up, it will not emit any events.\r\n *\r\n * The events are emitted by the Matter World instance and can be listened to via\r\n * the `SLEEP_START` and `SLEEP_END` events.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setSleepEvents\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} start - `true` if you want the sleep start event to be emitted for this body.\r\n * @param {boolean} end - `true` if you want the sleep end event to be emitted for this body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setSleepEvents", "longname": "Phaser.Physics.Matter.Image#setSleepEvents", "kind": "function", "description": "Enable sleep and wake events for this body.\r\rBy default when a body goes to sleep, or wakes up, it will not emit any events.\r\rThe events are emitted by the Matter World instance and can be listened to via\rthe `SLEEP_START` and `SLEEP_END` events.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if you want the sleep start event to be emitted for this body.", "name": "start" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if you want the sleep end event to be emitted for this body.", "name": "end" } ], "inherits": "Phaser.Physics.Matter.Components.Sleep#setSleepEvents", "inherited": true, "___id": "T000002R053538", "___s": true }, { "comment": "/**\r\n * Enables or disables the Sleep Start event for this body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setSleepStartEvent\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to enable the sleep event, or `false` to disable it.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setSleepStartEvent", "longname": "Phaser.Physics.Matter.Image#setSleepStartEvent", "kind": "function", "description": "Enables or disables the Sleep Start event for this body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable the sleep event, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Sleep#setSleepStartEvent", "inherited": true, "___id": "T000002R053539", "___s": true }, { "comment": "/**\r\n * Enables or disables the Sleep End event for this body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setSleepEndEvent\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to enable the sleep event, or `false` to disable it.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 121, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setSleepEndEvent", "longname": "Phaser.Physics.Matter.Image#setSleepEndEvent", "kind": "function", "description": "Enables or disables the Sleep End event for this body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable the sleep event, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Sleep#setSleepEndEvent", "inherited": true, "___id": "T000002R053540", "___s": true }, { "comment": "/**\r\n * Changes the physics body to be either static `true` or dynamic `false`.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Static#setStatic\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to set the body as being static, or `false` to make it dynamic.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Static.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setStatic", "longname": "Phaser.Physics.Matter.Image#setStatic", "kind": "function", "description": "Changes the physics body to be either static `true` or dynamic `false`.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to set the body as being static, or `false` to make it dynamic.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Static#setStatic", "inherited": true, "___id": "T000002R053541", "___s": true }, { "comment": "/**\r\n * Returns `true` if the body is static, otherwise `false` for a dynamic body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Static#isStatic\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if the body is static, otherwise `false`.\r\n */", "meta": { "filename": "Static.js", "lineno": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "isStatic", "longname": "Phaser.Physics.Matter.Image#isStatic", "kind": "function", "description": "Returns `true` if the body is static, otherwise `false` for a dynamic body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the body is static, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Static#isStatic", "inherited": true, "___id": "T000002R053542", "___s": true }, { "comment": "/**\r\n * Setting fixed rotation sets the Body inertia to Infinity, which stops it\r\n * from being able to rotate when forces are applied to it.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Transform#setFixedRotation\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 239, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setFixedRotation", "longname": "Phaser.Physics.Matter.Image#setFixedRotation", "kind": "function", "description": "Setting fixed rotation sets the Body inertia to Infinity, which stops it\rfrom being able to rotate when forces are applied to it.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Transform#setFixedRotation", "inherited": true, "___id": "T000002R053543", "___s": true }, { "comment": "/**\r\n * Sets the horizontal velocity of the physics body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#setVelocityX\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal velocity value.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setVelocityX", "longname": "Phaser.Physics.Matter.Image#setVelocityX", "kind": "function", "description": "Sets the horizontal velocity of the physics body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal velocity value.", "name": "x" } ], "inherits": "Phaser.Physics.Matter.Components.Velocity#setVelocityX", "inherited": true, "___id": "T000002R053544", "___s": true }, { "comment": "/**\r\n * Sets vertical velocity of the physics body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#setVelocityY\r\n * @since 3.0.0\r\n *\r\n * @param {number} y - The vertical velocity value.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setVelocityY", "longname": "Phaser.Physics.Matter.Image#setVelocityY", "kind": "function", "description": "Sets vertical velocity of the physics body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical velocity value.", "name": "y" } ], "inherits": "Phaser.Physics.Matter.Components.Velocity#setVelocityY", "inherited": true, "___id": "T000002R053545", "___s": true }, { "comment": "/**\r\n * Sets both the horizontal and vertical velocity of the physics body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#setVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal velocity value.\r\n * @param {number} [y=x] - The vertical velocity value, it can be either positive or negative. If not given, it will be the same as the `x` value.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 55, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setVelocity", "longname": "Phaser.Physics.Matter.Image#setVelocity", "kind": "function", "description": "Sets both the horizontal and vertical velocity of the physics body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal velocity value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical velocity value, it can be either positive or negative. If not given, it will be the same as the `x` value.", "name": "y" } ], "inherits": "Phaser.Physics.Matter.Components.Velocity#setVelocity", "inherited": true, "___id": "T000002R053546", "___s": true }, { "comment": "/**\r\n * Gets the current linear velocity of the physics body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#getVelocity\r\n * @since 3.60.0\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The current linear velocity of the body.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 75, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "getVelocity", "longname": "Phaser.Physics.Matter.Image#getVelocity", "kind": "function", "description": "Gets the current linear velocity of the physics body.", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The current linear velocity of the body." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Velocity#getVelocity", "inherited": true, "___id": "T000002R053547", "___s": true }, { "comment": "/**\r\n * Sets the angular velocity of the body instantly.\r\n * Position, angle, force etc. are unchanged.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#setAngularVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} velocity - The angular velocity.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setAngularVelocity", "longname": "Phaser.Physics.Matter.Image#setAngularVelocity", "kind": "function", "description": "Sets the angular velocity of the body instantly.\rPosition, angle, force etc. are unchanged.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angular velocity.", "name": "velocity" } ], "inherits": "Phaser.Physics.Matter.Components.Velocity#setAngularVelocity", "inherited": true, "___id": "T000002R053548", "___s": true }, { "comment": "/**\r\n * Gets the current rotational velocity of the body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#getAngularVelocity\r\n * @since 3.60.0\r\n *\r\n * @return {number} The current angular velocity of the body.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "getAngularVelocity", "longname": "Phaser.Physics.Matter.Image#getAngularVelocity", "kind": "function", "description": "Gets the current rotational velocity of the body.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current angular velocity of the body." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Velocity#getAngularVelocity", "inherited": true, "___id": "T000002R053549", "___s": true }, { "comment": "/**\r\n * Sets the current rotational speed of the body.\r\n * Direction is maintained. Affects body angular velocity.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#setAngularSpeed\r\n * @since 3.60.0\r\n *\r\n * @param {number} speed - The angular speed.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 119, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setAngularSpeed", "longname": "Phaser.Physics.Matter.Image#setAngularSpeed", "kind": "function", "description": "Sets the current rotational speed of the body.\rDirection is maintained. Affects body angular velocity.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angular speed.", "name": "speed" } ], "inherits": "Phaser.Physics.Matter.Components.Velocity#setAngularSpeed", "inherited": true, "___id": "T000002R053550", "___s": true }, { "comment": "/**\r\n * Gets the current rotational speed of the body.\r\n * Equivalent to the magnitude of its angular velocity.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#getAngularSpeed\r\n * @since 3.60.0\r\n *\r\n * @return {number} The current angular velocity of the body.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "getAngularSpeed", "longname": "Phaser.Physics.Matter.Image#getAngularSpeed", "kind": "function", "description": "Gets the current rotational speed of the body.\rEquivalent to the magnitude of its angular velocity.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current angular velocity of the body." } ], "memberof": "Phaser.Physics.Matter.Image", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Velocity#getAngularSpeed", "inherited": true, "___id": "T000002R053551", "___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": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "anims", "longname": "Phaser.Physics.Matter.Sprite#anims", "kind": "member", "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.", "type": { "names": [ "Phaser.Animations.AnimationState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationState" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Sprite#anims", "inherited": true, "___id": "T000002R053552", "___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": 125, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "preUpdate", "longname": "Phaser.Physics.Matter.Sprite#preUpdate", "kind": "function", "description": "Update this Sprite's animations.", "access": "protected", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#preUpdate", "inherited": true, "___id": "T000002R053553", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "play", "longname": "Phaser.Physics.Matter.Sprite#play", "kind": "function", "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.", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#play", "inherited": true, "___id": "T000002R053554", "___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": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "playReverse", "longname": "Phaser.Physics.Matter.Sprite#playReverse", "kind": "function", "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.", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#playReverse", "inherited": true, "___id": "T000002R053555", "___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": 270, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "playAfterDelay", "longname": "Phaser.Physics.Matter.Sprite#playAfterDelay", "kind": "function", "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'.", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#playAfterDelay", "inherited": true, "___id": "T000002R053556", "___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": 300, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "playAfterRepeat", "longname": "Phaser.Physics.Matter.Sprite#playAfterRepeat", "kind": "function", "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.", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#playAfterRepeat", "inherited": true, "___id": "T000002R053557", "___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": 327, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "chain", "longname": "Phaser.Physics.Matter.Sprite#chain", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#chain", "inherited": true, "___id": "T000002R053558", "___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": 359, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "stop", "longname": "Phaser.Physics.Matter.Sprite#stop", "kind": "function", "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.", "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Sprite#stop", "inherited": true, "___id": "T000002R053559", "___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": 377, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "stopAfterDelay", "longname": "Phaser.Physics.Matter.Sprite#stopAfterDelay", "kind": "function", "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.", "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.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of milliseconds to wait before stopping this animation.", "name": "delay" } ], "inherits": "Phaser.GameObjects.Sprite#stopAfterDelay", "inherited": true, "___id": "T000002R053560", "___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": 400, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "stopAfterRepeat", "longname": "Phaser.Physics.Matter.Sprite#stopAfterRepeat", "kind": "function", "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.", "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.Physics.Matter.Sprite", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Sprite#stopAfterRepeat", "inherited": true, "___id": "T000002R053561", "___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": 423, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "stopOnFrame", "longname": "Phaser.Physics.Matter.Sprite#stopOnFrame", "kind": "function", "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.", "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.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The frame to check before stopping this animation.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Sprite#stopOnFrame", "inherited": true, "___id": "T000002R053562", "___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": 447, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "name": "toJSON", "longname": "Phaser.Physics.Matter.Sprite#toJSON", "kind": "function", "description": "Build a JSON representation of this Sprite.", "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Sprite#toJSON", "inherited": true, "___id": "T000002R053563", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.Physics.Matter.Sprite#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R053567", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.Physics.Matter.Sprite#displayList", "kind": "member", "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.", "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R053568", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.Physics.Matter.Sprite#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R053569", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.Physics.Matter.Sprite#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R053570", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.Physics.Matter.Sprite#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R053571", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.Physics.Matter.Sprite#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R053572", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.Physics.Matter.Sprite#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R053573", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.Physics.Matter.Sprite#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R053574", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.Physics.Matter.Sprite#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R053575", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.Physics.Matter.Sprite#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R053576", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.Physics.Matter.Sprite#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R053577", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.Physics.Matter.Sprite#input", "kind": "member", "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()`.", "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R053578", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.Physics.Matter.Sprite#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R053579", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.Physics.Matter.Sprite#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R053580", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.Physics.Matter.Sprite#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "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" } ], "___id": "T000002R053581", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.Physics.Matter.Sprite#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "___id": "T000002R053582", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.Physics.Matter.Sprite#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "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" } ], "___id": "T000002R053583", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.Physics.Matter.Sprite#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "since": "3.0.0", "see": [ "Phaser.Data.DataManager" ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R053584", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.Physics.Matter.Sprite#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "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" } ], "___id": "T000002R053585", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.Physics.Matter.Sprite#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "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" } ], "___id": "T000002R053586", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.Physics.Matter.Sprite#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "___id": "T000002R053587", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.Physics.Matter.Sprite#getData", "kind": "function", "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.", "since": "3.0.0", "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "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" } ], "___id": "T000002R053588", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.Physics.Matter.Sprite#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "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" } ], "___id": "T000002R053589", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.Physics.Matter.Sprite#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R053590", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.Physics.Matter.Sprite#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R053591", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.Physics.Matter.Sprite#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R053592", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.Physics.Matter.Sprite#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R053593", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.Physics.Matter.Sprite#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "___id": "T000002R053594", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.Physics.Matter.Sprite#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "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" } ], "___id": "T000002R053595", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.Physics.Matter.Sprite#getIndexList", "kind": "function", "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.", "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R053596", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.Physics.Matter.Sprite#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "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" } ], "___id": "T000002R053597", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.Physics.Matter.Sprite#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R053598", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.Physics.Matter.Sprite#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R053599", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.Physics.Matter.Sprite#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R053600", "___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": 810, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "destroy", "longname": "Phaser.Physics.Matter.Sprite#destroy", "kind": "function", "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.", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#destroy", "inherited": true, "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" } ], "___id": "T000002R053601", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Physics.Matter.Sprite#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R053602", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Physics.Matter.Sprite#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R053603", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Physics.Matter.Sprite#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R053604", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Physics.Matter.Sprite#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R053605", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Physics.Matter.Sprite#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R053606", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Physics.Matter.Sprite#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R053607", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Physics.Matter.Sprite#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R053608", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Physics.Matter.Sprite#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R053609", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Physics.Matter.Sprite#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R053610", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Physics.Matter.Sprite#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R053611", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Physics.Matter.Sprite#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R053612", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.Physics.Matter.Sprite#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#clearAlpha", "___id": "T000002R053618", "___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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.Physics.Matter.Sprite#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#setAlpha", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Alpha#setAlpha", "___id": "T000002R053619", "___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 *\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.Physics.Matter.Sprite#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alpha", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alpha", "___id": "T000002R053620", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.Physics.Matter.Sprite#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "___id": "T000002R053621", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.Physics.Matter.Sprite#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "___id": "T000002R053622", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.Physics.Matter.Sprite#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "___id": "T000002R053623", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.Physics.Matter.Sprite#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "___id": "T000002R053624", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.Physics.Matter.Sprite#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "overrides": "Phaser.GameObjects.Components.BlendMode#blendMode", "___id": "T000002R053626", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.Physics.Matter.Sprite#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "___id": "T000002R053627", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.Physics.Matter.Sprite#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "overrides": "Phaser.GameObjects.Components.Depth#depth", "___id": "T000002R053629", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.Physics.Matter.Sprite#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Depth#setDepth", "___id": "T000002R053630", "___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.Components.Flip#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipX", "longname": "Phaser.Physics.Matter.Sprite#flipX", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#flipX", "___id": "T000002R053631", "___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.Components.Flip#flipY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipY", "longname": "Phaser.Physics.Matter.Sprite#flipY", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#flipY", "___id": "T000002R053632", "___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 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 * @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": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipX", "longname": "Phaser.Physics.Matter.Sprite#toggleFlipX", "kind": "function", "description": "Toggles the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#toggleFlipX", "___id": "T000002R053633", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipY", "longname": "Phaser.Physics.Matter.Sprite#toggleFlipY", "kind": "function", "description": "Toggles the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#toggleFlipY", "___id": "T000002R053634", "___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 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 * @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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipX", "longname": "Phaser.Physics.Matter.Sprite#setFlipX", "kind": "function", "description": "Sets the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlipX", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Flip#setFlipX", "___id": "T000002R053635", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\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": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipY", "longname": "Phaser.Physics.Matter.Sprite#setFlipY", "kind": "function", "description": "Sets the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlipY", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Flip#setFlipY", "___id": "T000002R053636", "___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 inversed 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 horizontal 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": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlip", "longname": "Phaser.Physics.Matter.Sprite#setFlip", "kind": "function", "description": "Sets the horizontal and vertical flipped state of this Game Object.\r\rA Game Object that is flipped will render inversed 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#setFlip", "inherited": true, "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 horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "overrides": "Phaser.GameObjects.Components.Flip#setFlip", "___id": "T000002R053637", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetFlip", "longname": "Phaser.Physics.Matter.Sprite#resetFlip", "kind": "function", "description": "Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#resetFlip", "inherited": true, "overrides": "Phaser.GameObjects.Components.Flip#resetFlip", "___id": "T000002R053638", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.Physics.Matter.Sprite#getCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getCenter", "___id": "T000002R053640", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.Physics.Matter.Sprite#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "___id": "T000002R053641", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.Physics.Matter.Sprite#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "___id": "T000002R053642", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.Physics.Matter.Sprite#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getTopRight", "___id": "T000002R053643", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.Physics.Matter.Sprite#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "___id": "T000002R053644", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.Physics.Matter.Sprite#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "___id": "T000002R053645", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.Physics.Matter.Sprite#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "___id": "T000002R053646", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.Physics.Matter.Sprite#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "___id": "T000002R053647", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.Physics.Matter.Sprite#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "___id": "T000002R053648", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.Physics.Matter.Sprite#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.GetBounds#getBounds", "___id": "T000002R053649", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.Physics.Matter.Sprite#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "overrides": "Phaser.GameObjects.Components.Mask#mask", "___id": "T000002R053650", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.Physics.Matter.Sprite#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "overrides": "Phaser.GameObjects.Components.Mask#setMask", "___id": "T000002R053651", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.Physics.Matter.Sprite#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "overrides": "Phaser.GameObjects.Components.Mask#clearMask", "___id": "T000002R053652", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.Physics.Matter.Sprite#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "overrides": "Phaser.GameObjects.Components.Mask#createBitmapMask", "___id": "T000002R053653", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.Physics.Matter.Sprite#createGeometryMask", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } }, "description": "This Geometry Mask that was created." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Mask#createGeometryMask", "___id": "T000002R053654", "___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 * @readonly\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": {} }, "name": "originX", "longname": "Phaser.Physics.Matter.Sprite#originX", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#originX", "___id": "T000002R053656", "___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 * @readonly\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "originY", "longname": "Phaser.Physics.Matter.Sprite#originY", "kind": "member", "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()`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#originY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#originY", "___id": "T000002R053657", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginX", "longname": "Phaser.Physics.Matter.Sprite#displayOriginX", "kind": "member", "description": "The horizontal display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#displayOriginX", "___id": "T000002R053658", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object.\r\n * The origin is a normalized value between 0 and 1.\r\n * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.\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": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayOriginY", "longname": "Phaser.Physics.Matter.Sprite#displayOriginY", "kind": "member", "description": "The vertical display origin of this Game Object.\rThe origin is a normalized value between 0 and 1.\rThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#displayOriginY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#displayOriginY", "___id": "T000002R053659", "___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": {} }, "name": "setOrigin", "longname": "Phaser.Physics.Matter.Sprite#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Origin#setOrigin", "___id": "T000002R053660", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.Physics.Matter.Sprite#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "___id": "T000002R053661", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.Physics.Matter.Sprite#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "___id": "T000002R053662", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.Physics.Matter.Sprite#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "overrides": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "___id": "T000002R053663", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.Physics.Matter.Sprite#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "overrides": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "___id": "T000002R053664", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.Physics.Matter.Sprite#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "overrides": "Phaser.GameObjects.Components.Pipeline#pipeline", "___id": "T000002R053665", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.Physics.Matter.Sprite#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "overrides": "Phaser.GameObjects.Components.Pipeline#pipelineData", "___id": "T000002R053666", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.Physics.Matter.Sprite#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "overrides": "Phaser.GameObjects.Components.Pipeline#initPipeline", "___id": "T000002R053667", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.Physics.Matter.Sprite#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "overrides": "Phaser.GameObjects.Components.Pipeline#setPipeline", "___id": "T000002R053668", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.Physics.Matter.Sprite#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "___id": "T000002R053669", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.Physics.Matter.Sprite#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "overrides": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "___id": "T000002R053670", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.Physics.Matter.Sprite#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "overrides": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "___id": "T000002R053671", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.Physics.Matter.Sprite#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "___id": "T000002R053672", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.Physics.Matter.Sprite#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "___id": "T000002R053673", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.Physics.Matter.Sprite#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "___id": "T000002R053674", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.Physics.Matter.Sprite#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#preFX", "___id": "T000002R053675", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.Physics.Matter.Sprite#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#postFX", "___id": "T000002R053676", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.Physics.Matter.Sprite#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "___id": "T000002R053677", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.Physics.Matter.Sprite#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "___id": "T000002R053678", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.Physics.Matter.Sprite#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "___id": "T000002R053679", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.Physics.Matter.Sprite#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "___id": "T000002R053680", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.Physics.Matter.Sprite#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "___id": "T000002R053681", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.Physics.Matter.Sprite#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "overrides": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "___id": "T000002R053682", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.Physics.Matter.Sprite#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "overrides": "Phaser.GameObjects.Components.PostPipeline#clearFX", "___id": "T000002R053683", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.Physics.Matter.Sprite#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "overrides": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "___id": "T000002R053684", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.Physics.Matter.Sprite#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "overrides": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "___id": "T000002R053685", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.Physics.Matter.Sprite#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "___id": "T000002R053686", "___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": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.Physics.Matter.Sprite#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#width", "inherited": true, "overrides": "Phaser.GameObjects.Components.Size#width", "___id": "T000002R053688", "___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": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.Physics.Matter.Sprite#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#height", "inherited": true, "overrides": "Phaser.GameObjects.Components.Size#height", "___id": "T000002R053689", "___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": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.Physics.Matter.Sprite#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayWidth", "inherited": true, "overrides": "Phaser.GameObjects.Components.Size#displayWidth", "___id": "T000002R053690", "___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": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.Physics.Matter.Sprite#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#displayHeight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Size#displayHeight", "___id": "T000002R053691", "___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": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSizeToFrame", "longname": "Phaser.Physics.Matter.Sprite#setSizeToFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setSizeToFrame", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Size#setSizeToFrame", "___id": "T000002R053692", "___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": 139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.Physics.Matter.Sprite#setSize", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setSize", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Size#setSize", "___id": "T000002R053693", "___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.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": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.Physics.Matter.Sprite#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Size#setDisplaySize", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Size#setDisplaySize", "___id": "T000002R053694", "___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": {} }, "name": "texture", "longname": "Phaser.Physics.Matter.Sprite#texture", "kind": "member", "description": "The Texture this Game Object is using to render with.", "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#texture", "inherited": true, "overrides": "Phaser.GameObjects.Components.Texture#texture", "___id": "T000002R053695", "___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": {} }, "name": "frame", "longname": "Phaser.Physics.Matter.Sprite#frame", "kind": "member", "description": "The Texture Frame this Game Object is using to render with.", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#frame", "inherited": true, "overrides": "Phaser.GameObjects.Components.Texture#frame", "___id": "T000002R053696", "___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": {} }, "name": "isCropped", "longname": "Phaser.Physics.Matter.Sprite#isCropped", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.11.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#isCropped", "inherited": true, "overrides": "Phaser.GameObjects.Components.Texture#isCropped", "___id": "T000002R053697", "___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 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 rect 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. 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.\r\n * @param {number} [width] - The width of the crop rectangle in pixels.\r\n * @param {number} [height] - The height of the crop rectangle in pixels.\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": {} }, "name": "setCrop", "longname": "Phaser.Physics.Matter.Sprite#setCrop", "kind": "function", "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 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 rect 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.", "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setCrop", "inherited": true, "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. 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.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the crop rectangle in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the crop rectangle in pixels.", "name": "height" } ], "___id": "T000002R053698", "___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": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTexture", "longname": "Phaser.Physics.Matter.Sprite#setTexture", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setTexture", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Texture#setTexture", "___id": "T000002R053699", "___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": 128, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFrame", "longname": "Phaser.Physics.Matter.Sprite#setFrame", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.TextureCrop#setFrame", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Texture#setFrame", "___id": "T000002R053700", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertice 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": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopLeft", "longname": "Phaser.Physics.Matter.Sprite#tintTopLeft", "kind": "member", "description": "The tint value being applied to the top-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopLeft", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintTopLeft", "___id": "T000002R053702", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-right vertice 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintTopRight", "longname": "Phaser.Physics.Matter.Sprite#tintTopRight", "kind": "member", "description": "The tint value being applied to the top-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintTopRight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintTopRight", "___id": "T000002R053703", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-left vertice 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": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomLeft", "longname": "Phaser.Physics.Matter.Sprite#tintBottomLeft", "kind": "member", "description": "The tint value being applied to the bottom-left vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "___id": "T000002R053704", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-right vertice 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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintBottomRight", "longname": "Phaser.Physics.Matter.Sprite#tintBottomRight", "kind": "member", "description": "The tint value being applied to the bottom-right vertice 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintBottomRight", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintBottomRight", "___id": "T000002R053705", "___s": true }, { "comment": "/**\r\n * The tint fill mode.\r\n *\r\n * `false` = An additive tint (the default), where vertices colors are blended with the texture.\r\n * `true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tintFill", "longname": "Phaser.Physics.Matter.Sprite#tintFill", "kind": "member", "description": "The tint fill mode.\r\r`false` = An additive tint (the default), where vertices colors are blended with the texture.\r`true` = A fill tint, where the vertices colors replace the texture, but respects texture alpha.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.11.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tintFill", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tintFill", "___id": "T000002R053706", "___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 'additive',\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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearTint", "longname": "Phaser.Physics.Matter.Sprite#clearTint", "kind": "function", "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff and the tint type to 'additive',\rwhich results in no visible change to the texture.", "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#clearTint", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#clearTint", "___id": "T000002R053707", "___s": true }, { "comment": "/**\r\n * Sets an additive tint 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 * multiplying it by 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 * To swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.\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": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTint", "longname": "Phaser.Physics.Matter.Sprite#setTint", "kind": "function", "description": "Sets an additive tint on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rmultiplying it by 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\rTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.", "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#setTint", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Tint#setTint", "___id": "T000002R053708", "___s": true }, { "comment": "/**\r\n * Sets a fill-based tint on this Game Object.\r\n *\r\n * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\r\n * with those in the tint. You can use this for effects such as making a player flash 'white'\r\n * if hit by something. You can provide either one color value, in which case the whole\r\n * Game Object will be rendered in that color. Or you can provide a color per corner. The colors\r\n * 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 * To swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintFill\r\n * @webglOnly\r\n * @since 3.11.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.\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": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setTintFill", "longname": "Phaser.Physics.Matter.Sprite#setTintFill", "kind": "function", "description": "Sets a fill-based tint on this Game Object.\r\rUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\rwith those in the tint. You can use this for effects such as making a player flash 'white'\rif hit by something. You can provide either one color value, in which case the whole\rGame Object will be rendered in that color. Or you can provide a color per corner. The colors\rare 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\rTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.11.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#setTintFill", "inherited": true, "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 not 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" } ], "overrides": "Phaser.GameObjects.Components.Tint#setTintFill", "___id": "T000002R053709", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * This property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.\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": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "tint", "longname": "Phaser.Physics.Matter.Sprite#tint", "kind": "member", "description": "The tint value being applied to the whole of the Game Object.\rThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#tint", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#tint", "___id": "T000002R053710", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * It checks to see if the 4 tint properties are set to the value 0xffffff\r\n * and that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.\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": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "isTinted", "longname": "Phaser.Physics.Matter.Sprite#isTinted", "kind": "member", "description": "Does this Game Object have a tint applied?\r\rIt checks to see if the 4 tint properties are set to the value 0xffffff\rand that the `tintFill` property is `false`. This indicates that a Game Object isn't tinted.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "readonly": true, "since": "3.11.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Tint#isTinted", "inherited": true, "overrides": "Phaser.GameObjects.Components.Tint#isTinted", "___id": "T000002R053711", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.Physics.Matter.Sprite#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "___id": "T000002R053712", "___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": {} }, "name": "x", "longname": "Phaser.Physics.Matter.Sprite#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#x", "___id": "T000002R053716", "___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": {} }, "name": "y", "longname": "Phaser.Physics.Matter.Sprite#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#y", "___id": "T000002R053717", "___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": {} }, "name": "z", "longname": "Phaser.Physics.Matter.Sprite#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#z", "___id": "T000002R053718", "___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": {} }, "name": "w", "longname": "Phaser.Physics.Matter.Sprite#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#w", "___id": "T000002R053719", "___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": {} }, "name": "scale", "longname": "Phaser.Physics.Matter.Sprite#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#scale", "___id": "T000002R053720", "___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": {} }, "name": "scaleX", "longname": "Phaser.Physics.Matter.Sprite#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#scaleX", "___id": "T000002R053721", "___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": {} }, "name": "scaleY", "longname": "Phaser.Physics.Matter.Sprite#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#scaleY", "___id": "T000002R053722", "___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": {} }, "name": "angle", "longname": "Phaser.Physics.Matter.Sprite#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#angle", "___id": "T000002R053723", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.Physics.Matter.Sprite#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#rotation", "___id": "T000002R053724", "___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": {} }, "name": "setPosition", "longname": "Phaser.Physics.Matter.Sprite#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#setPosition", "___id": "T000002R053725", "___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": {} }, "name": "copyPosition", "longname": "Phaser.Physics.Matter.Sprite#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#copyPosition", "___id": "T000002R053726", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.Physics.Matter.Sprite#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#setRandomPosition", "___id": "T000002R053727", "___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": {} }, "name": "setRotation", "longname": "Phaser.Physics.Matter.Sprite#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "overrides": "Phaser.GameObjects.Components.Transform#setRotation", "___id": "T000002R053728", "___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": {} }, "name": "setAngle", "longname": "Phaser.Physics.Matter.Sprite#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "overrides": "Phaser.GameObjects.Components.Transform#setAngle", "___id": "T000002R053729", "___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": {} }, "name": "setScale", "longname": "Phaser.Physics.Matter.Sprite#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#setScale", "___id": "T000002R053730", "___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": {} }, "name": "setX", "longname": "Phaser.Physics.Matter.Sprite#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Transform#setX", "___id": "T000002R053731", "___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": {} }, "name": "setY", "longname": "Phaser.Physics.Matter.Sprite#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Transform#setY", "___id": "T000002R053732", "___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": {} }, "name": "setZ", "longname": "Phaser.Physics.Matter.Sprite#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Transform#setZ", "___id": "T000002R053733", "___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": {} }, "name": "setW", "longname": "Phaser.Physics.Matter.Sprite#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Transform#setW", "___id": "T000002R053734", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.Physics.Matter.Sprite#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "___id": "T000002R053735", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.Physics.Matter.Sprite#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "___id": "T000002R053736", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.Physics.Matter.Sprite#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "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" } ], "overrides": "Phaser.GameObjects.Components.Transform#getLocalPoint", "___id": "T000002R053737", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.Physics.Matter.Sprite#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "overrides": "Phaser.GameObjects.Components.Transform#getParentRotation", "___id": "T000002R053738", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.Physics.Matter.Sprite#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "overrides": "Phaser.GameObjects.Components.Visible#visible", "___id": "T000002R053740", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.Physics.Matter.Sprite#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "overrides": "Phaser.GameObjects.Components.Visible#setVisible", "___id": "T000002R053741", "___s": true }, { "comment": "/**\r\n * Sets the restitution on the physics object.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Bounce#setBounce\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - A Number that defines the restitution (elasticity) of the body. The value is always positive and is in the range (0, 1). A value of 0 means collisions may be perfectly inelastic and no bouncing may occur. A value of 0.8 means the body may bounce back with approximately 80% of its kinetic energy. Note that collision response is based on pairs of bodies, and that restitution values are combined with the following formula: `Math.max(bodyA.restitution, bodyB.restitution)`\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Bounce.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setBounce", "longname": "Phaser.Physics.Matter.Sprite#setBounce", "kind": "function", "description": "Sets the restitution on the physics object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A Number that defines the restitution (elasticity) of the body. The value is always positive and is in the range (0, 1). A value of 0 means collisions may be perfectly inelastic and no bouncing may occur. A value of 0.8 means the body may bounce back with approximately 80% of its kinetic energy. Note that collision response is based on pairs of bodies, and that restitution values are combined with the following formula: `Math.max(bodyA.restitution, bodyB.restitution)`", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Bounce#setBounce", "inherited": true, "___id": "T000002R053742", "___s": true }, { "comment": "/**\r\n * Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31.\r\n * Two bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\r\n * categories are included in their collision masks (see {@link #setCollidesWith}).\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setCollisionCategory\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - Unique category bitfield.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setCollisionCategory", "longname": "Phaser.Physics.Matter.Sprite#setCollisionCategory", "kind": "function", "description": "Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31.\rTwo bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\rcategories are included in their collision masks (see {@link #setCollidesWith}).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Unique category bitfield.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setCollisionCategory", "inherited": true, "___id": "T000002R053743", "___s": true }, { "comment": "/**\r\n * Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values,\r\n * they will collide according to the usual rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\r\n * If two Matter Bodies have the same positive value, they will always collide; if they have the same negative value,\r\n * they will never collide.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setCollisionGroup\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - Unique group index.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setCollisionGroup", "longname": "Phaser.Physics.Matter.Sprite#setCollisionGroup", "kind": "function", "description": "Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values,\rthey will collide according to the usual rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\rIf two Matter Bodies have the same positive value, they will always collide; if they have the same negative value,\rthey will never collide.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Unique group index.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setCollisionGroup", "inherited": true, "___id": "T000002R053744", "___s": true }, { "comment": "/**\r\n * Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only\r\n * collide if each one includes the other's category in its mask based on a bitwise AND, i.e. `(categoryA & maskB) !== 0`\r\n * and `(categoryB & maskA) !== 0` are both true.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setCollidesWith\r\n * @since 3.0.0\r\n *\r\n * @param {(number|number[])} categories - A unique category bitfield, or an array of them.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setCollidesWith", "longname": "Phaser.Physics.Matter.Sprite#setCollidesWith", "kind": "function", "description": "Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only\rcollide if each one includes the other's category in its mask based on a bitwise AND, i.e. `(categoryA & maskB) !== 0`\rand `(categoryB & maskA) !== 0` are both true.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "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" } ] } ] } }, "description": "A unique category bitfield, or an array of them.", "name": "categories" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setCollidesWith", "inherited": true, "___id": "T000002R053745", "___s": true }, { "comment": "/**\r\n * The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\n *\r\n * This does not change the bodies collision category, group or filter. Those must be set in addition\r\n * to the callback.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setOnCollide\r\n * @since 3.22.0\r\n *\r\n * @param {function} callback - The callback to invoke when this body starts colliding with another.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 87, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setOnCollide", "longname": "Phaser.Physics.Matter.Sprite#setOnCollide", "kind": "function", "description": "The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\rThis does not change the bodies collision category, group or filter. Those must be set in addition\rto the callback.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke when this body starts colliding with another.", "name": "callback" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setOnCollide", "inherited": true, "___id": "T000002R053746", "___s": true }, { "comment": "/**\r\n * The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\n *\r\n * This does not change the bodies collision category, group or filter. Those must be set in addition\r\n * to the callback.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setOnCollideEnd\r\n * @since 3.22.0\r\n *\r\n * @param {function} callback - The callback to invoke when this body stops colliding with another.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setOnCollideEnd", "longname": "Phaser.Physics.Matter.Sprite#setOnCollideEnd", "kind": "function", "description": "The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\rThis does not change the bodies collision category, group or filter. Those must be set in addition\rto the callback.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke when this body stops colliding with another.", "name": "callback" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setOnCollideEnd", "inherited": true, "___id": "T000002R053747", "___s": true }, { "comment": "/**\r\n * The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\n *\r\n * This does not change the bodies collision category, group or filter. Those must be set in addition\r\n * to the callback.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setOnCollideActive\r\n * @since 3.22.0\r\n *\r\n * @param {function} callback - The callback to invoke for the duration of this body colliding with another.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 127, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setOnCollideActive", "longname": "Phaser.Physics.Matter.Sprite#setOnCollideActive", "kind": "function", "description": "The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\rThis does not change the bodies collision category, group or filter. Those must be set in addition\rto the callback.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke for the duration of this body colliding with another.", "name": "callback" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setOnCollideActive", "inherited": true, "___id": "T000002R053748", "___s": true }, { "comment": "/**\r\n * The callback is sent a reference to the other body, along with a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\n *\r\n * This does not change the bodies collision category, group or filter. Those must be set in addition\r\n * to the callback.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setOnCollideWith\r\n * @since 3.22.0\r\n *\r\n * @param {(MatterJS.Body|MatterJS.Body[])} body - The body, or an array of bodies, to test for collisions with.\r\n * @param {function} callback - The callback to invoke when this body collides with the given body or bodies.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 147, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setOnCollideWith", "longname": "Phaser.Physics.Matter.Sprite#setOnCollideWith", "kind": "function", "description": "The callback is sent a reference to the other body, along with a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\rThis does not change the bodies collision category, group or filter. Those must be set in addition\rto the callback.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "MatterJS.Body", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "MatterJS.Body" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.Body", "type": "NameExpression" } ] } ] } }, "description": "The body, or an array of bodies, to test for collisions with.", "name": "body" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke when this body collides with the given body or bodies.", "name": "callback" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setOnCollideWith", "inherited": true, "___id": "T000002R053749", "___s": true }, { "comment": "/**\r\n * Applies a force to a body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#applyForce\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector2} force - A Vector that specifies the force to apply.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "applyForce", "longname": "Phaser.Physics.Matter.Sprite#applyForce", "kind": "function", "description": "Applies a force to a body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector that specifies the force to apply.", "name": "force" } ], "inherits": "Phaser.Physics.Matter.Components.Force#applyForce", "inherited": true, "___id": "T000002R053750", "___s": true }, { "comment": "/**\r\n * Applies a force to a body from a given position.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#applyForceFrom\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector2} position - The position in which the force comes from.\r\n * @param {Phaser.Math.Vector2} force - A Vector that specifies the force to apply.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 38, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "applyForceFrom", "longname": "Phaser.Physics.Matter.Sprite#applyForceFrom", "kind": "function", "description": "Applies a force to a body from a given position.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The position in which the force comes from.", "name": "position" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector that specifies the force to apply.", "name": "force" } ], "inherits": "Phaser.Physics.Matter.Components.Force#applyForceFrom", "inherited": true, "___id": "T000002R053751", "___s": true }, { "comment": "/**\r\n * Apply thrust to the forward position of the body.\r\n *\r\n * Use very small values, such as 0.1, depending on the mass and required speed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#thrust\r\n * @since 3.0.0\r\n *\r\n * @param {number} speed - A speed value to be applied to a directional force.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "thrust", "longname": "Phaser.Physics.Matter.Sprite#thrust", "kind": "function", "description": "Apply thrust to the forward position of the body.\r\rUse very small values, such as 0.1, depending on the mass and required speed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A speed value to be applied to a directional force.", "name": "speed" } ], "inherits": "Phaser.Physics.Matter.Components.Force#thrust", "inherited": true, "___id": "T000002R053752", "___s": true }, { "comment": "/**\r\n * Apply thrust to the left position of the body.\r\n *\r\n * Use very small values, such as 0.1, depending on the mass and required speed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#thrustLeft\r\n * @since 3.0.0\r\n *\r\n * @param {number} speed - A speed value to be applied to a directional force.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "thrustLeft", "longname": "Phaser.Physics.Matter.Sprite#thrustLeft", "kind": "function", "description": "Apply thrust to the left position of the body.\r\rUse very small values, such as 0.1, depending on the mass and required speed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A speed value to be applied to a directional force.", "name": "speed" } ], "inherits": "Phaser.Physics.Matter.Components.Force#thrustLeft", "inherited": true, "___id": "T000002R053753", "___s": true }, { "comment": "/**\r\n * Apply thrust to the right position of the body.\r\n *\r\n * Use very small values, such as 0.1, depending on the mass and required speed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#thrustRight\r\n * @since 3.0.0\r\n *\r\n * @param {number} speed - A speed value to be applied to a directional force.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 102, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "thrustRight", "longname": "Phaser.Physics.Matter.Sprite#thrustRight", "kind": "function", "description": "Apply thrust to the right position of the body.\r\rUse very small values, such as 0.1, depending on the mass and required speed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A speed value to be applied to a directional force.", "name": "speed" } ], "inherits": "Phaser.Physics.Matter.Components.Force#thrustRight", "inherited": true, "___id": "T000002R053754", "___s": true }, { "comment": "/**\r\n * Apply thrust to the back position of the body.\r\n *\r\n * Use very small values, such as 0.1, depending on the mass and required speed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Force#thrustBack\r\n * @since 3.0.0\r\n *\r\n * @param {number} speed - A speed value to be applied to a directional force.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Force.js", "lineno": 125, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "thrustBack", "longname": "Phaser.Physics.Matter.Sprite#thrustBack", "kind": "function", "description": "Apply thrust to the back position of the body.\r\rUse very small values, such as 0.1, depending on the mass and required speed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A speed value to be applied to a directional force.", "name": "speed" } ], "inherits": "Phaser.Physics.Matter.Components.Force#thrustBack", "inherited": true, "___id": "T000002R053755", "___s": true }, { "comment": "/**\r\n * Sets new friction values for this Game Object's Matter Body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Friction#setFriction\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.\r\n * @param {number} [air] - If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.\r\n * @param {number} [fstatic] - If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never \"stick\" when it is nearly stationary.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Friction.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setFriction", "longname": "Phaser.Physics.Matter.Sprite#setFriction", "kind": "function", "description": "Sets new friction values for this Game Object's Matter Body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.", "name": "air" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never \"stick\" when it is nearly stationary.", "name": "fstatic" } ], "inherits": "Phaser.Physics.Matter.Components.Friction#setFriction", "inherited": true, "___id": "T000002R053756", "___s": true }, { "comment": "/**\r\n * Sets a new air resistance for this Game Object's Matter Body.\r\n * A value of 0 means the Body will never slow as it moves through space.\r\n * The higher the value, the faster a Body slows when moving through space.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Friction#setFrictionAir\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new air resistance for the Body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Friction.js", "lineno": 44, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setFrictionAir", "longname": "Phaser.Physics.Matter.Sprite#setFrictionAir", "kind": "function", "description": "Sets a new air resistance for this Game Object's Matter Body.\rA value of 0 means the Body will never slow as it moves through space.\rThe higher the value, the faster a Body slows when moving through space.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new air resistance for the Body.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Friction#setFrictionAir", "inherited": true, "___id": "T000002R053757", "___s": true }, { "comment": "/**\r\n * Sets a new static friction for this Game Object's Matter Body.\r\n * A value of 0 means the Body will never \"stick\" when it is nearly stationary.\r\n * The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Friction#setFrictionStatic\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new static friction for the Body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Friction.js", "lineno": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setFrictionStatic", "longname": "Phaser.Physics.Matter.Sprite#setFrictionStatic", "kind": "function", "description": "Sets a new static friction for this Game Object's Matter Body.\rA value of 0 means the Body will never \"stick\" when it is nearly stationary.\rThe higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new static friction for the Body.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Friction#setFrictionStatic", "inherited": true, "___id": "T000002R053758", "___s": true }, { "comment": "/**\r\n * A togglable function for ignoring world gravity in real-time on the current body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - Set to true to ignore the effect of world gravity, or false to not ignore it.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Gravity.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setIgnoreGravity", "longname": "Phaser.Physics.Matter.Sprite#setIgnoreGravity", "kind": "function", "description": "A togglable function for ignoring world gravity in real-time on the current body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true to ignore the effect of world gravity, or false to not ignore it.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity", "inherited": true, "___id": "T000002R053759", "___s": true }, { "comment": "/**\r\n * Sets the mass of the Game Object's Matter Body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Mass#setMass\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new mass of the body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mass.js", "lineno": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setMass", "longname": "Phaser.Physics.Matter.Sprite#setMass", "kind": "function", "description": "Sets the mass of the Game Object's Matter Body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new mass of the body.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Mass#setMass", "inherited": true, "___id": "T000002R053760", "___s": true }, { "comment": "/**\r\n * Sets density of the body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Mass#setDensity\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new density of the body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mass.js", "lineno": 35, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setDensity", "longname": "Phaser.Physics.Matter.Sprite#setDensity", "kind": "function", "description": "Sets density of the body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new density of the body.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Mass#setDensity", "inherited": true, "___id": "T000002R053761", "___s": true }, { "comment": "/**\r\n * The body's center of mass.\r\n *\r\n * Calling this creates a new `Vector2 each time to avoid mutation.\r\n *\r\n * If you only need to read the value and won't change it, you can get it from `GameObject.body.centerOfMass`.\r\n *\r\n * @name Phaser.Physics.Matter.Components.Mass#centerOfMass\r\n * @type {Phaser.Math.Vector2}\r\n * @readonly\r\n * @since 3.10.0\r\n *\r\n * @return {Phaser.Math.Vector2} The center of mass.\r\n */", "meta": { "filename": "Mass.js", "lineno": 52, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "centerOfMass", "longname": "Phaser.Physics.Matter.Sprite#centerOfMass", "kind": "member", "description": "The body's center of mass.\r\rCalling this creates a new `Vector2 each time to avoid mutation.\r\rIf you only need to read the value and won't change it, you can get it from `GameObject.body.centerOfMass`.", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "readonly": true, "since": "3.10.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The center of mass." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Mass#centerOfMass", "inherited": true, "___id": "T000002R053762", "___s": true }, { "comment": "/**\r\n * Set the body belonging to this Game Object to be a sensor.\r\n * Sensors trigger collision events, but don't react with colliding body physically.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sensor#setSensor\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to set the body as a sensor, or `false` to disable it.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sensor.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setSensor", "longname": "Phaser.Physics.Matter.Sprite#setSensor", "kind": "function", "description": "Set the body belonging to this Game Object to be a sensor.\rSensors trigger collision events, but don't react with colliding body physically.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to set the body as a sensor, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Sensor#setSensor", "inherited": true, "___id": "T000002R053763", "___s": true }, { "comment": "/**\r\n * Is the body belonging to this Game Object a sensor or not?\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sensor#isSensor\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if the body is a sensor, otherwise `false`.\r\n */", "meta": { "filename": "Sensor.js", "lineno": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "isSensor", "longname": "Phaser.Physics.Matter.Sprite#isSensor", "kind": "function", "description": "Is the body belonging to this Game Object a sensor or not?", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the body is a sensor, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Sensor#isSensor", "inherited": true, "___id": "T000002R053764", "___s": true }, { "comment": "/**\r\n * Set this Game Objects Matter physics body to be a rectangle shape.\r\n *\r\n * Calling this methods resets all previous properties you may have set on the body, including\r\n * plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setRectangle\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 23, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setRectangle", "longname": "Phaser.Physics.Matter.Sprite#setRectangle", "kind": "function", "description": "Set this Game Objects Matter physics body to be a rectangle shape.\r\rCalling this methods resets all previous properties you may have set on the body, including\rplugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "inherits": "Phaser.Physics.Matter.Components.SetBody#setRectangle", "inherited": true, "___id": "T000002R053765", "___s": true }, { "comment": "/**\r\n * Set this Game Objects Matter physics body to be a circle shape.\r\n *\r\n * Calling this methods resets all previous properties you may have set on the body, including\r\n * plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setCircle\r\n * @since 3.0.0\r\n *\r\n * @param {number} radius - The radius of the circle.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setCircle", "longname": "Phaser.Physics.Matter.Sprite#setCircle", "kind": "function", "description": "Set this Game Objects Matter physics body to be a circle shape.\r\rCalling this methods resets all previous properties you may have set on the body, including\rplugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the circle.", "name": "radius" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "inherits": "Phaser.Physics.Matter.Components.SetBody#setCircle", "inherited": true, "___id": "T000002R053766", "___s": true }, { "comment": "/**\r\n * Set this Game Objects Matter physics body to be a polygon shape.\r\n *\r\n * Calling this methods resets all previous properties you may have set on the body, including\r\n * plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setPolygon\r\n * @since 3.0.0\r\n *\r\n * @param {number} radius - The \"radius\" of the polygon, i.e. the distance from its center to any vertex. This is also the radius of its circumcircle.\r\n * @param {number} sides - The number of sides the polygon will have.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setPolygon", "longname": "Phaser.Physics.Matter.Sprite#setPolygon", "kind": "function", "description": "Set this Game Objects Matter physics body to be a polygon shape.\r\rCalling this methods resets all previous properties you may have set on the body, including\rplugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The \"radius\" of the polygon, i.e. the distance from its center to any vertex. This is also the radius of its circumcircle.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of sides the polygon will have.", "name": "sides" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "inherits": "Phaser.Physics.Matter.Components.SetBody#setPolygon", "inherited": true, "___id": "T000002R053767", "___s": true }, { "comment": "/**\r\n * Set this Game Objects Matter physics body to be a trapezoid shape.\r\n *\r\n * Calling this methods resets all previous properties you may have set on the body, including\r\n * plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setTrapezoid\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The width of the trapezoid Body.\r\n * @param {number} height - The height of the trapezoid Body.\r\n * @param {number} slope - The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 82, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setTrapezoid", "longname": "Phaser.Physics.Matter.Sprite#setTrapezoid", "kind": "function", "description": "Set this Game Objects Matter physics body to be a trapezoid shape.\r\rCalling this methods resets all previous properties you may have set on the body, including\rplugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the trapezoid Body.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the trapezoid Body.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.", "name": "slope" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "inherits": "Phaser.Physics.Matter.Components.SetBody#setTrapezoid", "inherited": true, "___id": "T000002R053768", "___s": true }, { "comment": "/**\r\n * Set this Game Object to use the given existing Matter Body.\r\n *\r\n * The body is first removed from the world before being added to this Game Object.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setExistingBody\r\n * @since 3.0.0\r\n *\r\n * @param {MatterJS.BodyType} body - The Body this Game Object should use.\r\n * @param {boolean} [addToWorld=true] - Should the body be immediately added to the World?\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setExistingBody", "longname": "Phaser.Physics.Matter.Sprite#setExistingBody", "kind": "function", "description": "Set this Game Object to use the given existing Matter Body.\r\rThe body is first removed from the world before being added to this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "MatterJS.BodyType" ], "parsedType": { "type": "NameExpression", "name": "MatterJS.BodyType" } }, "description": "The Body this Game Object should use.", "name": "body" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the body be immediately added to the World?", "name": "addToWorld" } ], "inherits": "Phaser.Physics.Matter.Components.SetBody#setExistingBody", "inherited": true, "___id": "T000002R053769", "___s": true }, { "comment": "/**\r\n * Set this Game Object to create and use a new Body based on the configuration object given.\r\n *\r\n * Calling this methods resets all previous properties you may have set on the body, including\r\n * plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.\r\n *\r\n * @method Phaser.Physics.Matter.Components.SetBody#setBody\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Physics.Matter.MatterSetBodyConfig)} config - Either a string, such as `circle`, or a Matter Set Body Configuration object.\r\n * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "SetBody.js", "lineno": 175, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setBody", "longname": "Phaser.Physics.Matter.Sprite#setBody", "kind": "function", "description": "Set this Game Object to create and use a new Body based on the configuration object given.\r\rCalling this methods resets all previous properties you may have set on the body, including\rplugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Types.Physics.Matter.MatterSetBodyConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterSetBodyConfig" } ] } }, "description": "Either a string, such as `circle`, or a Matter Set Body Configuration object.", "name": "config" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterBodyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterBodyConfig" } }, "optional": true, "description": "An optional Body configuration object that is used to set initial Body properties on creation.", "name": "options" } ], "inherits": "Phaser.Physics.Matter.Components.SetBody#setBody", "inherited": true, "___id": "T000002R053770", "___s": true }, { "comment": "/**\r\n * Sets this Body to sleep.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setToSleep\r\n * @since 3.22.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setToSleep", "longname": "Phaser.Physics.Matter.Sprite#setToSleep", "kind": "function", "description": "Sets this Body to sleep.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Sleep#setToSleep", "inherited": true, "___id": "T000002R053771", "___s": true }, { "comment": "/**\r\n * Wakes this Body if asleep.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setAwake\r\n * @since 3.22.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setAwake", "longname": "Phaser.Physics.Matter.Sprite#setAwake", "kind": "function", "description": "Wakes this Body if asleep.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Sleep#setAwake", "inherited": true, "___id": "T000002R053772", "___s": true }, { "comment": "/**\r\n * Sets the number of updates in which this body must have near-zero velocity before it is set as sleeping (if sleeping is enabled by the engine).\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setSleepThreshold\r\n * @since 3.0.0\r\n *\r\n * @param {number} [value=60] - A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setSleepThreshold", "longname": "Phaser.Physics.Matter.Sprite#setSleepThreshold", "kind": "function", "description": "Sets the number of updates in which this body must have near-zero velocity before it is set as sleeping (if sleeping is enabled by the engine).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 60, "description": "A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Sleep#setSleepThreshold", "inherited": true, "___id": "T000002R053773", "___s": true }, { "comment": "/**\r\n * Enable sleep and wake events for this body.\r\n *\r\n * By default when a body goes to sleep, or wakes up, it will not emit any events.\r\n *\r\n * The events are emitted by the Matter World instance and can be listened to via\r\n * the `SLEEP_START` and `SLEEP_END` events.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setSleepEvents\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} start - `true` if you want the sleep start event to be emitted for this body.\r\n * @param {boolean} end - `true` if you want the sleep end event to be emitted for this body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setSleepEvents", "longname": "Phaser.Physics.Matter.Sprite#setSleepEvents", "kind": "function", "description": "Enable sleep and wake events for this body.\r\rBy default when a body goes to sleep, or wakes up, it will not emit any events.\r\rThe events are emitted by the Matter World instance and can be listened to via\rthe `SLEEP_START` and `SLEEP_END` events.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if you want the sleep start event to be emitted for this body.", "name": "start" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if you want the sleep end event to be emitted for this body.", "name": "end" } ], "inherits": "Phaser.Physics.Matter.Components.Sleep#setSleepEvents", "inherited": true, "___id": "T000002R053774", "___s": true }, { "comment": "/**\r\n * Enables or disables the Sleep Start event for this body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setSleepStartEvent\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to enable the sleep event, or `false` to disable it.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setSleepStartEvent", "longname": "Phaser.Physics.Matter.Sprite#setSleepStartEvent", "kind": "function", "description": "Enables or disables the Sleep Start event for this body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable the sleep event, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Sleep#setSleepStartEvent", "inherited": true, "___id": "T000002R053775", "___s": true }, { "comment": "/**\r\n * Enables or disables the Sleep End event for this body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setSleepEndEvent\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to enable the sleep event, or `false` to disable it.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 121, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setSleepEndEvent", "longname": "Phaser.Physics.Matter.Sprite#setSleepEndEvent", "kind": "function", "description": "Enables or disables the Sleep End event for this body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable the sleep event, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Sleep#setSleepEndEvent", "inherited": true, "___id": "T000002R053776", "___s": true }, { "comment": "/**\r\n * Changes the physics body to be either static `true` or dynamic `false`.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Static#setStatic\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to set the body as being static, or `false` to make it dynamic.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Static.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setStatic", "longname": "Phaser.Physics.Matter.Sprite#setStatic", "kind": "function", "description": "Changes the physics body to be either static `true` or dynamic `false`.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to set the body as being static, or `false` to make it dynamic.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Static#setStatic", "inherited": true, "___id": "T000002R053777", "___s": true }, { "comment": "/**\r\n * Returns `true` if the body is static, otherwise `false` for a dynamic body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Static#isStatic\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if the body is static, otherwise `false`.\r\n */", "meta": { "filename": "Static.js", "lineno": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "isStatic", "longname": "Phaser.Physics.Matter.Sprite#isStatic", "kind": "function", "description": "Returns `true` if the body is static, otherwise `false` for a dynamic body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the body is static, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Static#isStatic", "inherited": true, "___id": "T000002R053778", "___s": true }, { "comment": "/**\r\n * Setting fixed rotation sets the Body inertia to Infinity, which stops it\r\n * from being able to rotate when forces are applied to it.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Transform#setFixedRotation\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 239, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setFixedRotation", "longname": "Phaser.Physics.Matter.Sprite#setFixedRotation", "kind": "function", "description": "Setting fixed rotation sets the Body inertia to Infinity, which stops it\rfrom being able to rotate when forces are applied to it.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Transform#setFixedRotation", "inherited": true, "___id": "T000002R053779", "___s": true }, { "comment": "/**\r\n * Sets the horizontal velocity of the physics body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#setVelocityX\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal velocity value.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setVelocityX", "longname": "Phaser.Physics.Matter.Sprite#setVelocityX", "kind": "function", "description": "Sets the horizontal velocity of the physics body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal velocity value.", "name": "x" } ], "inherits": "Phaser.Physics.Matter.Components.Velocity#setVelocityX", "inherited": true, "___id": "T000002R053780", "___s": true }, { "comment": "/**\r\n * Sets vertical velocity of the physics body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#setVelocityY\r\n * @since 3.0.0\r\n *\r\n * @param {number} y - The vertical velocity value.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setVelocityY", "longname": "Phaser.Physics.Matter.Sprite#setVelocityY", "kind": "function", "description": "Sets vertical velocity of the physics body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical velocity value.", "name": "y" } ], "inherits": "Phaser.Physics.Matter.Components.Velocity#setVelocityY", "inherited": true, "___id": "T000002R053781", "___s": true }, { "comment": "/**\r\n * Sets both the horizontal and vertical velocity of the physics body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#setVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal velocity value.\r\n * @param {number} [y=x] - The vertical velocity value, it can be either positive or negative. If not given, it will be the same as the `x` value.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 55, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setVelocity", "longname": "Phaser.Physics.Matter.Sprite#setVelocity", "kind": "function", "description": "Sets both the horizontal and vertical velocity of the physics body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal velocity value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical velocity value, it can be either positive or negative. If not given, it will be the same as the `x` value.", "name": "y" } ], "inherits": "Phaser.Physics.Matter.Components.Velocity#setVelocity", "inherited": true, "___id": "T000002R053782", "___s": true }, { "comment": "/**\r\n * Gets the current linear velocity of the physics body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#getVelocity\r\n * @since 3.60.0\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The current linear velocity of the body.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 75, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "getVelocity", "longname": "Phaser.Physics.Matter.Sprite#getVelocity", "kind": "function", "description": "Gets the current linear velocity of the physics body.", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The current linear velocity of the body." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Velocity#getVelocity", "inherited": true, "___id": "T000002R053783", "___s": true }, { "comment": "/**\r\n * Sets the angular velocity of the body instantly.\r\n * Position, angle, force etc. are unchanged.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#setAngularVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {number} velocity - The angular velocity.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setAngularVelocity", "longname": "Phaser.Physics.Matter.Sprite#setAngularVelocity", "kind": "function", "description": "Sets the angular velocity of the body instantly.\rPosition, angle, force etc. are unchanged.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angular velocity.", "name": "velocity" } ], "inherits": "Phaser.Physics.Matter.Components.Velocity#setAngularVelocity", "inherited": true, "___id": "T000002R053784", "___s": true }, { "comment": "/**\r\n * Gets the current rotational velocity of the body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#getAngularVelocity\r\n * @since 3.60.0\r\n *\r\n * @return {number} The current angular velocity of the body.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "getAngularVelocity", "longname": "Phaser.Physics.Matter.Sprite#getAngularVelocity", "kind": "function", "description": "Gets the current rotational velocity of the body.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current angular velocity of the body." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Velocity#getAngularVelocity", "inherited": true, "___id": "T000002R053785", "___s": true }, { "comment": "/**\r\n * Sets the current rotational speed of the body.\r\n * Direction is maintained. Affects body angular velocity.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#setAngularSpeed\r\n * @since 3.60.0\r\n *\r\n * @param {number} speed - The angular speed.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 119, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setAngularSpeed", "longname": "Phaser.Physics.Matter.Sprite#setAngularSpeed", "kind": "function", "description": "Sets the current rotational speed of the body.\rDirection is maintained. Affects body angular velocity.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angular speed.", "name": "speed" } ], "inherits": "Phaser.Physics.Matter.Components.Velocity#setAngularSpeed", "inherited": true, "___id": "T000002R053786", "___s": true }, { "comment": "/**\r\n * Gets the current rotational speed of the body.\r\n * Equivalent to the magnitude of its angular velocity.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Velocity#getAngularSpeed\r\n * @since 3.60.0\r\n *\r\n * @return {number} The current angular velocity of the body.\r\n */", "meta": { "filename": "Velocity.js", "lineno": 137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "getAngularSpeed", "longname": "Phaser.Physics.Matter.Sprite#getAngularSpeed", "kind": "function", "description": "Gets the current rotational speed of the body.\rEquivalent to the magnitude of its angular velocity.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current angular velocity of the body." } ], "memberof": "Phaser.Physics.Matter.Sprite", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Velocity#getAngularSpeed", "inherited": true, "___id": "T000002R053787", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Physics.Matter.TileBody#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R053788", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Physics.Matter.TileBody#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Physics.Matter.TileBody", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R053789", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Physics.Matter.TileBody#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R053790", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Physics.Matter.TileBody#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R053791", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Physics.Matter.TileBody#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R053792", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Physics.Matter.TileBody#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R053793", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Physics.Matter.TileBody#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R053794", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Physics.Matter.TileBody#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R053795", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Physics.Matter.TileBody#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R053796", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Physics.Matter.TileBody#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R053797", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Physics.Matter.TileBody#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R053798", "___s": true }, { "comment": "/**\r\n * Sets the restitution on the physics object.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Bounce#setBounce\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - A Number that defines the restitution (elasticity) of the body. The value is always positive and is in the range (0, 1). A value of 0 means collisions may be perfectly inelastic and no bouncing may occur. A value of 0.8 means the body may bounce back with approximately 80% of its kinetic energy. Note that collision response is based on pairs of bodies, and that restitution values are combined with the following formula: `Math.max(bodyA.restitution, bodyB.restitution)`\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Bounce.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setBounce", "longname": "Phaser.Physics.Matter.TileBody#setBounce", "kind": "function", "description": "Sets the restitution on the physics object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A Number that defines the restitution (elasticity) of the body. The value is always positive and is in the range (0, 1). A value of 0 means collisions may be perfectly inelastic and no bouncing may occur. A value of 0.8 means the body may bounce back with approximately 80% of its kinetic energy. Note that collision response is based on pairs of bodies, and that restitution values are combined with the following formula: `Math.max(bodyA.restitution, bodyB.restitution)`", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Bounce#setBounce", "inherited": true, "___id": "T000002R053799", "___s": true }, { "comment": "/**\r\n * Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31.\r\n * Two bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\r\n * categories are included in their collision masks (see {@link #setCollidesWith}).\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setCollisionCategory\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - Unique category bitfield.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setCollisionCategory", "longname": "Phaser.Physics.Matter.TileBody#setCollisionCategory", "kind": "function", "description": "Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31.\rTwo bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\rcategories are included in their collision masks (see {@link #setCollidesWith}).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Unique category bitfield.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setCollisionCategory", "inherited": true, "___id": "T000002R053800", "___s": true }, { "comment": "/**\r\n * Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values,\r\n * they will collide according to the usual rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\r\n * If two Matter Bodies have the same positive value, they will always collide; if they have the same negative value,\r\n * they will never collide.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setCollisionGroup\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - Unique group index.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setCollisionGroup", "longname": "Phaser.Physics.Matter.TileBody#setCollisionGroup", "kind": "function", "description": "Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values,\rthey will collide according to the usual rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\rIf two Matter Bodies have the same positive value, they will always collide; if they have the same negative value,\rthey will never collide.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Unique group index.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setCollisionGroup", "inherited": true, "___id": "T000002R053801", "___s": true }, { "comment": "/**\r\n * Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only\r\n * collide if each one includes the other's category in its mask based on a bitwise AND, i.e. `(categoryA & maskB) !== 0`\r\n * and `(categoryB & maskA) !== 0` are both true.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setCollidesWith\r\n * @since 3.0.0\r\n *\r\n * @param {(number|number[])} categories - A unique category bitfield, or an array of them.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setCollidesWith", "longname": "Phaser.Physics.Matter.TileBody#setCollidesWith", "kind": "function", "description": "Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only\rcollide if each one includes the other's category in its mask based on a bitwise AND, i.e. `(categoryA & maskB) !== 0`\rand `(categoryB & maskA) !== 0` are both true.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "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" } ] } ] } }, "description": "A unique category bitfield, or an array of them.", "name": "categories" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setCollidesWith", "inherited": true, "___id": "T000002R053802", "___s": true }, { "comment": "/**\r\n * The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\n *\r\n * This does not change the bodies collision category, group or filter. Those must be set in addition\r\n * to the callback.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setOnCollide\r\n * @since 3.22.0\r\n *\r\n * @param {function} callback - The callback to invoke when this body starts colliding with another.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 87, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setOnCollide", "longname": "Phaser.Physics.Matter.TileBody#setOnCollide", "kind": "function", "description": "The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\rThis does not change the bodies collision category, group or filter. Those must be set in addition\rto the callback.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke when this body starts colliding with another.", "name": "callback" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setOnCollide", "inherited": true, "___id": "T000002R053803", "___s": true }, { "comment": "/**\r\n * The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\n *\r\n * This does not change the bodies collision category, group or filter. Those must be set in addition\r\n * to the callback.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setOnCollideEnd\r\n * @since 3.22.0\r\n *\r\n * @param {function} callback - The callback to invoke when this body stops colliding with another.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setOnCollideEnd", "longname": "Phaser.Physics.Matter.TileBody#setOnCollideEnd", "kind": "function", "description": "The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\rThis does not change the bodies collision category, group or filter. Those must be set in addition\rto the callback.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke when this body stops colliding with another.", "name": "callback" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setOnCollideEnd", "inherited": true, "___id": "T000002R053804", "___s": true }, { "comment": "/**\r\n * The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\n *\r\n * This does not change the bodies collision category, group or filter. Those must be set in addition\r\n * to the callback.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setOnCollideActive\r\n * @since 3.22.0\r\n *\r\n * @param {function} callback - The callback to invoke for the duration of this body colliding with another.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 127, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setOnCollideActive", "longname": "Phaser.Physics.Matter.TileBody#setOnCollideActive", "kind": "function", "description": "The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\rThis does not change the bodies collision category, group or filter. Those must be set in addition\rto the callback.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke for the duration of this body colliding with another.", "name": "callback" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setOnCollideActive", "inherited": true, "___id": "T000002R053805", "___s": true }, { "comment": "/**\r\n * The callback is sent a reference to the other body, along with a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\n *\r\n * This does not change the bodies collision category, group or filter. Those must be set in addition\r\n * to the callback.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Collision#setOnCollideWith\r\n * @since 3.22.0\r\n *\r\n * @param {(MatterJS.Body|MatterJS.Body[])} body - The body, or an array of bodies, to test for collisions with.\r\n * @param {function} callback - The callback to invoke when this body collides with the given body or bodies.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Collision.js", "lineno": 147, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setOnCollideWith", "longname": "Phaser.Physics.Matter.TileBody#setOnCollideWith", "kind": "function", "description": "The callback is sent a reference to the other body, along with a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\r\rThis does not change the bodies collision category, group or filter. Those must be set in addition\rto the callback.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "MatterJS.Body", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "MatterJS.Body" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "MatterJS.Body", "type": "NameExpression" } ] } ] } }, "description": "The body, or an array of bodies, to test for collisions with.", "name": "body" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The callback to invoke when this body collides with the given body or bodies.", "name": "callback" } ], "inherits": "Phaser.Physics.Matter.Components.Collision#setOnCollideWith", "inherited": true, "___id": "T000002R053806", "___s": true }, { "comment": "/**\r\n * Sets new friction values for this Game Object's Matter Body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Friction#setFriction\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.\r\n * @param {number} [air] - If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.\r\n * @param {number} [fstatic] - If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never \"stick\" when it is nearly stationary.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Friction.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setFriction", "longname": "Phaser.Physics.Matter.TileBody#setFriction", "kind": "function", "description": "Sets new friction values for this Game Object's Matter Body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.", "name": "air" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never \"stick\" when it is nearly stationary.", "name": "fstatic" } ], "inherits": "Phaser.Physics.Matter.Components.Friction#setFriction", "inherited": true, "___id": "T000002R053807", "___s": true }, { "comment": "/**\r\n * Sets a new air resistance for this Game Object's Matter Body.\r\n * A value of 0 means the Body will never slow as it moves through space.\r\n * The higher the value, the faster a Body slows when moving through space.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Friction#setFrictionAir\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new air resistance for the Body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Friction.js", "lineno": 44, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setFrictionAir", "longname": "Phaser.Physics.Matter.TileBody#setFrictionAir", "kind": "function", "description": "Sets a new air resistance for this Game Object's Matter Body.\rA value of 0 means the Body will never slow as it moves through space.\rThe higher the value, the faster a Body slows when moving through space.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new air resistance for the Body.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Friction#setFrictionAir", "inherited": true, "___id": "T000002R053808", "___s": true }, { "comment": "/**\r\n * Sets a new static friction for this Game Object's Matter Body.\r\n * A value of 0 means the Body will never \"stick\" when it is nearly stationary.\r\n * The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Friction#setFrictionStatic\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new static friction for the Body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Friction.js", "lineno": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setFrictionStatic", "longname": "Phaser.Physics.Matter.TileBody#setFrictionStatic", "kind": "function", "description": "Sets a new static friction for this Game Object's Matter Body.\rA value of 0 means the Body will never \"stick\" when it is nearly stationary.\rThe higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new static friction for the Body.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Friction#setFrictionStatic", "inherited": true, "___id": "T000002R053809", "___s": true }, { "comment": "/**\r\n * A togglable function for ignoring world gravity in real-time on the current body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - Set to true to ignore the effect of world gravity, or false to not ignore it.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Gravity.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setIgnoreGravity", "longname": "Phaser.Physics.Matter.TileBody#setIgnoreGravity", "kind": "function", "description": "A togglable function for ignoring world gravity in real-time on the current body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true to ignore the effect of world gravity, or false to not ignore it.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity", "inherited": true, "___id": "T000002R053810", "___s": true }, { "comment": "/**\r\n * Sets the mass of the Game Object's Matter Body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Mass#setMass\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new mass of the body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mass.js", "lineno": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setMass", "longname": "Phaser.Physics.Matter.TileBody#setMass", "kind": "function", "description": "Sets the mass of the Game Object's Matter Body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new mass of the body.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Mass#setMass", "inherited": true, "___id": "T000002R053811", "___s": true }, { "comment": "/**\r\n * Sets density of the body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Mass#setDensity\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new density of the body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mass.js", "lineno": 35, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setDensity", "longname": "Phaser.Physics.Matter.TileBody#setDensity", "kind": "function", "description": "Sets density of the body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new density of the body.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Mass#setDensity", "inherited": true, "___id": "T000002R053812", "___s": true }, { "comment": "/**\r\n * The body's center of mass.\r\n *\r\n * Calling this creates a new `Vector2 each time to avoid mutation.\r\n *\r\n * If you only need to read the value and won't change it, you can get it from `GameObject.body.centerOfMass`.\r\n *\r\n * @name Phaser.Physics.Matter.Components.Mass#centerOfMass\r\n * @type {Phaser.Math.Vector2}\r\n * @readonly\r\n * @since 3.10.0\r\n *\r\n * @return {Phaser.Math.Vector2} The center of mass.\r\n */", "meta": { "filename": "Mass.js", "lineno": 52, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "centerOfMass", "longname": "Phaser.Physics.Matter.TileBody#centerOfMass", "kind": "member", "description": "The body's center of mass.\r\rCalling this creates a new `Vector2 each time to avoid mutation.\r\rIf you only need to read the value and won't change it, you can get it from `GameObject.body.centerOfMass`.", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "readonly": true, "since": "3.10.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The center of mass." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Mass#centerOfMass", "inherited": true, "___id": "T000002R053813", "___s": true }, { "comment": "/**\r\n * Set the body belonging to this Game Object to be a sensor.\r\n * Sensors trigger collision events, but don't react with colliding body physically.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sensor#setSensor\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to set the body as a sensor, or `false` to disable it.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sensor.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setSensor", "longname": "Phaser.Physics.Matter.TileBody#setSensor", "kind": "function", "description": "Set the body belonging to this Game Object to be a sensor.\rSensors trigger collision events, but don't react with colliding body physically.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to set the body as a sensor, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Sensor#setSensor", "inherited": true, "___id": "T000002R053814", "___s": true }, { "comment": "/**\r\n * Is the body belonging to this Game Object a sensor or not?\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sensor#isSensor\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if the body is a sensor, otherwise `false`.\r\n */", "meta": { "filename": "Sensor.js", "lineno": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "isSensor", "longname": "Phaser.Physics.Matter.TileBody#isSensor", "kind": "function", "description": "Is the body belonging to this Game Object a sensor or not?", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the body is a sensor, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Sensor#isSensor", "inherited": true, "___id": "T000002R053815", "___s": true }, { "comment": "/**\r\n * Sets this Body to sleep.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setToSleep\r\n * @since 3.22.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setToSleep", "longname": "Phaser.Physics.Matter.TileBody#setToSleep", "kind": "function", "description": "Sets this Body to sleep.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Sleep#setToSleep", "inherited": true, "___id": "T000002R053816", "___s": true }, { "comment": "/**\r\n * Wakes this Body if asleep.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setAwake\r\n * @since 3.22.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setAwake", "longname": "Phaser.Physics.Matter.TileBody#setAwake", "kind": "function", "description": "Wakes this Body if asleep.", "since": "3.22.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Sleep#setAwake", "inherited": true, "___id": "T000002R053817", "___s": true }, { "comment": "/**\r\n * Sets the number of updates in which this body must have near-zero velocity before it is set as sleeping (if sleeping is enabled by the engine).\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setSleepThreshold\r\n * @since 3.0.0\r\n *\r\n * @param {number} [value=60] - A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setSleepThreshold", "longname": "Phaser.Physics.Matter.TileBody#setSleepThreshold", "kind": "function", "description": "Sets the number of updates in which this body must have near-zero velocity before it is set as sleeping (if sleeping is enabled by the engine).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 60, "description": "A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Sleep#setSleepThreshold", "inherited": true, "___id": "T000002R053818", "___s": true }, { "comment": "/**\r\n * Enable sleep and wake events for this body.\r\n *\r\n * By default when a body goes to sleep, or wakes up, it will not emit any events.\r\n *\r\n * The events are emitted by the Matter World instance and can be listened to via\r\n * the `SLEEP_START` and `SLEEP_END` events.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setSleepEvents\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} start - `true` if you want the sleep start event to be emitted for this body.\r\n * @param {boolean} end - `true` if you want the sleep end event to be emitted for this body.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setSleepEvents", "longname": "Phaser.Physics.Matter.TileBody#setSleepEvents", "kind": "function", "description": "Enable sleep and wake events for this body.\r\rBy default when a body goes to sleep, or wakes up, it will not emit any events.\r\rThe events are emitted by the Matter World instance and can be listened to via\rthe `SLEEP_START` and `SLEEP_END` events.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if you want the sleep start event to be emitted for this body.", "name": "start" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if you want the sleep end event to be emitted for this body.", "name": "end" } ], "inherits": "Phaser.Physics.Matter.Components.Sleep#setSleepEvents", "inherited": true, "___id": "T000002R053819", "___s": true }, { "comment": "/**\r\n * Enables or disables the Sleep Start event for this body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setSleepStartEvent\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to enable the sleep event, or `false` to disable it.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setSleepStartEvent", "longname": "Phaser.Physics.Matter.TileBody#setSleepStartEvent", "kind": "function", "description": "Enables or disables the Sleep Start event for this body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable the sleep event, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Sleep#setSleepStartEvent", "inherited": true, "___id": "T000002R053820", "___s": true }, { "comment": "/**\r\n * Enables or disables the Sleep End event for this body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Sleep#setSleepEndEvent\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to enable the sleep event, or `false` to disable it.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Sleep.js", "lineno": 121, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setSleepEndEvent", "longname": "Phaser.Physics.Matter.TileBody#setSleepEndEvent", "kind": "function", "description": "Enables or disables the Sleep End event for this body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable the sleep event, or `false` to disable it.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Sleep#setSleepEndEvent", "inherited": true, "___id": "T000002R053821", "___s": true }, { "comment": "/**\r\n * Changes the physics body to be either static `true` or dynamic `false`.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Static#setStatic\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to set the body as being static, or `false` to make it dynamic.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Static.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "setStatic", "longname": "Phaser.Physics.Matter.TileBody#setStatic", "kind": "function", "description": "Changes the physics body to be either static `true` or dynamic `false`.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to set the body as being static, or `false` to make it dynamic.", "name": "value" } ], "inherits": "Phaser.Physics.Matter.Components.Static#setStatic", "inherited": true, "___id": "T000002R053822", "___s": true }, { "comment": "/**\r\n * Returns `true` if the body is static, otherwise `false` for a dynamic body.\r\n *\r\n * @method Phaser.Physics.Matter.Components.Static#isStatic\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if the body is static, otherwise `false`.\r\n */", "meta": { "filename": "Static.js", "lineno": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\matter-js\\components", "code": {} }, "name": "isStatic", "longname": "Phaser.Physics.Matter.TileBody#isStatic", "kind": "function", "description": "Returns `true` if the body is static, otherwise `false` for a dynamic body.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the body is static, otherwise `false`." } ], "memberof": "Phaser.Physics.Matter.TileBody", "scope": "instance", "inherits": "Phaser.Physics.Matter.Components.Static#isStatic", "inherited": true, "___id": "T000002R053823", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Physics.Matter.World#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Physics.Matter.World", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R053824", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Physics.Matter.World#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Physics.Matter.World", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R053825", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Physics.Matter.World#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Physics.Matter.World", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R053826", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Physics.Matter.World#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Physics.Matter.World", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R053827", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Physics.Matter.World#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.World", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R053828", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Physics.Matter.World#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.World", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R053829", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Physics.Matter.World#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.World", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R053830", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Physics.Matter.World#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.World", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R053831", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Physics.Matter.World#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.World", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R053832", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Physics.Matter.World#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Physics.Matter.World", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R053833", "___s": true }, { "comment": "/**\r\n * A handy reference to the Plugin Manager that is responsible for this plugin.\r\n * Can be used as a route to gain access to game systems and events.\r\n *\r\n * @name Phaser.Plugins.BasePlugin#pluginManager\r\n * @type {Phaser.Plugins.PluginManager}\r\n * @protected\r\n * @since 3.8.0\r\n */", "meta": { "filename": "BasePlugin.js", "lineno": 27, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "name": "pluginManager", "longname": "Phaser.Plugins.ScenePlugin#pluginManager", "kind": "member", "description": "A handy reference to the Plugin Manager that is responsible for this plugin.\rCan be used as a route to gain access to game systems and events.", "type": { "names": [ "Phaser.Plugins.PluginManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Plugins.PluginManager" } }, "access": "protected", "since": "3.8.0", "memberof": "Phaser.Plugins.ScenePlugin", "scope": "instance", "inherits": "Phaser.Plugins.BasePlugin#pluginManager", "inherited": true, "___id": "T000002R053834", "___s": true }, { "comment": "/**\r\n * A reference to the Game instance this plugin is running under.\r\n *\r\n * @name Phaser.Plugins.BasePlugin#game\r\n * @type {Phaser.Game}\r\n * @protected\r\n * @since 3.8.0\r\n */", "meta": { "filename": "BasePlugin.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "name": "game", "longname": "Phaser.Plugins.ScenePlugin#game", "kind": "member", "description": "A reference to the Game instance this plugin is running under.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "access": "protected", "since": "3.8.0", "memberof": "Phaser.Plugins.ScenePlugin", "scope": "instance", "inherits": "Phaser.Plugins.BasePlugin#game", "inherited": true, "___id": "T000002R053835", "___s": true }, { "comment": "/**\r\n * The PluginManager calls this method on a Global Plugin when the plugin is first instantiated.\r\n * It will never be called again on this instance.\r\n * In here you can set-up whatever you need for this plugin to run.\r\n * If a plugin is set to automatically start then `BasePlugin.start` will be called immediately after this.\r\n * On a Scene Plugin, this method is never called. Use {@link Phaser.Plugins.ScenePlugin#boot} instead.\r\n *\r\n * @method Phaser.Plugins.BasePlugin#init\r\n * @since 3.8.0\r\n *\r\n * @param {?any} [data] - A value specified by the user, if any, from the `data` property of the plugin's configuration object (if started at game boot) or passed in the PluginManager's `install` method (if started manually).\r\n */", "meta": { "filename": "BasePlugin.js", "lineno": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "name": "init", "longname": "Phaser.Plugins.ScenePlugin#init", "kind": "function", "description": "The PluginManager calls this method on a Global Plugin when the plugin is first instantiated.\rIt will never be called again on this instance.\rIn here you can set-up whatever you need for this plugin to run.\rIf a plugin is set to automatically start then `BasePlugin.start` will be called immediately after this.\rOn a Scene Plugin, this method is never called. Use {@link Phaser.Plugins.ScenePlugin#boot} instead.", "since": "3.8.0", "memberof": "Phaser.Plugins.ScenePlugin", "scope": "instance", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "nullable": true } }, "optional": true, "nullable": true, "description": "A value specified by the user, if any, from the `data` property of the plugin's configuration object (if started at game boot) or passed in the PluginManager's `install` method (if started manually).", "name": "data" } ], "inherits": "Phaser.Plugins.BasePlugin#init", "inherited": true, "___id": "T000002R053836", "___s": true }, { "comment": "/**\r\n * The PluginManager calls this method on a Global Plugin when the plugin is started.\r\n * If a plugin is stopped, and then started again, this will get called again.\r\n * Typically called immediately after `BasePlugin.init`.\r\n * On a Scene Plugin, this method is never called.\r\n *\r\n * @method Phaser.Plugins.BasePlugin#start\r\n * @since 3.8.0\r\n */", "meta": { "filename": "BasePlugin.js", "lineno": 65, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "name": "start", "longname": "Phaser.Plugins.ScenePlugin#start", "kind": "function", "description": "The PluginManager calls this method on a Global Plugin when the plugin is started.\rIf a plugin is stopped, and then started again, this will get called again.\rTypically called immediately after `BasePlugin.init`.\rOn a Scene Plugin, this method is never called.", "since": "3.8.0", "memberof": "Phaser.Plugins.ScenePlugin", "scope": "instance", "inherits": "Phaser.Plugins.BasePlugin#start", "inherited": true, "___id": "T000002R053837", "___s": true }, { "comment": "/**\r\n * The PluginManager calls this method on a Global Plugin when the plugin is stopped.\r\n * The game code has requested that your plugin stop doing whatever it does.\r\n * It is now considered as 'inactive' by the PluginManager.\r\n * Handle that process here (i.e. stop listening for events, etc)\r\n * If the plugin is started again then `BasePlugin.start` will be called again.\r\n * On a Scene Plugin, this method is never called.\r\n *\r\n * @method Phaser.Plugins.BasePlugin#stop\r\n * @since 3.8.0\r\n */", "meta": { "filename": "BasePlugin.js", "lineno": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\plugins", "code": {} }, "name": "stop", "longname": "Phaser.Plugins.ScenePlugin#stop", "kind": "function", "description": "The PluginManager calls this method on a Global Plugin when the plugin is stopped.\rThe game code has requested that your plugin stop doing whatever it does.\rIt is now considered as 'inactive' by the PluginManager.\rHandle that process here (i.e. stop listening for events, etc)\rIf the plugin is started again then `BasePlugin.start` will be called again.\rOn a Scene Plugin, this method is never called.", "since": "3.8.0", "memberof": "Phaser.Plugins.ScenePlugin", "scope": "instance", "inherits": "Phaser.Plugins.BasePlugin#stop", "inherited": true, "___id": "T000002R053838", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R053839", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.Canvas.CanvasRenderer", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R053840", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R053841", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R053842", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R053843", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R053844", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R053845", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R053846", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R053847", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R053848", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.Canvas.CanvasRenderer#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.Canvas.CanvasRenderer", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R053849", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R053850", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.WebGLPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R053851", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R053852", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R053853", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R053854", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R053855", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R053856", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R053857", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R053858", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R053859", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.WebGLPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLPipeline", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R053860", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R053861", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R053862", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R053863", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R053864", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R053865", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R053866", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R053867", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R053868", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R053869", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R053870", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R053871", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R053872", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R053873", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R053874", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R053875", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R053876", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R053877", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R053878", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R053879", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R053880", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R053881", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R053882", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R053883", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R053884", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R053885", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R053886", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R053887", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R053888", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R053889", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R053890", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R053891", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R053892", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R053893", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R053894", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R053895", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R053896", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R053897", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R053898", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "___id": "T000002R053899", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "___id": "T000002R053900", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "___id": "T000002R053901", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "___id": "T000002R053902", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "___id": "T000002R053903", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "___id": "T000002R053904", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "___id": "T000002R053905", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "___id": "T000002R053906", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "___id": "T000002R053907", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R053908", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "___id": "T000002R053909", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "___id": "T000002R053910", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "___id": "T000002R053911", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R053912", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "___id": "T000002R053913", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "___id": "T000002R053914", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "___id": "T000002R053915", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "___id": "T000002R053916", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "___id": "T000002R053917", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "___id": "T000002R053918", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R053919", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "___id": "T000002R053920", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "___id": "T000002R053921", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "___id": "T000002R053922", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R053923", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "___id": "T000002R053924", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "___id": "T000002R053925", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "___id": "T000002R053926", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R053927", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "___id": "T000002R053928", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R053929", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "___id": "T000002R053930", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "___id": "T000002R053931", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "___id": "T000002R053932", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "___id": "T000002R053933", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "___id": "T000002R053934", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "___id": "T000002R053935", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "___id": "T000002R053936", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "___id": "T000002R053937", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "___id": "T000002R053938", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "___id": "T000002R053939", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "___id": "T000002R053940", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "___id": "T000002R053941", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "___id": "T000002R053942", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "___id": "T000002R053943", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "___id": "T000002R053944", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "___id": "T000002R053945", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "___id": "T000002R053946", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "___id": "T000002R053947", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "___id": "T000002R053948", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "___id": "T000002R053949", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "___id": "T000002R053950", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "___id": "T000002R053951", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "___id": "T000002R053952", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "___id": "T000002R053953", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "___id": "T000002R053954", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "___id": "T000002R053955", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "___id": "T000002R053956", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "___id": "T000002R053957", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "___id": "T000002R053958", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "___id": "T000002R053959", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#destroy\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#DESTROY\r\n * @since 3.0.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2551, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:DESTROY" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#destroy", "inherited": true, "___id": "T000002R053960", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R053961", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R053962", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R053963", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R053964", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R053965", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R053966", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R053967", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R053968", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R053969", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R053970", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R053971", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R053972", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R053973", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R053974", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R053975", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R053976", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R053977", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R053978", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R053979", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R053980", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R053981", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R053982", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R053983", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R053984", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R053985", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R053986", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R053987", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R053988", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R053989", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R053990", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R053991", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R053992", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R053993", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R053994", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R053995", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R053996", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R053997", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R053998", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R053999", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R054000", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R054001", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R054002", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R054003", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R054004", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R054005", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R054006", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R054007", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R054008", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R054009", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "___id": "T000002R054010", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "___id": "T000002R054011", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "___id": "T000002R054012", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "___id": "T000002R054013", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "___id": "T000002R054014", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "___id": "T000002R054015", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "___id": "T000002R054016", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "___id": "T000002R054017", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "___id": "T000002R054018", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R054019", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "___id": "T000002R054020", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "___id": "T000002R054021", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "___id": "T000002R054022", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R054023", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "___id": "T000002R054024", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "___id": "T000002R054025", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "___id": "T000002R054026", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "___id": "T000002R054027", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "___id": "T000002R054028", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "___id": "T000002R054029", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R054030", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "___id": "T000002R054031", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "___id": "T000002R054032", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "___id": "T000002R054033", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R054034", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "___id": "T000002R054035", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "___id": "T000002R054036", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "___id": "T000002R054037", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R054038", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "___id": "T000002R054039", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R054040", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "___id": "T000002R054041", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "___id": "T000002R054042", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "___id": "T000002R054043", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "___id": "T000002R054044", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "___id": "T000002R054045", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "___id": "T000002R054046", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "___id": "T000002R054047", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "___id": "T000002R054048", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "___id": "T000002R054049", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "___id": "T000002R054050", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "___id": "T000002R054051", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "___id": "T000002R054052", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "___id": "T000002R054053", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "___id": "T000002R054054", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "___id": "T000002R054055", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "___id": "T000002R054056", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "___id": "T000002R054057", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "___id": "T000002R054058", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "___id": "T000002R054059", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "___id": "T000002R054060", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "___id": "T000002R054061", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "___id": "T000002R054062", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "___id": "T000002R054063", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "___id": "T000002R054064", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "___id": "T000002R054065", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "___id": "T000002R054066", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "___id": "T000002R054067", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "___id": "T000002R054068", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "___id": "T000002R054069", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "___id": "T000002R054070", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R054071", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R054072", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R054073", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R054074", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R054075", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R054076", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R054077", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R054078", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R054079", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R054080", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R054081", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to a Game Object or Camera,\r\n * this property contains a reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject\r\n * @type {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "gameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#gameObject", "kind": "member", "description": "If this Post Pipeline belongs to a Game Object or Camera,\rthis property contains a reference to it.", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject", "inherited": true, "___id": "T000002R054082", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to an FX Controller, this is a\r\n * reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller\r\n * @type {Phaser.FX.Controller}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "controller", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#controller", "kind": "member", "description": "If this Post Pipeline belongs to an FX Controller, this is a\rreference to it.", "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller", "inherited": true, "___id": "T000002R054083", "___s": true }, { "comment": "/**\r\n * A Color Matrix instance belonging to this pipeline.\r\n *\r\n * Used during calls to the `drawFrame` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "colorMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#colorMatrix", "kind": "member", "description": "A Color Matrix instance belonging to this pipeline.\r\rUsed during calls to the `drawFrame` method.", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix", "inherited": true, "___id": "T000002R054084", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#fullFrame1", "kind": "member", "description": "A reference to the Full Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1", "inherited": true, "___id": "T000002R054085", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#fullFrame2", "kind": "member", "description": "A reference to the Full Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2", "inherited": true, "___id": "T000002R054086", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#halfFrame1", "kind": "member", "description": "A reference to the Half Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1", "inherited": true, "___id": "T000002R054087", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#halfFrame2", "kind": "member", "description": "A reference to the Half Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2", "inherited": true, "___id": "T000002R054088", "___s": true }, { "comment": "/**\r\n * Returns the FX Controller for this Post FX Pipeline.\r\n *\r\n * This is called internally and not typically required outside.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Controller} [controller] - An FX Controller, or undefined.\r\n *\r\n * @return {Phaser.FX.Controller|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} The FX Controller responsible, or this Pipeline.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "getController", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#getController", "kind": "function", "description": "Returns the FX Controller for this Post FX Pipeline.\r\rThis is called internally and not typically required outside.", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.FX.Controller", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.FX.Controller" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The FX Controller responsible, or this Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "optional": true, "description": "An FX Controller, or undefined.", "name": "controller" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController", "inherited": true, "___id": "T000002R054089", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * This method does _not_ bind a shader. It uses whatever shader\r\n * is currently bound in this pipeline. It also does _not_ clear\r\n * the frame buffers after use. You should take care of both of\r\n * these things if you call this method directly.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copySprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#copySprite", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThis method does _not_ bind a shader. It uses whatever shader\ris currently bound in this pipeline. It also does _not_ clear\rthe frame buffers after use. You should take care of both of\rthese things if you call this method directly.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite", "inherited": true, "___id": "T000002R054090", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#copyFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame", "inherited": true, "___id": "T000002R054091", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyToGame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#copyToGame", "kind": "function", "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame", "inherited": true, "___id": "T000002R054092", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using this pipelines\r\n * Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "drawFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#drawFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target, using this pipelines\rColor Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame", "inherited": true, "___id": "T000002R054093", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFrames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#blendFrames", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames", "inherited": true, "___id": "T000002R054094", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFramesAdditive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#blendFramesAdditive", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive", "inherited": true, "___id": "T000002R054095", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "clearFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#clearFrame", "kind": "function", "description": "Clears the given Render Target.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame", "inherited": true, "___id": "T000002R054096", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blitFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#blitFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame", "inherited": true, "___id": "T000002R054097", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrameRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#copyFrameRect", "kind": "function", "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect", "inherited": true, "___id": "T000002R054098", "___s": true }, { "comment": "/**\r\n * Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * If no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\r\n * and use that instead, which should be done when you need to draw the final results of\r\n * this pipeline to the game canvas.\r\n *\r\n * You can optionally set the shader to be used for the draw here, if this is a multi-shader\r\n * pipeline. By default `currentShader` will be used. If you need to set a shader but not\r\n * a target, just pass `null` as the `target` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to draw to. If not set, it will pop the fbo from the stack.\r\n * @param {boolean} [clear=true] - Clear the target before copying? Only used if `target` parameter is set.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to use during the draw.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "bindAndDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#bindAndDraw", "kind": "function", "description": "Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\rIf no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\rand use that instead, which should be done when you need to draw the final results of\rthis pipeline to the game canvas.\r\rYou can optionally set the shader to be used for the draw here, if this is a multi-shader\rpipeline. By default `currentShader` will be used. If you need to set a shader but not\ra target, just pass `null` as the `target` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to draw to. If not set, it will pop the fbo from the stack.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying? Only used if `target` parameter is set.", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use during the draw.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw", "inherited": true, "___id": "T000002R054099", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 571, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy", "inherited": true, "___id": "T000002R054100", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R054101", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R054102", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R054103", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R054104", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R054105", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R054106", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R054107", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R054108", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R054109", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R054110", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R054111", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R054112", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R054113", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R054114", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R054115", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R054116", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R054117", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R054118", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R054119", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R054120", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R054121", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R054122", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R054123", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R054124", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R054125", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R054126", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R054127", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R054128", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R054129", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R054130", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R054131", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R054132", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R054133", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R054134", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R054135", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R054136", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R054137", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R054138", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054139", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R054140", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R054141", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R054142", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054143", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054144", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054145", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R054146", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R054147", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R054148", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054149", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054150", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R054151", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R054152", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R054153", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R054154", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R054155", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054156", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054157", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R054158", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R054159", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054160", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R054161", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054162", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R054163", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054164", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054165", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054166", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R054167", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R054168", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R054169", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054170", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054171", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R054172", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R054173", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R054174", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R054175", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R054176", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R054177", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R054178", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054179", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054180", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054181", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054182", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054183", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054184", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054185", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054186", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054187", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054188", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054189", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054190", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054191", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054192", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054193", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054194", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054195", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054196", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054197", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054198", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054199", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R054200", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R054201", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R054202", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R054203", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R054204", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R054205", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R054206", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R054207", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R054208", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R054209", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R054210", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to a Game Object or Camera,\r\n * this property contains a reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject\r\n * @type {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "gameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#gameObject", "kind": "member", "description": "If this Post Pipeline belongs to a Game Object or Camera,\rthis property contains a reference to it.", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject", "inherited": true, "___id": "T000002R054211", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to an FX Controller, this is a\r\n * reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller\r\n * @type {Phaser.FX.Controller}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "controller", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#controller", "kind": "member", "description": "If this Post Pipeline belongs to an FX Controller, this is a\rreference to it.", "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller", "inherited": true, "___id": "T000002R054212", "___s": true }, { "comment": "/**\r\n * A Color Matrix instance belonging to this pipeline.\r\n *\r\n * Used during calls to the `drawFrame` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "colorMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#colorMatrix", "kind": "member", "description": "A Color Matrix instance belonging to this pipeline.\r\rUsed during calls to the `drawFrame` method.", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix", "inherited": true, "___id": "T000002R054213", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#fullFrame1", "kind": "member", "description": "A reference to the Full Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1", "inherited": true, "___id": "T000002R054214", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#fullFrame2", "kind": "member", "description": "A reference to the Full Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2", "inherited": true, "___id": "T000002R054215", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#halfFrame1", "kind": "member", "description": "A reference to the Half Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1", "inherited": true, "___id": "T000002R054216", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#halfFrame2", "kind": "member", "description": "A reference to the Half Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2", "inherited": true, "___id": "T000002R054217", "___s": true }, { "comment": "/**\r\n * Returns the FX Controller for this Post FX Pipeline.\r\n *\r\n * This is called internally and not typically required outside.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Controller} [controller] - An FX Controller, or undefined.\r\n *\r\n * @return {Phaser.FX.Controller|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} The FX Controller responsible, or this Pipeline.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "getController", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#getController", "kind": "function", "description": "Returns the FX Controller for this Post FX Pipeline.\r\rThis is called internally and not typically required outside.", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.FX.Controller", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.FX.Controller" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The FX Controller responsible, or this Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "optional": true, "description": "An FX Controller, or undefined.", "name": "controller" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController", "inherited": true, "___id": "T000002R054218", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * This method does _not_ bind a shader. It uses whatever shader\r\n * is currently bound in this pipeline. It also does _not_ clear\r\n * the frame buffers after use. You should take care of both of\r\n * these things if you call this method directly.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copySprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#copySprite", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThis method does _not_ bind a shader. It uses whatever shader\ris currently bound in this pipeline. It also does _not_ clear\rthe frame buffers after use. You should take care of both of\rthese things if you call this method directly.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite", "inherited": true, "___id": "T000002R054219", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#copyFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame", "inherited": true, "___id": "T000002R054220", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyToGame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#copyToGame", "kind": "function", "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame", "inherited": true, "___id": "T000002R054221", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using this pipelines\r\n * Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "drawFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#drawFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target, using this pipelines\rColor Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame", "inherited": true, "___id": "T000002R054222", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFrames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#blendFrames", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames", "inherited": true, "___id": "T000002R054223", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFramesAdditive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#blendFramesAdditive", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive", "inherited": true, "___id": "T000002R054224", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "clearFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#clearFrame", "kind": "function", "description": "Clears the given Render Target.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame", "inherited": true, "___id": "T000002R054225", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blitFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#blitFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame", "inherited": true, "___id": "T000002R054226", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrameRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#copyFrameRect", "kind": "function", "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect", "inherited": true, "___id": "T000002R054227", "___s": true }, { "comment": "/**\r\n * Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * If no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\r\n * and use that instead, which should be done when you need to draw the final results of\r\n * this pipeline to the game canvas.\r\n *\r\n * You can optionally set the shader to be used for the draw here, if this is a multi-shader\r\n * pipeline. By default `currentShader` will be used. If you need to set a shader but not\r\n * a target, just pass `null` as the `target` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to draw to. If not set, it will pop the fbo from the stack.\r\n * @param {boolean} [clear=true] - Clear the target before copying? Only used if `target` parameter is set.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to use during the draw.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "bindAndDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#bindAndDraw", "kind": "function", "description": "Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\rIf no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\rand use that instead, which should be done when you need to draw the final results of\rthis pipeline to the game canvas.\r\rYou can optionally set the shader to be used for the draw here, if this is a multi-shader\rpipeline. By default `currentShader` will be used. If you need to set a shader but not\ra target, just pass `null` as the `target` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to draw to. If not set, it will pop the fbo from the stack.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying? Only used if `target` parameter is set.", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use during the draw.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw", "inherited": true, "___id": "T000002R054228", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 571, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy", "inherited": true, "___id": "T000002R054229", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R054230", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R054231", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R054232", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R054233", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R054234", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R054235", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R054236", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R054237", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R054238", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R054239", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R054240", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R054241", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R054242", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R054243", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R054244", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R054245", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R054246", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R054247", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R054248", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R054249", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R054250", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R054251", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R054252", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R054253", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R054254", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R054255", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R054256", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R054257", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R054258", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R054259", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R054260", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R054261", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R054262", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R054263", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R054264", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R054265", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R054266", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R054267", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054268", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R054269", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R054270", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R054271", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054272", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054273", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054274", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R054275", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R054276", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R054277", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054278", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054279", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R054280", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R054281", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R054282", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R054283", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R054284", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054285", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054286", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R054287", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R054288", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054289", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R054290", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054291", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R054292", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054293", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054294", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054295", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R054296", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R054297", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R054298", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054299", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054300", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R054301", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R054302", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R054303", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R054304", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R054305", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R054306", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R054307", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054308", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054309", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054310", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054311", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054312", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054313", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054314", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054315", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054316", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054317", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054318", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054319", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054320", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054321", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054322", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054323", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054324", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054325", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054326", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054327", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054328", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R054329", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R054330", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R054331", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R054332", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R054333", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R054334", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R054335", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R054336", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R054337", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R054338", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R054339", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to a Game Object or Camera,\r\n * this property contains a reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject\r\n * @type {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "gameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#gameObject", "kind": "member", "description": "If this Post Pipeline belongs to a Game Object or Camera,\rthis property contains a reference to it.", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject", "inherited": true, "___id": "T000002R054340", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to an FX Controller, this is a\r\n * reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller\r\n * @type {Phaser.FX.Controller}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "controller", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#controller", "kind": "member", "description": "If this Post Pipeline belongs to an FX Controller, this is a\rreference to it.", "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller", "inherited": true, "___id": "T000002R054341", "___s": true }, { "comment": "/**\r\n * A Color Matrix instance belonging to this pipeline.\r\n *\r\n * Used during calls to the `drawFrame` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "colorMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#colorMatrix", "kind": "member", "description": "A Color Matrix instance belonging to this pipeline.\r\rUsed during calls to the `drawFrame` method.", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix", "inherited": true, "___id": "T000002R054342", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#fullFrame1", "kind": "member", "description": "A reference to the Full Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1", "inherited": true, "___id": "T000002R054343", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#fullFrame2", "kind": "member", "description": "A reference to the Full Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2", "inherited": true, "___id": "T000002R054344", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#halfFrame1", "kind": "member", "description": "A reference to the Half Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1", "inherited": true, "___id": "T000002R054345", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#halfFrame2", "kind": "member", "description": "A reference to the Half Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2", "inherited": true, "___id": "T000002R054346", "___s": true }, { "comment": "/**\r\n * Returns the FX Controller for this Post FX Pipeline.\r\n *\r\n * This is called internally and not typically required outside.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Controller} [controller] - An FX Controller, or undefined.\r\n *\r\n * @return {Phaser.FX.Controller|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} The FX Controller responsible, or this Pipeline.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "getController", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#getController", "kind": "function", "description": "Returns the FX Controller for this Post FX Pipeline.\r\rThis is called internally and not typically required outside.", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.FX.Controller", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.FX.Controller" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The FX Controller responsible, or this Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "optional": true, "description": "An FX Controller, or undefined.", "name": "controller" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController", "inherited": true, "___id": "T000002R054347", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * This method does _not_ bind a shader. It uses whatever shader\r\n * is currently bound in this pipeline. It also does _not_ clear\r\n * the frame buffers after use. You should take care of both of\r\n * these things if you call this method directly.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copySprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#copySprite", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThis method does _not_ bind a shader. It uses whatever shader\ris currently bound in this pipeline. It also does _not_ clear\rthe frame buffers after use. You should take care of both of\rthese things if you call this method directly.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite", "inherited": true, "___id": "T000002R054348", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#copyFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame", "inherited": true, "___id": "T000002R054349", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyToGame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#copyToGame", "kind": "function", "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame", "inherited": true, "___id": "T000002R054350", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using this pipelines\r\n * Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "drawFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#drawFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target, using this pipelines\rColor Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame", "inherited": true, "___id": "T000002R054351", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFrames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#blendFrames", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames", "inherited": true, "___id": "T000002R054352", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFramesAdditive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#blendFramesAdditive", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive", "inherited": true, "___id": "T000002R054353", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "clearFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#clearFrame", "kind": "function", "description": "Clears the given Render Target.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame", "inherited": true, "___id": "T000002R054354", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blitFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#blitFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame", "inherited": true, "___id": "T000002R054355", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrameRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#copyFrameRect", "kind": "function", "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect", "inherited": true, "___id": "T000002R054356", "___s": true }, { "comment": "/**\r\n * Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * If no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\r\n * and use that instead, which should be done when you need to draw the final results of\r\n * this pipeline to the game canvas.\r\n *\r\n * You can optionally set the shader to be used for the draw here, if this is a multi-shader\r\n * pipeline. By default `currentShader` will be used. If you need to set a shader but not\r\n * a target, just pass `null` as the `target` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to draw to. If not set, it will pop the fbo from the stack.\r\n * @param {boolean} [clear=true] - Clear the target before copying? Only used if `target` parameter is set.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to use during the draw.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "bindAndDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#bindAndDraw", "kind": "function", "description": "Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\rIf no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\rand use that instead, which should be done when you need to draw the final results of\rthis pipeline to the game canvas.\r\rYou can optionally set the shader to be used for the draw here, if this is a multi-shader\rpipeline. By default `currentShader` will be used. If you need to set a shader but not\ra target, just pass `null` as the `target` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to draw to. If not set, it will pop the fbo from the stack.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying? Only used if `target` parameter is set.", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use during the draw.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw", "inherited": true, "___id": "T000002R054357", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 571, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy", "inherited": true, "___id": "T000002R054358", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R054359", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R054360", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R054361", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R054362", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R054363", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R054364", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R054365", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R054366", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R054367", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R054368", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R054369", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R054370", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R054371", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R054372", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R054373", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R054374", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R054375", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R054376", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R054377", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R054378", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R054379", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R054380", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R054381", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R054382", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R054383", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R054384", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R054385", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R054386", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R054387", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R054388", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R054389", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R054390", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R054391", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R054392", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R054393", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R054394", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R054395", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R054396", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054397", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R054398", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R054399", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R054400", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054401", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054402", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054403", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R054404", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R054405", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R054406", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054407", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054408", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R054409", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R054410", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R054411", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R054412", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R054413", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054414", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054415", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R054416", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R054417", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054418", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R054419", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054420", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R054421", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054422", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054423", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054424", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R054425", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R054426", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R054427", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054428", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054429", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R054430", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R054431", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R054432", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R054433", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R054434", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R054435", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R054436", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054437", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054438", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054439", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054440", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054441", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054442", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054443", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054444", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054445", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054446", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054447", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054448", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054449", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054450", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054451", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054452", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054453", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054454", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054455", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054456", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054457", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R054458", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R054459", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R054460", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R054461", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R054462", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R054463", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R054464", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R054465", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R054466", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R054467", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R054468", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to a Game Object or Camera,\r\n * this property contains a reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject\r\n * @type {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "gameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#gameObject", "kind": "member", "description": "If this Post Pipeline belongs to a Game Object or Camera,\rthis property contains a reference to it.", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject", "inherited": true, "___id": "T000002R054469", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to an FX Controller, this is a\r\n * reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller\r\n * @type {Phaser.FX.Controller}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "controller", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#controller", "kind": "member", "description": "If this Post Pipeline belongs to an FX Controller, this is a\rreference to it.", "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller", "inherited": true, "___id": "T000002R054470", "___s": true }, { "comment": "/**\r\n * A Color Matrix instance belonging to this pipeline.\r\n *\r\n * Used during calls to the `drawFrame` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "colorMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#colorMatrix", "kind": "member", "description": "A Color Matrix instance belonging to this pipeline.\r\rUsed during calls to the `drawFrame` method.", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix", "inherited": true, "___id": "T000002R054471", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#fullFrame1", "kind": "member", "description": "A reference to the Full Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1", "inherited": true, "___id": "T000002R054472", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#fullFrame2", "kind": "member", "description": "A reference to the Full Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2", "inherited": true, "___id": "T000002R054473", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#halfFrame1", "kind": "member", "description": "A reference to the Half Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1", "inherited": true, "___id": "T000002R054474", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#halfFrame2", "kind": "member", "description": "A reference to the Half Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2", "inherited": true, "___id": "T000002R054475", "___s": true }, { "comment": "/**\r\n * Returns the FX Controller for this Post FX Pipeline.\r\n *\r\n * This is called internally and not typically required outside.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Controller} [controller] - An FX Controller, or undefined.\r\n *\r\n * @return {Phaser.FX.Controller|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} The FX Controller responsible, or this Pipeline.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "getController", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#getController", "kind": "function", "description": "Returns the FX Controller for this Post FX Pipeline.\r\rThis is called internally and not typically required outside.", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.FX.Controller", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.FX.Controller" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The FX Controller responsible, or this Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "optional": true, "description": "An FX Controller, or undefined.", "name": "controller" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController", "inherited": true, "___id": "T000002R054476", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * This method does _not_ bind a shader. It uses whatever shader\r\n * is currently bound in this pipeline. It also does _not_ clear\r\n * the frame buffers after use. You should take care of both of\r\n * these things if you call this method directly.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copySprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#copySprite", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThis method does _not_ bind a shader. It uses whatever shader\ris currently bound in this pipeline. It also does _not_ clear\rthe frame buffers after use. You should take care of both of\rthese things if you call this method directly.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite", "inherited": true, "___id": "T000002R054477", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#copyFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame", "inherited": true, "___id": "T000002R054478", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyToGame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#copyToGame", "kind": "function", "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame", "inherited": true, "___id": "T000002R054479", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using this pipelines\r\n * Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "drawFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#drawFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target, using this pipelines\rColor Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame", "inherited": true, "___id": "T000002R054480", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFrames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#blendFrames", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames", "inherited": true, "___id": "T000002R054481", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFramesAdditive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#blendFramesAdditive", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive", "inherited": true, "___id": "T000002R054482", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "clearFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#clearFrame", "kind": "function", "description": "Clears the given Render Target.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame", "inherited": true, "___id": "T000002R054483", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blitFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#blitFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame", "inherited": true, "___id": "T000002R054484", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrameRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#copyFrameRect", "kind": "function", "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect", "inherited": true, "___id": "T000002R054485", "___s": true }, { "comment": "/**\r\n * Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * If no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\r\n * and use that instead, which should be done when you need to draw the final results of\r\n * this pipeline to the game canvas.\r\n *\r\n * You can optionally set the shader to be used for the draw here, if this is a multi-shader\r\n * pipeline. By default `currentShader` will be used. If you need to set a shader but not\r\n * a target, just pass `null` as the `target` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to draw to. If not set, it will pop the fbo from the stack.\r\n * @param {boolean} [clear=true] - Clear the target before copying? Only used if `target` parameter is set.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to use during the draw.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "bindAndDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#bindAndDraw", "kind": "function", "description": "Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\rIf no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\rand use that instead, which should be done when you need to draw the final results of\rthis pipeline to the game canvas.\r\rYou can optionally set the shader to be used for the draw here, if this is a multi-shader\rpipeline. By default `currentShader` will be used. If you need to set a shader but not\ra target, just pass `null` as the `target` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to draw to. If not set, it will pop the fbo from the stack.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying? Only used if `target` parameter is set.", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use during the draw.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw", "inherited": true, "___id": "T000002R054486", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 571, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy", "inherited": true, "___id": "T000002R054487", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R054488", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R054489", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R054490", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R054491", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R054492", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R054493", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R054494", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R054495", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R054496", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R054497", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R054498", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R054499", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R054500", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R054501", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R054502", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R054503", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R054504", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R054505", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R054506", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R054507", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R054508", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R054509", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R054510", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R054511", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R054512", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R054513", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R054514", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R054515", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R054516", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R054517", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R054518", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R054519", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R054520", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R054521", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R054522", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R054523", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R054524", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R054525", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054526", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R054527", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R054528", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R054529", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054530", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054531", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054532", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R054533", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R054534", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R054535", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054536", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054537", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R054538", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R054539", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R054540", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R054541", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R054542", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054543", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054544", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R054545", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R054546", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054547", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R054548", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054549", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R054550", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054551", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054552", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054553", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R054554", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R054555", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R054556", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054557", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054558", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R054559", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R054560", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R054561", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R054562", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R054563", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R054564", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R054565", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054566", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054567", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054568", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054569", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054570", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054571", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054572", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054573", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054574", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054575", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054576", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054577", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054578", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054579", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054580", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054581", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054582", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054583", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054584", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054585", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054586", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R054587", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R054588", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R054589", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R054590", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R054591", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R054592", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R054593", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R054594", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R054595", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R054596", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R054597", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to a Game Object or Camera,\r\n * this property contains a reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject\r\n * @type {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "gameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#gameObject", "kind": "member", "description": "If this Post Pipeline belongs to a Game Object or Camera,\rthis property contains a reference to it.", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject", "inherited": true, "___id": "T000002R054598", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to an FX Controller, this is a\r\n * reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller\r\n * @type {Phaser.FX.Controller}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "controller", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#controller", "kind": "member", "description": "If this Post Pipeline belongs to an FX Controller, this is a\rreference to it.", "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller", "inherited": true, "___id": "T000002R054599", "___s": true }, { "comment": "/**\r\n * A Color Matrix instance belonging to this pipeline.\r\n *\r\n * Used during calls to the `drawFrame` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "colorMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#colorMatrix", "kind": "member", "description": "A Color Matrix instance belonging to this pipeline.\r\rUsed during calls to the `drawFrame` method.", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix", "inherited": true, "___id": "T000002R054600", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#fullFrame1", "kind": "member", "description": "A reference to the Full Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1", "inherited": true, "___id": "T000002R054601", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#fullFrame2", "kind": "member", "description": "A reference to the Full Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2", "inherited": true, "___id": "T000002R054602", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#halfFrame1", "kind": "member", "description": "A reference to the Half Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1", "inherited": true, "___id": "T000002R054603", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#halfFrame2", "kind": "member", "description": "A reference to the Half Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2", "inherited": true, "___id": "T000002R054604", "___s": true }, { "comment": "/**\r\n * Returns the FX Controller for this Post FX Pipeline.\r\n *\r\n * This is called internally and not typically required outside.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Controller} [controller] - An FX Controller, or undefined.\r\n *\r\n * @return {Phaser.FX.Controller|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} The FX Controller responsible, or this Pipeline.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "getController", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#getController", "kind": "function", "description": "Returns the FX Controller for this Post FX Pipeline.\r\rThis is called internally and not typically required outside.", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.FX.Controller", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.FX.Controller" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The FX Controller responsible, or this Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "optional": true, "description": "An FX Controller, or undefined.", "name": "controller" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController", "inherited": true, "___id": "T000002R054605", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * This method does _not_ bind a shader. It uses whatever shader\r\n * is currently bound in this pipeline. It also does _not_ clear\r\n * the frame buffers after use. You should take care of both of\r\n * these things if you call this method directly.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copySprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#copySprite", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThis method does _not_ bind a shader. It uses whatever shader\ris currently bound in this pipeline. It also does _not_ clear\rthe frame buffers after use. You should take care of both of\rthese things if you call this method directly.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite", "inherited": true, "___id": "T000002R054606", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#copyFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame", "inherited": true, "___id": "T000002R054607", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyToGame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#copyToGame", "kind": "function", "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame", "inherited": true, "___id": "T000002R054608", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using this pipelines\r\n * Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "drawFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#drawFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target, using this pipelines\rColor Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame", "inherited": true, "___id": "T000002R054609", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFrames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#blendFrames", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames", "inherited": true, "___id": "T000002R054610", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFramesAdditive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#blendFramesAdditive", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive", "inherited": true, "___id": "T000002R054611", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "clearFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#clearFrame", "kind": "function", "description": "Clears the given Render Target.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame", "inherited": true, "___id": "T000002R054612", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blitFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#blitFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame", "inherited": true, "___id": "T000002R054613", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrameRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#copyFrameRect", "kind": "function", "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect", "inherited": true, "___id": "T000002R054614", "___s": true }, { "comment": "/**\r\n * Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * If no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\r\n * and use that instead, which should be done when you need to draw the final results of\r\n * this pipeline to the game canvas.\r\n *\r\n * You can optionally set the shader to be used for the draw here, if this is a multi-shader\r\n * pipeline. By default `currentShader` will be used. If you need to set a shader but not\r\n * a target, just pass `null` as the `target` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to draw to. If not set, it will pop the fbo from the stack.\r\n * @param {boolean} [clear=true] - Clear the target before copying? Only used if `target` parameter is set.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to use during the draw.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "bindAndDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#bindAndDraw", "kind": "function", "description": "Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\rIf no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\rand use that instead, which should be done when you need to draw the final results of\rthis pipeline to the game canvas.\r\rYou can optionally set the shader to be used for the draw here, if this is a multi-shader\rpipeline. By default `currentShader` will be used. If you need to set a shader but not\ra target, just pass `null` as the `target` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to draw to. If not set, it will pop the fbo from the stack.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying? Only used if `target` parameter is set.", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use during the draw.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw", "inherited": true, "___id": "T000002R054615", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 571, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy", "inherited": true, "___id": "T000002R054616", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R054617", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R054618", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R054619", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R054620", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R054621", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R054622", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R054623", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R054624", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R054625", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R054626", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R054627", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R054628", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R054629", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R054630", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R054631", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R054632", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R054633", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R054634", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R054635", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R054636", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R054637", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R054638", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R054639", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R054640", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R054641", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R054642", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R054643", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R054644", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R054645", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R054646", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R054647", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R054648", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R054649", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R054650", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R054651", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R054652", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R054653", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R054654", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054655", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R054656", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R054657", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R054658", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054659", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054660", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054661", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R054662", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R054663", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R054664", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054665", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054666", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R054667", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R054668", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R054669", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R054670", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R054671", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054672", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054673", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R054674", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R054675", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054676", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R054677", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054678", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R054679", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054680", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054681", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054682", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R054683", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R054684", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R054685", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054686", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054687", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R054688", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R054689", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R054690", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R054691", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R054692", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R054693", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R054694", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054695", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054696", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054697", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054698", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054699", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054700", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054701", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054702", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054703", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054704", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054705", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054706", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054707", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054708", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054709", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054710", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054711", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054712", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054713", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054714", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054715", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R054716", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R054717", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R054718", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R054719", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R054720", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R054721", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R054722", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R054723", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R054724", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R054725", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R054726", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to a Game Object or Camera,\r\n * this property contains a reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject\r\n * @type {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "gameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#gameObject", "kind": "member", "description": "If this Post Pipeline belongs to a Game Object or Camera,\rthis property contains a reference to it.", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject", "inherited": true, "___id": "T000002R054727", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to an FX Controller, this is a\r\n * reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller\r\n * @type {Phaser.FX.Controller}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "controller", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#controller", "kind": "member", "description": "If this Post Pipeline belongs to an FX Controller, this is a\rreference to it.", "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller", "inherited": true, "___id": "T000002R054728", "___s": true }, { "comment": "/**\r\n * A Color Matrix instance belonging to this pipeline.\r\n *\r\n * Used during calls to the `drawFrame` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "colorMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#colorMatrix", "kind": "member", "description": "A Color Matrix instance belonging to this pipeline.\r\rUsed during calls to the `drawFrame` method.", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix", "inherited": true, "___id": "T000002R054729", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#fullFrame1", "kind": "member", "description": "A reference to the Full Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1", "inherited": true, "___id": "T000002R054730", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#fullFrame2", "kind": "member", "description": "A reference to the Full Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2", "inherited": true, "___id": "T000002R054731", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#halfFrame1", "kind": "member", "description": "A reference to the Half Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1", "inherited": true, "___id": "T000002R054732", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#halfFrame2", "kind": "member", "description": "A reference to the Half Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2", "inherited": true, "___id": "T000002R054733", "___s": true }, { "comment": "/**\r\n * Returns the FX Controller for this Post FX Pipeline.\r\n *\r\n * This is called internally and not typically required outside.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Controller} [controller] - An FX Controller, or undefined.\r\n *\r\n * @return {Phaser.FX.Controller|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} The FX Controller responsible, or this Pipeline.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "getController", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#getController", "kind": "function", "description": "Returns the FX Controller for this Post FX Pipeline.\r\rThis is called internally and not typically required outside.", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.FX.Controller", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.FX.Controller" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The FX Controller responsible, or this Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "optional": true, "description": "An FX Controller, or undefined.", "name": "controller" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController", "inherited": true, "___id": "T000002R054734", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * This method does _not_ bind a shader. It uses whatever shader\r\n * is currently bound in this pipeline. It also does _not_ clear\r\n * the frame buffers after use. You should take care of both of\r\n * these things if you call this method directly.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copySprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#copySprite", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThis method does _not_ bind a shader. It uses whatever shader\ris currently bound in this pipeline. It also does _not_ clear\rthe frame buffers after use. You should take care of both of\rthese things if you call this method directly.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite", "inherited": true, "___id": "T000002R054735", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#copyFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame", "inherited": true, "___id": "T000002R054736", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyToGame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#copyToGame", "kind": "function", "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame", "inherited": true, "___id": "T000002R054737", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using this pipelines\r\n * Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "drawFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#drawFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target, using this pipelines\rColor Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame", "inherited": true, "___id": "T000002R054738", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFrames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#blendFrames", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames", "inherited": true, "___id": "T000002R054739", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFramesAdditive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#blendFramesAdditive", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive", "inherited": true, "___id": "T000002R054740", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "clearFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#clearFrame", "kind": "function", "description": "Clears the given Render Target.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame", "inherited": true, "___id": "T000002R054741", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blitFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#blitFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame", "inherited": true, "___id": "T000002R054742", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrameRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#copyFrameRect", "kind": "function", "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect", "inherited": true, "___id": "T000002R054743", "___s": true }, { "comment": "/**\r\n * Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * If no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\r\n * and use that instead, which should be done when you need to draw the final results of\r\n * this pipeline to the game canvas.\r\n *\r\n * You can optionally set the shader to be used for the draw here, if this is a multi-shader\r\n * pipeline. By default `currentShader` will be used. If you need to set a shader but not\r\n * a target, just pass `null` as the `target` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to draw to. If not set, it will pop the fbo from the stack.\r\n * @param {boolean} [clear=true] - Clear the target before copying? Only used if `target` parameter is set.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to use during the draw.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "bindAndDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#bindAndDraw", "kind": "function", "description": "Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\rIf no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\rand use that instead, which should be done when you need to draw the final results of\rthis pipeline to the game canvas.\r\rYou can optionally set the shader to be used for the draw here, if this is a multi-shader\rpipeline. By default `currentShader` will be used. If you need to set a shader but not\ra target, just pass `null` as the `target` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to draw to. If not set, it will pop the fbo from the stack.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying? Only used if `target` parameter is set.", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use during the draw.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw", "inherited": true, "___id": "T000002R054744", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 571, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy", "inherited": true, "___id": "T000002R054745", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R054746", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R054747", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R054748", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R054749", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R054750", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R054751", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R054752", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R054753", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R054754", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R054755", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R054756", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R054757", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R054758", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R054759", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R054760", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R054761", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R054762", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R054763", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R054764", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R054765", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R054766", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R054767", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R054768", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R054769", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R054770", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R054771", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R054772", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R054773", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R054774", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R054775", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R054776", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R054777", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R054778", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R054779", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R054780", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R054781", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R054782", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R054783", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054784", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R054785", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R054786", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R054787", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054788", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054789", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054790", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R054791", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R054792", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R054793", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054794", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054795", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R054796", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R054797", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R054798", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R054799", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R054800", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054801", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054802", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R054803", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R054804", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054805", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R054806", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054807", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R054808", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054809", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054810", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054811", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R054812", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R054813", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R054814", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054815", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054816", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R054817", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R054818", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R054819", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R054820", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R054821", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R054822", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R054823", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054824", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054825", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054826", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054827", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054828", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054829", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054830", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054831", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054832", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054833", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054834", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054835", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054836", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054837", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054838", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054839", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054840", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054841", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054842", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054843", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054844", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R054845", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R054846", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R054847", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R054848", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R054849", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R054850", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R054851", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R054852", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R054853", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R054854", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R054855", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to a Game Object or Camera,\r\n * this property contains a reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject\r\n * @type {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "gameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#gameObject", "kind": "member", "description": "If this Post Pipeline belongs to a Game Object or Camera,\rthis property contains a reference to it.", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject", "inherited": true, "___id": "T000002R054856", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to an FX Controller, this is a\r\n * reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller\r\n * @type {Phaser.FX.Controller}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "controller", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#controller", "kind": "member", "description": "If this Post Pipeline belongs to an FX Controller, this is a\rreference to it.", "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller", "inherited": true, "___id": "T000002R054857", "___s": true }, { "comment": "/**\r\n * A Color Matrix instance belonging to this pipeline.\r\n *\r\n * Used during calls to the `drawFrame` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "colorMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#colorMatrix", "kind": "member", "description": "A Color Matrix instance belonging to this pipeline.\r\rUsed during calls to the `drawFrame` method.", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix", "inherited": true, "___id": "T000002R054858", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#fullFrame1", "kind": "member", "description": "A reference to the Full Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1", "inherited": true, "___id": "T000002R054859", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#fullFrame2", "kind": "member", "description": "A reference to the Full Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2", "inherited": true, "___id": "T000002R054860", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#halfFrame1", "kind": "member", "description": "A reference to the Half Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1", "inherited": true, "___id": "T000002R054861", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#halfFrame2", "kind": "member", "description": "A reference to the Half Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2", "inherited": true, "___id": "T000002R054862", "___s": true }, { "comment": "/**\r\n * Returns the FX Controller for this Post FX Pipeline.\r\n *\r\n * This is called internally and not typically required outside.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Controller} [controller] - An FX Controller, or undefined.\r\n *\r\n * @return {Phaser.FX.Controller|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} The FX Controller responsible, or this Pipeline.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "getController", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#getController", "kind": "function", "description": "Returns the FX Controller for this Post FX Pipeline.\r\rThis is called internally and not typically required outside.", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.FX.Controller", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.FX.Controller" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The FX Controller responsible, or this Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "optional": true, "description": "An FX Controller, or undefined.", "name": "controller" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController", "inherited": true, "___id": "T000002R054863", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * This method does _not_ bind a shader. It uses whatever shader\r\n * is currently bound in this pipeline. It also does _not_ clear\r\n * the frame buffers after use. You should take care of both of\r\n * these things if you call this method directly.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copySprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#copySprite", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThis method does _not_ bind a shader. It uses whatever shader\ris currently bound in this pipeline. It also does _not_ clear\rthe frame buffers after use. You should take care of both of\rthese things if you call this method directly.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite", "inherited": true, "___id": "T000002R054864", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#copyFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame", "inherited": true, "___id": "T000002R054865", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyToGame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#copyToGame", "kind": "function", "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame", "inherited": true, "___id": "T000002R054866", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using this pipelines\r\n * Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "drawFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#drawFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target, using this pipelines\rColor Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame", "inherited": true, "___id": "T000002R054867", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFrames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#blendFrames", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames", "inherited": true, "___id": "T000002R054868", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFramesAdditive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#blendFramesAdditive", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive", "inherited": true, "___id": "T000002R054869", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "clearFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#clearFrame", "kind": "function", "description": "Clears the given Render Target.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame", "inherited": true, "___id": "T000002R054870", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blitFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#blitFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame", "inherited": true, "___id": "T000002R054871", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrameRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#copyFrameRect", "kind": "function", "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect", "inherited": true, "___id": "T000002R054872", "___s": true }, { "comment": "/**\r\n * Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * If no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\r\n * and use that instead, which should be done when you need to draw the final results of\r\n * this pipeline to the game canvas.\r\n *\r\n * You can optionally set the shader to be used for the draw here, if this is a multi-shader\r\n * pipeline. By default `currentShader` will be used. If you need to set a shader but not\r\n * a target, just pass `null` as the `target` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to draw to. If not set, it will pop the fbo from the stack.\r\n * @param {boolean} [clear=true] - Clear the target before copying? Only used if `target` parameter is set.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to use during the draw.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "bindAndDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#bindAndDraw", "kind": "function", "description": "Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\rIf no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\rand use that instead, which should be done when you need to draw the final results of\rthis pipeline to the game canvas.\r\rYou can optionally set the shader to be used for the draw here, if this is a multi-shader\rpipeline. By default `currentShader` will be used. If you need to set a shader but not\ra target, just pass `null` as the `target` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to draw to. If not set, it will pop the fbo from the stack.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying? Only used if `target` parameter is set.", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use during the draw.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw", "inherited": true, "___id": "T000002R054873", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 571, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy", "inherited": true, "___id": "T000002R054874", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R054875", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R054876", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R054877", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R054878", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R054879", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R054880", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R054881", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R054882", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R054883", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R054884", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R054885", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R054886", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R054887", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R054888", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R054889", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R054890", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R054891", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R054892", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R054893", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R054894", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R054895", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R054896", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R054897", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R054898", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R054899", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R054900", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R054901", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R054902", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R054903", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R054904", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R054905", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R054906", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R054907", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R054908", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R054909", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R054910", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R054911", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R054912", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054913", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R054914", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R054915", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R054916", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054917", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054918", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R054919", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R054920", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R054921", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R054922", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054923", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R054924", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R054925", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R054926", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R054927", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R054928", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R054929", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054930", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054931", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R054932", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R054933", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054934", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R054935", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054936", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R054937", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054938", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054939", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R054940", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R054941", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R054942", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R054943", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054944", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R054945", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R054946", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R054947", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R054948", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R054949", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R054950", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R054951", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R054952", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054953", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054954", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054955", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054956", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054957", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054958", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054959", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054960", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054961", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054962", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054963", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054964", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054965", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054966", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054967", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054968", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054969", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054970", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054971", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054972", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R054973", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R054974", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R054975", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R054976", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R054977", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R054978", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R054979", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R054980", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R054981", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R054982", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R054983", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R054984", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to a Game Object or Camera,\r\n * this property contains a reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject\r\n * @type {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "gameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#gameObject", "kind": "member", "description": "If this Post Pipeline belongs to a Game Object or Camera,\rthis property contains a reference to it.", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject", "inherited": true, "___id": "T000002R054985", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to an FX Controller, this is a\r\n * reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller\r\n * @type {Phaser.FX.Controller}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "controller", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#controller", "kind": "member", "description": "If this Post Pipeline belongs to an FX Controller, this is a\rreference to it.", "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller", "inherited": true, "___id": "T000002R054986", "___s": true }, { "comment": "/**\r\n * A Color Matrix instance belonging to this pipeline.\r\n *\r\n * Used during calls to the `drawFrame` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "colorMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#colorMatrix", "kind": "member", "description": "A Color Matrix instance belonging to this pipeline.\r\rUsed during calls to the `drawFrame` method.", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix", "inherited": true, "___id": "T000002R054987", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#fullFrame1", "kind": "member", "description": "A reference to the Full Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1", "inherited": true, "___id": "T000002R054988", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#fullFrame2", "kind": "member", "description": "A reference to the Full Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2", "inherited": true, "___id": "T000002R054989", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#halfFrame1", "kind": "member", "description": "A reference to the Half Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1", "inherited": true, "___id": "T000002R054990", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#halfFrame2", "kind": "member", "description": "A reference to the Half Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2", "inherited": true, "___id": "T000002R054991", "___s": true }, { "comment": "/**\r\n * Returns the FX Controller for this Post FX Pipeline.\r\n *\r\n * This is called internally and not typically required outside.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Controller} [controller] - An FX Controller, or undefined.\r\n *\r\n * @return {Phaser.FX.Controller|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} The FX Controller responsible, or this Pipeline.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "getController", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#getController", "kind": "function", "description": "Returns the FX Controller for this Post FX Pipeline.\r\rThis is called internally and not typically required outside.", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.FX.Controller", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.FX.Controller" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The FX Controller responsible, or this Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "optional": true, "description": "An FX Controller, or undefined.", "name": "controller" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController", "inherited": true, "___id": "T000002R054992", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * This method does _not_ bind a shader. It uses whatever shader\r\n * is currently bound in this pipeline. It also does _not_ clear\r\n * the frame buffers after use. You should take care of both of\r\n * these things if you call this method directly.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copySprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#copySprite", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThis method does _not_ bind a shader. It uses whatever shader\ris currently bound in this pipeline. It also does _not_ clear\rthe frame buffers after use. You should take care of both of\rthese things if you call this method directly.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite", "inherited": true, "___id": "T000002R054993", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#copyFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame", "inherited": true, "___id": "T000002R054994", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyToGame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#copyToGame", "kind": "function", "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame", "inherited": true, "___id": "T000002R054995", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using this pipelines\r\n * Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "drawFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#drawFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target, using this pipelines\rColor Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame", "inherited": true, "___id": "T000002R054996", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFrames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#blendFrames", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames", "inherited": true, "___id": "T000002R054997", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFramesAdditive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#blendFramesAdditive", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive", "inherited": true, "___id": "T000002R054998", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "clearFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#clearFrame", "kind": "function", "description": "Clears the given Render Target.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame", "inherited": true, "___id": "T000002R054999", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blitFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#blitFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame", "inherited": true, "___id": "T000002R055000", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrameRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#copyFrameRect", "kind": "function", "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect", "inherited": true, "___id": "T000002R055001", "___s": true }, { "comment": "/**\r\n * Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * If no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\r\n * and use that instead, which should be done when you need to draw the final results of\r\n * this pipeline to the game canvas.\r\n *\r\n * You can optionally set the shader to be used for the draw here, if this is a multi-shader\r\n * pipeline. By default `currentShader` will be used. If you need to set a shader but not\r\n * a target, just pass `null` as the `target` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to draw to. If not set, it will pop the fbo from the stack.\r\n * @param {boolean} [clear=true] - Clear the target before copying? Only used if `target` parameter is set.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to use during the draw.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "bindAndDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#bindAndDraw", "kind": "function", "description": "Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\rIf no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\rand use that instead, which should be done when you need to draw the final results of\rthis pipeline to the game canvas.\r\rYou can optionally set the shader to be used for the draw here, if this is a multi-shader\rpipeline. By default `currentShader` will be used. If you need to set a shader but not\ra target, just pass `null` as the `target` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to draw to. If not set, it will pop the fbo from the stack.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying? Only used if `target` parameter is set.", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use during the draw.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw", "inherited": true, "___id": "T000002R055002", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 571, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy", "inherited": true, "___id": "T000002R055003", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R055004", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R055005", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R055006", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R055007", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R055008", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R055009", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R055010", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R055011", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R055012", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R055013", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R055014", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R055015", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R055016", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R055017", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R055018", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R055019", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R055020", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R055021", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R055022", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R055023", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R055024", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R055025", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R055026", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R055027", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R055028", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R055029", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R055030", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R055031", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R055032", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R055033", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R055034", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R055035", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R055036", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R055037", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R055038", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R055039", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R055040", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R055041", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055042", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R055043", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R055044", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R055045", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055046", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055047", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055048", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R055049", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R055050", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R055051", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055052", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055053", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R055054", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R055055", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R055056", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R055057", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R055058", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055059", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055060", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R055061", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R055062", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055063", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R055064", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055065", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R055066", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055067", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055068", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055069", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R055070", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R055071", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R055072", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055073", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055074", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R055075", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R055076", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R055077", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R055078", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R055079", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R055080", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R055081", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055082", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055083", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055084", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055085", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055086", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055087", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055088", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055089", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055090", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055091", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055092", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055093", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055094", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055095", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055096", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055097", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055098", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055099", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055100", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055101", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055102", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R055103", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R055104", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R055105", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R055106", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R055107", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R055108", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R055109", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R055110", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R055111", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R055112", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R055113", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to a Game Object or Camera,\r\n * this property contains a reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject\r\n * @type {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "gameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#gameObject", "kind": "member", "description": "If this Post Pipeline belongs to a Game Object or Camera,\rthis property contains a reference to it.", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject", "inherited": true, "___id": "T000002R055114", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to an FX Controller, this is a\r\n * reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller\r\n * @type {Phaser.FX.Controller}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "controller", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#controller", "kind": "member", "description": "If this Post Pipeline belongs to an FX Controller, this is a\rreference to it.", "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller", "inherited": true, "___id": "T000002R055115", "___s": true }, { "comment": "/**\r\n * A Color Matrix instance belonging to this pipeline.\r\n *\r\n * Used during calls to the `drawFrame` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "colorMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#colorMatrix", "kind": "member", "description": "A Color Matrix instance belonging to this pipeline.\r\rUsed during calls to the `drawFrame` method.", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix", "inherited": true, "___id": "T000002R055116", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#fullFrame1", "kind": "member", "description": "A reference to the Full Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1", "inherited": true, "___id": "T000002R055117", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#fullFrame2", "kind": "member", "description": "A reference to the Full Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2", "inherited": true, "___id": "T000002R055118", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#halfFrame1", "kind": "member", "description": "A reference to the Half Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1", "inherited": true, "___id": "T000002R055119", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#halfFrame2", "kind": "member", "description": "A reference to the Half Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2", "inherited": true, "___id": "T000002R055120", "___s": true }, { "comment": "/**\r\n * Returns the FX Controller for this Post FX Pipeline.\r\n *\r\n * This is called internally and not typically required outside.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Controller} [controller] - An FX Controller, or undefined.\r\n *\r\n * @return {Phaser.FX.Controller|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} The FX Controller responsible, or this Pipeline.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "getController", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#getController", "kind": "function", "description": "Returns the FX Controller for this Post FX Pipeline.\r\rThis is called internally and not typically required outside.", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.FX.Controller", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.FX.Controller" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The FX Controller responsible, or this Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "optional": true, "description": "An FX Controller, or undefined.", "name": "controller" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController", "inherited": true, "___id": "T000002R055121", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * This method does _not_ bind a shader. It uses whatever shader\r\n * is currently bound in this pipeline. It also does _not_ clear\r\n * the frame buffers after use. You should take care of both of\r\n * these things if you call this method directly.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copySprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#copySprite", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThis method does _not_ bind a shader. It uses whatever shader\ris currently bound in this pipeline. It also does _not_ clear\rthe frame buffers after use. You should take care of both of\rthese things if you call this method directly.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite", "inherited": true, "___id": "T000002R055122", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#copyFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame", "inherited": true, "___id": "T000002R055123", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyToGame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#copyToGame", "kind": "function", "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame", "inherited": true, "___id": "T000002R055124", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using this pipelines\r\n * Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "drawFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#drawFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target, using this pipelines\rColor Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame", "inherited": true, "___id": "T000002R055125", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFrames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#blendFrames", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames", "inherited": true, "___id": "T000002R055126", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFramesAdditive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#blendFramesAdditive", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive", "inherited": true, "___id": "T000002R055127", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "clearFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#clearFrame", "kind": "function", "description": "Clears the given Render Target.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame", "inherited": true, "___id": "T000002R055128", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blitFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#blitFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame", "inherited": true, "___id": "T000002R055129", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrameRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#copyFrameRect", "kind": "function", "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect", "inherited": true, "___id": "T000002R055130", "___s": true }, { "comment": "/**\r\n * Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * If no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\r\n * and use that instead, which should be done when you need to draw the final results of\r\n * this pipeline to the game canvas.\r\n *\r\n * You can optionally set the shader to be used for the draw here, if this is a multi-shader\r\n * pipeline. By default `currentShader` will be used. If you need to set a shader but not\r\n * a target, just pass `null` as the `target` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to draw to. If not set, it will pop the fbo from the stack.\r\n * @param {boolean} [clear=true] - Clear the target before copying? Only used if `target` parameter is set.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to use during the draw.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "bindAndDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#bindAndDraw", "kind": "function", "description": "Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\rIf no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\rand use that instead, which should be done when you need to draw the final results of\rthis pipeline to the game canvas.\r\rYou can optionally set the shader to be used for the draw here, if this is a multi-shader\rpipeline. By default `currentShader` will be used. If you need to set a shader but not\ra target, just pass `null` as the `target` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to draw to. If not set, it will pop the fbo from the stack.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying? Only used if `target` parameter is set.", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use during the draw.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw", "inherited": true, "___id": "T000002R055131", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 571, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy", "inherited": true, "___id": "T000002R055132", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R055133", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R055134", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R055135", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R055136", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R055137", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R055138", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R055139", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R055140", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R055141", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R055142", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R055143", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R055144", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R055145", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R055146", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R055147", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R055148", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R055149", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R055150", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R055151", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R055152", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R055153", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R055154", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R055155", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R055156", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R055157", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R055158", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R055159", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R055160", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R055161", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R055162", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R055163", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R055164", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R055165", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R055166", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R055167", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R055168", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R055169", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R055170", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055171", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R055172", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R055173", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R055174", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055175", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055176", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055177", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R055178", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R055179", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R055180", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055181", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055182", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R055183", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R055184", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R055185", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R055186", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R055187", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055188", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055189", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R055190", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R055191", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055192", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R055193", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055194", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R055195", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055196", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055197", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055198", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R055199", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R055200", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R055201", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055202", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055203", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R055204", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R055205", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R055206", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R055207", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R055208", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R055209", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R055210", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055211", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055212", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055213", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055214", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055215", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055216", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055217", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055218", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055219", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055220", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055221", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055222", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055223", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055224", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055225", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055226", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055227", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055228", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055229", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055230", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055231", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R055232", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R055233", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R055234", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R055235", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R055236", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R055237", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R055238", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R055239", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R055240", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R055241", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R055242", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to a Game Object or Camera,\r\n * this property contains a reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject\r\n * @type {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "gameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#gameObject", "kind": "member", "description": "If this Post Pipeline belongs to a Game Object or Camera,\rthis property contains a reference to it.", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject", "inherited": true, "___id": "T000002R055243", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to an FX Controller, this is a\r\n * reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller\r\n * @type {Phaser.FX.Controller}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "controller", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#controller", "kind": "member", "description": "If this Post Pipeline belongs to an FX Controller, this is a\rreference to it.", "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller", "inherited": true, "___id": "T000002R055244", "___s": true }, { "comment": "/**\r\n * A Color Matrix instance belonging to this pipeline.\r\n *\r\n * Used during calls to the `drawFrame` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "colorMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#colorMatrix", "kind": "member", "description": "A Color Matrix instance belonging to this pipeline.\r\rUsed during calls to the `drawFrame` method.", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix", "inherited": true, "___id": "T000002R055245", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#fullFrame1", "kind": "member", "description": "A reference to the Full Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1", "inherited": true, "___id": "T000002R055246", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#fullFrame2", "kind": "member", "description": "A reference to the Full Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2", "inherited": true, "___id": "T000002R055247", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#halfFrame1", "kind": "member", "description": "A reference to the Half Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1", "inherited": true, "___id": "T000002R055248", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#halfFrame2", "kind": "member", "description": "A reference to the Half Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2", "inherited": true, "___id": "T000002R055249", "___s": true }, { "comment": "/**\r\n * Returns the FX Controller for this Post FX Pipeline.\r\n *\r\n * This is called internally and not typically required outside.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Controller} [controller] - An FX Controller, or undefined.\r\n *\r\n * @return {Phaser.FX.Controller|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} The FX Controller responsible, or this Pipeline.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "getController", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#getController", "kind": "function", "description": "Returns the FX Controller for this Post FX Pipeline.\r\rThis is called internally and not typically required outside.", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.FX.Controller", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.FX.Controller" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The FX Controller responsible, or this Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "optional": true, "description": "An FX Controller, or undefined.", "name": "controller" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController", "inherited": true, "___id": "T000002R055250", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * This method does _not_ bind a shader. It uses whatever shader\r\n * is currently bound in this pipeline. It also does _not_ clear\r\n * the frame buffers after use. You should take care of both of\r\n * these things if you call this method directly.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copySprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#copySprite", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThis method does _not_ bind a shader. It uses whatever shader\ris currently bound in this pipeline. It also does _not_ clear\rthe frame buffers after use. You should take care of both of\rthese things if you call this method directly.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite", "inherited": true, "___id": "T000002R055251", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#copyFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame", "inherited": true, "___id": "T000002R055252", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyToGame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#copyToGame", "kind": "function", "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame", "inherited": true, "___id": "T000002R055253", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using this pipelines\r\n * Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "drawFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#drawFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target, using this pipelines\rColor Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame", "inherited": true, "___id": "T000002R055254", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFrames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#blendFrames", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames", "inherited": true, "___id": "T000002R055255", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFramesAdditive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#blendFramesAdditive", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive", "inherited": true, "___id": "T000002R055256", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "clearFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#clearFrame", "kind": "function", "description": "Clears the given Render Target.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame", "inherited": true, "___id": "T000002R055257", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blitFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#blitFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame", "inherited": true, "___id": "T000002R055258", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrameRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#copyFrameRect", "kind": "function", "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect", "inherited": true, "___id": "T000002R055259", "___s": true }, { "comment": "/**\r\n * Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * If no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\r\n * and use that instead, which should be done when you need to draw the final results of\r\n * this pipeline to the game canvas.\r\n *\r\n * You can optionally set the shader to be used for the draw here, if this is a multi-shader\r\n * pipeline. By default `currentShader` will be used. If you need to set a shader but not\r\n * a target, just pass `null` as the `target` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to draw to. If not set, it will pop the fbo from the stack.\r\n * @param {boolean} [clear=true] - Clear the target before copying? Only used if `target` parameter is set.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to use during the draw.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "bindAndDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#bindAndDraw", "kind": "function", "description": "Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\rIf no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\rand use that instead, which should be done when you need to draw the final results of\rthis pipeline to the game canvas.\r\rYou can optionally set the shader to be used for the draw here, if this is a multi-shader\rpipeline. By default `currentShader` will be used. If you need to set a shader but not\ra target, just pass `null` as the `target` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to draw to. If not set, it will pop the fbo from the stack.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying? Only used if `target` parameter is set.", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use during the draw.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw", "inherited": true, "___id": "T000002R055260", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 571, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy", "inherited": true, "___id": "T000002R055261", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R055262", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R055263", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R055264", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R055265", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R055266", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R055267", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R055268", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R055269", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R055270", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R055271", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R055272", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R055273", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R055274", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R055275", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R055276", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R055277", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R055278", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R055279", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R055280", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R055281", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R055282", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R055283", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R055284", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R055285", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R055286", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R055287", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R055288", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R055289", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R055290", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R055291", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R055292", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R055293", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R055294", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R055295", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R055296", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R055297", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R055298", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R055299", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055300", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R055301", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R055302", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R055303", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055304", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055305", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055306", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R055307", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R055308", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R055309", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055310", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055311", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R055312", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R055313", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R055314", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R055315", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R055316", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055317", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055318", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R055319", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R055320", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055321", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R055322", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055323", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R055324", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055325", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055326", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055327", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R055328", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R055329", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R055330", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055331", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055332", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R055333", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R055334", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R055335", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R055336", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R055337", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R055338", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R055339", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055340", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055341", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055342", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055343", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055344", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055345", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055346", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055347", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055348", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055349", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055350", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055351", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055352", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055353", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055354", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055355", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055356", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055357", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055358", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055359", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055360", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R055361", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R055362", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R055363", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R055364", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R055365", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R055366", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R055367", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R055368", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R055369", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R055370", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R055371", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to a Game Object or Camera,\r\n * this property contains a reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject\r\n * @type {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "gameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#gameObject", "kind": "member", "description": "If this Post Pipeline belongs to a Game Object or Camera,\rthis property contains a reference to it.", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject", "inherited": true, "___id": "T000002R055372", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to an FX Controller, this is a\r\n * reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller\r\n * @type {Phaser.FX.Controller}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "controller", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#controller", "kind": "member", "description": "If this Post Pipeline belongs to an FX Controller, this is a\rreference to it.", "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller", "inherited": true, "___id": "T000002R055373", "___s": true }, { "comment": "/**\r\n * A Color Matrix instance belonging to this pipeline.\r\n *\r\n * Used during calls to the `drawFrame` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "colorMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#colorMatrix", "kind": "member", "description": "A Color Matrix instance belonging to this pipeline.\r\rUsed during calls to the `drawFrame` method.", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix", "inherited": true, "___id": "T000002R055374", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#fullFrame1", "kind": "member", "description": "A reference to the Full Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1", "inherited": true, "___id": "T000002R055375", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#fullFrame2", "kind": "member", "description": "A reference to the Full Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2", "inherited": true, "___id": "T000002R055376", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#halfFrame1", "kind": "member", "description": "A reference to the Half Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1", "inherited": true, "___id": "T000002R055377", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#halfFrame2", "kind": "member", "description": "A reference to the Half Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2", "inherited": true, "___id": "T000002R055378", "___s": true }, { "comment": "/**\r\n * Returns the FX Controller for this Post FX Pipeline.\r\n *\r\n * This is called internally and not typically required outside.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Controller} [controller] - An FX Controller, or undefined.\r\n *\r\n * @return {Phaser.FX.Controller|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} The FX Controller responsible, or this Pipeline.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "getController", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#getController", "kind": "function", "description": "Returns the FX Controller for this Post FX Pipeline.\r\rThis is called internally and not typically required outside.", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.FX.Controller", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.FX.Controller" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The FX Controller responsible, or this Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "optional": true, "description": "An FX Controller, or undefined.", "name": "controller" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController", "inherited": true, "___id": "T000002R055379", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * This method does _not_ bind a shader. It uses whatever shader\r\n * is currently bound in this pipeline. It also does _not_ clear\r\n * the frame buffers after use. You should take care of both of\r\n * these things if you call this method directly.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copySprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#copySprite", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThis method does _not_ bind a shader. It uses whatever shader\ris currently bound in this pipeline. It also does _not_ clear\rthe frame buffers after use. You should take care of both of\rthese things if you call this method directly.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite", "inherited": true, "___id": "T000002R055380", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#copyFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame", "inherited": true, "___id": "T000002R055381", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyToGame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#copyToGame", "kind": "function", "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame", "inherited": true, "___id": "T000002R055382", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using this pipelines\r\n * Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "drawFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#drawFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target, using this pipelines\rColor Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame", "inherited": true, "___id": "T000002R055383", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFrames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#blendFrames", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames", "inherited": true, "___id": "T000002R055384", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFramesAdditive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#blendFramesAdditive", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive", "inherited": true, "___id": "T000002R055385", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "clearFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#clearFrame", "kind": "function", "description": "Clears the given Render Target.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame", "inherited": true, "___id": "T000002R055386", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blitFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#blitFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame", "inherited": true, "___id": "T000002R055387", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrameRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#copyFrameRect", "kind": "function", "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect", "inherited": true, "___id": "T000002R055388", "___s": true }, { "comment": "/**\r\n * Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * If no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\r\n * and use that instead, which should be done when you need to draw the final results of\r\n * this pipeline to the game canvas.\r\n *\r\n * You can optionally set the shader to be used for the draw here, if this is a multi-shader\r\n * pipeline. By default `currentShader` will be used. If you need to set a shader but not\r\n * a target, just pass `null` as the `target` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to draw to. If not set, it will pop the fbo from the stack.\r\n * @param {boolean} [clear=true] - Clear the target before copying? Only used if `target` parameter is set.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to use during the draw.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "bindAndDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#bindAndDraw", "kind": "function", "description": "Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\rIf no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\rand use that instead, which should be done when you need to draw the final results of\rthis pipeline to the game canvas.\r\rYou can optionally set the shader to be used for the draw here, if this is a multi-shader\rpipeline. By default `currentShader` will be used. If you need to set a shader but not\ra target, just pass `null` as the `target` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to draw to. If not set, it will pop the fbo from the stack.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying? Only used if `target` parameter is set.", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use during the draw.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw", "inherited": true, "___id": "T000002R055389", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 571, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy", "inherited": true, "___id": "T000002R055390", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R055391", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R055392", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R055393", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R055394", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R055395", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R055396", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R055397", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R055398", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R055399", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R055400", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R055401", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R055402", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R055403", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R055404", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R055405", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R055406", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R055407", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R055408", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R055409", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R055410", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R055411", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R055412", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R055413", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R055414", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R055415", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R055416", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R055417", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R055418", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R055419", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R055420", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R055421", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R055422", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R055423", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R055424", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R055425", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R055426", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R055427", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R055428", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055429", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R055430", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R055431", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R055432", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055433", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055434", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055435", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R055436", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R055437", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R055438", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055439", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055440", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R055441", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R055442", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R055443", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R055444", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R055445", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055446", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055447", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R055448", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R055449", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055450", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R055451", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055452", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R055453", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055454", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055455", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055456", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R055457", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R055458", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R055459", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055460", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055461", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R055462", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R055463", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R055464", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R055465", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R055466", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R055467", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R055468", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055469", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055470", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055471", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055472", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055473", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055474", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055475", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055476", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055477", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055478", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055479", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055480", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055481", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055482", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055483", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055484", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055485", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055486", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055487", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055488", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055489", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R055490", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R055491", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R055492", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R055493", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R055494", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R055495", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R055496", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R055497", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R055498", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R055499", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R055500", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to a Game Object or Camera,\r\n * this property contains a reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject\r\n * @type {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "gameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#gameObject", "kind": "member", "description": "If this Post Pipeline belongs to a Game Object or Camera,\rthis property contains a reference to it.", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject", "inherited": true, "___id": "T000002R055501", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to an FX Controller, this is a\r\n * reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller\r\n * @type {Phaser.FX.Controller}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "controller", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#controller", "kind": "member", "description": "If this Post Pipeline belongs to an FX Controller, this is a\rreference to it.", "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller", "inherited": true, "___id": "T000002R055502", "___s": true }, { "comment": "/**\r\n * A Color Matrix instance belonging to this pipeline.\r\n *\r\n * Used during calls to the `drawFrame` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "colorMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#colorMatrix", "kind": "member", "description": "A Color Matrix instance belonging to this pipeline.\r\rUsed during calls to the `drawFrame` method.", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix", "inherited": true, "___id": "T000002R055503", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#fullFrame1", "kind": "member", "description": "A reference to the Full Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1", "inherited": true, "___id": "T000002R055504", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#fullFrame2", "kind": "member", "description": "A reference to the Full Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2", "inherited": true, "___id": "T000002R055505", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#halfFrame1", "kind": "member", "description": "A reference to the Half Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1", "inherited": true, "___id": "T000002R055506", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#halfFrame2", "kind": "member", "description": "A reference to the Half Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2", "inherited": true, "___id": "T000002R055507", "___s": true }, { "comment": "/**\r\n * Returns the FX Controller for this Post FX Pipeline.\r\n *\r\n * This is called internally and not typically required outside.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Controller} [controller] - An FX Controller, or undefined.\r\n *\r\n * @return {Phaser.FX.Controller|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} The FX Controller responsible, or this Pipeline.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "getController", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#getController", "kind": "function", "description": "Returns the FX Controller for this Post FX Pipeline.\r\rThis is called internally and not typically required outside.", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.FX.Controller", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.FX.Controller" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The FX Controller responsible, or this Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "optional": true, "description": "An FX Controller, or undefined.", "name": "controller" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController", "inherited": true, "___id": "T000002R055508", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * This method does _not_ bind a shader. It uses whatever shader\r\n * is currently bound in this pipeline. It also does _not_ clear\r\n * the frame buffers after use. You should take care of both of\r\n * these things if you call this method directly.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copySprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#copySprite", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThis method does _not_ bind a shader. It uses whatever shader\ris currently bound in this pipeline. It also does _not_ clear\rthe frame buffers after use. You should take care of both of\rthese things if you call this method directly.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite", "inherited": true, "___id": "T000002R055509", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#copyFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame", "inherited": true, "___id": "T000002R055510", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyToGame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#copyToGame", "kind": "function", "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame", "inherited": true, "___id": "T000002R055511", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using this pipelines\r\n * Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "drawFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#drawFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target, using this pipelines\rColor Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame", "inherited": true, "___id": "T000002R055512", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFrames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#blendFrames", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames", "inherited": true, "___id": "T000002R055513", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFramesAdditive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#blendFramesAdditive", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive", "inherited": true, "___id": "T000002R055514", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "clearFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#clearFrame", "kind": "function", "description": "Clears the given Render Target.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame", "inherited": true, "___id": "T000002R055515", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blitFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#blitFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame", "inherited": true, "___id": "T000002R055516", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrameRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#copyFrameRect", "kind": "function", "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect", "inherited": true, "___id": "T000002R055517", "___s": true }, { "comment": "/**\r\n * Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * If no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\r\n * and use that instead, which should be done when you need to draw the final results of\r\n * this pipeline to the game canvas.\r\n *\r\n * You can optionally set the shader to be used for the draw here, if this is a multi-shader\r\n * pipeline. By default `currentShader` will be used. If you need to set a shader but not\r\n * a target, just pass `null` as the `target` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to draw to. If not set, it will pop the fbo from the stack.\r\n * @param {boolean} [clear=true] - Clear the target before copying? Only used if `target` parameter is set.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to use during the draw.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "bindAndDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#bindAndDraw", "kind": "function", "description": "Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\rIf no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\rand use that instead, which should be done when you need to draw the final results of\rthis pipeline to the game canvas.\r\rYou can optionally set the shader to be used for the draw here, if this is a multi-shader\rpipeline. By default `currentShader` will be used. If you need to set a shader but not\ra target, just pass `null` as the `target` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to draw to. If not set, it will pop the fbo from the stack.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying? Only used if `target` parameter is set.", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use during the draw.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw", "inherited": true, "___id": "T000002R055518", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 571, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy", "inherited": true, "___id": "T000002R055519", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R055520", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R055521", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R055522", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R055523", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R055524", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R055525", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R055526", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R055527", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R055528", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R055529", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R055530", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R055531", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R055532", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R055533", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R055534", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R055535", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R055536", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R055537", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R055538", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R055539", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R055540", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R055541", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R055542", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R055543", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R055544", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R055545", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R055546", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R055547", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R055548", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R055549", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R055550", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R055551", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R055552", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R055553", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R055554", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R055555", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R055556", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R055557", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055558", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R055559", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R055560", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R055561", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055562", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055563", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055564", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R055565", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R055566", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R055567", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055568", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055569", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R055570", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R055571", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R055572", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R055573", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R055574", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055575", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055576", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R055577", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R055578", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055579", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R055580", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055581", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R055582", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055583", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055584", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055585", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R055586", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R055587", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R055588", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055589", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055590", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R055591", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R055592", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R055593", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R055594", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R055595", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R055596", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R055597", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055598", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055599", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055600", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055601", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055602", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055603", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055604", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055605", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055606", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055607", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055608", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055609", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055610", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055611", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055612", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055613", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055614", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055615", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055616", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055617", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055618", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R055619", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R055620", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R055621", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R055622", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R055623", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R055624", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R055625", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R055626", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R055627", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R055628", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R055629", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to a Game Object or Camera,\r\n * this property contains a reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject\r\n * @type {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "gameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#gameObject", "kind": "member", "description": "If this Post Pipeline belongs to a Game Object or Camera,\rthis property contains a reference to it.", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject", "inherited": true, "___id": "T000002R055630", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to an FX Controller, this is a\r\n * reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller\r\n * @type {Phaser.FX.Controller}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "controller", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#controller", "kind": "member", "description": "If this Post Pipeline belongs to an FX Controller, this is a\rreference to it.", "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller", "inherited": true, "___id": "T000002R055631", "___s": true }, { "comment": "/**\r\n * A Color Matrix instance belonging to this pipeline.\r\n *\r\n * Used during calls to the `drawFrame` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "colorMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#colorMatrix", "kind": "member", "description": "A Color Matrix instance belonging to this pipeline.\r\rUsed during calls to the `drawFrame` method.", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix", "inherited": true, "___id": "T000002R055632", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#fullFrame1", "kind": "member", "description": "A reference to the Full Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1", "inherited": true, "___id": "T000002R055633", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#fullFrame2", "kind": "member", "description": "A reference to the Full Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2", "inherited": true, "___id": "T000002R055634", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#halfFrame1", "kind": "member", "description": "A reference to the Half Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1", "inherited": true, "___id": "T000002R055635", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#halfFrame2", "kind": "member", "description": "A reference to the Half Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2", "inherited": true, "___id": "T000002R055636", "___s": true }, { "comment": "/**\r\n * Returns the FX Controller for this Post FX Pipeline.\r\n *\r\n * This is called internally and not typically required outside.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Controller} [controller] - An FX Controller, or undefined.\r\n *\r\n * @return {Phaser.FX.Controller|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} The FX Controller responsible, or this Pipeline.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "getController", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#getController", "kind": "function", "description": "Returns the FX Controller for this Post FX Pipeline.\r\rThis is called internally and not typically required outside.", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.FX.Controller", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.FX.Controller" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The FX Controller responsible, or this Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "optional": true, "description": "An FX Controller, or undefined.", "name": "controller" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController", "inherited": true, "___id": "T000002R055637", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * This method does _not_ bind a shader. It uses whatever shader\r\n * is currently bound in this pipeline. It also does _not_ clear\r\n * the frame buffers after use. You should take care of both of\r\n * these things if you call this method directly.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copySprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#copySprite", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThis method does _not_ bind a shader. It uses whatever shader\ris currently bound in this pipeline. It also does _not_ clear\rthe frame buffers after use. You should take care of both of\rthese things if you call this method directly.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite", "inherited": true, "___id": "T000002R055638", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#copyFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame", "inherited": true, "___id": "T000002R055639", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyToGame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#copyToGame", "kind": "function", "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame", "inherited": true, "___id": "T000002R055640", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using this pipelines\r\n * Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "drawFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#drawFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target, using this pipelines\rColor Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame", "inherited": true, "___id": "T000002R055641", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFrames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#blendFrames", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames", "inherited": true, "___id": "T000002R055642", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFramesAdditive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#blendFramesAdditive", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive", "inherited": true, "___id": "T000002R055643", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "clearFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#clearFrame", "kind": "function", "description": "Clears the given Render Target.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame", "inherited": true, "___id": "T000002R055644", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blitFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#blitFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame", "inherited": true, "___id": "T000002R055645", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrameRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#copyFrameRect", "kind": "function", "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect", "inherited": true, "___id": "T000002R055646", "___s": true }, { "comment": "/**\r\n * Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * If no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\r\n * and use that instead, which should be done when you need to draw the final results of\r\n * this pipeline to the game canvas.\r\n *\r\n * You can optionally set the shader to be used for the draw here, if this is a multi-shader\r\n * pipeline. By default `currentShader` will be used. If you need to set a shader but not\r\n * a target, just pass `null` as the `target` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to draw to. If not set, it will pop the fbo from the stack.\r\n * @param {boolean} [clear=true] - Clear the target before copying? Only used if `target` parameter is set.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to use during the draw.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "bindAndDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#bindAndDraw", "kind": "function", "description": "Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\rIf no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\rand use that instead, which should be done when you need to draw the final results of\rthis pipeline to the game canvas.\r\rYou can optionally set the shader to be used for the draw here, if this is a multi-shader\rpipeline. By default `currentShader` will be used. If you need to set a shader but not\ra target, just pass `null` as the `target` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to draw to. If not set, it will pop the fbo from the stack.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying? Only used if `target` parameter is set.", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use during the draw.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw", "inherited": true, "___id": "T000002R055647", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 571, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy", "inherited": true, "___id": "T000002R055648", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R055649", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R055650", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R055651", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R055652", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R055653", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R055654", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R055655", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R055656", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R055657", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R055658", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R055659", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R055660", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R055661", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R055662", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R055663", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R055664", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R055665", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R055666", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R055667", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R055668", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R055669", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R055670", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R055671", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R055672", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R055673", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R055674", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R055675", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R055676", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R055677", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R055678", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R055679", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R055680", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R055681", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R055682", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R055683", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R055684", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R055685", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R055686", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055687", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R055688", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R055689", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R055690", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055691", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055692", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055693", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R055694", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R055695", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R055696", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055697", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055698", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R055699", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R055700", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R055701", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R055702", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R055703", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055704", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055705", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R055706", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R055707", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055708", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R055709", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055710", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R055711", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055712", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055713", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055714", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R055715", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R055716", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R055717", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055718", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055719", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R055720", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R055721", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R055722", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R055723", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R055724", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R055725", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R055726", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055727", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055728", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055729", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055730", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055731", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055732", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055733", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055734", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055735", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055736", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055737", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055738", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055739", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055740", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055741", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055742", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055743", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055744", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055745", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055746", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055747", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R055748", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R055749", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R055750", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R055751", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R055752", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R055753", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R055754", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R055755", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R055756", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R055757", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R055758", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to a Game Object or Camera,\r\n * this property contains a reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject\r\n * @type {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "gameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#gameObject", "kind": "member", "description": "If this Post Pipeline belongs to a Game Object or Camera,\rthis property contains a reference to it.", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#gameObject", "inherited": true, "___id": "T000002R055759", "___s": true }, { "comment": "/**\r\n * If this Post Pipeline belongs to an FX Controller, this is a\r\n * reference to it.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller\r\n * @type {Phaser.FX.Controller}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "controller", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#controller", "kind": "member", "description": "If this Post Pipeline belongs to an FX Controller, this is a\rreference to it.", "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#controller", "inherited": true, "___id": "T000002R055760", "___s": true }, { "comment": "/**\r\n * A Color Matrix instance belonging to this pipeline.\r\n *\r\n * Used during calls to the `drawFrame` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "colorMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#colorMatrix", "kind": "member", "description": "A Color Matrix instance belonging to this pipeline.\r\rUsed during calls to the `drawFrame` method.", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#colorMatrix", "inherited": true, "___id": "T000002R055761", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#fullFrame1", "kind": "member", "description": "A reference to the Full Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame1", "inherited": true, "___id": "T000002R055762", "___s": true }, { "comment": "/**\r\n * A reference to the Full Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is the full size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fullFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#fullFrame2", "kind": "member", "description": "A reference to the Full Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is the full size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#fullFrame2", "inherited": true, "___id": "T000002R055763", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 1 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame1", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#halfFrame1", "kind": "member", "description": "A reference to the Half Frame 1 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame1", "inherited": true, "___id": "T000002R055764", "___s": true }, { "comment": "/**\r\n * A reference to the Half Frame 2 Render Target that belongs to the\r\n * Utility Pipeline. This property is set during the `boot` method.\r\n *\r\n * This Render Target is half the size of the renderer.\r\n *\r\n * You can use this directly in Post FX Pipelines for multi-target effects.\r\n * However, be aware that these targets are shared between all post fx pipelines.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "halfFrame2", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#halfFrame2", "kind": "member", "description": "A reference to the Half Frame 2 Render Target that belongs to the\rUtility Pipeline. This property is set during the `boot` method.\r\rThis Render Target is half the size of the renderer.\r\rYou can use this directly in Post FX Pipelines for multi-target effects.\rHowever, be aware that these targets are shared between all post fx pipelines.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#halfFrame2", "inherited": true, "___id": "T000002R055765", "___s": true }, { "comment": "/**\r\n * Returns the FX Controller for this Post FX Pipeline.\r\n *\r\n * This is called internally and not typically required outside.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.FX.Controller} [controller] - An FX Controller, or undefined.\r\n *\r\n * @return {Phaser.FX.Controller|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} The FX Controller responsible, or this Pipeline.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "getController", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#getController", "kind": "function", "description": "Returns the FX Controller for this Post FX Pipeline.\r\rThis is called internally and not typically required outside.", "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.FX.Controller", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.FX.Controller" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The FX Controller responsible, or this Pipeline." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.FX.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.FX.Controller" } }, "optional": true, "description": "An FX Controller, or undefined.", "name": "controller" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#getController", "inherited": true, "___id": "T000002R055766", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * This method does _not_ bind a shader. It uses whatever shader\r\n * is currently bound in this pipeline. It also does _not_ clear\r\n * the frame buffers after use. You should take care of both of\r\n * these things if you call this method directly.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copySprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#copySprite", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThis method does _not_ bind a shader. It uses whatever shader\ris currently bound in this pipeline. It also does _not_ clear\rthe frame buffers after use. You should take care of both of\rthese things if you call this method directly.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copySprite", "inherited": true, "___id": "T000002R055767", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * The difference between this method and `drawFrame` is that this method\r\n * uses a faster copy shader, where only the brightness can be modified.\r\n * If you need color level manipulation, see `drawFrame` instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#copyFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rYou can optionally set the brightness factor of the copy.\r\rThe difference between this method and `drawFrame` is that this method\ruses a faster copy shader, where only the brightness can be modified.\rIf you need color level manipulation, see `drawFrame` instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrame", "inherited": true, "___id": "T000002R055768", "___s": true }, { "comment": "/**\r\n * Pops the framebuffer from the renderers FBO stack and sets that as the active target,\r\n * then draws the `source` Render Target to it. It then resets the renderer textures.\r\n *\r\n * This should be done when you need to draw the _final_ results of a pipeline to the game\r\n * canvas, or the next framebuffer in line on the FBO stack. You should only call this once\r\n * in the `onDraw` handler and it should be the final thing called. Be careful not to call\r\n * this if you need to actually use the pipeline shader, instead of the copy shader. In\r\n * those cases, use the `bindAndDraw` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyToGame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#copyToGame", "kind": "function", "description": "Pops the framebuffer from the renderers FBO stack and sets that as the active target,\rthen draws the `source` Render Target to it. It then resets the renderer textures.\r\rThis should be done when you need to draw the _final_ results of a pipeline to the game\rcanvas, or the next framebuffer in line on the FBO stack. You should only call this once\rin the `onDraw` handler and it should be the final thing called. Be careful not to call\rthis if you need to actually use the pipeline shader, instead of the copy shader. In\rthose cases, use the `bindAndDraw` method.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyToGame", "inherited": true, "___id": "T000002R055769", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target, using this pipelines\r\n * Color Matrix.\r\n *\r\n * The difference between this method and `copyFrame` is that this method\r\n * uses a color matrix shader, where you have full control over the luminance\r\n * values used during the copy. If you don't need this, you can use the faster\r\n * `copyFrame` method instead.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "drawFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#drawFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target, using this pipelines\rColor Matrix.\r\rThe difference between this method and `copyFrame` is that this method\ruses a color matrix shader, where you have full control over the luminance\rvalues used during the copy. If you don't need this, you can use the faster\r`copyFrame` method instead.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#drawFrame", "inherited": true, "___id": "T000002R055770", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFrames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#blendFrames", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFrames", "inherited": true, "___id": "T000002R055771", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFramesAdditive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#blendFramesAdditive", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blendFramesAdditive", "inherited": true, "___id": "T000002R055772", "___s": true }, { "comment": "/**\r\n * Clears the given Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target to clear.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "clearFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#clearFrame", "kind": "function", "description": "Clears the given Render Target.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to clear.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#clearFrame", "inherited": true, "___id": "T000002R055773", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * The difference with this copy is that no resizing takes place. If the `source`\r\n * Render Target is larger than the `target` then only a portion the same size as\r\n * the `target` dimensions is copied across.\r\n *\r\n * You can optionally set the brightness factor of the copy.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} [brightness=1] - The brightness value applied to the frame copy.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 444, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blitFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#blitFrame", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rThe difference with this copy is that no resizing takes place. If the `source`\rRender Target is larger than the `target` then only a portion the same size as\rthe `target` dimensions is copied across.\r\rYou can optionally set the brightness factor of the copy.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The brightness value applied to the frame copy.", "name": "brightness" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#blitFrame", "inherited": true, "___id": "T000002R055774", "___s": true }, { "comment": "/**\r\n * Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\n *\r\n * This method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\r\n * require the use of any shaders. Remember the coordinates are given in standard WebGL format,\r\n * where x and y specify the lower-left corner of the section, not the top-left. Also, the\r\n * copy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\r\n * place.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n * @param {number} x - The x coordinate of the lower left corner where to start copying.\r\n * @param {number} y - The y coordinate of the lower left corner where to start copying.\r\n * @param {number} width - The width of the texture.\r\n * @param {number} height - The height of the texture.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyFrameRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#copyFrameRect", "kind": "function", "description": "Binds the `source` Render Target and then copies a section of it to the `target` Render Target.\r\rThis method is extremely fast because it uses `gl.copyTexSubImage2D` and doesn't\rrequire the use of any shaders. Remember the coordinates are given in standard WebGL format,\rwhere x and y specify the lower-left corner of the section, not the top-left. Also, the\rcopy entirely replaces the contents of the target texture, no 'merging' or 'blending' takes\rplace.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the lower left corner where to start copying.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the lower left corner where to start copying.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#copyFrameRect", "inherited": true, "___id": "T000002R055775", "___s": true }, { "comment": "/**\r\n * Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * If no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\r\n * and use that instead, which should be done when you need to draw the final results of\r\n * this pipeline to the game canvas.\r\n *\r\n * You can optionally set the shader to be used for the draw here, if this is a multi-shader\r\n * pipeline. By default `currentShader` will be used. If you need to set a shader but not\r\n * a target, just pass `null` as the `target` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to draw to. If not set, it will pop the fbo from the stack.\r\n * @param {boolean} [clear=true] - Clear the target before copying? Only used if `target` parameter is set.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to use during the draw.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "bindAndDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#bindAndDraw", "kind": "function", "description": "Binds this pipeline and draws the `source` Render Target to the `target` Render Target.\r\rIf no `target` is specified, it will pop the framebuffer from the Renderers FBO stack\rand use that instead, which should be done when you need to draw the final results of\rthis pipeline to the game canvas.\r\rYou can optionally set the shader to be used for the draw here, if this is a multi-shader\rpipeline. By default `currentShader` will be used. If you need to set a shader but not\ra target, just pass `null` as the `target` parameter.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to draw to. If not set, it will pop the fbo from the stack.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying? Only used if `target` parameter is set.", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use during the draw.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#bindAndDraw", "inherited": true, "___id": "T000002R055776", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "PostFXPipeline.js", "lineno": 571, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline#destroy", "inherited": true, "___id": "T000002R055777", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R055778", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R055779", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R055780", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R055781", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R055782", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R055783", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R055784", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R055785", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R055786", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R055787", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R055788", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R055789", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R055790", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R055791", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R055792", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R055793", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R055794", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R055795", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R055796", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R055797", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R055798", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R055799", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R055800", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R055801", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R055802", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R055803", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R055804", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R055805", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R055806", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R055807", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R055808", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R055809", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R055810", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R055811", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R055812", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R055813", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R055814", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R055815", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055816", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R055817", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R055818", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R055819", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055820", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055821", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R055822", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R055823", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R055824", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R055825", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055826", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R055827", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R055828", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R055829", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R055830", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R055831", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R055832", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055833", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055834", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R055835", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R055836", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055837", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R055838", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055839", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R055840", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055841", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055842", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R055843", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R055844", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R055845", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R055846", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055847", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R055848", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R055849", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R055850", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R055851", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R055852", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R055853", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R055854", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R055855", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055856", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055857", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055858", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055859", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055860", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055861", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055862", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055863", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055864", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055865", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055866", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055867", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055868", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055869", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055870", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055871", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055872", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055873", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055874", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055875", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R055876", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R055877", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R055878", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R055879", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R055880", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R055881", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R055882", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R055883", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R055884", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R055885", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R055886", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R055887", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R055888", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R055889", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R055890", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R055891", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R055892", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R055893", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R055894", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R055895", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R055896", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R055897", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R055898", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R055899", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R055900", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R055901", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R055902", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R055903", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R055904", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R055905", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R055906", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R055907", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R055908", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R055909", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R055910", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R055911", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R055912", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R055913", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R055914", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R055915", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R055916", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R055917", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R055918", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R055919", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R055920", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R055921", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R055922", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R055923", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R055924", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R055925", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "___id": "T000002R055926", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "___id": "T000002R055927", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "___id": "T000002R055928", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "___id": "T000002R055929", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "___id": "T000002R055930", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "___id": "T000002R055931", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "___id": "T000002R055932", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "___id": "T000002R055933", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R055934", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "___id": "T000002R055935", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "___id": "T000002R055936", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "___id": "T000002R055937", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R055938", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "___id": "T000002R055939", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "___id": "T000002R055940", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "___id": "T000002R055941", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "___id": "T000002R055942", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "___id": "T000002R055943", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R055944", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "___id": "T000002R055945", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "___id": "T000002R055946", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "___id": "T000002R055947", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R055948", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "___id": "T000002R055949", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "___id": "T000002R055950", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "___id": "T000002R055951", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R055952", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "___id": "T000002R055953", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R055954", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "___id": "T000002R055955", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "___id": "T000002R055956", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "___id": "T000002R055957", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "___id": "T000002R055958", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "___id": "T000002R055959", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "___id": "T000002R055960", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "___id": "T000002R055961", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "___id": "T000002R055962", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "___id": "T000002R055963", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "___id": "T000002R055964", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "___id": "T000002R055965", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "___id": "T000002R055966", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "___id": "T000002R055967", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "___id": "T000002R055968", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "___id": "T000002R055969", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "___id": "T000002R055970", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "___id": "T000002R055971", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "___id": "T000002R055972", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "___id": "T000002R055973", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "___id": "T000002R055974", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "___id": "T000002R055975", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "___id": "T000002R055976", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "___id": "T000002R055977", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "___id": "T000002R055978", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "___id": "T000002R055979", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "___id": "T000002R055980", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "___id": "T000002R055981", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "___id": "T000002R055982", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "___id": "T000002R055983", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R055984", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R055985", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R055986", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R055987", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R055988", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R055989", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R055990", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R055991", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R055992", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R055993", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R055994", "___s": true }, { "comment": "/**\r\n * A reference to the Draw Sprite Shader belonging to this Pipeline.\r\n *\r\n * This shader is used when the sprite is drawn to this fbo (or to the game if drawToFrame is false)\r\n *\r\n * This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#drawSpriteShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @default null\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "drawSpriteShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#drawSpriteShader", "kind": "member", "description": "A reference to the Draw Sprite Shader belonging to this Pipeline.\r\rThis shader is used when the sprite is drawn to this fbo (or to the game if drawToFrame is false)\r\rThis property is set during the `boot` method.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "defaultvalue": "null", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#drawSpriteShader", "inherited": true, "___id": "T000002R055995", "___s": true }, { "comment": "/**\r\n * A reference to the Copy Shader belonging to this Pipeline.\r\n *\r\n * This shader is used when you call the `copySprite` method.\r\n *\r\n * This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#copyShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @default null\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 111, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#copyShader", "kind": "member", "description": "A reference to the Copy Shader belonging to this Pipeline.\r\rThis shader is used when you call the `copySprite` method.\r\rThis property is set during the `boot` method.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "defaultvalue": "null", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#copyShader", "inherited": true, "___id": "T000002R055996", "___s": true }, { "comment": "/**\r\n * A reference to the Game Draw Shader belonging to this Pipeline.\r\n *\r\n * This shader draws the fbo to the game.\r\n *\r\n * This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#gameShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @default null\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "gameShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#gameShader", "kind": "member", "description": "A reference to the Game Draw Shader belonging to this Pipeline.\r\rThis shader draws the fbo to the game.\r\rThis property is set during the `boot` method.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "defaultvalue": "null", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#gameShader", "inherited": true, "___id": "T000002R055997", "___s": true }, { "comment": "/**\r\n * A reference to the Color Matrix Shader belonging to this Pipeline.\r\n *\r\n * This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#colorMatrixShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "colorMatrixShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#colorMatrixShader", "kind": "member", "description": "A reference to the Color Matrix Shader belonging to this Pipeline.\r\rThis property is set during the `boot` method.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#colorMatrixShader", "inherited": true, "___id": "T000002R055998", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices used specifically during the copySprite method.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#quadVertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "quadVertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#quadVertexData", "kind": "member", "description": "Raw byte buffer of vertices used specifically during the copySprite method.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#quadVertexData", "inherited": true, "___id": "T000002R055999", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the quadVertexData.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#quadVertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "quadVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#quadVertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the quadVertexData.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#quadVertexBuffer", "inherited": true, "___id": "T000002R056000", "___s": true }, { "comment": "/**\r\n * Float32 view of the quad array buffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#quadVertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 170, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "quadVertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#quadVertexViewF32", "kind": "member", "description": "Float32 view of the quad array buffer.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#quadVertexViewF32", "inherited": true, "___id": "T000002R056001", "___s": true }, { "comment": "/**\r\n * The full-screen Render Target that the sprite is first drawn to.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#fsTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 199, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "fsTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#fsTarget", "kind": "member", "description": "The full-screen Render Target that the sprite is first drawn to.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#fsTarget", "inherited": true, "___id": "T000002R056004", "___s": true }, { "comment": "/**\r\n * Handles the resizing of the quad vertex data.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onResize\r\n * @since 3.60.0\r\n *\r\n * @param {number} width - The new width of the quad.\r\n * @param {number} height - The new height of the quad.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 259, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onResize", "kind": "function", "description": "Handles the resizing of the quad vertex data.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the quad.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of the quad.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onResize", "inherited": true, "___id": "T000002R056006", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where x0 / y0 = 0, x1 / y1 = 1, x2 / y2 = 2 and x3 / y3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#batchQuad\r\n * @since 3.60.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 292, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere x0 / y0 = 0, x1 / y1 = 1, x2 / y2 = 2 and x3 / y3 = 3", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#batchQuad", "inherited": true, "___id": "T000002R056007", "___s": true }, { "comment": "/**\r\n * This callback is invoked when a sprite is drawn by this pipeline.\r\n *\r\n * It will fire after the shader has been set, but before the sprite has been drawn,\r\n * so use it to set any additional uniforms you may need.\r\n *\r\n * Note: Manipulating the Sprite during this callback will _not_ change how it is drawn to the Render Target.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onDrawSprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Sprite} gameObject - The Sprite being drawn.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The Render Target the Sprite will be drawn to.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 428, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "onDrawSprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onDrawSprite", "kind": "function", "description": "This callback is invoked when a sprite is drawn by this pipeline.\r\rIt will fire after the shader has been set, but before the sprite has been drawn,\rso use it to set any additional uniforms you may need.\r\rNote: Manipulating the Sprite during this callback will _not_ change how it is drawn to the Render Target.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "The Sprite being drawn.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target the Sprite will be drawn to.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onDrawSprite", "inherited": true, "___id": "T000002R056008", "___s": true }, { "comment": "/**\r\n * This callback is invoked when you call the `copySprite` method.\r\n *\r\n * It will fire after the shader has been set, but before the source target has been copied,\r\n * so use it to set any additional uniforms you may need.\r\n *\r\n * Note: Manipulating the Sprite during this callback will _not_ change the Render Targets.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onCopySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target being copied from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target that will be copied to.\r\n * @param {Phaser.GameObjects.Sprite} gameObject - The Sprite being copied.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 446, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "onCopySprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onCopySprite", "kind": "function", "description": "This callback is invoked when you call the `copySprite` method.\r\rIt will fire after the shader has been set, but before the source target has been copied,\rso use it to set any additional uniforms you may need.\r\rNote: Manipulating the Sprite during this callback will _not_ change the Render Targets.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target being copied from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target that will be copied to.", "name": "target" }, { "type": { "names": [ "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "The Sprite being copied.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#onCopySprite", "inherited": true, "___id": "T000002R056009", "___s": true }, { "comment": "/**\r\n * Copy the `source` Render Target to the `target` Render Target.\r\n *\r\n * No target resizing takes place. If the `source` Render Target is larger than the `target`,\r\n * then only a portion the same size as the `target` dimensions is copied across.\r\n *\r\n * Calling this method will invoke the `onCopySprite` handler and will also call\r\n * the `onFXCopy` callback on the Sprite. Both of these happen prior to the copy, allowing you\r\n * to use them to set shader uniforms and other values.\r\n *\r\n * You can optionally pass in a ColorMatrix. If so, it will use the ColorMatrix shader\r\n * during the copy, allowing you to manipulate the colors to a fine degree.\r\n * See the `ColorMatrix` class for more details.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#copySprite\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target being copied from.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target that will be copied to.\r\n * @param {boolean} [clear=true] - Clear the target before copying?\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n * @param {boolean} [eraseMode=false] - Erase source from target using ERASE Blend Mode?\r\n * @param {Phaser.Display.ColorMatrix} [colorMatrix] - Optional ColorMatrix to use when copying the Sprite.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to use to copy the target. Defaults to the `copyShader`.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 465, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copySprite", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#copySprite", "kind": "function", "description": "Copy the `source` Render Target to the `target` Render Target.\r\rNo target resizing takes place. If the `source` Render Target is larger than the `target`,\rthen only a portion the same size as the `target` dimensions is copied across.\r\rCalling this method will invoke the `onCopySprite` handler and will also call\rthe `onFXCopy` callback on the Sprite. Both of these happen prior to the copy, allowing you\rto use them to set shader uniforms and other values.\r\rYou can optionally pass in a ColorMatrix. If so, it will use the ColorMatrix shader\rduring the copy, allowing you to manipulate the colors to a fine degree.\rSee the `ColorMatrix` class for more details.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target being copied from.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target that will be copied to.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the target before copying?", "name": "clear" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Erase source from target using ERASE Blend Mode?", "name": "eraseMode" }, { "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "optional": true, "description": "Optional ColorMatrix to use when copying the Sprite.", "name": "colorMatrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to use to copy the target. Defaults to the `copyShader`.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#copySprite", "inherited": true, "___id": "T000002R056010", "___s": true }, { "comment": "/**\r\n * Draws the `source` Render Target to the `target` Render Target.\r\n *\r\n * This is done using whatever the currently bound shader is. This method does\r\n * not set a shader. All it does is bind the source texture, set the viewport and UVs\r\n * then bind the target framebuffer, clears it and draws the source to it.\r\n *\r\n * At the end a null framebuffer is bound. No other clearing-up takes place, so\r\n * use this method carefully.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#copy\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 569, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copy", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#copy", "kind": "function", "description": "Draws the `source` Render Target to the `target` Render Target.\r\rThis is done using whatever the currently bound shader is. This method does\rnot set a shader. All it does is bind the source texture, set the viewport and UVs\rthen bind the target framebuffer, clears it and draws the source to it.\r\rAt the end a null framebuffer is bound. No other clearing-up takes place, so\ruse this method carefully.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#copy", "inherited": true, "___id": "T000002R056011", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using a linear blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#blendFrames\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 611, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFrames", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#blendFrames", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing a linear blend effect, which is controlled by the `strength` parameter.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#blendFrames", "inherited": true, "___id": "T000002R056012", "___s": true }, { "comment": "/**\r\n * Draws the `source1` and `source2` Render Targets to the `target` Render Target\r\n * using an additive blend effect, which is controlled by the `strength` parameter.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#blendFramesAdditive\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source1 - The first source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source2 - The second source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The target Render Target.\r\n * @param {number} [strength=1] - The strength of the blend.\r\n * @param {boolean} [clearAlpha=true] - Clear the alpha channel when running `gl.clear` on the target?\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 629, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "blendFramesAdditive", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#blendFramesAdditive", "kind": "function", "description": "Draws the `source1` and `source2` Render Targets to the `target` Render Target\rusing an additive blend effect, which is controlled by the `strength` parameter.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The first source Render Target.", "name": "source1" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The second source Render Target.", "name": "source2" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The target Render Target.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blend.", "name": "strength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Clear the alpha channel when running `gl.clear` on the target?", "name": "clearAlpha" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#blendFramesAdditive", "inherited": true, "___id": "T000002R056013", "___s": true }, { "comment": "/**\r\n * This method will copy the given Render Target to the game canvas using the `copyShader`.\r\n *\r\n * This applies the results of the copy shader during the draw.\r\n *\r\n * If you wish to copy the target without any effects see the `copyToGame` method instead.\r\n *\r\n * This method should be the final thing called in your pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#drawToGame\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw to the game.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 647, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "drawToGame", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#drawToGame", "kind": "function", "description": "This method will copy the given Render Target to the game canvas using the `copyShader`.\r\rThis applies the results of the copy shader during the draw.\r\rIf you wish to copy the target without any effects see the `copyToGame` method instead.\r\rThis method should be the final thing called in your pipeline.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw to the game.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#drawToGame", "inherited": true, "___id": "T000002R056014", "___s": true }, { "comment": "/**\r\n * This method will copy the given Render Target to the game canvas using the `gameShader`.\r\n *\r\n * Unless you've changed it, the `gameShader` copies the target without modifying it, just\r\n * ensuring it is placed in the correct location on the canvas.\r\n *\r\n * If you wish to draw the target with and apply the fragment shader at the same time,\r\n * see the `drawToGame` method instead.\r\n *\r\n * This method should be the final thing called in your pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#copyToGame\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to copy to the game.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 670, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "copyToGame", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#copyToGame", "kind": "function", "description": "This method will copy the given Render Target to the game canvas using the `gameShader`.\r\rUnless you've changed it, the `gameShader` copies the target without modifying it, just\rensuring it is placed in the correct location on the canvas.\r\rIf you wish to draw the target with and apply the fragment shader at the same time,\rsee the `drawToGame` method instead.\r\rThis method should be the final thing called in your pipeline.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to copy to the game.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#copyToGame", "inherited": true, "___id": "T000002R056015", "___s": true }, { "comment": "/**\r\n * This method is called by `drawToGame` and `copyToGame`. It takes the source Render Target\r\n * and copies it back to the game canvas, or the next frame buffer in the stack, and should\r\n * be considered the very last thing this pipeline does.\r\n *\r\n * You don't normally need to call this method, or override it, however it is left public\r\n * should you wish to do so.\r\n *\r\n * Note that it does _not_ set a shader. You should do this yourself if invoking this.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#bindAndDraw\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The Render Target to draw to the game.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 695, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "bindAndDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#bindAndDraw", "kind": "function", "description": "This method is called by `drawToGame` and `copyToGame`. It takes the source Render Target\rand copies it back to the game canvas, or the next frame buffer in the stack, and should\rbe considered the very last thing this pipeline does.\r\rYou don't normally need to call this method, or override it, however it is left public\rshould you wish to do so.\r\rNote that it does _not_ set a shader. You should do this yourself if invoking this.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target to draw to the game.", "name": "source" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#bindAndDraw", "inherited": true, "___id": "T000002R056016", "___s": true }, { "comment": "/**\r\n * Set the UV values for the 6 vertices that make up the quad used by the copy shader.\r\n *\r\n * Be sure to call `resetUVs` once you have finished manipulating the UV coordinates.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setUVs\r\n * @since 3.60.0\r\n *\r\n * @param {number} uA - The u value of vertex A.\r\n * @param {number} vA - The v value of vertex A.\r\n * @param {number} uB - The u value of vertex B.\r\n * @param {number} vB - The v value of vertex B.\r\n * @param {number} uC - The u value of vertex C.\r\n * @param {number} vC - The v value of vertex C.\r\n * @param {number} uD - The u value of vertex D.\r\n * @param {number} vD - The v value of vertex D.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 801, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "setUVs", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#setUVs", "kind": "function", "description": "Set the UV values for the 6 vertices that make up the quad used by the copy shader.\r\rBe sure to call `resetUVs` once you have finished manipulating the UV coordinates.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The u value of vertex A.", "name": "uA" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The v value of vertex A.", "name": "vA" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The u value of vertex B.", "name": "uB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The v value of vertex B.", "name": "vB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The u value of vertex C.", "name": "uC" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The v value of vertex C.", "name": "vC" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The u value of vertex D.", "name": "uD" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The v value of vertex D.", "name": "vD" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setUVs", "inherited": true, "___id": "T000002R056017", "___s": true }, { "comment": "/**\r\n * Sets the vertex UV coordinates of the quad used by the copy shaders\r\n * so that they correctly adjust the texture coordinates for a blit frame effect.\r\n *\r\n * Be sure to call `resetUVs` once you have finished manipulating the UV coordinates.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setTargetUVs\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} source - The source Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} target - The target Render Target.\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 841, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "setTargetUVs", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#setTargetUVs", "kind": "function", "description": "Sets the vertex UV coordinates of the quad used by the copy shaders\rso that they correctly adjust the texture coordinates for a blit frame effect.\r\rBe sure to call `resetUVs` once you have finished manipulating the UV coordinates.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The source Render Target.", "name": "source" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The target Render Target.", "name": "target" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#setTargetUVs", "inherited": true, "___id": "T000002R056018", "___s": true }, { "comment": "/**\r\n * Resets the quad vertice UV values to their default settings.\r\n *\r\n * The quad is used by the copy shader in this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#resetUVs\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PreFXPipeline.js", "lineno": 869, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "resetUVs", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#resetUVs", "kind": "function", "description": "Resets the quad vertice UV values to their default settings.\r\rThe quad is used by the copy shader in this pipeline.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.PreFXPipeline#resetUVs", "inherited": true, "___id": "T000002R056019", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R056020", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R056021", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R056022", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R056023", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R056024", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R056025", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R056026", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R056027", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R056028", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R056029", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R056030", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R056031", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R056032", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R056033", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R056034", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R056035", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R056036", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R056037", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R056038", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R056039", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R056040", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R056041", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R056042", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R056043", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R056044", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R056045", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R056046", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R056047", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R056048", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R056049", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R056050", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R056051", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R056052", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R056053", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R056054", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R056055", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R056056", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R056057", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R056058", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R056059", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R056060", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R056061", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R056062", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R056063", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R056064", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R056065", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R056066", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R056067", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R056068", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R056069", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R056070", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R056071", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R056072", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R056073", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056074", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056075", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R056076", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R056077", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R056078", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056079", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R056080", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056081", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056082", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056083", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R056084", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R056085", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R056086", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R056087", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R056088", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R056089", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R056090", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R056091", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R056092", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R056093", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R056094", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056095", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056096", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056097", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056098", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056099", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056100", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056101", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056102", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056103", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056104", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056105", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056106", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056107", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056108", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056109", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056110", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056111", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056112", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056113", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056114", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056115", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R056116", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R056117", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R056118", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R056119", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R056120", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R056121", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R056122", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R056123", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R056124", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R056125", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.FXPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.FXPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R056126", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R056127", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R056128", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R056129", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R056130", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R056131", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R056132", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R056133", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R056134", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R056135", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R056136", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R056137", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R056138", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R056139", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R056140", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R056141", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R056142", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R056143", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R056144", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R056145", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R056146", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R056147", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R056148", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R056149", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R056150", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R056151", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R056152", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R056153", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R056154", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R056155", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R056156", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R056157", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R056158", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R056159", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R056160", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R056161", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R056162", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R056163", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "___id": "T000002R056164", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "___id": "T000002R056165", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "___id": "T000002R056166", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "___id": "T000002R056167", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "___id": "T000002R056168", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "___id": "T000002R056169", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "___id": "T000002R056170", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "___id": "T000002R056171", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "___id": "T000002R056172", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R056173", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "___id": "T000002R056174", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "___id": "T000002R056175", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "___id": "T000002R056176", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R056177", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "___id": "T000002R056178", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "___id": "T000002R056179", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "___id": "T000002R056180", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "___id": "T000002R056181", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "___id": "T000002R056182", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "___id": "T000002R056183", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R056184", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "___id": "T000002R056185", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "___id": "T000002R056186", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "___id": "T000002R056187", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R056188", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "___id": "T000002R056189", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "___id": "T000002R056190", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "___id": "T000002R056191", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R056192", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "___id": "T000002R056193", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R056194", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "___id": "T000002R056195", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "___id": "T000002R056196", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "___id": "T000002R056197", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "___id": "T000002R056198", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "___id": "T000002R056199", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "___id": "T000002R056200", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "___id": "T000002R056201", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "___id": "T000002R056202", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "___id": "T000002R056203", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "___id": "T000002R056204", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "___id": "T000002R056205", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "___id": "T000002R056206", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "___id": "T000002R056207", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "___id": "T000002R056208", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "___id": "T000002R056209", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "___id": "T000002R056210", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "___id": "T000002R056211", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "___id": "T000002R056212", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "___id": "T000002R056213", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "___id": "T000002R056214", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "___id": "T000002R056215", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "___id": "T000002R056216", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "___id": "T000002R056217", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "___id": "T000002R056218", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "___id": "T000002R056219", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "___id": "T000002R056220", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "___id": "T000002R056221", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "___id": "T000002R056222", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "___id": "T000002R056223", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "___id": "T000002R056224", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R056225", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R056226", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R056227", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R056228", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R056229", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R056230", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R056231", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R056232", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R056233", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R056234", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R056235", "___s": true }, { "comment": "/**\r\n * A temporary Transform Matrix, re-used internally during batching by the\r\n * Shape Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.MultiPipeline#calcMatrix\r\n * @type {Phaser.GameObjects.Components.TransformMatrix}\r\n * @since 3.55.0\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "calcMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#calcMatrix", "kind": "member", "description": "A temporary Transform Matrix, re-used internally during batching by the\rShape Game Objects.", "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#calcMatrix", "inherited": true, "___id": "T000002R056238", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * Rectangle factors in the given transform matrices before adding to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillRect\r\n * @since 3.55.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 653, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#batchFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rRectangle factors in the given transform matrices before adding to the batch.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillRect", "inherited": true, "___id": "T000002R056246", "___s": true }, { "comment": "/**\r\n * Pushes a filled triangle into the vertex batch.\r\n *\r\n * Triangle factors in the given transform matrices before adding to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillTriangle\r\n * @since 3.55.0\r\n *\r\n * @param {number} x0 - Point 0 x coordinate.\r\n * @param {number} y0 - Point 0 y coordinate.\r\n * @param {number} x1 - Point 1 x coordinate.\r\n * @param {number} y1 - Point 1 y coordinate.\r\n * @param {number} x2 - Point 2 x coordinate.\r\n * @param {number} y2 - Point 2 y coordinate.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 687, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchFillTriangle", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#batchFillTriangle", "kind": "function", "description": "Pushes a filled triangle into the vertex batch.\r\rTriangle factors in the given transform matrices before adding to the batch.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 x coordinate.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 y coordinate.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 x coordinate.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 y coordinate.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 x coordinate.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 y coordinate.", "name": "y2" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillTriangle", "inherited": true, "___id": "T000002R056247", "___s": true }, { "comment": "/**\r\n * Pushes a stroked triangle into the vertex batch.\r\n *\r\n * Triangle factors in the given transform matrices before adding to the batch.\r\n *\r\n * The triangle is created from 3 lines and drawn using the `batchStrokePath` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokeTriangle\r\n * @since 3.55.0\r\n *\r\n * @param {number} x0 - Point 0 x coordinate.\r\n * @param {number} y0 - Point 0 y coordinate.\r\n * @param {number} x1 - Point 1 x coordinate.\r\n * @param {number} y1 - Point 1 y coordinate.\r\n * @param {number} x2 - Point 2 x coordinate.\r\n * @param {number} y2 - Point 2 y coordinate.\r\n * @param {number} lineWidth - The width of the line in pixels.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 730, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchStrokeTriangle", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#batchStrokeTriangle", "kind": "function", "description": "Pushes a stroked triangle into the vertex batch.\r\rTriangle factors in the given transform matrices before adding to the batch.\r\rThe triangle is created from 3 lines and drawn using the `batchStrokePath` method.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 x coordinate.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 y coordinate.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 x coordinate.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 y coordinate.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 x coordinate.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 y coordinate.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the line in pixels.", "name": "lineWidth" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokeTriangle", "inherited": true, "___id": "T000002R056248", "___s": true }, { "comment": "/**\r\n * Adds the given path to the vertex batch for rendering.\r\n *\r\n * It works by taking the array of path data and then passing it through Earcut, which\r\n * creates a list of polygons. Each polygon is then added to the batch.\r\n *\r\n * The path is always automatically closed because it's filled.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillPath\r\n * @since 3.55.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like[]} path - Collection of points that represent the path.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchFillPath", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#batchFillPath", "kind": "function", "description": "Adds the given path to the vertex batch for rendering.\r\rIt works by taking the array of path data and then passing it through Earcut, which\rcreates a list of polygons. Each polygon is then added to the batch.\r\rThe path is always automatically closed because it's filled.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "description": "Collection of points that represent the path.", "name": "path" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillPath", "inherited": true, "___id": "T000002R056249", "___s": true }, { "comment": "/**\r\n * Adds the given path to the vertex batch for rendering.\r\n *\r\n * It works by taking the array of path data and calling `batchLine` for each section\r\n * of the path.\r\n *\r\n * The path is optionally closed at the end.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokePath\r\n * @since 3.55.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like[]} path - Collection of points that represent the path.\r\n * @param {number} lineWidth - The width of the line segments in pixels.\r\n * @param {boolean} pathOpen - Indicates if the path should be closed or left open.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 846, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchStrokePath", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#batchStrokePath", "kind": "function", "description": "Adds the given path to the vertex batch for rendering.\r\rIt works by taking the array of path data and calling `batchLine` for each section\rof the path.\r\rThe path is optionally closed at the end.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "description": "Collection of points that represent the path.", "name": "path" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the line segments in pixels.", "name": "lineWidth" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates if the path should be closed or left open.", "name": "pathOpen" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokePath", "inherited": true, "___id": "T000002R056250", "___s": true }, { "comment": "/**\r\n * Creates a line out of 4 quads and adds it to the vertex batch based on the given line values.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchLine\r\n * @since 3.55.0\r\n *\r\n * @param {number} ax - x coordinate of the start of the line.\r\n * @param {number} ay - y coordinate of the start of the line.\r\n * @param {number} bx - x coordinate of the end of the line.\r\n * @param {number} by - y coordinate of the end of the line.\r\n * @param {number} aLineWidth - Width of the start of the line.\r\n * @param {number} bLineWidth - Width of the end of the line.\r\n * @param {number} index - If this line is part of a multi-line draw, the index of the line in the draw.\r\n * @param {boolean} closePath - Does this line close a multi-line path?\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 894, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchLine", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#batchLine", "kind": "function", "description": "Creates a line out of 4 quads and adds it to the vertex batch based on the given line values.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "x coordinate of the start of the line.", "name": "ax" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "y coordinate of the start of the line.", "name": "ay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "x coordinate of the end of the line.", "name": "bx" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "y coordinate of the end of the line.", "name": "by" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the start of the line.", "name": "aLineWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the end of the line.", "name": "bLineWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "If this line is part of a multi-line draw, the index of the line in the draw.", "name": "index" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Does this line close a multi-line path?", "name": "closePath" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchLine", "inherited": true, "___id": "T000002R056251", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#destroy\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#DESTROY\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 1013, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:DESTROY" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#destroy", "inherited": true, "___id": "T000002R056252", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R056253", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R056254", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R056255", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R056256", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R056257", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R056258", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R056259", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R056260", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R056261", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R056262", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R056263", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R056264", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R056265", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R056266", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R056267", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R056268", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R056269", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R056270", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R056271", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R056272", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R056273", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R056274", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R056275", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R056276", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R056277", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R056278", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R056279", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R056280", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R056281", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R056282", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R056283", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R056284", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R056285", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R056286", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R056287", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R056288", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R056289", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R056290", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R056291", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R056292", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R056293", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R056294", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R056295", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R056296", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R056297", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R056298", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R056299", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R056300", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R056301", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R056302", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R056303", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R056304", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R056305", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056306", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056307", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R056308", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R056309", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R056310", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R056311", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056312", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R056313", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056314", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056315", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056316", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R056317", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R056318", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R056319", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R056320", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R056321", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R056322", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R056323", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R056324", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R056325", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R056326", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056327", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056328", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056329", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056330", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056331", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056332", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056333", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056334", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056335", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056336", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056337", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056338", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056339", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056340", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056341", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056342", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056343", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056344", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056345", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056346", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056347", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R056348", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R056349", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R056350", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R056351", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R056352", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R056353", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R056354", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R056355", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R056356", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R056357", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.LightPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.LightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R056358", "___s": true }, { "comment": "/**\r\n * A temporary Transform Matrix, re-used internally during batching by the\r\n * Shape Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.MultiPipeline#calcMatrix\r\n * @type {Phaser.GameObjects.Components.TransformMatrix}\r\n * @since 3.55.0\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "calcMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#calcMatrix", "kind": "member", "description": "A temporary Transform Matrix, re-used internally during batching by the\rShape Game Objects.", "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#calcMatrix", "inherited": true, "___id": "T000002R056362", "___s": true }, { "comment": "/**\r\n * Takes a Sprite Game Object, or any object that extends it, and adds it to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchSprite\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.Image|Phaser.GameObjects.Sprite)} gameObject - The texture based Game Object to add to the batch.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use for the rendering transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentTransformMatrix] - The transform matrix of the parent container, if set.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 287, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchSprite", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#batchSprite", "kind": "function", "description": "Takes a Sprite Game Object, or any object that extends it, and adds it to the batch.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.Image", "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.Image" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } ] } }, "description": "The texture based Game Object to add to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use for the rendering transform.", "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 set.", "name": "parentTransformMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchSprite", "inherited": true, "___id": "T000002R056370", "___s": true }, { "comment": "/**\r\n * Generic function for batching a textured quad using argument values instead of a Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTexture\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - Source GameObject.\r\n * @param {WebGLTexture} texture - Raw WebGLTexture associated with the quad.\r\n * @param {number} textureWidth - Real texture width.\r\n * @param {number} textureHeight - Real texture height.\r\n * @param {number} srcX - X coordinate of the quad.\r\n * @param {number} srcY - Y coordinate of the quad.\r\n * @param {number} srcWidth - Width of the quad.\r\n * @param {number} srcHeight - Height of the quad.\r\n * @param {number} scaleX - X component of scale.\r\n * @param {number} scaleY - Y component of scale.\r\n * @param {number} rotation - Rotation of the quad.\r\n * @param {boolean} flipX - Indicates if the quad is horizontally flipped.\r\n * @param {boolean} flipY - Indicates if the quad is vertically flipped.\r\n * @param {number} scrollFactorX - By which factor is the quad affected by the camera horizontal scroll.\r\n * @param {number} scrollFactorY - By which factor is the quad effected by the camera vertical scroll.\r\n * @param {number} displayOriginX - Horizontal origin in pixels.\r\n * @param {number} displayOriginY - Vertical origin in pixels.\r\n * @param {number} frameX - X coordinate of the texture frame.\r\n * @param {number} frameY - Y coordinate of the texture frame.\r\n * @param {number} frameWidth - Width of the texture frame.\r\n * @param {number} frameHeight - Height of the texture frame.\r\n * @param {number} tintTL - Tint for top left.\r\n * @param {number} tintTR - Tint for top right.\r\n * @param {number} tintBL - Tint for bottom left.\r\n * @param {number} tintBR - Tint for bottom right.\r\n * @param {number} tintEffect - The tint effect.\r\n * @param {number} uOffset - Horizontal offset on texture coordinate.\r\n * @param {number} vOffset - Vertical offset on texture coordinate.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - Current used camera.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentTransformMatrix - Parent container.\r\n * @param {boolean} [skipFlip=false] - Skip the renderTexture check.\r\n * @param {number} [textureUnit] - Use the currently bound texture unit?\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#batchTexture", "kind": "function", "description": "Generic function for batching a textured quad using argument values instead of a Game Object.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "Source GameObject.", "name": "gameObject" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "Raw WebGLTexture associated with the quad.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Real texture width.", "name": "textureWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Real texture height.", "name": "textureHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X coordinate of the quad.", "name": "srcX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y coordinate of the quad.", "name": "srcY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the quad.", "name": "srcWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the quad.", "name": "srcHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of scale.", "name": "scaleX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of scale.", "name": "scaleY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Rotation of the quad.", "name": "rotation" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates if the quad is horizontally flipped.", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates if the quad is vertically flipped.", "name": "flipY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "By which factor is the quad affected by the camera horizontal scroll.", "name": "scrollFactorX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "By which factor is the quad effected by the camera vertical scroll.", "name": "scrollFactorY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal origin in pixels.", "name": "displayOriginX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical origin in pixels.", "name": "displayOriginY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X coordinate of the texture frame.", "name": "frameX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y coordinate of the texture frame.", "name": "frameY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the texture frame.", "name": "frameWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the texture frame.", "name": "frameHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for top left.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for top right.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for bottom left.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for bottom right.", "name": "tintBR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint effect.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal offset on texture coordinate.", "name": "uOffset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical offset on texture coordinate.", "name": "vOffset" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "Current used camera.", "name": "camera" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "Parent container.", "name": "parentTransformMatrix" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip the renderTexture check.", "name": "skipFlip" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Use the currently bound texture unit?", "name": "textureUnit" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTexture", "inherited": true, "___id": "T000002R056371", "___s": true }, { "comment": "/**\r\n * Adds a Texture Frame into the batch for rendering.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTextureFrame\r\n * @since 3.12.0\r\n *\r\n * @param {Phaser.Textures.Frame} frame - The Texture Frame to be rendered.\r\n * @param {number} x - The horizontal position to render the texture at.\r\n * @param {number} y - The vertical position to render the texture at.\r\n * @param {number} tint - The tint color.\r\n * @param {number} alpha - The alpha value.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} transformMatrix - The Transform Matrix to use for the texture.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentTransformMatrix] - A parent Transform Matrix.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 608, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchTextureFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#batchTextureFrame", "kind": "function", "description": "Adds a Texture Frame into the batch for rendering.", "since": "3.12.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "description": "The Texture Frame to be rendered.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position to render the texture at.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position to render the texture at.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color.", "name": "tint" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha value.", "name": "alpha" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The Transform Matrix to use for the texture.", "name": "transformMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "A parent Transform Matrix.", "name": "parentTransformMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTextureFrame", "inherited": true, "___id": "T000002R056372", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * Rectangle factors in the given transform matrices before adding to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillRect\r\n * @since 3.55.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 653, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#batchFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rRectangle factors in the given transform matrices before adding to the batch.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillRect", "inherited": true, "___id": "T000002R056373", "___s": true }, { "comment": "/**\r\n * Pushes a filled triangle into the vertex batch.\r\n *\r\n * Triangle factors in the given transform matrices before adding to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillTriangle\r\n * @since 3.55.0\r\n *\r\n * @param {number} x0 - Point 0 x coordinate.\r\n * @param {number} y0 - Point 0 y coordinate.\r\n * @param {number} x1 - Point 1 x coordinate.\r\n * @param {number} y1 - Point 1 y coordinate.\r\n * @param {number} x2 - Point 2 x coordinate.\r\n * @param {number} y2 - Point 2 y coordinate.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 687, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchFillTriangle", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#batchFillTriangle", "kind": "function", "description": "Pushes a filled triangle into the vertex batch.\r\rTriangle factors in the given transform matrices before adding to the batch.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 x coordinate.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 y coordinate.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 x coordinate.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 y coordinate.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 x coordinate.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 y coordinate.", "name": "y2" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillTriangle", "inherited": true, "___id": "T000002R056374", "___s": true }, { "comment": "/**\r\n * Pushes a stroked triangle into the vertex batch.\r\n *\r\n * Triangle factors in the given transform matrices before adding to the batch.\r\n *\r\n * The triangle is created from 3 lines and drawn using the `batchStrokePath` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokeTriangle\r\n * @since 3.55.0\r\n *\r\n * @param {number} x0 - Point 0 x coordinate.\r\n * @param {number} y0 - Point 0 y coordinate.\r\n * @param {number} x1 - Point 1 x coordinate.\r\n * @param {number} y1 - Point 1 y coordinate.\r\n * @param {number} x2 - Point 2 x coordinate.\r\n * @param {number} y2 - Point 2 y coordinate.\r\n * @param {number} lineWidth - The width of the line in pixels.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 730, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchStrokeTriangle", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#batchStrokeTriangle", "kind": "function", "description": "Pushes a stroked triangle into the vertex batch.\r\rTriangle factors in the given transform matrices before adding to the batch.\r\rThe triangle is created from 3 lines and drawn using the `batchStrokePath` method.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 x coordinate.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 y coordinate.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 x coordinate.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 y coordinate.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 x coordinate.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 y coordinate.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the line in pixels.", "name": "lineWidth" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokeTriangle", "inherited": true, "___id": "T000002R056375", "___s": true }, { "comment": "/**\r\n * Adds the given path to the vertex batch for rendering.\r\n *\r\n * It works by taking the array of path data and then passing it through Earcut, which\r\n * creates a list of polygons. Each polygon is then added to the batch.\r\n *\r\n * The path is always automatically closed because it's filled.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillPath\r\n * @since 3.55.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like[]} path - Collection of points that represent the path.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchFillPath", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#batchFillPath", "kind": "function", "description": "Adds the given path to the vertex batch for rendering.\r\rIt works by taking the array of path data and then passing it through Earcut, which\rcreates a list of polygons. Each polygon is then added to the batch.\r\rThe path is always automatically closed because it's filled.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "description": "Collection of points that represent the path.", "name": "path" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillPath", "inherited": true, "___id": "T000002R056376", "___s": true }, { "comment": "/**\r\n * Adds the given path to the vertex batch for rendering.\r\n *\r\n * It works by taking the array of path data and calling `batchLine` for each section\r\n * of the path.\r\n *\r\n * The path is optionally closed at the end.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokePath\r\n * @since 3.55.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like[]} path - Collection of points that represent the path.\r\n * @param {number} lineWidth - The width of the line segments in pixels.\r\n * @param {boolean} pathOpen - Indicates if the path should be closed or left open.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 846, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchStrokePath", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#batchStrokePath", "kind": "function", "description": "Adds the given path to the vertex batch for rendering.\r\rIt works by taking the array of path data and calling `batchLine` for each section\rof the path.\r\rThe path is optionally closed at the end.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "description": "Collection of points that represent the path.", "name": "path" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the line segments in pixels.", "name": "lineWidth" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates if the path should be closed or left open.", "name": "pathOpen" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokePath", "inherited": true, "___id": "T000002R056377", "___s": true }, { "comment": "/**\r\n * Creates a line out of 4 quads and adds it to the vertex batch based on the given line values.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchLine\r\n * @since 3.55.0\r\n *\r\n * @param {number} ax - x coordinate of the start of the line.\r\n * @param {number} ay - y coordinate of the start of the line.\r\n * @param {number} bx - x coordinate of the end of the line.\r\n * @param {number} by - y coordinate of the end of the line.\r\n * @param {number} aLineWidth - Width of the start of the line.\r\n * @param {number} bLineWidth - Width of the end of the line.\r\n * @param {number} index - If this line is part of a multi-line draw, the index of the line in the draw.\r\n * @param {boolean} closePath - Does this line close a multi-line path?\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 894, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchLine", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#batchLine", "kind": "function", "description": "Creates a line out of 4 quads and adds it to the vertex batch based on the given line values.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "x coordinate of the start of the line.", "name": "ax" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "y coordinate of the start of the line.", "name": "ay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "x coordinate of the end of the line.", "name": "bx" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "y coordinate of the end of the line.", "name": "by" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the start of the line.", "name": "aLineWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the end of the line.", "name": "bLineWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "If this line is part of a multi-line draw, the index of the line in the draw.", "name": "index" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Does this line close a multi-line path?", "name": "closePath" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchLine", "inherited": true, "___id": "T000002R056378", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#destroy\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#DESTROY\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 1013, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:DESTROY" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#destroy", "inherited": true, "___id": "T000002R056379", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R056380", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R056381", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R056382", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R056383", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R056384", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R056385", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R056386", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R056387", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R056388", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R056389", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R056390", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R056391", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R056392", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R056393", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R056394", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R056395", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R056396", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R056397", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R056398", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R056399", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R056400", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R056401", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R056402", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R056403", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R056404", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R056405", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R056406", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R056407", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R056408", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R056409", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R056410", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R056411", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R056412", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R056413", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R056414", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R056415", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R056416", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R056417", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R056418", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R056419", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R056420", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R056421", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R056422", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R056423", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R056424", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R056425", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R056426", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R056427", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R056428", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R056429", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R056430", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R056431", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R056432", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R056433", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056434", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056435", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R056436", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R056437", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R056438", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R056439", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056440", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R056441", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056442", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056443", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056444", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R056445", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R056446", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R056447", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R056448", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R056449", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R056450", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R056451", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R056452", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R056453", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R056454", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R056455", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R056456", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056457", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056458", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056459", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056460", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056461", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056462", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056463", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056464", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056465", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056466", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056467", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056468", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056469", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056470", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056471", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056472", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056473", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056474", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056475", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056476", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056477", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R056478", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R056479", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R056480", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R056481", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R056482", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R056483", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R056484", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R056485", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R056486", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R056487", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.MobilePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R056488", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R056489", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R056490", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R056491", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R056492", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R056493", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R056494", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R056495", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R056496", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R056497", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R056498", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R056499", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R056500", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R056501", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R056502", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R056503", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R056504", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R056505", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R056506", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R056507", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R056508", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R056509", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R056510", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R056511", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R056512", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R056513", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R056514", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R056515", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R056516", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R056517", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R056518", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R056519", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R056520", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R056521", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R056522", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R056523", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R056524", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R056525", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R056526", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "___id": "T000002R056527", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "___id": "T000002R056528", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "___id": "T000002R056529", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "___id": "T000002R056530", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "___id": "T000002R056531", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "___id": "T000002R056532", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "___id": "T000002R056533", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "___id": "T000002R056534", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "___id": "T000002R056535", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R056536", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "___id": "T000002R056537", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "___id": "T000002R056538", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "___id": "T000002R056539", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R056540", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "___id": "T000002R056541", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "___id": "T000002R056542", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "___id": "T000002R056543", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "___id": "T000002R056544", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "___id": "T000002R056545", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "___id": "T000002R056546", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R056547", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "___id": "T000002R056548", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "___id": "T000002R056549", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "___id": "T000002R056550", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R056551", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "___id": "T000002R056552", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "___id": "T000002R056553", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "___id": "T000002R056554", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R056555", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "___id": "T000002R056556", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R056557", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "___id": "T000002R056558", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "___id": "T000002R056559", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "___id": "T000002R056560", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "___id": "T000002R056561", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "___id": "T000002R056562", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "___id": "T000002R056563", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "___id": "T000002R056564", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "___id": "T000002R056565", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "___id": "T000002R056566", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "___id": "T000002R056567", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "___id": "T000002R056568", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "___id": "T000002R056569", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "___id": "T000002R056570", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "___id": "T000002R056571", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "___id": "T000002R056572", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "___id": "T000002R056573", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "___id": "T000002R056574", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "___id": "T000002R056575", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "___id": "T000002R056576", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "___id": "T000002R056577", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "___id": "T000002R056578", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "___id": "T000002R056579", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "___id": "T000002R056580", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "___id": "T000002R056581", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "___id": "T000002R056582", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "___id": "T000002R056583", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "___id": "T000002R056584", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "___id": "T000002R056585", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "___id": "T000002R056586", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "___id": "T000002R056587", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#destroy\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#DESTROY\r\n * @since 3.0.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2551, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:DESTROY" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#destroy", "inherited": true, "___id": "T000002R056588", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R056589", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R056590", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R056591", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R056592", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R056593", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R056594", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R056595", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R056596", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R056597", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R056598", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.PointLightPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R056599", "___s": true }, { "comment": "/**\r\n * A temporary Transform Matrix, re-used internally during batching by the\r\n * Shape Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.MultiPipeline#calcMatrix\r\n * @type {Phaser.GameObjects.Components.TransformMatrix}\r\n * @since 3.55.0\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "calcMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#calcMatrix", "kind": "member", "description": "A temporary Transform Matrix, re-used internally during batching by the\rShape Game Objects.", "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#calcMatrix", "inherited": true, "___id": "T000002R056603", "___s": true }, { "comment": "/**\r\n * Called every time the pipeline is bound by the renderer.\r\n * Sets the shader program, vertex buffer and other resources.\r\n * Should only be called when changing pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#boot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#boot", "kind": "function", "description": "Called every time the pipeline is bound by the renderer.\rSets the shader program, vertex buffer and other resources.\rShould only be called when changing pipeline.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#boot", "inherited": true, "___id": "T000002R056611", "___s": true }, { "comment": "/**\r\n * Takes a Sprite Game Object, or any object that extends it, and adds it to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchSprite\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.Image|Phaser.GameObjects.Sprite)} gameObject - The texture based Game Object to add to the batch.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use for the rendering transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentTransformMatrix] - The transform matrix of the parent container, if set.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 287, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchSprite", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#batchSprite", "kind": "function", "description": "Takes a Sprite Game Object, or any object that extends it, and adds it to the batch.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.Image", "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.Image" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } ] } }, "description": "The texture based Game Object to add to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use for the rendering transform.", "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 set.", "name": "parentTransformMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchSprite", "inherited": true, "___id": "T000002R056612", "___s": true }, { "comment": "/**\r\n * Generic function for batching a textured quad using argument values instead of a Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTexture\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - Source GameObject.\r\n * @param {WebGLTexture} texture - Raw WebGLTexture associated with the quad.\r\n * @param {number} textureWidth - Real texture width.\r\n * @param {number} textureHeight - Real texture height.\r\n * @param {number} srcX - X coordinate of the quad.\r\n * @param {number} srcY - Y coordinate of the quad.\r\n * @param {number} srcWidth - Width of the quad.\r\n * @param {number} srcHeight - Height of the quad.\r\n * @param {number} scaleX - X component of scale.\r\n * @param {number} scaleY - Y component of scale.\r\n * @param {number} rotation - Rotation of the quad.\r\n * @param {boolean} flipX - Indicates if the quad is horizontally flipped.\r\n * @param {boolean} flipY - Indicates if the quad is vertically flipped.\r\n * @param {number} scrollFactorX - By which factor is the quad affected by the camera horizontal scroll.\r\n * @param {number} scrollFactorY - By which factor is the quad effected by the camera vertical scroll.\r\n * @param {number} displayOriginX - Horizontal origin in pixels.\r\n * @param {number} displayOriginY - Vertical origin in pixels.\r\n * @param {number} frameX - X coordinate of the texture frame.\r\n * @param {number} frameY - Y coordinate of the texture frame.\r\n * @param {number} frameWidth - Width of the texture frame.\r\n * @param {number} frameHeight - Height of the texture frame.\r\n * @param {number} tintTL - Tint for top left.\r\n * @param {number} tintTR - Tint for top right.\r\n * @param {number} tintBL - Tint for bottom left.\r\n * @param {number} tintBR - Tint for bottom right.\r\n * @param {number} tintEffect - The tint effect.\r\n * @param {number} uOffset - Horizontal offset on texture coordinate.\r\n * @param {number} vOffset - Vertical offset on texture coordinate.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - Current used camera.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentTransformMatrix - Parent container.\r\n * @param {boolean} [skipFlip=false] - Skip the renderTexture check.\r\n * @param {number} [textureUnit] - Use the currently bound texture unit?\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#batchTexture", "kind": "function", "description": "Generic function for batching a textured quad using argument values instead of a Game Object.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "Source GameObject.", "name": "gameObject" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "Raw WebGLTexture associated with the quad.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Real texture width.", "name": "textureWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Real texture height.", "name": "textureHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X coordinate of the quad.", "name": "srcX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y coordinate of the quad.", "name": "srcY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the quad.", "name": "srcWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the quad.", "name": "srcHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of scale.", "name": "scaleX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of scale.", "name": "scaleY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Rotation of the quad.", "name": "rotation" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates if the quad is horizontally flipped.", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates if the quad is vertically flipped.", "name": "flipY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "By which factor is the quad affected by the camera horizontal scroll.", "name": "scrollFactorX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "By which factor is the quad effected by the camera vertical scroll.", "name": "scrollFactorY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal origin in pixels.", "name": "displayOriginX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical origin in pixels.", "name": "displayOriginY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X coordinate of the texture frame.", "name": "frameX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y coordinate of the texture frame.", "name": "frameY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the texture frame.", "name": "frameWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the texture frame.", "name": "frameHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for top left.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for top right.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for bottom left.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for bottom right.", "name": "tintBR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint effect.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal offset on texture coordinate.", "name": "uOffset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical offset on texture coordinate.", "name": "vOffset" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "Current used camera.", "name": "camera" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "Parent container.", "name": "parentTransformMatrix" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip the renderTexture check.", "name": "skipFlip" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Use the currently bound texture unit?", "name": "textureUnit" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTexture", "inherited": true, "___id": "T000002R056613", "___s": true }, { "comment": "/**\r\n * Adds a Texture Frame into the batch for rendering.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTextureFrame\r\n * @since 3.12.0\r\n *\r\n * @param {Phaser.Textures.Frame} frame - The Texture Frame to be rendered.\r\n * @param {number} x - The horizontal position to render the texture at.\r\n * @param {number} y - The vertical position to render the texture at.\r\n * @param {number} tint - The tint color.\r\n * @param {number} alpha - The alpha value.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} transformMatrix - The Transform Matrix to use for the texture.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentTransformMatrix] - A parent Transform Matrix.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 608, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchTextureFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#batchTextureFrame", "kind": "function", "description": "Adds a Texture Frame into the batch for rendering.", "since": "3.12.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "description": "The Texture Frame to be rendered.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position to render the texture at.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position to render the texture at.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color.", "name": "tint" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha value.", "name": "alpha" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The Transform Matrix to use for the texture.", "name": "transformMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "A parent Transform Matrix.", "name": "parentTransformMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTextureFrame", "inherited": true, "___id": "T000002R056614", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * Rectangle factors in the given transform matrices before adding to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillRect\r\n * @since 3.55.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 653, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#batchFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rRectangle factors in the given transform matrices before adding to the batch.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillRect", "inherited": true, "___id": "T000002R056615", "___s": true }, { "comment": "/**\r\n * Pushes a filled triangle into the vertex batch.\r\n *\r\n * Triangle factors in the given transform matrices before adding to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillTriangle\r\n * @since 3.55.0\r\n *\r\n * @param {number} x0 - Point 0 x coordinate.\r\n * @param {number} y0 - Point 0 y coordinate.\r\n * @param {number} x1 - Point 1 x coordinate.\r\n * @param {number} y1 - Point 1 y coordinate.\r\n * @param {number} x2 - Point 2 x coordinate.\r\n * @param {number} y2 - Point 2 y coordinate.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 687, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchFillTriangle", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#batchFillTriangle", "kind": "function", "description": "Pushes a filled triangle into the vertex batch.\r\rTriangle factors in the given transform matrices before adding to the batch.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 x coordinate.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 y coordinate.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 x coordinate.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 y coordinate.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 x coordinate.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 y coordinate.", "name": "y2" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillTriangle", "inherited": true, "___id": "T000002R056616", "___s": true }, { "comment": "/**\r\n * Pushes a stroked triangle into the vertex batch.\r\n *\r\n * Triangle factors in the given transform matrices before adding to the batch.\r\n *\r\n * The triangle is created from 3 lines and drawn using the `batchStrokePath` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokeTriangle\r\n * @since 3.55.0\r\n *\r\n * @param {number} x0 - Point 0 x coordinate.\r\n * @param {number} y0 - Point 0 y coordinate.\r\n * @param {number} x1 - Point 1 x coordinate.\r\n * @param {number} y1 - Point 1 y coordinate.\r\n * @param {number} x2 - Point 2 x coordinate.\r\n * @param {number} y2 - Point 2 y coordinate.\r\n * @param {number} lineWidth - The width of the line in pixels.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 730, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchStrokeTriangle", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#batchStrokeTriangle", "kind": "function", "description": "Pushes a stroked triangle into the vertex batch.\r\rTriangle factors in the given transform matrices before adding to the batch.\r\rThe triangle is created from 3 lines and drawn using the `batchStrokePath` method.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 x coordinate.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 y coordinate.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 x coordinate.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 y coordinate.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 x coordinate.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 y coordinate.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the line in pixels.", "name": "lineWidth" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokeTriangle", "inherited": true, "___id": "T000002R056617", "___s": true }, { "comment": "/**\r\n * Adds the given path to the vertex batch for rendering.\r\n *\r\n * It works by taking the array of path data and then passing it through Earcut, which\r\n * creates a list of polygons. Each polygon is then added to the batch.\r\n *\r\n * The path is always automatically closed because it's filled.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillPath\r\n * @since 3.55.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like[]} path - Collection of points that represent the path.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchFillPath", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#batchFillPath", "kind": "function", "description": "Adds the given path to the vertex batch for rendering.\r\rIt works by taking the array of path data and then passing it through Earcut, which\rcreates a list of polygons. Each polygon is then added to the batch.\r\rThe path is always automatically closed because it's filled.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "description": "Collection of points that represent the path.", "name": "path" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillPath", "inherited": true, "___id": "T000002R056618", "___s": true }, { "comment": "/**\r\n * Adds the given path to the vertex batch for rendering.\r\n *\r\n * It works by taking the array of path data and calling `batchLine` for each section\r\n * of the path.\r\n *\r\n * The path is optionally closed at the end.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokePath\r\n * @since 3.55.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like[]} path - Collection of points that represent the path.\r\n * @param {number} lineWidth - The width of the line segments in pixels.\r\n * @param {boolean} pathOpen - Indicates if the path should be closed or left open.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 846, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchStrokePath", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#batchStrokePath", "kind": "function", "description": "Adds the given path to the vertex batch for rendering.\r\rIt works by taking the array of path data and calling `batchLine` for each section\rof the path.\r\rThe path is optionally closed at the end.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "description": "Collection of points that represent the path.", "name": "path" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the line segments in pixels.", "name": "lineWidth" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates if the path should be closed or left open.", "name": "pathOpen" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokePath", "inherited": true, "___id": "T000002R056619", "___s": true }, { "comment": "/**\r\n * Creates a line out of 4 quads and adds it to the vertex batch based on the given line values.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchLine\r\n * @since 3.55.0\r\n *\r\n * @param {number} ax - x coordinate of the start of the line.\r\n * @param {number} ay - y coordinate of the start of the line.\r\n * @param {number} bx - x coordinate of the end of the line.\r\n * @param {number} by - y coordinate of the end of the line.\r\n * @param {number} aLineWidth - Width of the start of the line.\r\n * @param {number} bLineWidth - Width of the end of the line.\r\n * @param {number} index - If this line is part of a multi-line draw, the index of the line in the draw.\r\n * @param {boolean} closePath - Does this line close a multi-line path?\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 894, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchLine", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#batchLine", "kind": "function", "description": "Creates a line out of 4 quads and adds it to the vertex batch based on the given line values.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "x coordinate of the start of the line.", "name": "ax" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "y coordinate of the start of the line.", "name": "ay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "x coordinate of the end of the line.", "name": "bx" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "y coordinate of the end of the line.", "name": "by" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the start of the line.", "name": "aLineWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the end of the line.", "name": "bLineWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "If this line is part of a multi-line draw, the index of the line in the draw.", "name": "index" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Does this line close a multi-line path?", "name": "closePath" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchLine", "inherited": true, "___id": "T000002R056620", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#destroy\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#DESTROY\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 1013, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:DESTROY" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#destroy", "inherited": true, "___id": "T000002R056621", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R056622", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R056623", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R056624", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R056625", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R056626", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R056627", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R056628", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R056629", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R056630", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R056631", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R056632", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R056633", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R056634", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R056635", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R056636", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R056637", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R056638", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R056639", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R056640", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R056641", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R056642", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R056643", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R056644", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R056645", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R056646", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R056647", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R056648", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R056649", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R056650", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R056651", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R056652", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R056653", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R056654", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R056655", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R056656", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R056657", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R056658", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R056659", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R056660", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R056661", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R056662", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R056663", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R056664", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R056665", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R056666", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R056667", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R056668", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R056669", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R056670", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R056671", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R056672", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R056673", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R056674", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R056675", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056676", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056677", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R056678", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R056679", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R056680", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R056681", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056682", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R056683", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056684", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056685", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056686", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R056687", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R056688", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R056689", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R056690", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R056691", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R056692", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R056693", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R056694", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R056695", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R056696", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R056697", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R056698", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056699", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056700", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056701", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056702", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056703", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056704", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056705", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056706", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056707", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056708", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056709", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056710", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056711", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056712", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056713", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056714", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056715", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056716", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056717", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056718", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056719", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R056720", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R056721", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R056722", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R056723", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R056724", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R056725", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R056726", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R056727", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R056728", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R056729", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.RopePipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.RopePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R056730", "___s": true }, { "comment": "/**\r\n * A temporary Transform Matrix, re-used internally during batching by the\r\n * Shape Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.Pipelines.MultiPipeline#calcMatrix\r\n * @type {Phaser.GameObjects.Components.TransformMatrix}\r\n * @since 3.55.0\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "calcMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#calcMatrix", "kind": "member", "description": "A temporary Transform Matrix, re-used internally during batching by the\rShape Game Objects.", "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#calcMatrix", "inherited": true, "___id": "T000002R056734", "___s": true }, { "comment": "/**\r\n * Called every time the pipeline is bound by the renderer.\r\n * Sets the shader program, vertex buffer and other resources.\r\n * Should only be called when changing pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#boot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 268, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#boot", "kind": "function", "description": "Called every time the pipeline is bound by the renderer.\rSets the shader program, vertex buffer and other resources.\rShould only be called when changing pipeline.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#boot", "inherited": true, "___id": "T000002R056742", "___s": true }, { "comment": "/**\r\n * Takes a Sprite Game Object, or any object that extends it, and adds it to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchSprite\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.Image|Phaser.GameObjects.Sprite)} gameObject - The texture based Game Object to add to the batch.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use for the rendering transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentTransformMatrix] - The transform matrix of the parent container, if set.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 287, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchSprite", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#batchSprite", "kind": "function", "description": "Takes a Sprite Game Object, or any object that extends it, and adds it to the batch.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.Image", "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.Image" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } ] } }, "description": "The texture based Game Object to add to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use for the rendering transform.", "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 set.", "name": "parentTransformMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchSprite", "inherited": true, "___id": "T000002R056743", "___s": true }, { "comment": "/**\r\n * Generic function for batching a textured quad using argument values instead of a Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTexture\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - Source GameObject.\r\n * @param {WebGLTexture} texture - Raw WebGLTexture associated with the quad.\r\n * @param {number} textureWidth - Real texture width.\r\n * @param {number} textureHeight - Real texture height.\r\n * @param {number} srcX - X coordinate of the quad.\r\n * @param {number} srcY - Y coordinate of the quad.\r\n * @param {number} srcWidth - Width of the quad.\r\n * @param {number} srcHeight - Height of the quad.\r\n * @param {number} scaleX - X component of scale.\r\n * @param {number} scaleY - Y component of scale.\r\n * @param {number} rotation - Rotation of the quad.\r\n * @param {boolean} flipX - Indicates if the quad is horizontally flipped.\r\n * @param {boolean} flipY - Indicates if the quad is vertically flipped.\r\n * @param {number} scrollFactorX - By which factor is the quad affected by the camera horizontal scroll.\r\n * @param {number} scrollFactorY - By which factor is the quad effected by the camera vertical scroll.\r\n * @param {number} displayOriginX - Horizontal origin in pixels.\r\n * @param {number} displayOriginY - Vertical origin in pixels.\r\n * @param {number} frameX - X coordinate of the texture frame.\r\n * @param {number} frameY - Y coordinate of the texture frame.\r\n * @param {number} frameWidth - Width of the texture frame.\r\n * @param {number} frameHeight - Height of the texture frame.\r\n * @param {number} tintTL - Tint for top left.\r\n * @param {number} tintTR - Tint for top right.\r\n * @param {number} tintBL - Tint for bottom left.\r\n * @param {number} tintBR - Tint for bottom right.\r\n * @param {number} tintEffect - The tint effect.\r\n * @param {number} uOffset - Horizontal offset on texture coordinate.\r\n * @param {number} vOffset - Vertical offset on texture coordinate.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - Current used camera.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentTransformMatrix - Parent container.\r\n * @param {boolean} [skipFlip=false] - Skip the renderTexture check.\r\n * @param {number} [textureUnit] - Use the currently bound texture unit?\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#batchTexture", "kind": "function", "description": "Generic function for batching a textured quad using argument values instead of a Game Object.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "Source GameObject.", "name": "gameObject" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "Raw WebGLTexture associated with the quad.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Real texture width.", "name": "textureWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Real texture height.", "name": "textureHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X coordinate of the quad.", "name": "srcX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y coordinate of the quad.", "name": "srcY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the quad.", "name": "srcWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the quad.", "name": "srcHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of scale.", "name": "scaleX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of scale.", "name": "scaleY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Rotation of the quad.", "name": "rotation" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates if the quad is horizontally flipped.", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates if the quad is vertically flipped.", "name": "flipY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "By which factor is the quad affected by the camera horizontal scroll.", "name": "scrollFactorX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "By which factor is the quad effected by the camera vertical scroll.", "name": "scrollFactorY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal origin in pixels.", "name": "displayOriginX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical origin in pixels.", "name": "displayOriginY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X coordinate of the texture frame.", "name": "frameX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y coordinate of the texture frame.", "name": "frameY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the texture frame.", "name": "frameWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the texture frame.", "name": "frameHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for top left.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for top right.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for bottom left.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Tint for bottom right.", "name": "tintBR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint effect.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal offset on texture coordinate.", "name": "uOffset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical offset on texture coordinate.", "name": "vOffset" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "Current used camera.", "name": "camera" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "Parent container.", "name": "parentTransformMatrix" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip the renderTexture check.", "name": "skipFlip" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Use the currently bound texture unit?", "name": "textureUnit" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTexture", "inherited": true, "___id": "T000002R056744", "___s": true }, { "comment": "/**\r\n * Adds a Texture Frame into the batch for rendering.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTextureFrame\r\n * @since 3.12.0\r\n *\r\n * @param {Phaser.Textures.Frame} frame - The Texture Frame to be rendered.\r\n * @param {number} x - The horizontal position to render the texture at.\r\n * @param {number} y - The vertical position to render the texture at.\r\n * @param {number} tint - The tint color.\r\n * @param {number} alpha - The alpha value.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} transformMatrix - The Transform Matrix to use for the texture.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentTransformMatrix] - A parent Transform Matrix.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 608, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchTextureFrame", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#batchTextureFrame", "kind": "function", "description": "Adds a Texture Frame into the batch for rendering.", "since": "3.12.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "description": "The Texture Frame to be rendered.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position to render the texture at.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position to render the texture at.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color.", "name": "tint" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha value.", "name": "alpha" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The Transform Matrix to use for the texture.", "name": "transformMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "A parent Transform Matrix.", "name": "parentTransformMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchTextureFrame", "inherited": true, "___id": "T000002R056745", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * Rectangle factors in the given transform matrices before adding to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillRect\r\n * @since 3.55.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 653, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#batchFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rRectangle factors in the given transform matrices before adding to the batch.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillRect", "inherited": true, "___id": "T000002R056746", "___s": true }, { "comment": "/**\r\n * Pushes a filled triangle into the vertex batch.\r\n *\r\n * Triangle factors in the given transform matrices before adding to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillTriangle\r\n * @since 3.55.0\r\n *\r\n * @param {number} x0 - Point 0 x coordinate.\r\n * @param {number} y0 - Point 0 y coordinate.\r\n * @param {number} x1 - Point 1 x coordinate.\r\n * @param {number} y1 - Point 1 y coordinate.\r\n * @param {number} x2 - Point 2 x coordinate.\r\n * @param {number} y2 - Point 2 y coordinate.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 687, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchFillTriangle", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#batchFillTriangle", "kind": "function", "description": "Pushes a filled triangle into the vertex batch.\r\rTriangle factors in the given transform matrices before adding to the batch.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 x coordinate.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 y coordinate.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 x coordinate.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 y coordinate.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 x coordinate.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 y coordinate.", "name": "y2" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillTriangle", "inherited": true, "___id": "T000002R056747", "___s": true }, { "comment": "/**\r\n * Pushes a stroked triangle into the vertex batch.\r\n *\r\n * Triangle factors in the given transform matrices before adding to the batch.\r\n *\r\n * The triangle is created from 3 lines and drawn using the `batchStrokePath` method.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokeTriangle\r\n * @since 3.55.0\r\n *\r\n * @param {number} x0 - Point 0 x coordinate.\r\n * @param {number} y0 - Point 0 y coordinate.\r\n * @param {number} x1 - Point 1 x coordinate.\r\n * @param {number} y1 - Point 1 y coordinate.\r\n * @param {number} x2 - Point 2 x coordinate.\r\n * @param {number} y2 - Point 2 y coordinate.\r\n * @param {number} lineWidth - The width of the line in pixels.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 730, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchStrokeTriangle", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#batchStrokeTriangle", "kind": "function", "description": "Pushes a stroked triangle into the vertex batch.\r\rTriangle factors in the given transform matrices before adding to the batch.\r\rThe triangle is created from 3 lines and drawn using the `batchStrokePath` method.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 x coordinate.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 0 y coordinate.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 x coordinate.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 1 y coordinate.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 x coordinate.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Point 2 y coordinate.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the line in pixels.", "name": "lineWidth" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokeTriangle", "inherited": true, "___id": "T000002R056748", "___s": true }, { "comment": "/**\r\n * Adds the given path to the vertex batch for rendering.\r\n *\r\n * It works by taking the array of path data and then passing it through Earcut, which\r\n * creates a list of polygons. Each polygon is then added to the batch.\r\n *\r\n * The path is always automatically closed because it's filled.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillPath\r\n * @since 3.55.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like[]} path - Collection of points that represent the path.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchFillPath", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#batchFillPath", "kind": "function", "description": "Adds the given path to the vertex batch for rendering.\r\rIt works by taking the array of path data and then passing it through Earcut, which\rcreates a list of polygons. Each polygon is then added to the batch.\r\rThe path is always automatically closed because it's filled.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "description": "Collection of points that represent the path.", "name": "path" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchFillPath", "inherited": true, "___id": "T000002R056749", "___s": true }, { "comment": "/**\r\n * Adds the given path to the vertex batch for rendering.\r\n *\r\n * It works by taking the array of path data and calling `batchLine` for each section\r\n * of the path.\r\n *\r\n * The path is optionally closed at the end.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokePath\r\n * @since 3.55.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like[]} path - Collection of points that represent the path.\r\n * @param {number} lineWidth - The width of the line segments in pixels.\r\n * @param {boolean} pathOpen - Indicates if the path should be closed or left open.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 846, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchStrokePath", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#batchStrokePath", "kind": "function", "description": "Adds the given path to the vertex batch for rendering.\r\rIt works by taking the array of path data and calling `batchLine` for each section\rof the path.\r\rThe path is optionally closed at the end.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "description": "Collection of points that represent the path.", "name": "path" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the line segments in pixels.", "name": "lineWidth" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates if the path should be closed or left open.", "name": "pathOpen" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchStrokePath", "inherited": true, "___id": "T000002R056750", "___s": true }, { "comment": "/**\r\n * Creates a line out of 4 quads and adds it to the vertex batch based on the given line values.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchLine\r\n * @since 3.55.0\r\n *\r\n * @param {number} ax - x coordinate of the start of the line.\r\n * @param {number} ay - y coordinate of the start of the line.\r\n * @param {number} bx - x coordinate of the end of the line.\r\n * @param {number} by - y coordinate of the end of the line.\r\n * @param {number} aLineWidth - Width of the start of the line.\r\n * @param {number} bLineWidth - Width of the end of the line.\r\n * @param {number} index - If this line is part of a multi-line draw, the index of the line in the draw.\r\n * @param {boolean} closePath - Does this line close a multi-line path?\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} currentMatrix - The current transform.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - The parent transform.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 894, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "batchLine", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#batchLine", "kind": "function", "description": "Creates a line out of 4 quads and adds it to the vertex batch based on the given line values.", "since": "3.55.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "x coordinate of the start of the line.", "name": "ax" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "y coordinate of the start of the line.", "name": "ay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "x coordinate of the end of the line.", "name": "bx" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "y coordinate of the end of the line.", "name": "by" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the start of the line.", "name": "aLineWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the end of the line.", "name": "bLineWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "If this line is part of a multi-line draw, the index of the line in the draw.", "name": "index" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Does this line close a multi-line path?", "name": "closePath" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The current transform.", "name": "currentMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The parent transform.", "name": "parentMatrix" } ], "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#batchLine", "inherited": true, "___id": "T000002R056751", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.Pipelines.MultiPipeline#destroy\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#DESTROY\r\n * @since 3.60.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "MultiPipeline.js", "lineno": 1013, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl\\pipelines", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:DESTROY" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.Pipelines.MultiPipeline#destroy", "inherited": true, "___id": "T000002R056752", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R056753", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R056754", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R056755", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R056756", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R056757", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R056758", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R056759", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R056760", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R056761", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R056762", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R056763", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R056764", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R056765", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R056766", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R056767", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R056768", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R056769", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R056770", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R056771", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R056772", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R056773", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R056774", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R056775", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R056776", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R056777", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R056778", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R056779", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R056780", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R056781", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R056782", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R056783", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R056784", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R056785", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R056786", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R056787", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R056788", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R056789", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R056790", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "___id": "T000002R056791", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "___id": "T000002R056792", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "___id": "T000002R056793", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R056794", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R056795", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "___id": "T000002R056796", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "___id": "T000002R056797", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "___id": "T000002R056798", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R056799", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R056800", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "___id": "T000002R056801", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "___id": "T000002R056802", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R056803", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R056804", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "___id": "T000002R056805", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "___id": "T000002R056806", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056807", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056808", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "___id": "T000002R056809", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R056810", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R056811", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "___id": "T000002R056812", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056813", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R056814", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056815", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056816", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "___id": "T000002R056817", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R056818", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "___id": "T000002R056819", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R056820", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R056821", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "___id": "T000002R056822", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "___id": "T000002R056823", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R056824", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "___id": "T000002R056825", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "___id": "T000002R056826", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "___id": "T000002R056827", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R056828", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "___id": "T000002R056829", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056830", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056831", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056832", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056833", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056834", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056835", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056836", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056837", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056838", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056839", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056840", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056841", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056842", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056843", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056844", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056845", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056846", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056847", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056848", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056849", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "___id": "T000002R056850", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R056851", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R056852", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R056853", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R056854", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R056855", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R056856", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R056857", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R056858", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R056859", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R056860", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.SinglePipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R056861", "___s": true }, { "comment": "/**\r\n * Name of the pipeline. Used for identification and setting from Game Objects.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "name", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#name", "kind": "member", "description": "Name of the pipeline. Used for identification and setting from Game Objects.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#name", "inherited": true, "___id": "T000002R056862", "___s": true }, { "comment": "/**\r\n * The Phaser Game instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#game\r\n * @type {Phaser.Game}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "game", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#game", "kind": "member", "description": "The Phaser Game instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#game", "inherited": true, "___id": "T000002R056863", "___s": true }, { "comment": "/**\r\n * The WebGL Renderer instance to which this pipeline is bound.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderer\r\n * @type {Phaser.Renderer.WebGL.WebGLRenderer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderer", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#renderer", "kind": "member", "description": "The WebGL Renderer instance to which this pipeline is bound.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderer", "inherited": true, "___id": "T000002R056864", "___s": true }, { "comment": "/**\r\n * A reference to the WebGL Pipeline Manager.\r\n *\r\n * This is initially undefined and only set when this pipeline is added\r\n * to the manager.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#manager\r\n * @type {?Phaser.Renderer.WebGL.PipelineManager}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "manager", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#manager", "kind": "member", "description": "A reference to the WebGL Pipeline Manager.\r\rThis is initially undefined and only set when this pipeline is added\rto the manager.", "type": { "names": [ "Phaser.Renderer.WebGL.PipelineManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.PipelineManager", "nullable": true } }, "nullable": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#manager", "inherited": true, "___id": "T000002R056865", "___s": true }, { "comment": "/**\r\n * The WebGL context this WebGL Pipeline uses.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#gl\r\n * @type {WebGLRenderingContext}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "gl", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#gl", "kind": "member", "description": "The WebGL context this WebGL Pipeline uses.", "type": { "names": [ "WebGLRenderingContext" ], "parsedType": { "type": "NameExpression", "name": "WebGLRenderingContext" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#gl", "inherited": true, "___id": "T000002R056866", "___s": true }, { "comment": "/**\r\n * The canvas which this WebGL Pipeline renders to.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#view\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "view", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#view", "kind": "member", "description": "The canvas which this WebGL Pipeline renders to.", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#view", "inherited": true, "___id": "T000002R056867", "___s": true }, { "comment": "/**\r\n * Width of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "width", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#width", "kind": "member", "description": "Width of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#width", "inherited": true, "___id": "T000002R056868", "___s": true }, { "comment": "/**\r\n * Height of the current viewport.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "height", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#height", "kind": "member", "description": "Height of the current viewport.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#height", "inherited": true, "___id": "T000002R056869", "___s": true }, { "comment": "/**\r\n * The current number of vertices that have been added to the pipeline batch.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCount", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#vertexCount", "kind": "member", "description": "The current number of vertices that have been added to the pipeline batch.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCount", "inherited": true, "___id": "T000002R056870", "___s": true }, { "comment": "/**\r\n * The total number of vertices that this pipeline batch can hold before it will flush.\r\n *\r\n * This defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexCapacity", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#vertexCapacity", "kind": "member", "description": "The total number of vertices that this pipeline batch can hold before it will flush.\r\rThis defaults to `renderer batchSize * 6`, where `batchSize` is defined in the Renderer Game Config.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity", "inherited": true, "___id": "T000002R056871", "___s": true }, { "comment": "/**\r\n * Raw byte buffer of vertices.\r\n *\r\n * Either set via the config object `vertices` property, or generates a new Array Buffer of\r\n * size `vertexCapacity * vertexSize`.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData\r\n * @type {ArrayBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexData", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#vertexData", "kind": "member", "description": "Raw byte buffer of vertices.\r\rEither set via the config object `vertices` property, or generates a new Array Buffer of\rsize `vertexCapacity * vertexSize`.", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexData", "inherited": true, "___id": "T000002R056872", "___s": true }, { "comment": "/**\r\n * The WebGLBuffer that holds the vertex data.\r\n *\r\n * Created from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\r\n * is created. If not, a `DYNAMIC_DRAW` buffer is created.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer\r\n * @type {WebGLBuffer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#vertexBuffer", "kind": "member", "description": "The WebGLBuffer that holds the vertex data.\r\rCreated from the `vertexData` ArrayBuffer. If `vertices` are set in the config, a `STATIC_DRAW` buffer\ris created. If not, a `DYNAMIC_DRAW` buffer is created.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer", "inherited": true, "___id": "T000002R056873", "___s": true }, { "comment": "/**\r\n * The currently active WebGLBuffer.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer\r\n * @type {WebGLBuffer}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#activeBuffer", "kind": "member", "description": "The currently active WebGLBuffer.", "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeBuffer", "inherited": true, "___id": "T000002R056874", "___s": true }, { "comment": "/**\r\n * The primitive topology which the pipeline will use to submit draw calls.\r\n *\r\n * Defaults to GL_TRIANGLES if not otherwise set in the config.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#topology\r\n * @type {GLenum}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "topology", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#topology", "kind": "member", "description": "The primitive topology which the pipeline will use to submit draw calls.\r\rDefaults to GL_TRIANGLES if not otherwise set in the config.", "type": { "names": [ "GLenum" ], "parsedType": { "type": "NameExpression", "name": "GLenum" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#topology", "inherited": true, "___id": "T000002R056875", "___s": true }, { "comment": "/**\r\n * Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#bytes\r\n * @type {Uint8Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bytes", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#bytes", "kind": "member", "description": "Uint8 view to the `vertexData` ArrayBuffer. Used for uploading vertex buffer resources to the GPU.", "type": { "names": [ "Uint8Array" ], "parsedType": { "type": "NameExpression", "name": "Uint8Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bytes", "inherited": true, "___id": "T000002R056876", "___s": true }, { "comment": "/**\r\n * Float32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 216, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewF32", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#vertexViewF32", "kind": "member", "description": "Float32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewF32", "inherited": true, "___id": "T000002R056877", "___s": true }, { "comment": "/**\r\n * Uint32 view of the array buffer containing the pipeline's vertices.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32\r\n * @type {Uint32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 225, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexViewU32", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#vertexViewU32", "kind": "member", "description": "Uint32 view of the array buffer containing the pipeline's vertices.", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexViewU32", "inherited": true, "___id": "T000002R056878", "___s": true }, { "comment": "/**\r\n * Indicates if the current pipeline is active, or not.\r\n *\r\n * Toggle this property to enable or disable a pipeline from rendering anything.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "active", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#active", "kind": "member", "description": "Indicates if the current pipeline is active, or not.\r\rToggle this property to enable or disable a pipeline from rendering anything.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#active", "inherited": true, "___id": "T000002R056879", "___s": true }, { "comment": "/**\r\n * Some pipelines require the forced use of texture zero (like the light pipeline).\r\n *\r\n * This property should be set when that is the case.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#forceZero\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "forceZero", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#forceZero", "kind": "member", "description": "Some pipelines require the forced use of texture zero (like the light pipeline).\r\rThis property should be set when that is the case.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#forceZero", "inherited": true, "___id": "T000002R056880", "___s": true }, { "comment": "/**\r\n * Indicates if this pipeline has booted or not.\r\n *\r\n * A pipeline boots only when the Game instance itself, and all associated systems, is\r\n * fully ready.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#hasBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 256, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "hasBooted", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#hasBooted", "kind": "member", "description": "Indicates if this pipeline has booted or not.\r\rA pipeline boots only when the Game instance itself, and all associated systems, is\rfully ready.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#hasBooted", "inherited": true, "___id": "T000002R056881", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Post FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPostFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPostFX", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#isPostFX", "kind": "member", "description": "Indicates if this is a Post FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPostFX", "inherited": true, "___id": "T000002R056882", "___s": true }, { "comment": "/**\r\n * Indicates if this is a Pre FX Pipeline, or not.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#isPreFX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 279, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "isPreFX", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#isPreFX", "kind": "member", "description": "Indicates if this is a Pre FX Pipeline, or not.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#isPreFX", "inherited": true, "___id": "T000002R056883", "___s": true }, { "comment": "/**\r\n * An array of RenderTarget instances that belong to this pipeline.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#renderTargets\r\n * @type {Phaser.Renderer.WebGL.RenderTarget[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "renderTargets", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#renderTargets", "kind": "member", "description": "An array of RenderTarget instances that belong to this pipeline.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.RenderTarget", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#renderTargets", "inherited": true, "___id": "T000002R056884", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget\r\n * @type {Phaser.Renderer.WebGL.RenderTarget}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#currentRenderTarget", "kind": "member", "description": "A reference to the currently bound Render Target instance from the `WebGLPipeline.renderTargets` array.", "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentRenderTarget", "inherited": true, "___id": "T000002R056885", "___s": true }, { "comment": "/**\r\n * An array of all the WebGLShader instances that belong to this pipeline.\r\n *\r\n * Shaders manage their own attributes and uniforms, but share the same vertex data buffer,\r\n * which belongs to this pipeline.\r\n *\r\n * Shaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\r\n * but can also be called at any point in your game. See the method documentation for details.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#shaders\r\n * @type {Phaser.Renderer.WebGL.WebGLShader[]}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shaders", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#shaders", "kind": "member", "description": "An array of all the WebGLShader instances that belong to this pipeline.\r\rShaders manage their own attributes and uniforms, but share the same vertex data buffer,\rwhich belongs to this pipeline.\r\rShaders are set in a call to the `setShadersFromConfig` method, which happens automatically,\rbut can also be called at any point in your game. See the method documentation for details.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.WebGLShader", "type": "NameExpression" } ] } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shaders", "inherited": true, "___id": "T000002R056886", "___s": true }, { "comment": "/**\r\n * A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\n *\r\n * For lots of pipelines, this is the only shader, so it is a quick way to reference it without\r\n * an array look-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentShader\r\n * @type {Phaser.Renderer.WebGL.WebGLShader}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 322, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentShader", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#currentShader", "kind": "member", "description": "A reference to the currently bound WebGLShader instance from the `WebGLPipeline.shaders` array.\r\rFor lots of pipelines, this is the only shader, so it is a quick way to reference it without\ran array look-up.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentShader", "inherited": true, "___id": "T000002R056887", "___s": true }, { "comment": "/**\r\n * The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 334, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#projectionMatrix", "kind": "member", "description": "The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionMatrix", "inherited": true, "___id": "T000002R056888", "___s": true }, { "comment": "/**\r\n * The cached width of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 343, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionWidth", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#projectionWidth", "kind": "member", "description": "The cached width of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionWidth", "inherited": true, "___id": "T000002R056889", "___s": true }, { "comment": "/**\r\n * The cached height of the Projection matrix.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "projectionHeight", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#projectionHeight", "kind": "member", "description": "The cached height of the Projection matrix.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#projectionHeight", "inherited": true, "___id": "T000002R056890", "___s": true }, { "comment": "/**\r\n * The configuration object that was used to create this pipeline.\r\n *\r\n * Treat this object as 'read only', because changing it post-creation will not\r\n * impact this pipeline in any way. However, it is used internally for cloning\r\n * and post-boot set-up.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#config\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "config", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#config", "kind": "member", "description": "The configuration object that was used to create this pipeline.\r\rTreat this object as 'read only', because changing it post-creation will not\rimpact this pipeline in any way. However, it is used internally for cloning\rand post-boot set-up.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#config", "inherited": true, "___id": "T000002R056891", "___s": true }, { "comment": "/**\r\n * Has the GL Context been reset to the Phaser defaults since the last time\r\n * this pipeline was bound? This is set automatically when the Pipeline Manager\r\n * resets itself, usually after handing off to a 3rd party renderer like Spine.\r\n *\r\n * You should treat this property as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#glReset\r\n * @type {boolean}\r\n * @since 3.53.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "glReset", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#glReset", "kind": "member", "description": "Has the GL Context been reset to the Phaser defaults since the last time\rthis pipeline was bound? This is set automatically when the Pipeline Manager\rresets itself, usually after handing off to a 3rd party renderer like Spine.\r\rYou should treat this property as read-only.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.53.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#glReset", "inherited": true, "___id": "T000002R056892", "___s": true }, { "comment": "/**\r\n * The temporary Pipeline batch. This array contains the batch entries for\r\n * the current frame, which is a package of textures and vertex offsets used\r\n * for drawing. This package is built dynamically as the frame is built\r\n * and cleared during the flush method.\r\n *\r\n * Treat this array and all of its contents as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#batch\r\n * @type {Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batch", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#batch", "kind": "member", "description": "The temporary Pipeline batch. This array contains the batch entries for\rthe current frame, which is a package of textures and vertex offsets used\rfor drawing. This package is built dynamically as the frame is built\rand cleared during the flush method.\r\rTreat this array and all of its contents as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batch", "inherited": true, "___id": "T000002R056893", "___s": true }, { "comment": "/**\r\n * The most recently created Pipeline batch entry.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentBatch\r\n * @type {?Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#currentBatch", "kind": "member", "description": "The most recently created Pipeline batch entry.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineBatchEntry", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentBatch", "inherited": true, "___id": "T000002R056894", "___s": true }, { "comment": "/**\r\n * The most recently bound WebGLTexture, used as part of the batch process.\r\n *\r\n * Reset to null as part of the flush method.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentTexture\r\n * @type {?WebGLTexture}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#currentTexture", "kind": "member", "description": "The most recently bound WebGLTexture, used as part of the batch process.\r\rReset to null as part of the flush method.\r\rTreat this value as read-only.", "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentTexture", "inherited": true, "___id": "T000002R056895", "___s": true }, { "comment": "/**\r\n * Holds the most recently assigned texture unit.\r\n *\r\n * Treat this value as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#currentUnit\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 427, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "currentUnit", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#currentUnit", "kind": "member", "description": "Holds the most recently assigned texture unit.\r\rTreat this value as read-only.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#currentUnit", "inherited": true, "___id": "T000002R056896", "___s": true }, { "comment": "/**\r\n * The currently active WebGLTextures, used as part of the batch process.\r\n *\r\n * Reset to empty as part of the bind method.\r\n *\r\n * Treat this array as read-only.\r\n *\r\n * @name Phaser.Renderer.WebGL.WebGLPipeline#activeTextures\r\n * @type {WebGLTexture[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "activeTextures", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#activeTextures", "kind": "member", "description": "The currently active WebGLTextures, used as part of the batch process.\r\rReset to empty as part of the bind method.\r\rTreat this array as read-only.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "WebGLTexture", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#activeTextures", "inherited": true, "___id": "T000002R056897", "___s": true }, { "comment": "/**\r\n * Called when the Game has fully booted and the Renderer has finished setting up.\r\n *\r\n * By this stage all Game level systems are now in place. You can perform any final tasks that the\r\n * pipeline may need, that relies on game systems such as the Texture Manager being ready.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#boot\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BOOT\r\n * @since 3.11.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "boot", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#boot", "kind": "function", "description": "Called when the Game has fully booted and the Renderer has finished setting up.\r\rBy this stage all Game level systems are now in place. You can perform any final tasks that the\rpipeline may need, that relies on game systems such as the Texture Manager being ready.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BOOT" ], "since": "3.11.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#boot", "inherited": true, "___id": "T000002R056898", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBoot\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBoot", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#onBoot", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBoot", "inherited": true, "___id": "T000002R056899", "___s": true }, { "comment": "/**\r\n * This method is called once when this pipeline has finished being set-up\r\n * at the end of the boot process. By the time this method is called, all\r\n * of the shaders are ready and configured. It's also called if the renderer\r\n * changes size.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onResize\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onResize", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#onResize", "kind": "function", "description": "This method is called once when this pipeline has finished being set-up\rat the end of the boot process. By the time this method is called, all\rof the shaders are ready and configured. It's also called if the renderer\rchanges size.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onResize", "inherited": true, "___id": "T000002R056900", "___s": true }, { "comment": "/**\r\n * Sets the currently active shader within this pipeline.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShader\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} shader - The shader to set as being current.\r\n * @param {boolean} [setAttributes=false] - Should the vertex attribute pointers be set?\r\n * @param {WebGLBuffer} [vertexBuffer] - The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShader", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#setShader", "kind": "function", "description": "Sets the currently active shader within this pipeline.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader to set as being current.", "name": "shader" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the vertex attribute pointers be set?", "name": "setAttributes" }, { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The vertex buffer to be set before the shader is bound. Defaults to the one owned by this pipeline.", "name": "vertexBuffer" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShader", "inherited": true, "___id": "T000002R056901", "___s": true }, { "comment": "/**\r\n * Searches all shaders in this pipeline for one matching the given name, then returns it.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The index of the shader to set.\r\n *\r\n * @return {Phaser.Renderer.WebGL.WebGLShader} The WebGLShader instance, if found.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "getShaderByName", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#getShaderByName", "kind": "function", "description": "Searches all shaders in this pipeline for one matching the given name, then returns it.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The WebGLShader instance, if found." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The index of the shader to set.", "name": "name" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#getShaderByName", "inherited": true, "___id": "T000002R056902", "___s": true }, { "comment": "/**\r\n * Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r\n * `config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\r\n * setting them into the `shaders` array of this pipeline.\r\n *\r\n * This is a destructive process. Be very careful when you call it, should you need to.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration object for this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setShadersFromConfig", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#setShadersFromConfig", "kind": "function", "description": "Destroys all shaders currently set in the `WebGLPipeline.shaders` array and then parses the given\r`config` object, extracting the shaders from it, creating `WebGLShader` instances and finally\rsetting them into the `shaders` array of this pipeline.\r\rThis is a destructive process. Be very careful when you call it, should you need to.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.WebGLPipelineConfig" } }, "description": "The configuration object for this WebGL Pipeline.", "name": "config" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setShadersFromConfig", "inherited": true, "___id": "T000002R056903", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\r\n * and pushes the entry into the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#createBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 777, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "createBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#createBatch", "kind": "function", "description": "Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero\rand pushes the entry into the batch.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#createBatch", "inherited": true, "___id": "T000002R056904", "___s": true }, { "comment": "/**\r\n * Adds the given texture to the current WebGL Pipeline Batch Entry and\r\n * increases the batch entry unit and maxUnit values by 1.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "addTextureToBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#addTextureToBatch", "kind": "function", "description": "Adds the given texture to the current WebGL Pipeline Batch Entry and\rincreases the batch entry unit and maxUnit values by 1.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#addTextureToBatch", "inherited": true, "___id": "T000002R056905", "___s": true }, { "comment": "/**\r\n * Takes the given WebGLTexture and determines what to do with it.\r\n *\r\n * If there is no current batch (i.e. after a flush) it will create a new\r\n * batch from it.\r\n *\r\n * If the texture is already bound, it will return the current texture unit.\r\n *\r\n * If the texture already exists in the current batch, the unit gets reset\r\n * to match it.\r\n *\r\n * If the texture cannot be found in the current batch, and it supports\r\n * multiple textures, it's added into the batch and the unit indexes are\r\n * advanced.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#pushBatch\r\n * @since 3.60.0\r\n *\r\n * @param {WebGLTexture} texture - The WebGLTexture assigned to this batch entry.\r\n *\r\n * @return {number} The texture unit that was bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 827, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "pushBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#pushBatch", "kind": "function", "description": "Takes the given WebGLTexture and determines what to do with it.\r\rIf there is no current batch (i.e. after a flush) it will create a new\rbatch from it.\r\rIf the texture is already bound, it will return the current texture unit.\r\rIf the texture already exists in the current batch, the unit gets reset\rto match it.\r\rIf the texture cannot be found in the current batch, and it supports\rmultiple textures, it's added into the batch and the unit indexes are\radvanced.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit that was bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "description": "The WebGLTexture assigned to this batch entry.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#pushBatch", "inherited": true, "___id": "T000002R056906", "___s": true }, { "comment": "/**\r\n * Custom pipelines can use this method in order to perform any required pre-batch tasks\r\n * for the given Game Object. It must return the texture unit the Game Object was assigned.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setGameObject\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered or added to the batch.\r\n * @param {Phaser.Textures.Frame} [frame] - Optional frame to use. Can override that of the Game Object.\r\n *\r\n * @return {number} The texture unit the Game Object has been assigned.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 900, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setGameObject", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#setGameObject", "kind": "function", "description": "Custom pipelines can use this method in order to perform any required pre-batch tasks\rfor the given Game Object. It must return the texture unit the Game Object was assigned.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The texture unit the Game Object has been assigned." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered or added to the batch.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "optional": true, "description": "Optional frame to use. Can override that of the Game Object.", "name": "frame" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setGameObject", "inherited": true, "___id": "T000002R056907", "___s": true }, { "comment": "/**\r\n * Check if the current batch of vertices is full.\r\n *\r\n * You can optionally provide an `amount` parameter. If given, it will check if the batch\r\n * needs to flush _if_ the `amount` is added to it. This allows you to test if you should\r\n * flush before populating the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush\r\n * @since 3.0.0\r\n *\r\n * @param {number} [amount=0] - Will the batch need to flush if this many vertices are added to it?\r\n *\r\n * @return {boolean} `true` if the current batch should be flushed, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "shouldFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#shouldFlush", "kind": "function", "description": "Check if the current batch of vertices is full.\r\rYou can optionally provide an `amount` parameter. If given, it will check if the batch\rneeds to flush _if_ the `amount` is added to it. This allows you to test if you should\rflush before populating the batch.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the current batch should be flushed, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Will the batch need to flush if this many vertices are added to it?", "name": "amount" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush", "inherited": true, "___id": "T000002R056908", "___s": true }, { "comment": "/**\r\n * Returns the number of vertices that can be added to the current batch before\r\n * it will trigger a flush to happen.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable\r\n * @since 3.60.0\r\n *\r\n * @return {number} The number of vertices that can still be added to the current batch before it will flush.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 940, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "vertexAvailable", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#vertexAvailable", "kind": "function", "description": "Returns the number of vertices that can be added to the current batch before\rit will trigger a flush to happen.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices that can still be added to the current batch before it will flush." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#vertexAvailable", "inherited": true, "___id": "T000002R056909", "___s": true }, { "comment": "/**\r\n * Resizes the properties used to describe the viewport.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#resize\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#RESIZE\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "resize", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#resize", "kind": "function", "description": "Resizes the properties used to describe the viewport.\r\rThis method is called automatically by the renderer during its resize handler.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:RESIZE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#resize", "inherited": true, "___id": "T000002R056910", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to use the given dimensions\r\n * and resets the `uProjectionMatrix` uniform on all bound shaders.\r\n *\r\n * This method is called automatically by the renderer during its resize handler.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix\r\n * @since 3.50.0\r\n *\r\n * @param {number} width - The new width of this WebGL Pipeline.\r\n * @param {number} height - The new height of this WebGL Pipeline.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#setProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to use the given dimensions\rand resets the `uProjectionMatrix` uniform on all bound shaders.\r\rThis method is called automatically by the renderer during its resize handler.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of this WebGL Pipeline.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of this WebGL Pipeline.", "name": "height" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setProjectionMatrix", "inherited": true, "___id": "T000002R056911", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to flip the y\r\n * and bottom values. Call with 'false' as the parameter to flip\r\n * them back again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [flipY=true] - Flip the y and bottom values?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flipProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#flipProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to flip the y\rand bottom values. Call with 'false' as the parameter to flip\rthem back again.", "since": "3.60.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the y and bottom values?", "name": "flipY" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flipProjectionMatrix", "inherited": true, "___id": "T000002R056912", "___s": true }, { "comment": "/**\r\n * Adjusts this pipelines ortho Projection Matrix to match that of the global\r\n * WebGL Renderer Projection Matrix.\r\n *\r\n * This method is called automatically by the Pipeline Manager when this\r\n * pipeline is set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "updateProjectionMatrix", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#updateProjectionMatrix", "kind": "function", "description": "Adjusts this pipelines ortho Projection Matrix to match that of the global\rWebGL Renderer Projection Matrix.\r\rThis method is called automatically by the Pipeline Manager when this\rpipeline is set.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#updateProjectionMatrix", "inherited": true, "___id": "T000002R056913", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\n *\r\n * It binds the resources and shader needed for this pipeline, including setting the vertex buffer\r\n * and attribute pointers.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bind", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#bind", "kind": "function", "description": "This method is called every time the Pipeline Manager makes this pipeline the currently active one.\r\rIt binds the resources and shader needed for this pipeline, including setting the vertex buffer\rand attribute pointers.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bind", "inherited": true, "___id": "T000002R056914", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager rebinds this pipeline.\r\n *\r\n * It resets all shaders this pipeline uses, setting their attributes again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#rebind\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#REBIND\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [currentShader] - The shader to set as being current.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "rebind", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#rebind", "kind": "function", "description": "This method is called every time the Pipeline Manager rebinds this pipeline.\r\rIt resets all shaders this pipeline uses, setting their attributes again.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:REBIND" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set as being current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#rebind", "inherited": true, "___id": "T000002R056915", "___s": true }, { "comment": "/**\r\n * Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\n *\r\n * It first checks to see if it's already set as the active buffer and only\r\n * binds itself if not.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLBuffer} [buffer] - The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.\r\n *\r\n * @return {boolean} `true` if the vertex buffer was bound, or `false` if it was already bound.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setVertexBuffer", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#setVertexBuffer", "kind": "function", "description": "Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.\r\rIt first checks to see if it's already set as the active buffer and only\rbinds itself if not.", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the vertex buffer was bound, or `false` if it was already bound." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLBuffer" ], "parsedType": { "type": "NameExpression", "name": "WebGLBuffer" } }, "optional": true, "description": "The Vertex Buffer to be bound. Defaults to the one owned by this pipeline.", "name": "buffer" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setVertexBuffer", "inherited": true, "___id": "T000002R056916", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\r\n * belonging to a Game Object is about to be added to the batch. When this is called, the\r\n * renderer has just performed a flush. It will bind the current render target, if any are set\r\n * and finally call the `onPreBatch` hook.\r\n *\r\n * It is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#preBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "preBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#preBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right before a quad\rbelonging to a Game Object is about to be added to the batch. When this is called, the\rrenderer has just performed a flush. It will bind the current render target, if any are set\rand finally call the `onPreBatch` hook.\r\rIt is also called as part of the `PipelineManager.preBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#preBatch", "inherited": true, "___id": "T000002R056917", "___s": true }, { "comment": "/**\r\n * This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\r\n * belonging to a Game Object has been added to the batch. When this is called, the\r\n * renderer has just performed a flush.\r\n *\r\n * It calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\r\n * additional Post FX Pipeline processing.\r\n *\r\n * It is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#postBatch\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)} [gameObject] - The Game Object or Camera that invoked this pipeline, if any.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1255, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "postBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#postBatch", "kind": "function", "description": "This method is called as a result of the `WebGLPipeline.batchQuad` method, right after a quad\rbelonging to a Game Object has been added to the batch. When this is called, the\rrenderer has just performed a flush.\r\rIt calls the `onDraw` hook followed by the `onPostBatch` hook, which can be used to perform\radditional Post FX Pipeline processing.\r\rIt is also called as part of the `PipelineManager.postBatch` method when processing Post FX Pipelines.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } }, "optional": true, "description": "The Game Object or Camera that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#postBatch", "inherited": true, "___id": "T000002R056918", "___s": true }, { "comment": "/**\r\n * This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\n *\r\n * This method is called every time the `postBatch` method is called and is passed a\r\n * reference to the current render target.\r\n *\r\n * At the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\r\n * however, you can do as much additional processing as you like in this method if\r\n * you override it from within your own pipelines.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onDraw\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} renderTarget - The Render Target.\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [swapTarget] - A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onDraw", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#onDraw", "kind": "function", "description": "This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.\r\rThis method is called every time the `postBatch` method is called and is passed a\rreference to the current render target.\r\rAt the very least a Post FX Pipeline should call `this.bindAndDraw(renderTarget)`,\rhowever, you can do as much additional processing as you like in this method if\ryou override it from within your own pipelines.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "description": "The Render Target.", "name": "renderTarget" }, { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "A Swap Render Target, useful for double-buffer effects. Only set by SpriteFX Pipelines.", "name": "swapTarget" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onDraw", "inherited": true, "___id": "T000002R056919", "___s": true }, { "comment": "/**\r\n * This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\r\n * it to another one. This happens after a call to `flush` and before the new pipeline is bound.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#unbind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "unbind", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#unbind", "kind": "function", "description": "This method is called every time the Pipeline Manager deactivates this pipeline, swapping from\rit to another one. This happens after a call to `flush` and before the new pipeline is bound.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#unbind", "inherited": true, "___id": "T000002R056920", "___s": true }, { "comment": "/**\r\n * Uploads the vertex data and emits a draw call for the current batch of vertices.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#flush\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "flush", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#flush", "kind": "function", "description": "Uploads the vertex data and emits a draw call for the current batch of vertices.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:BEFORE_FLUSH", "Phaser.Renderer.WebGL.Pipelines.Events#event:AFTER_FLUSH" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#flush", "inherited": true, "___id": "T000002R056921", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the Pipeline Manager makes this the active pipeline. It is called\r\n * at the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\r\n * shader is passed to this hook.\r\n *\r\n * For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\r\n * only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\n *\r\n * If you need to listen for that event instead, use the `onBind` hook.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onActive\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as current.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onActive", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#onActive", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the Pipeline Manager makes this the active pipeline. It is called\rat the end of the `WebGLPipeline.bind` method, after the current shader has been set. The current\rshader is passed to this hook.\r\rFor example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will\ronly be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.\r\rIf you need to listen for that event instead, use the `onBind` hook.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "description": "The shader that was set as current.", "name": "currentShader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onActive", "inherited": true, "___id": "T000002R056922", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\r\n * even if the pipeline is already active.\r\n *\r\n * Unlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\r\n * active, this hook is called for every Game Object that requests use of this pipeline, allowing you to\r\n * perform per-object set-up, such as loading shader uniform data.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBind\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBind", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#onBind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time a **Game Object** asks the Pipeline Manager to use this pipeline,\reven if the pipeline is already active.\r\rUnlike the `onActive` method, which is only called when the Pipeline Manager makes this pipeline\ractive, this hook is called for every Game Object that requests use of this pipeline, allowing you to\rperform per-object set-up, such as loading shader uniform data.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBind", "inherited": true, "___id": "T000002R056923", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\r\n * pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\r\n * and then returing to Phaser again.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRebind\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRebind", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#onRebind", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a\rpipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine,\rand then returing to Phaser again.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRebind", "inherited": true, "___id": "T000002R056924", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time the `batchQuad` or `batchTri` methods are called. If this was\r\n * as a result of a Game Object, then the Game Object reference is passed to this hook too.\r\n *\r\n * This hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\r\n * call 'flush' from within this.\r\n *\r\n * Note that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\r\n * for example the Graphics Game Object.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1478, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#onBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time the `batchQuad` or `batchTri` methods are called. If this was\ras a result of a Game Object, then the Game Object reference is passed to this hook too.\r\rThis hook is called _after_ the quad (or tri) has been added to the batch, so you can safely\rcall 'flush' from within this.\r\rNote that Game Objects may call `batchQuad` or `batchTri` multiple times for a single draw,\rfor example the Graphics Game Object.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBatch", "inherited": true, "___id": "T000002R056925", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately before a **Game Object** is about to add itself to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#onPreBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately before a **Game Object** is about to add itself to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreBatch", "inherited": true, "___id": "T000002R056926", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after a **Game Object** has been added to the batch.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} [gameObject] - The Game Object that invoked this pipeline, if any.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostBatch", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#onPostBatch", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after a **Game Object** has been added to the batch.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "optional": true, "description": "The Game Object that invoked this pipeline, if any.", "name": "gameObject" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostBatch", "inherited": true, "___id": "T000002R056927", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called once per frame, right before anything has been rendered, but after the canvas\r\n * has been cleared. If this pipeline has a render target, it will also have been cleared by this point.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPreRender", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#onPreRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called once per frame, right before anything has been rendered, but after the canvas\rhas been cleared. If this pipeline has a render target, it will also have been cleared by this point.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPreRender", "inherited": true, "___id": "T000002R056928", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, by every Camera in a Scene that wants to render.\r\n *\r\n * It is called at the start of the rendering process, before anything has been drawn to the Camera.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Scene Camera being rendered with.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1540, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onRender", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#onRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, by every Camera in a Scene that wants to render.\r\rIt is called at the start of the rendering process, before anything has been drawn to the Camera.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene being rendered.", "name": "scene" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Scene Camera being rendered with.", "name": "camera" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onRender", "inherited": true, "___id": "T000002R056929", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\n *\r\n * It is called at the very end of the rendering process, once all Cameras, for all Scenes, have\r\n * been rendered.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender\r\n * @since 3.50.0\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onPostRender", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#onPostRender", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called _once per frame_, after all rendering has happened and snapshots have been taken.\r\rIt is called at the very end of the rendering process, once all Cameras, for all Scenes, have\rbeen rendered.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onPostRender", "inherited": true, "___id": "T000002R056930", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called every time this pipeline is asked to flush its batch.\r\n *\r\n * It is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\r\n * perform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onBeforeFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#onBeforeFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called every time this pipeline is asked to flush its batch.\r\rIt is called immediately before the `gl.bufferData` and `gl.drawArrays` calls are made, so you can\rperform any final pre-render modifications. To apply changes post-render, see `onAfterFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onBeforeFlush", "inherited": true, "___id": "T000002R056931", "___s": true }, { "comment": "/**\r\n * By default this is an empty method hook that you can override and use in your own custom pipelines.\r\n *\r\n * This method is called immediately after this pipeline has finished flushing its batch.\r\n *\r\n * It is called after the `gl.drawArrays` call.\r\n *\r\n * You can perform additional post-render effects, but be careful not to call `flush`\r\n * on this pipeline from within this method, or you'll cause an infinite loop.\r\n *\r\n * To apply changes pre-render, see `onBeforeFlush`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [isPostFlush=false] - Was this flush invoked as part of a post-process, or not?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "onAfterFlush", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#onAfterFlush", "kind": "function", "description": "By default this is an empty method hook that you can override and use in your own custom pipelines.\r\rThis method is called immediately after this pipeline has finished flushing its batch.\r\rIt is called after the `gl.drawArrays` call.\r\rYou can perform additional post-render effects, but be careful not to call `flush`\ron this pipeline from within this method, or you'll cause an infinite loop.\r\rTo apply changes pre-render, see `onBeforeFlush`.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Was this flush invoked as part of a post-process, or not?", "name": "isPostFlush" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#onAfterFlush", "inherited": true, "___id": "T000002R056932", "___s": true }, { "comment": "/**\r\n * Adds a single vertex to the current vertex buffer and increments the\r\n * `vertexCount` property by 1.\r\n *\r\n * This method is called directly by `batchTri` and `batchQuad`.\r\n *\r\n * It does not perform any batch limit checking itself, so if you need to call\r\n * this method directly, do so in the same way that `batchQuad` does, for example.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchVert\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The vertex x position.\r\n * @param {number} y - The vertex y position.\r\n * @param {number} u - UV u value.\r\n * @param {number} v - UV v value.\r\n * @param {number} unit - Texture unit to which the texture needs to be bound.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {number} tint - The tint color value.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1610, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchVert", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#batchVert", "kind": "function", "description": "Adds a single vertex to the current vertex buffer and increments the\r`vertexCount` property by 1.\r\rThis method is called directly by `batchTri` and `batchQuad`.\r\rIt does not perform any batch limit checking itself, so if you need to call\rthis method directly, do so in the same way that `batchQuad` does, for example.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertex y position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u value.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v value.", "name": "v" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint color value.", "name": "tint" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchVert", "inherited": true, "___id": "T000002R056933", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 6 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0----3\r\n * |\\ B|\r\n * | \\ |\r\n * | \\ |\r\n * | A \\|\r\n * | \\\r\n * 1----2\r\n * ```\r\n *\r\n * Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchQuad\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x0 - The top-left x position.\r\n * @param {number} y0 - The top-left y position.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {number} tintBR - The bottom-right tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchQuad", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#batchQuad", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 6 vertices in the following arrangement:\r\r```\r0----3\r|\\ B|\r| \\ |\r| \\ |\r| A \\|\r| \\\r1----2\r```\r\rWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x position.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y position.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color value.", "name": "tintBR" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchQuad", "inherited": true, "___id": "T000002R056934", "___s": true }, { "comment": "/**\r\n * Adds the vertices data into the batch and flushes if full.\r\n *\r\n * Assumes 3 vertices in the following arrangement:\r\n *\r\n * ```\r\n * 0\r\n * |\\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * | \\\r\n * 1-----2\r\n * ```\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#batchTri\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|null)} gameObject - The Game Object, if any, drawing this quad.\r\n * @param {number} x1 - The bottom-left x position.\r\n * @param {number} y1 - The bottom-left y position.\r\n * @param {number} x2 - The bottom-right x position.\r\n * @param {number} y2 - The bottom-right y position.\r\n * @param {number} x3 - The top-right x position.\r\n * @param {number} y3 - The top-right y position.\r\n * @param {number} u0 - UV u0 value.\r\n * @param {number} v0 - UV v0 value.\r\n * @param {number} u1 - UV u1 value.\r\n * @param {number} v1 - UV v1 value.\r\n * @param {number} tintTL - The top-left tint color value.\r\n * @param {number} tintTR - The top-right tint color value.\r\n * @param {number} tintBL - The bottom-left tint color value.\r\n * @param {(number|boolean)} tintEffect - The tint effect for the shader to use.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {number} [unit=0] - Texture unit to which the texture needs to be bound.\r\n *\r\n * @return {boolean} `true` if this method caused the batch to flush, otherwise `false`.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "batchTri", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#batchTri", "kind": "function", "description": "Adds the vertices data into the batch and flushes if full.\r\rAssumes 3 vertices in the following arrangement:\r\r```\r0\r|\\\r| \\\r| \\\r| \\\r| \\\r1-----2\r```", "since": "3.50.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this method caused the batch to flush, otherwise `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NullLiteral" } ] } }, "description": "The Game Object, if any, drawing this quad.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left x position.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left y position.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right x position.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right y position.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right x position.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right y position.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u0 value.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v0 value.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV u1 value.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "UV v1 value.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color value.", "name": "tintTL" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color value.", "name": "tintTR" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color value.", "name": "tintBL" }, { "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "The tint effect for the shader to use.", "name": "tintEffect" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Texture unit to which the texture needs to be bound.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#batchTri", "inherited": true, "___id": "T000002R056935", "___s": true }, { "comment": "/**\r\n * Pushes a filled rectangle into the vertex batch.\r\n *\r\n * The dimensions are run through `Math.floor` before the quad is generated.\r\n *\r\n * Rectangle has no transform values and isn't transformed into the local space.\r\n *\r\n * Used for directly batching untransformed rectangles, such as Camera background colors.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - Horizontal top left coordinate of the rectangle.\r\n * @param {number} y - Vertical top left coordinate of the rectangle.\r\n * @param {number} width - Width of the rectangle.\r\n * @param {number} height - Height of the rectangle.\r\n * @param {number} color - Color of the rectangle to draw.\r\n * @param {number} alpha - Alpha value of the rectangle to draw.\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch if a flush occurs.\r\n * @param {boolean} [flipUV=true] - Flip the vertical UV coordinates of the texture before rendering?\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "drawFillRect", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#drawFillRect", "kind": "function", "description": "Pushes a filled rectangle into the vertex batch.\r\rThe dimensions are run through `Math.floor` before the quad is generated.\r\rRectangle has no transform values and isn't transformed into the local space.\r\rUsed for directly batching untransformed rectangles, such as Camera background colors.", "since": "3.50.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal top left coordinate of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical top left coordinate of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Color of the rectangle to draw.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Alpha value of the rectangle to draw.", "name": "alpha" }, { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch if a flush occurs.", "name": "texture" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Flip the vertical UV coordinates of the texture before rendering?", "name": "flipUV" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#drawFillRect", "inherited": true, "___id": "T000002R056936", "___s": true }, { "comment": "/**\r\n * Sets the texture to be bound to the next available texture unit and returns\r\n * the unit id.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.\r\n *\r\n * @return {number} The assigned texture unit.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTexture2D", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#setTexture2D", "kind": "function", "description": "Sets the texture to be bound to the next available texture unit and returns\rthe unit id.", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The assigned texture unit." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "WebGLTexture that will be assigned to the current batch. If not given uses `whiteTexture`.", "name": "texture" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTexture2D", "inherited": true, "___id": "T000002R056937", "___s": true }, { "comment": "/**\r\n * Activates the given WebGL Texture and binds it to the requested texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindTexture\r\n * @since 3.50.0\r\n *\r\n * @param {WebGLTexture} [target] - The WebGLTexture to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1935, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindTexture", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#bindTexture", "kind": "function", "description": "Activates the given WebGL Texture and binds it to the requested texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "WebGLTexture" ], "parsedType": { "type": "NameExpression", "name": "WebGLTexture" } }, "optional": true, "description": "The WebGLTexture to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindTexture", "inherited": true, "___id": "T000002R056938", "___s": true }, { "comment": "/**\r\n * Activates the given Render Target texture and binds it to the\r\n * requested WebGL texture slot.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.RenderTarget} [target] - The Render Target to activate and bind.\r\n * @param {number} [unit=0] - The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.\r\n *\r\n * @return {this} This WebGL Pipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "bindRenderTarget", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#bindRenderTarget", "kind": "function", "description": "Activates the given Render Target texture and binds it to the\rrequested WebGL texture slot.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGL Pipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.RenderTarget" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderTarget" } }, "optional": true, "description": "The Render Target to activate and bind.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The WebGL texture ID to activate. Defaults to `gl.TEXTURE0`.", "name": "unit" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#bindRenderTarget", "inherited": true, "___id": "T000002R056939", "___s": true }, { "comment": "/**\r\n * Sets the current duration into a 1f uniform value based on the given name.\r\n *\r\n * This can be used for mapping time uniform values, such as `iTime`.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setTime\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1976, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setTime", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#setTime", "kind": "function", "description": "Sets the current duration into a 1f uniform value based on the given name.\r\rThis can be used for mapping time uniform values, such as `iTime`.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setTime", "inherited": true, "___id": "T000002R056940", "___s": true }, { "comment": "/**\r\n * Sets a boolean uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setBoolean\r\n * @since 3.60.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} value - The new value of the `boolean` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 1996, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setBoolean", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#setBoolean", "kind": "function", "description": "Sets a boolean uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The new value of the `boolean` uniform.", "name": "value" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setBoolean", "inherited": true, "___id": "T000002R056941", "___s": true }, { "comment": "/**\r\n * Sets a 1f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `float` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1f", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#set1f", "kind": "function", "description": "Sets a 1f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `float` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1f", "inherited": true, "___id": "T000002R056942", "___s": true }, { "comment": "/**\r\n * Sets a 2f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec2` uniform.\r\n * @param {number} y - The new Y component of the `vec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2f", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#set2f", "kind": "function", "description": "Sets a 2f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2f", "inherited": true, "___id": "T000002R056943", "___s": true }, { "comment": "/**\r\n * Sets a 3f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `vec3` uniform.\r\n * @param {number} y - The new Y component of the `vec3` uniform.\r\n * @param {number} z - The new Z component of the `vec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2078, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3f", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#set3f", "kind": "function", "description": "Sets a 3f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `vec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `vec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `vec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3f", "inherited": true, "___id": "T000002R056944", "___s": true }, { "comment": "/**\r\n * Sets a 4f uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4f\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform\r\n * @param {number} y - Y component of the uniform\r\n * @param {number} z - Z component of the uniform\r\n * @param {number} w - W component of the uniform\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4f", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#set4f", "kind": "function", "description": "Sets a 4f uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4f", "inherited": true, "___id": "T000002R056945", "___s": true }, { "comment": "/**\r\n * Sets a 1fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1fv", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#set1fv", "kind": "function", "description": "Sets a 1fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1fv", "inherited": true, "___id": "T000002R056946", "___s": true }, { "comment": "/**\r\n * Sets a 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#set2fv", "kind": "function", "description": "Sets a 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2fv", "inherited": true, "___id": "T000002R056947", "___s": true }, { "comment": "/**\r\n * Sets a 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#set3fv", "kind": "function", "description": "Sets a 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3fv", "inherited": true, "___id": "T000002R056948", "___s": true }, { "comment": "/**\r\n * Sets a 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#set4fv", "kind": "function", "description": "Sets a 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4fv", "inherited": true, "___id": "T000002R056949", "___s": true }, { "comment": "/**\r\n * Sets a 1iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1iv", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#set1iv", "kind": "function", "description": "Sets a 1iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1iv", "inherited": true, "___id": "T000002R056950", "___s": true }, { "comment": "/**\r\n * Sets a 2iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2iv", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#set2iv", "kind": "function", "description": "Sets a 2iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2iv", "inherited": true, "___id": "T000002R056951", "___s": true }, { "comment": "/**\r\n * Sets a 3iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3iv", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#set3iv", "kind": "function", "description": "Sets a 3iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3iv", "inherited": true, "___id": "T000002R056952", "___s": true }, { "comment": "/**\r\n * Sets a 4iv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4iv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number[]|Float32Array} arr - The new value to be used for the uniform variable.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4iv", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#set4iv", "kind": "function", "description": "Sets a 4iv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "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 new value to be used for the uniform variable.", "name": "arr" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4iv", "inherited": true, "___id": "T000002R056953", "___s": true }, { "comment": "/**\r\n * Sets a 1i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set1i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new value of the `int` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2353, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set1i", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#set1i", "kind": "function", "description": "Sets a 1i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the `int` uniform.", "name": "x" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set1i", "inherited": true, "___id": "T000002R056954", "___s": true }, { "comment": "/**\r\n * Sets a 2i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set2i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec2` uniform.\r\n * @param {number} y - The new Y component of the `ivec2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set2i", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#set2i", "kind": "function", "description": "Sets a 2i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec2` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec2` uniform.", "name": "y" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set2i", "inherited": true, "___id": "T000002R056955", "___s": true }, { "comment": "/**\r\n * Sets a 3i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set3i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - The new X component of the `ivec3` uniform.\r\n * @param {number} y - The new Y component of the `ivec3` uniform.\r\n * @param {number} z - The new Z component of the `ivec3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set3i", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#set3i", "kind": "function", "description": "Sets a 3i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new X component of the `ivec3` uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Y component of the `ivec3` uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new Z component of the `ivec3` uniform.", "name": "z" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set3i", "inherited": true, "___id": "T000002R056956", "___s": true }, { "comment": "/**\r\n * Sets a 4i uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#set4i\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {number} x - X component of the uniform.\r\n * @param {number} y - Y component of the uniform.\r\n * @param {number} z - Z component of the uniform.\r\n * @param {number} w - W component of the uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "set4i", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#set4i", "kind": "function", "description": "Sets a 4i uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "X component of the uniform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Y component of the uniform.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Z component of the uniform.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "W component of the uniform.", "name": "w" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#set4i", "inherited": true, "___id": "T000002R056957", "___s": true }, { "comment": "/**\r\n * Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {number[]|Float32Array} matrix - The new values for the `mat2` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix2fv", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#setMatrix2fv", "kind": "function", "description": "Sets a matrix 2fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "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 new values for the `mat2` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2fv", "inherited": true, "___id": "T000002R056958", "___s": true }, { "comment": "/**\r\n * Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The new values for the `mat3` uniform.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix3fv", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#setMatrix3fv", "kind": "function", "description": "Sets a matrix 3fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The new values for the `mat3` uniform.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3fv", "inherited": true, "___id": "T000002R056959", "___s": true }, { "comment": "/**\r\n * Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\n *\r\n * The current shader is bound, before the uniform is set, making it active within the\r\n * WebGLRenderer. This means you can safely call this method from a location such as\r\n * a Scene `create` or `update` method. However, when working within a Shader file\r\n * directly, use the `WebGLShader` method equivalent instead, to avoid the program\r\n * being set.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv\r\n * @since 3.50.0\r\n *\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {boolean} transpose - Whether to transpose the matrix. Should be `false`.\r\n * @param {Float32Array} matrix - The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.\r\n * @param {Phaser.Renderer.WebGL.WebGLShader} [shader] - The shader to set the value on. If not given, the `currentShader` is used.\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "setMatrix4fv", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#setMatrix4fv", "kind": "function", "description": "Sets a matrix 4fv uniform value based on the given name on the currently set shader.\r\rThe current shader is bound, before the uniform is set, making it active within the\rWebGLRenderer. This means you can safely call this method from a location such as\ra Scene `create` or `update` method. However, when working within a Shader file\rdirectly, use the `WebGLShader` method equivalent instead, to avoid the program\rbeing set.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to transpose the matrix. Should be `false`.", "name": "transpose" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The matrix data. If using a Matrix4 this should be the `Matrix4.val` property.", "name": "matrix" }, { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLShader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLShader" } }, "optional": true, "description": "The shader to set the value on. If not given, the `currentShader` is used.", "name": "shader" } ], "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4fv", "inherited": true, "___id": "T000002R056960", "___s": true }, { "comment": "/**\r\n * Destroys all shader instances, removes all object references and nulls all external references.\r\n *\r\n * @method Phaser.Renderer.WebGL.WebGLPipeline#destroy\r\n * @fires Phaser.Renderer.WebGL.Pipelines.Events#DESTROY\r\n * @since 3.0.0\r\n *\r\n * @return {this} This WebGLPipeline instance.\r\n */", "meta": { "filename": "WebGLPipeline.js", "lineno": 2551, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\renderer\\webgl", "code": {} }, "name": "destroy", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#destroy", "kind": "function", "description": "Destroys all shader instances, removes all object references and nulls all external references.", "fires": [ "Phaser.Renderer.WebGL.Pipelines.Events#event:DESTROY" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This WebGLPipeline instance." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Renderer.WebGL.WebGLPipeline#destroy", "inherited": true, "___id": "T000002R056961", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R056962", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R056963", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R056964", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R056965", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R056966", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R056967", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R056968", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R056969", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R056970", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R056971", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.Pipelines.UtilityPipeline", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R056972", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R056973", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Renderer.WebGL.WebGLRenderer", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R056974", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R056975", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R056976", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R056977", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R056978", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R056979", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R056980", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R056981", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R056982", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Renderer.WebGL.WebGLRenderer#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Renderer.WebGL.WebGLRenderer", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R056983", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Scale.ScaleManager#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Scale.ScaleManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R056984", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Scale.ScaleManager#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Scale.ScaleManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R056985", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Scale.ScaleManager#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Scale.ScaleManager", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R056986", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Scale.ScaleManager#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Scale.ScaleManager", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R056987", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Scale.ScaleManager#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Scale.ScaleManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R056988", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Scale.ScaleManager#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Scale.ScaleManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R056989", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Scale.ScaleManager#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Scale.ScaleManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R056990", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Scale.ScaleManager#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Scale.ScaleManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R056991", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Scale.ScaleManager#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Scale.ScaleManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R056992", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Scale.ScaleManager#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Scale.ScaleManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R056993", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Scale.ScaleManager#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Scale.ScaleManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R056994", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Sound.BaseSound#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Sound.BaseSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R056995", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Sound.BaseSound#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Sound.BaseSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R056996", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Sound.BaseSound#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Sound.BaseSound", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R056997", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Sound.BaseSound#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Sound.BaseSound", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R056998", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Sound.BaseSound#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Sound.BaseSound", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R056999", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Sound.BaseSound#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.BaseSound", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R057000", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Sound.BaseSound#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.BaseSound", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R057001", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Sound.BaseSound#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.BaseSound", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R057002", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Sound.BaseSound#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.BaseSound", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R057003", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Sound.BaseSound#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.BaseSound", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R057004", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Sound.BaseSound#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.BaseSound", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R057005", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Sound.BaseSoundManager#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Sound.BaseSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R057006", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Sound.BaseSoundManager#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Sound.BaseSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R057007", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Sound.BaseSoundManager#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Sound.BaseSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R057008", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Sound.BaseSoundManager#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Sound.BaseSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R057009", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Sound.BaseSoundManager#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Sound.BaseSoundManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R057010", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Sound.BaseSoundManager#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.BaseSoundManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R057011", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Sound.BaseSoundManager#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.BaseSoundManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R057012", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Sound.BaseSoundManager#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.BaseSoundManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R057013", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Sound.BaseSoundManager#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.BaseSoundManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R057014", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Sound.BaseSoundManager#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.BaseSoundManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R057015", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Sound.BaseSoundManager#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.BaseSoundManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R057016", "___s": true }, { "comment": "/**\r\n * Local reference to the sound manager.\r\n *\r\n * @name Phaser.Sound.BaseSound#manager\r\n * @type {Phaser.Sound.BaseSoundManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "manager", "longname": "Phaser.Sound.HTML5AudioSound#manager", "kind": "member", "description": "Local reference to the sound manager.", "type": { "names": [ "Phaser.Sound.BaseSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSoundManager" } }, "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#manager", "inherited": true, "___id": "T000002R057017", "___s": true }, { "comment": "/**\r\n * Asset key for the sound.\r\n *\r\n * @name Phaser.Sound.BaseSound#key\r\n * @type {string}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "key", "longname": "Phaser.Sound.HTML5AudioSound#key", "kind": "member", "description": "Asset key for the sound.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#key", "inherited": true, "___id": "T000002R057018", "___s": true }, { "comment": "/**\r\n * Flag indicating if sound is currently playing.\r\n *\r\n * @name Phaser.Sound.BaseSound#isPlaying\r\n * @type {boolean}\r\n * @default false\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "isPlaying", "longname": "Phaser.Sound.HTML5AudioSound#isPlaying", "kind": "member", "description": "Flag indicating if sound is currently playing.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#isPlaying", "inherited": true, "___id": "T000002R057019", "___s": true }, { "comment": "/**\r\n * Flag indicating if sound is currently paused.\r\n *\r\n * @name Phaser.Sound.BaseSound#isPaused\r\n * @type {boolean}\r\n * @default false\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "isPaused", "longname": "Phaser.Sound.HTML5AudioSound#isPaused", "kind": "member", "description": "Flag indicating if sound is currently paused.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#isPaused", "inherited": true, "___id": "T000002R057020", "___s": true }, { "comment": "/**\r\n * A property that holds the value of sound's actual playback rate,\r\n * after its rate and detune values has been combined with global\r\n * rate and detune values.\r\n *\r\n * @name Phaser.Sound.BaseSound#totalRate\r\n * @type {number}\r\n * @default 1\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "totalRate", "longname": "Phaser.Sound.HTML5AudioSound#totalRate", "kind": "member", "description": "A property that holds the value of sound's actual playback rate,\rafter its rate and detune values has been combined with global\rrate and detune values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#totalRate", "inherited": true, "___id": "T000002R057021", "___s": true }, { "comment": "/**\r\n * A value representing the duration, in seconds.\r\n * It could be total sound duration or a marker duration.\r\n *\r\n * @name Phaser.Sound.BaseSound#duration\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "duration", "longname": "Phaser.Sound.HTML5AudioSound#duration", "kind": "member", "description": "A value representing the duration, in seconds.\rIt could be total sound duration or a marker duration.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#duration", "inherited": true, "___id": "T000002R057022", "___s": true }, { "comment": "/**\r\n * The total duration of the sound in seconds.\r\n *\r\n * @name Phaser.Sound.BaseSound#totalDuration\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 103, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "totalDuration", "longname": "Phaser.Sound.HTML5AudioSound#totalDuration", "kind": "member", "description": "The total duration of the sound in seconds.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#totalDuration", "inherited": true, "___id": "T000002R057023", "___s": true }, { "comment": "/**\r\n * Object containing markers definitions.\r\n *\r\n * @name Phaser.Sound.BaseSound#markers\r\n * @type {Object.}\r\n * @default {}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "markers", "longname": "Phaser.Sound.HTML5AudioSound#markers", "kind": "member", "description": "Object containing markers definitions.", "type": { "names": [ "Object." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } ] } }, "defaultvalue": "{}", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#markers", "inherited": true, "___id": "T000002R057026", "___s": true }, { "comment": "/**\r\n * Currently playing marker.\r\n * 'null' if whole sound is playing.\r\n *\r\n * @name Phaser.Sound.BaseSound#currentMarker\r\n * @type {Phaser.Types.Sound.SoundMarker}\r\n * @default null\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "currentMarker", "longname": "Phaser.Sound.HTML5AudioSound#currentMarker", "kind": "member", "description": "Currently playing marker.\r'null' if whole sound is playing.", "type": { "names": [ "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } }, "defaultvalue": "null", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#currentMarker", "inherited": true, "___id": "T000002R057027", "___s": true }, { "comment": "/**\r\n * Flag indicating if destroy method was called on this sound.\r\n *\r\n * @name Phaser.Sound.BaseSound#pendingRemove\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 171, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "pendingRemove", "longname": "Phaser.Sound.HTML5AudioSound#pendingRemove", "kind": "member", "description": "Flag indicating if destroy method was called on this sound.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#pendingRemove", "inherited": true, "___id": "T000002R057028", "___s": true }, { "comment": "/**\r\n * Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object.\r\n * This allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.\r\n *\r\n * @method Phaser.Sound.BaseSound#addMarker\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Sound.SoundMarker} marker - Marker object.\r\n *\r\n * @return {boolean} Whether the marker was added successfully.\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "addMarker", "longname": "Phaser.Sound.HTML5AudioSound#addMarker", "kind": "function", "description": "Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object.\rThis allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the marker was added successfully." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } }, "description": "Marker object.", "name": "marker" } ], "inherits": "Phaser.Sound.BaseSound#addMarker", "inherited": true, "___id": "T000002R057029", "___s": true }, { "comment": "/**\r\n * Updates previously added marker.\r\n *\r\n * @method Phaser.Sound.BaseSound#updateMarker\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Sound.SoundMarker} marker - Marker object with updated values.\r\n *\r\n * @return {boolean} Whether the marker was updated successfully.\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 229, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "updateMarker", "longname": "Phaser.Sound.HTML5AudioSound#updateMarker", "kind": "function", "description": "Updates previously added marker.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the marker was updated successfully." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } }, "description": "Marker object with updated values.", "name": "marker" } ], "inherits": "Phaser.Sound.BaseSound#updateMarker", "inherited": true, "___id": "T000002R057030", "___s": true }, { "comment": "/**\r\n * Removes a marker from the sound.\r\n *\r\n * @method Phaser.Sound.BaseSound#removeMarker\r\n * @since 3.0.0\r\n *\r\n * @param {string} markerName - The name of the marker to remove.\r\n *\r\n * @return {?Phaser.Types.Sound.SoundMarker} Removed marker object or 'null' if there was no marker with provided name.\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 259, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "removeMarker", "longname": "Phaser.Sound.HTML5AudioSound#removeMarker", "kind": "function", "description": "Removes a marker from the sound.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker", "nullable": true } }, "nullable": true, "description": "Removed marker object or 'null' if there was no marker with provided name." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the marker to remove.", "name": "markerName" } ], "inherits": "Phaser.Sound.BaseSound#removeMarker", "inherited": true, "___id": "T000002R057031", "___s": true }, { "comment": "/**\r\n * Method used internally for applying config values to some of the sound properties.\r\n *\r\n * @method Phaser.Sound.BaseSound#applyConfig\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "applyConfig", "longname": "Phaser.Sound.HTML5AudioSound#applyConfig", "kind": "function", "description": "Method used internally for applying config values to some of the sound properties.", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#applyConfig", "inherited": true, "___id": "T000002R057032", "___s": true }, { "comment": "/**\r\n * Method used internally for resetting values of some of the config properties.\r\n *\r\n * @method Phaser.Sound.BaseSound#resetConfig\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 428, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "resetConfig", "longname": "Phaser.Sound.HTML5AudioSound#resetConfig", "kind": "function", "description": "Method used internally for resetting values of some of the config properties.", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#resetConfig", "inherited": true, "___id": "T000002R057033", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Sound.HTML5AudioSound#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R057034", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Sound.HTML5AudioSound#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R057035", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Sound.HTML5AudioSound#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R057036", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Sound.HTML5AudioSound#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R057037", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Sound.HTML5AudioSound#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R057038", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Sound.HTML5AudioSound#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R057039", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Sound.HTML5AudioSound#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R057040", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Sound.HTML5AudioSound#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R057041", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Sound.HTML5AudioSound#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R057042", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Sound.HTML5AudioSound#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R057043", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Sound.HTML5AudioSound#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.HTML5AudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R057044", "___s": true }, { "comment": "/**\r\n * Local reference to game.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#game\r\n * @type {Phaser.Game}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "game", "longname": "Phaser.Sound.HTML5AudioSoundManager#game", "kind": "member", "description": "Local reference to game.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#game", "inherited": true, "___id": "T000002R057045", "___s": true }, { "comment": "/**\r\n * Local reference to the JSON Cache, as used by Audio Sprites.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#jsonCache\r\n * @type {Phaser.Cache.BaseCache}\r\n * @readonly\r\n * @since 3.7.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "jsonCache", "longname": "Phaser.Sound.HTML5AudioSoundManager#jsonCache", "kind": "member", "description": "Local reference to the JSON Cache, as used by Audio Sprites.", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "readonly": true, "since": "3.7.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#jsonCache", "inherited": true, "___id": "T000002R057046", "___s": true }, { "comment": "/**\r\n * Flag indicating if sounds should be paused when game looses focus,\r\n * for instance when user switches to another tab/program/app.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#pauseOnBlur\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "pauseOnBlur", "longname": "Phaser.Sound.HTML5AudioSoundManager#pauseOnBlur", "kind": "member", "description": "Flag indicating if sounds should be paused when game looses focus,\rfor instance when user switches to another tab/program/app.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#pauseOnBlur", "inherited": true, "___id": "T000002R057048", "___s": true }, { "comment": "/**\r\n * Mobile devices require sounds to be triggered from an explicit user action,\r\n * such as a tap, before any sound can be loaded/played on a web page.\r\n * Set to true if the audio system is currently locked awaiting user interaction.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#locked\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 128, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "locked", "longname": "Phaser.Sound.HTML5AudioSoundManager#locked", "kind": "member", "description": "Mobile devices require sounds to be triggered from an explicit user action,\rsuch as a tap, before any sound can be loaded/played on a web page.\rSet to true if the audio system is currently locked awaiting user interaction.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#locked", "inherited": true, "___id": "T000002R057051", "___s": true }, { "comment": "/**\r\n * Flag used to track if the game has lost focus.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#gameLostFocus\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "gameLostFocus", "longname": "Phaser.Sound.HTML5AudioSoundManager#gameLostFocus", "kind": "member", "description": "Flag used to track if the game has lost focus.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#gameLostFocus", "inherited": true, "___id": "T000002R057053", "___s": true }, { "comment": "/**\r\n * The Spatial Audio listener position.\r\n *\r\n * Only available with WebAudio.\r\n *\r\n * You can modify the x/y properties of this Vec2 directly to\r\n * adjust the listener position within the game world.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#listenerPosition\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 162, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "listenerPosition", "longname": "Phaser.Sound.HTML5AudioSoundManager#listenerPosition", "kind": "member", "description": "The Spatial Audio listener position.\r\rOnly available with WebAudio.\r\rYou can modify the x/y properties of this Vec2 directly to\radjust the listener position within the game world.", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.60.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#listenerPosition", "inherited": true, "___id": "T000002R057054", "___s": true }, { "comment": "/**\r\n * Adds a new audio sprite sound into the sound manager.\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 * @method Phaser.Sound.BaseSoundManager#addAudioSprite\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - Asset key for the sound.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config] - An optional config object containing default sound settings.\r\n *\r\n * @return {(Phaser.Sound.NoAudioSound|Phaser.Sound.HTML5AudioSound|Phaser.Sound.WebAudioSound)} The new audio sprite sound instance.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 196, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "addAudioSprite", "longname": "Phaser.Sound.HTML5AudioSoundManager#addAudioSprite", "kind": "function", "description": "Adds a new audio sprite sound into the sound manager.\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", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Sound.NoAudioSound", "Phaser.Sound.HTML5AudioSound", "Phaser.Sound.WebAudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.NoAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" } ] } }, "description": "The new audio sprite sound instance." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "An optional config object containing default sound settings.", "name": "config" } ], "inherits": "Phaser.Sound.BaseSoundManager#addAudioSprite", "inherited": true, "___id": "T000002R057055", "___s": true }, { "comment": "/**\r\n * Gets the first sound in this Sound Manager that matches the given key.\r\n * If none can be found it returns `null`.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#get\r\n * @since 3.23.0\r\n *\r\n * @generic {Phaser.Sound.BaseSound} T\r\n * @genericUse {T} - [$return]\r\n *\r\n * @param {string} key - Sound asset key.\r\n *\r\n * @return {?Phaser.Sound.BaseSound} - The sound, or null.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 241, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "get", "longname": "Phaser.Sound.HTML5AudioSoundManager#get", "kind": "function", "description": "Gets the first sound in this Sound Manager that matches the given key.\rIf none can be found it returns `null`.", "since": "3.23.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Sound.BaseSound} T", "value": "{Phaser.Sound.BaseSound} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$return]", "value": "{T} - [$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Sound.BaseSound" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSound", "nullable": true } }, "nullable": true, "description": "- The sound, or null." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Sound asset key.", "name": "key" } ], "inherits": "Phaser.Sound.BaseSoundManager#get", "inherited": true, "___id": "T000002R057056", "___s": true }, { "comment": "/**\r\n * Gets all sounds in this Sound Manager.\r\n *\r\n * You can optionally specify a key, in which case only Sound instances that match the given key\r\n * will be returned.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#getAll\r\n * @since 3.23.0\r\n *\r\n * @generic {Phaser.Sound.BaseSound} T\r\n * @genericUse {T[]} - [$return]\r\n *\r\n * @param {string} [key] - Optional asset key. If given, only Sound instances with this key will be returned.\r\n *\r\n * @return {Phaser.Sound.BaseSound[]} - The sounds, or an empty array.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 260, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "getAll", "longname": "Phaser.Sound.HTML5AudioSoundManager#getAll", "kind": "function", "description": "Gets all sounds in this Sound Manager.\r\rYou can optionally specify a key, in which case only Sound instances that match the given key\rwill be returned.", "since": "3.23.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Sound.BaseSound} T", "value": "{Phaser.Sound.BaseSound} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [$return]", "value": "{T[]} - [$return]" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Sound.BaseSound", "type": "NameExpression" } ] } }, "description": "- The sounds, or an empty array." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional asset key. If given, only Sound instances with this key will be returned.", "name": "key" } ], "inherits": "Phaser.Sound.BaseSoundManager#getAll", "inherited": true, "___id": "T000002R057057", "___s": true }, { "comment": "/**\r\n * Returns all sounds from this Sound Manager that are currently\r\n * playing. That is, Sound instances that have their `isPlaying`\r\n * property set to `true`.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#getAllPlaying\r\n * @since 3.60.0\r\n *\r\n * @generic {Phaser.Sound.BaseSound} T\r\n * @genericUse {T[]} - [$return]\r\n *\r\n * @return {Phaser.Sound.BaseSound[]} - All currently playing sounds, or an empty array.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "getAllPlaying", "longname": "Phaser.Sound.HTML5AudioSoundManager#getAllPlaying", "kind": "function", "description": "Returns all sounds from this Sound Manager that are currently\rplaying. That is, Sound instances that have their `isPlaying`\rproperty set to `true`.", "since": "3.60.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Sound.BaseSound} T", "value": "{Phaser.Sound.BaseSound} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [$return]", "value": "{T[]} - [$return]" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Sound.BaseSound", "type": "NameExpression" } ] } }, "description": "- All currently playing sounds, or an empty array." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#getAllPlaying", "inherited": true, "___id": "T000002R057058", "___s": true }, { "comment": "/**\r\n * Adds a new sound to the sound manager and plays it.\r\n *\r\n * The sound will be automatically removed (destroyed) once playback ends.\r\n *\r\n * This lets you play a new sound on the fly without the need to keep a reference to it.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#play\r\n * @listens Phaser.Sound.Events#COMPLETE\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - Asset key for the sound.\r\n * @param {(Phaser.Types.Sound.SoundConfig|Phaser.Types.Sound.SoundMarker)} [extra] - An optional additional object containing settings to be applied to the sound. It could be either config or marker object.\r\n *\r\n * @return {boolean} Whether the sound started playing successfully.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 306, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "play", "longname": "Phaser.Sound.HTML5AudioSoundManager#play", "kind": "function", "description": "Adds a new sound to the sound manager and plays it.\r\rThe sound will be automatically removed (destroyed) once playback ends.\r\rThis lets you play a new sound on the fly without the need to keep a reference to it.", "listens": [ "Phaser.Sound.Events#event:COMPLETE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound started playing successfully." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig", "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" }, { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } ] } }, "optional": true, "description": "An optional additional object containing settings to be applied to the sound. It could be either config or marker object.", "name": "extra" } ], "inherits": "Phaser.Sound.BaseSoundManager#play", "inherited": true, "___id": "T000002R057059", "___s": true }, { "comment": "/**\r\n * Adds a new audio sprite sound to the sound manager and plays it.\r\n * The sprite will be automatically removed (destroyed) once playback ends.\r\n * This lets you play a new sound on the fly without the need to keep a reference to it.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#playAudioSprite\r\n * @listens Phaser.Sound.Events#COMPLETE\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - Asset key for the sound.\r\n * @param {string} spriteName - The name of the sound sprite to play.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config] - An optional config object containing default sound settings.\r\n *\r\n * @return {boolean} Whether the audio sprite sound started playing successfully.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 347, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "playAudioSprite", "longname": "Phaser.Sound.HTML5AudioSoundManager#playAudioSprite", "kind": "function", "description": "Adds a new audio sprite sound to the sound manager and plays it.\rThe sprite will be automatically removed (destroyed) once playback ends.\rThis lets you play a new sound on the fly without the need to keep a reference to it.", "listens": [ "Phaser.Sound.Events#event:COMPLETE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the audio sprite sound started playing successfully." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the sound sprite to play.", "name": "spriteName" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "An optional config object containing default sound settings.", "name": "config" } ], "inherits": "Phaser.Sound.BaseSoundManager#playAudioSprite", "inherited": true, "___id": "T000002R057060", "___s": true }, { "comment": "/**\r\n * Removes a sound from the sound manager.\r\n * The removed sound is destroyed before removal.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#remove\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Sound.BaseSound} sound - The sound object to remove.\r\n *\r\n * @return {boolean} True if the sound was removed successfully, otherwise false.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 371, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "remove", "longname": "Phaser.Sound.HTML5AudioSoundManager#remove", "kind": "function", "description": "Removes a sound from the sound manager.\rThe removed sound is destroyed before removal.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the sound was removed successfully, otherwise false." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Sound.BaseSound" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSound" } }, "description": "The sound object to remove.", "name": "sound" } ], "inherits": "Phaser.Sound.BaseSoundManager#remove", "inherited": true, "___id": "T000002R057061", "___s": true }, { "comment": "/**\r\n * Removes all sounds from the manager, destroying the sounds.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#removeAll\r\n * @since 3.23.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 398, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "removeAll", "longname": "Phaser.Sound.HTML5AudioSoundManager#removeAll", "kind": "function", "description": "Removes all sounds from the manager, destroying the sounds.", "since": "3.23.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#removeAll", "inherited": true, "___id": "T000002R057062", "___s": true }, { "comment": "/**\r\n * Removes all sounds from the sound manager that have an asset key matching the given value.\r\n * The removed sounds are destroyed before removal.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#removeByKey\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key to match when removing sound objects.\r\n *\r\n * @return {number} The number of matching sound objects that were removed.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 414, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "removeByKey", "longname": "Phaser.Sound.HTML5AudioSoundManager#removeByKey", "kind": "function", "description": "Removes all sounds from the sound manager that have an asset key matching the given value.\rThe removed sounds are destroyed before removal.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of matching sound objects that were removed." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to match when removing sound objects.", "name": "key" } ], "inherits": "Phaser.Sound.BaseSoundManager#removeByKey", "inherited": true, "___id": "T000002R057063", "___s": true }, { "comment": "/**\r\n * Pauses all the sounds in the game.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#pauseAll\r\n * @fires Phaser.Sound.Events#PAUSE_ALL\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 446, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "pauseAll", "longname": "Phaser.Sound.HTML5AudioSoundManager#pauseAll", "kind": "function", "description": "Pauses all the sounds in the game.", "fires": [ "Phaser.Sound.Events#event:PAUSE_ALL" ], "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#pauseAll", "inherited": true, "___id": "T000002R057064", "___s": true }, { "comment": "/**\r\n * Resumes all the sounds in the game.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#resumeAll\r\n * @fires Phaser.Sound.Events#RESUME_ALL\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "resumeAll", "longname": "Phaser.Sound.HTML5AudioSoundManager#resumeAll", "kind": "function", "description": "Resumes all the sounds in the game.", "fires": [ "Phaser.Sound.Events#event:RESUME_ALL" ], "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#resumeAll", "inherited": true, "___id": "T000002R057065", "___s": true }, { "comment": "/**\r\n * Sets the X and Y position of the Spatial Audio listener on this Web Audios context.\r\n *\r\n * If you call this method with no parameters it will default to the center-point of\r\n * the game canvas. Depending on the type of game you're making, you may need to call\r\n * this method constantly to reset the listener position as the camera scrolls.\r\n *\r\n * Calling this method does nothing on HTML5Audio.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#setListenerPosition\r\n * @since 3.60.0\r\n *\r\n * @param {number} [x] - The x position of the Spatial Audio listener.\r\n * @param {number} [y] - The y position of the Spatial Audio listener.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 480, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "setListenerPosition", "longname": "Phaser.Sound.HTML5AudioSoundManager#setListenerPosition", "kind": "function", "description": "Sets the X and Y position of the Spatial Audio listener on this Web Audios context.\r\rIf you call this method with no parameters it will default to the center-point of\rthe game canvas. Depending on the type of game you're making, you may need to call\rthis method constantly to reset the listener position as the camera scrolls.\r\rCalling this method does nothing on HTML5Audio.", "since": "3.60.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The x position of the Spatial Audio listener.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y position of the Spatial Audio listener.", "name": "y" } ], "inherits": "Phaser.Sound.BaseSoundManager#setListenerPosition", "inherited": true, "___id": "T000002R057066", "___s": true }, { "comment": "/**\r\n * Stops all the sounds in the game.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#stopAll\r\n * @fires Phaser.Sound.Events#STOP_ALL\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 497, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "stopAll", "longname": "Phaser.Sound.HTML5AudioSoundManager#stopAll", "kind": "function", "description": "Stops all the sounds in the game.", "fires": [ "Phaser.Sound.Events#event:STOP_ALL" ], "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#stopAll", "inherited": true, "___id": "T000002R057067", "___s": true }, { "comment": "/**\r\n * Stops any sounds matching the given key.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#stopByKey\r\n * @since 3.23.0\r\n *\r\n * @param {string} key - Sound asset key.\r\n *\r\n * @return {number} - How many sounds were stopped.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 514, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "stopByKey", "longname": "Phaser.Sound.HTML5AudioSoundManager#stopByKey", "kind": "function", "description": "Stops any sounds matching the given key.", "since": "3.23.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "- How many sounds were stopped." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Sound asset key.", "name": "key" } ], "inherits": "Phaser.Sound.BaseSoundManager#stopByKey", "inherited": true, "___id": "T000002R057068", "___s": true }, { "comment": "/**\r\n * Update method called on every game step.\r\n * Removes destroyed sounds and updates every active sound in the game.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#update\r\n * @protected\r\n * @fires Phaser.Sound.Events#UNLOCKED\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 elapsed since the last frame.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 605, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "update", "longname": "Phaser.Sound.HTML5AudioSoundManager#update", "kind": "function", "description": "Update method called on every game step.\rRemoves destroyed sounds and updates every active sound in the game.", "access": "protected", "fires": [ "Phaser.Sound.Events#event:UNLOCKED" ], "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "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 elapsed since the last frame.", "name": "delta" } ], "inherits": "Phaser.Sound.BaseSoundManager#update", "inherited": true, "___id": "T000002R057071", "___s": true }, { "comment": "/**\r\n * Sets the global playback rate at which all the sounds will be played.\r\n *\r\n * For example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\r\n * and 2.0 doubles the audios playback speed.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#setRate\r\n * @fires Phaser.Sound.Events#GLOBAL_RATE\r\n * @since 3.3.0\r\n *\r\n * @param {number} value - Global playback rate at which all the sounds will be played.\r\n *\r\n * @return {this} This Sound Manager.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 686, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "setRate", "longname": "Phaser.Sound.HTML5AudioSoundManager#setRate", "kind": "function", "description": "Sets the global playback rate at which all the sounds will be played.\r\rFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\rand 2.0 doubles the audios playback speed.", "fires": [ "Phaser.Sound.Events#event:GLOBAL_RATE" ], "since": "3.3.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound Manager." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Global playback rate at which all the sounds will be played.", "name": "value" } ], "inherits": "Phaser.Sound.BaseSoundManager#setRate", "inherited": true, "___id": "T000002R057073", "___s": true }, { "comment": "/**\r\n * Global playback rate at which all the sounds will be played.\r\n * Value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\r\n * and 2.0 doubles the audio's playback speed.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#rate\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 707, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "rate", "longname": "Phaser.Sound.HTML5AudioSoundManager#rate", "kind": "member", "description": "Global playback rate at which all the sounds will be played.\rValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\rand 2.0 doubles the audio's playback speed.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#rate", "inherited": true, "___id": "T000002R057074", "___s": true }, { "comment": "/**\r\n * Sets the global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\r\n * The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#setDetune\r\n * @fires Phaser.Sound.Events#GLOBAL_DETUNE\r\n * @since 3.3.0\r\n *\r\n * @param {number} value - The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @return {this} This Sound Manager.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 738, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "setDetune", "longname": "Phaser.Sound.HTML5AudioSoundManager#setDetune", "kind": "function", "description": "Sets the global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\rThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "fires": [ "Phaser.Sound.Events#event:GLOBAL_DETUNE" ], "since": "3.3.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound Manager." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "name": "value" } ], "inherits": "Phaser.Sound.BaseSoundManager#setDetune", "inherited": true, "___id": "T000002R057075", "___s": true }, { "comment": "/**\r\n * Global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\r\n * The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#detune\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 757, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "detune", "longname": "Phaser.Sound.HTML5AudioSoundManager#detune", "kind": "member", "description": "Global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\rThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#detune", "inherited": true, "___id": "T000002R057076", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Sound.HTML5AudioSoundManager#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R057077", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Sound.HTML5AudioSoundManager#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R057078", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Sound.HTML5AudioSoundManager#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R057079", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Sound.HTML5AudioSoundManager#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R057080", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Sound.HTML5AudioSoundManager#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R057081", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Sound.HTML5AudioSoundManager#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R057082", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Sound.HTML5AudioSoundManager#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R057083", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Sound.HTML5AudioSoundManager#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R057084", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Sound.HTML5AudioSoundManager#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R057085", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Sound.HTML5AudioSoundManager#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R057086", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Sound.HTML5AudioSoundManager#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.HTML5AudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R057087", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Sound.NoAudioSound#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R057088", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Sound.NoAudioSound#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Sound.NoAudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R057089", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Sound.NoAudioSound#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Sound.NoAudioSound", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R057090", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Sound.NoAudioSound#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Sound.NoAudioSound", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R057091", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Sound.NoAudioSound#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Sound.NoAudioSound", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R057092", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Sound.NoAudioSound#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.NoAudioSound", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R057093", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Sound.NoAudioSound#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.NoAudioSound", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R057094", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Sound.NoAudioSound#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.NoAudioSound", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R057095", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Sound.NoAudioSound#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.NoAudioSound", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R057096", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Sound.NoAudioSound#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.NoAudioSound", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R057097", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Sound.NoAudioSound#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.NoAudioSound", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R057098", "___s": true }, { "comment": "/**\r\n * Local reference to game.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#game\r\n * @type {Phaser.Game}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "game", "longname": "Phaser.Sound.NoAudioSoundManager#game", "kind": "member", "description": "Local reference to game.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#game", "inherited": true, "___id": "T000002R057099", "___s": true }, { "comment": "/**\r\n * Local reference to the JSON Cache, as used by Audio Sprites.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#jsonCache\r\n * @type {Phaser.Cache.BaseCache}\r\n * @readonly\r\n * @since 3.7.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "jsonCache", "longname": "Phaser.Sound.NoAudioSoundManager#jsonCache", "kind": "member", "description": "Local reference to the JSON Cache, as used by Audio Sprites.", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "readonly": true, "since": "3.7.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#jsonCache", "inherited": true, "___id": "T000002R057100", "___s": true }, { "comment": "/**\r\n * Global mute setting.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#mute\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "mute", "longname": "Phaser.Sound.NoAudioSoundManager#mute", "kind": "member", "description": "Global mute setting.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#mute", "inherited": true, "___id": "T000002R057102", "___s": true }, { "comment": "/**\r\n * Global volume setting.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#volume\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "volume", "longname": "Phaser.Sound.NoAudioSoundManager#volume", "kind": "member", "description": "Global volume setting.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#volume", "inherited": true, "___id": "T000002R057103", "___s": true }, { "comment": "/**\r\n * Flag indicating if sounds should be paused when game looses focus,\r\n * for instance when user switches to another tab/program/app.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#pauseOnBlur\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "pauseOnBlur", "longname": "Phaser.Sound.NoAudioSoundManager#pauseOnBlur", "kind": "member", "description": "Flag indicating if sounds should be paused when game looses focus,\rfor instance when user switches to another tab/program/app.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#pauseOnBlur", "inherited": true, "___id": "T000002R057104", "___s": true }, { "comment": "/**\r\n * Mobile devices require sounds to be triggered from an explicit user action,\r\n * such as a tap, before any sound can be loaded/played on a web page.\r\n * Set to true if the audio system is currently locked awaiting user interaction.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#locked\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 128, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "locked", "longname": "Phaser.Sound.NoAudioSoundManager#locked", "kind": "member", "description": "Mobile devices require sounds to be triggered from an explicit user action,\rsuch as a tap, before any sound can be loaded/played on a web page.\rSet to true if the audio system is currently locked awaiting user interaction.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#locked", "inherited": true, "___id": "T000002R057107", "___s": true }, { "comment": "/**\r\n * Flag used to track if the game has lost focus.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#gameLostFocus\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "gameLostFocus", "longname": "Phaser.Sound.NoAudioSoundManager#gameLostFocus", "kind": "member", "description": "Flag used to track if the game has lost focus.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#gameLostFocus", "inherited": true, "___id": "T000002R057109", "___s": true }, { "comment": "/**\r\n * The Spatial Audio listener position.\r\n *\r\n * Only available with WebAudio.\r\n *\r\n * You can modify the x/y properties of this Vec2 directly to\r\n * adjust the listener position within the game world.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#listenerPosition\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 162, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "listenerPosition", "longname": "Phaser.Sound.NoAudioSoundManager#listenerPosition", "kind": "member", "description": "The Spatial Audio listener position.\r\rOnly available with WebAudio.\r\rYou can modify the x/y properties of this Vec2 directly to\radjust the listener position within the game world.", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.60.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#listenerPosition", "inherited": true, "___id": "T000002R057110", "___s": true }, { "comment": "/**\r\n * Returns all sounds from this Sound Manager that are currently\r\n * playing. That is, Sound instances that have their `isPlaying`\r\n * property set to `true`.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#getAllPlaying\r\n * @since 3.60.0\r\n *\r\n * @generic {Phaser.Sound.BaseSound} T\r\n * @genericUse {T[]} - [$return]\r\n *\r\n * @return {Phaser.Sound.BaseSound[]} - All currently playing sounds, or an empty array.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "getAllPlaying", "longname": "Phaser.Sound.NoAudioSoundManager#getAllPlaying", "kind": "function", "description": "Returns all sounds from this Sound Manager that are currently\rplaying. That is, Sound instances that have their `isPlaying`\rproperty set to `true`.", "since": "3.60.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Sound.BaseSound} T", "value": "{Phaser.Sound.BaseSound} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [$return]", "value": "{T[]} - [$return]" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Sound.BaseSound", "type": "NameExpression" } ] } }, "description": "- All currently playing sounds, or an empty array." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#getAllPlaying", "inherited": true, "___id": "T000002R057111", "___s": true }, { "comment": "/**\r\n * Sets the X and Y position of the Spatial Audio listener on this Web Audios context.\r\n *\r\n * If you call this method with no parameters it will default to the center-point of\r\n * the game canvas. Depending on the type of game you're making, you may need to call\r\n * this method constantly to reset the listener position as the camera scrolls.\r\n *\r\n * Calling this method does nothing on HTML5Audio.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#setListenerPosition\r\n * @since 3.60.0\r\n *\r\n * @param {number} [x] - The x position of the Spatial Audio listener.\r\n * @param {number} [y] - The y position of the Spatial Audio listener.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 480, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "setListenerPosition", "longname": "Phaser.Sound.NoAudioSoundManager#setListenerPosition", "kind": "function", "description": "Sets the X and Y position of the Spatial Audio listener on this Web Audios context.\r\rIf you call this method with no parameters it will default to the center-point of\rthe game canvas. Depending on the type of game you're making, you may need to call\rthis method constantly to reset the listener position as the camera scrolls.\r\rCalling this method does nothing on HTML5Audio.", "since": "3.60.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The x position of the Spatial Audio listener.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y position of the Spatial Audio listener.", "name": "y" } ], "inherits": "Phaser.Sound.BaseSoundManager#setListenerPosition", "inherited": true, "___id": "T000002R057112", "___s": true }, { "comment": "/**\r\n * Global playback rate at which all the sounds will be played.\r\n * Value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\r\n * and 2.0 doubles the audio's playback speed.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#rate\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 707, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "rate", "longname": "Phaser.Sound.NoAudioSoundManager#rate", "kind": "member", "description": "Global playback rate at which all the sounds will be played.\rValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\rand 2.0 doubles the audio's playback speed.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#rate", "inherited": true, "___id": "T000002R057113", "___s": true }, { "comment": "/**\r\n * Global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\r\n * The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#detune\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 757, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "detune", "longname": "Phaser.Sound.NoAudioSoundManager#detune", "kind": "member", "description": "Global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\rThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#detune", "inherited": true, "___id": "T000002R057114", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Sound.NoAudioSoundManager#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R057115", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Sound.NoAudioSoundManager#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R057116", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Sound.NoAudioSoundManager#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R057117", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Sound.NoAudioSoundManager#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R057118", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Sound.NoAudioSoundManager#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R057119", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Sound.NoAudioSoundManager#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R057120", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Sound.NoAudioSoundManager#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R057121", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Sound.NoAudioSoundManager#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R057122", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Sound.NoAudioSoundManager#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R057123", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Sound.NoAudioSoundManager#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R057124", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Sound.NoAudioSoundManager#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.NoAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R057125", "___s": true }, { "comment": "/**\r\n * Local reference to the sound manager.\r\n *\r\n * @name Phaser.Sound.BaseSound#manager\r\n * @type {Phaser.Sound.BaseSoundManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "manager", "longname": "Phaser.Sound.WebAudioSound#manager", "kind": "member", "description": "Local reference to the sound manager.", "type": { "names": [ "Phaser.Sound.BaseSoundManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSoundManager" } }, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#manager", "inherited": true, "___id": "T000002R057126", "___s": true }, { "comment": "/**\r\n * Asset key for the sound.\r\n *\r\n * @name Phaser.Sound.BaseSound#key\r\n * @type {string}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "key", "longname": "Phaser.Sound.WebAudioSound#key", "kind": "member", "description": "Asset key for the sound.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#key", "inherited": true, "___id": "T000002R057127", "___s": true }, { "comment": "/**\r\n * Flag indicating if sound is currently playing.\r\n *\r\n * @name Phaser.Sound.BaseSound#isPlaying\r\n * @type {boolean}\r\n * @default false\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "isPlaying", "longname": "Phaser.Sound.WebAudioSound#isPlaying", "kind": "member", "description": "Flag indicating if sound is currently playing.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#isPlaying", "inherited": true, "___id": "T000002R057128", "___s": true }, { "comment": "/**\r\n * Flag indicating if sound is currently paused.\r\n *\r\n * @name Phaser.Sound.BaseSound#isPaused\r\n * @type {boolean}\r\n * @default false\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "isPaused", "longname": "Phaser.Sound.WebAudioSound#isPaused", "kind": "member", "description": "Flag indicating if sound is currently paused.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#isPaused", "inherited": true, "___id": "T000002R057129", "___s": true }, { "comment": "/**\r\n * A property that holds the value of sound's actual playback rate,\r\n * after its rate and detune values has been combined with global\r\n * rate and detune values.\r\n *\r\n * @name Phaser.Sound.BaseSound#totalRate\r\n * @type {number}\r\n * @default 1\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "totalRate", "longname": "Phaser.Sound.WebAudioSound#totalRate", "kind": "member", "description": "A property that holds the value of sound's actual playback rate,\rafter its rate and detune values has been combined with global\rrate and detune values.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#totalRate", "inherited": true, "___id": "T000002R057130", "___s": true }, { "comment": "/**\r\n * A value representing the duration, in seconds.\r\n * It could be total sound duration or a marker duration.\r\n *\r\n * @name Phaser.Sound.BaseSound#duration\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "duration", "longname": "Phaser.Sound.WebAudioSound#duration", "kind": "member", "description": "A value representing the duration, in seconds.\rIt could be total sound duration or a marker duration.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#duration", "inherited": true, "___id": "T000002R057131", "___s": true }, { "comment": "/**\r\n * The total duration of the sound in seconds.\r\n *\r\n * @name Phaser.Sound.BaseSound#totalDuration\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 103, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "totalDuration", "longname": "Phaser.Sound.WebAudioSound#totalDuration", "kind": "member", "description": "The total duration of the sound in seconds.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#totalDuration", "inherited": true, "___id": "T000002R057132", "___s": true }, { "comment": "/**\r\n * Object containing markers definitions.\r\n *\r\n * @name Phaser.Sound.BaseSound#markers\r\n * @type {Object.}\r\n * @default {}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "markers", "longname": "Phaser.Sound.WebAudioSound#markers", "kind": "member", "description": "Object containing markers definitions.", "type": { "names": [ "Object." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } ] } }, "defaultvalue": "{}", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#markers", "inherited": true, "___id": "T000002R057135", "___s": true }, { "comment": "/**\r\n * Currently playing marker.\r\n * 'null' if whole sound is playing.\r\n *\r\n * @name Phaser.Sound.BaseSound#currentMarker\r\n * @type {Phaser.Types.Sound.SoundMarker}\r\n * @default null\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "currentMarker", "longname": "Phaser.Sound.WebAudioSound#currentMarker", "kind": "member", "description": "Currently playing marker.\r'null' if whole sound is playing.", "type": { "names": [ "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } }, "defaultvalue": "null", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#currentMarker", "inherited": true, "___id": "T000002R057136", "___s": true }, { "comment": "/**\r\n * Flag indicating if destroy method was called on this sound.\r\n *\r\n * @name Phaser.Sound.BaseSound#pendingRemove\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 171, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "pendingRemove", "longname": "Phaser.Sound.WebAudioSound#pendingRemove", "kind": "member", "description": "Flag indicating if destroy method was called on this sound.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#pendingRemove", "inherited": true, "___id": "T000002R057137", "___s": true }, { "comment": "/**\r\n * Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object.\r\n * This allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.\r\n *\r\n * @method Phaser.Sound.BaseSound#addMarker\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Sound.SoundMarker} marker - Marker object.\r\n *\r\n * @return {boolean} Whether the marker was added successfully.\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "addMarker", "longname": "Phaser.Sound.WebAudioSound#addMarker", "kind": "function", "description": "Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object.\rThis allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the marker was added successfully." } ], "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } }, "description": "Marker object.", "name": "marker" } ], "inherits": "Phaser.Sound.BaseSound#addMarker", "inherited": true, "___id": "T000002R057138", "___s": true }, { "comment": "/**\r\n * Updates previously added marker.\r\n *\r\n * @method Phaser.Sound.BaseSound#updateMarker\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Sound.SoundMarker} marker - Marker object with updated values.\r\n *\r\n * @return {boolean} Whether the marker was updated successfully.\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 229, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "updateMarker", "longname": "Phaser.Sound.WebAudioSound#updateMarker", "kind": "function", "description": "Updates previously added marker.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the marker was updated successfully." } ], "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } }, "description": "Marker object with updated values.", "name": "marker" } ], "inherits": "Phaser.Sound.BaseSound#updateMarker", "inherited": true, "___id": "T000002R057139", "___s": true }, { "comment": "/**\r\n * Removes a marker from the sound.\r\n *\r\n * @method Phaser.Sound.BaseSound#removeMarker\r\n * @since 3.0.0\r\n *\r\n * @param {string} markerName - The name of the marker to remove.\r\n *\r\n * @return {?Phaser.Types.Sound.SoundMarker} Removed marker object or 'null' if there was no marker with provided name.\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 259, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "removeMarker", "longname": "Phaser.Sound.WebAudioSound#removeMarker", "kind": "function", "description": "Removes a marker from the sound.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker", "nullable": true } }, "nullable": true, "description": "Removed marker object or 'null' if there was no marker with provided name." } ], "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the marker to remove.", "name": "markerName" } ], "inherits": "Phaser.Sound.BaseSound#removeMarker", "inherited": true, "___id": "T000002R057140", "___s": true }, { "comment": "/**\r\n * Method used internally for resetting values of some of the config properties.\r\n *\r\n * @method Phaser.Sound.BaseSound#resetConfig\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSound.js", "lineno": 428, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "resetConfig", "longname": "Phaser.Sound.WebAudioSound#resetConfig", "kind": "function", "description": "Method used internally for resetting values of some of the config properties.", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Sound.BaseSound#resetConfig", "inherited": true, "___id": "T000002R057141", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Sound.WebAudioSound#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R057142", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Sound.WebAudioSound#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R057143", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Sound.WebAudioSound#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R057144", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Sound.WebAudioSound#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R057145", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Sound.WebAudioSound#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R057146", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Sound.WebAudioSound#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R057147", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Sound.WebAudioSound#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R057148", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Sound.WebAudioSound#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R057149", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Sound.WebAudioSound#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R057150", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Sound.WebAudioSound#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R057151", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Sound.WebAudioSound#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.WebAudioSound", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R057152", "___s": true }, { "comment": "/**\r\n * Local reference to game.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#game\r\n * @type {Phaser.Game}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "game", "longname": "Phaser.Sound.WebAudioSoundManager#game", "kind": "member", "description": "Local reference to game.", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#game", "inherited": true, "___id": "T000002R057153", "___s": true }, { "comment": "/**\r\n * Local reference to the JSON Cache, as used by Audio Sprites.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#jsonCache\r\n * @type {Phaser.Cache.BaseCache}\r\n * @readonly\r\n * @since 3.7.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "jsonCache", "longname": "Phaser.Sound.WebAudioSoundManager#jsonCache", "kind": "member", "description": "Local reference to the JSON Cache, as used by Audio Sprites.", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "readonly": true, "since": "3.7.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#jsonCache", "inherited": true, "___id": "T000002R057154", "___s": true }, { "comment": "/**\r\n * Flag indicating if sounds should be paused when game looses focus,\r\n * for instance when user switches to another tab/program/app.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#pauseOnBlur\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "pauseOnBlur", "longname": "Phaser.Sound.WebAudioSoundManager#pauseOnBlur", "kind": "member", "description": "Flag indicating if sounds should be paused when game looses focus,\rfor instance when user switches to another tab/program/app.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#pauseOnBlur", "inherited": true, "___id": "T000002R057156", "___s": true }, { "comment": "/**\r\n * Mobile devices require sounds to be triggered from an explicit user action,\r\n * such as a tap, before any sound can be loaded/played on a web page.\r\n * Set to true if the audio system is currently locked awaiting user interaction.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#locked\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 128, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "locked", "longname": "Phaser.Sound.WebAudioSoundManager#locked", "kind": "member", "description": "Mobile devices require sounds to be triggered from an explicit user action,\rsuch as a tap, before any sound can be loaded/played on a web page.\rSet to true if the audio system is currently locked awaiting user interaction.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#locked", "inherited": true, "___id": "T000002R057159", "___s": true }, { "comment": "/**\r\n * Flag used to track if the game has lost focus.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#gameLostFocus\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "gameLostFocus", "longname": "Phaser.Sound.WebAudioSoundManager#gameLostFocus", "kind": "member", "description": "Flag used to track if the game has lost focus.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#gameLostFocus", "inherited": true, "___id": "T000002R057161", "___s": true }, { "comment": "/**\r\n * The Spatial Audio listener position.\r\n *\r\n * Only available with WebAudio.\r\n *\r\n * You can modify the x/y properties of this Vec2 directly to\r\n * adjust the listener position within the game world.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#listenerPosition\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 162, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "listenerPosition", "longname": "Phaser.Sound.WebAudioSoundManager#listenerPosition", "kind": "member", "description": "The Spatial Audio listener position.\r\rOnly available with WebAudio.\r\rYou can modify the x/y properties of this Vec2 directly to\radjust the listener position within the game world.", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.60.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#listenerPosition", "inherited": true, "___id": "T000002R057162", "___s": true }, { "comment": "/**\r\n * Adds a new audio sprite sound into the sound manager.\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 * @method Phaser.Sound.BaseSoundManager#addAudioSprite\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - Asset key for the sound.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config] - An optional config object containing default sound settings.\r\n *\r\n * @return {(Phaser.Sound.NoAudioSound|Phaser.Sound.HTML5AudioSound|Phaser.Sound.WebAudioSound)} The new audio sprite sound instance.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 196, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "addAudioSprite", "longname": "Phaser.Sound.WebAudioSoundManager#addAudioSprite", "kind": "function", "description": "Adds a new audio sprite sound into the sound manager.\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", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Sound.NoAudioSound", "Phaser.Sound.HTML5AudioSound", "Phaser.Sound.WebAudioSound" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.NoAudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSound" }, { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSound" } ] } }, "description": "The new audio sprite sound instance." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "An optional config object containing default sound settings.", "name": "config" } ], "inherits": "Phaser.Sound.BaseSoundManager#addAudioSprite", "inherited": true, "___id": "T000002R057163", "___s": true }, { "comment": "/**\r\n * Gets the first sound in this Sound Manager that matches the given key.\r\n * If none can be found it returns `null`.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#get\r\n * @since 3.23.0\r\n *\r\n * @generic {Phaser.Sound.BaseSound} T\r\n * @genericUse {T} - [$return]\r\n *\r\n * @param {string} key - Sound asset key.\r\n *\r\n * @return {?Phaser.Sound.BaseSound} - The sound, or null.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 241, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "get", "longname": "Phaser.Sound.WebAudioSoundManager#get", "kind": "function", "description": "Gets the first sound in this Sound Manager that matches the given key.\rIf none can be found it returns `null`.", "since": "3.23.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Sound.BaseSound} T", "value": "{Phaser.Sound.BaseSound} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$return]", "value": "{T} - [$return]" } ], "returns": [ { "type": { "names": [ "Phaser.Sound.BaseSound" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSound", "nullable": true } }, "nullable": true, "description": "- The sound, or null." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Sound asset key.", "name": "key" } ], "inherits": "Phaser.Sound.BaseSoundManager#get", "inherited": true, "___id": "T000002R057164", "___s": true }, { "comment": "/**\r\n * Gets all sounds in this Sound Manager.\r\n *\r\n * You can optionally specify a key, in which case only Sound instances that match the given key\r\n * will be returned.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#getAll\r\n * @since 3.23.0\r\n *\r\n * @generic {Phaser.Sound.BaseSound} T\r\n * @genericUse {T[]} - [$return]\r\n *\r\n * @param {string} [key] - Optional asset key. If given, only Sound instances with this key will be returned.\r\n *\r\n * @return {Phaser.Sound.BaseSound[]} - The sounds, or an empty array.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 260, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "getAll", "longname": "Phaser.Sound.WebAudioSoundManager#getAll", "kind": "function", "description": "Gets all sounds in this Sound Manager.\r\rYou can optionally specify a key, in which case only Sound instances that match the given key\rwill be returned.", "since": "3.23.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Sound.BaseSound} T", "value": "{Phaser.Sound.BaseSound} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [$return]", "value": "{T[]} - [$return]" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Sound.BaseSound", "type": "NameExpression" } ] } }, "description": "- The sounds, or an empty array." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional asset key. If given, only Sound instances with this key will be returned.", "name": "key" } ], "inherits": "Phaser.Sound.BaseSoundManager#getAll", "inherited": true, "___id": "T000002R057165", "___s": true }, { "comment": "/**\r\n * Returns all sounds from this Sound Manager that are currently\r\n * playing. That is, Sound instances that have their `isPlaying`\r\n * property set to `true`.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#getAllPlaying\r\n * @since 3.60.0\r\n *\r\n * @generic {Phaser.Sound.BaseSound} T\r\n * @genericUse {T[]} - [$return]\r\n *\r\n * @return {Phaser.Sound.BaseSound[]} - All currently playing sounds, or an empty array.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "getAllPlaying", "longname": "Phaser.Sound.WebAudioSoundManager#getAllPlaying", "kind": "function", "description": "Returns all sounds from this Sound Manager that are currently\rplaying. That is, Sound instances that have their `isPlaying`\rproperty set to `true`.", "since": "3.60.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Sound.BaseSound} T", "value": "{Phaser.Sound.BaseSound} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [$return]", "value": "{T[]} - [$return]" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Sound.BaseSound", "type": "NameExpression" } ] } }, "description": "- All currently playing sounds, or an empty array." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#getAllPlaying", "inherited": true, "___id": "T000002R057166", "___s": true }, { "comment": "/**\r\n * Adds a new sound to the sound manager and plays it.\r\n *\r\n * The sound will be automatically removed (destroyed) once playback ends.\r\n *\r\n * This lets you play a new sound on the fly without the need to keep a reference to it.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#play\r\n * @listens Phaser.Sound.Events#COMPLETE\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - Asset key for the sound.\r\n * @param {(Phaser.Types.Sound.SoundConfig|Phaser.Types.Sound.SoundMarker)} [extra] - An optional additional object containing settings to be applied to the sound. It could be either config or marker object.\r\n *\r\n * @return {boolean} Whether the sound started playing successfully.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 306, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "play", "longname": "Phaser.Sound.WebAudioSoundManager#play", "kind": "function", "description": "Adds a new sound to the sound manager and plays it.\r\rThe sound will be automatically removed (destroyed) once playback ends.\r\rThis lets you play a new sound on the fly without the need to keep a reference to it.", "listens": [ "Phaser.Sound.Events#event:COMPLETE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the sound started playing successfully." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig", "Phaser.Types.Sound.SoundMarker" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" }, { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundMarker" } ] } }, "optional": true, "description": "An optional additional object containing settings to be applied to the sound. It could be either config or marker object.", "name": "extra" } ], "inherits": "Phaser.Sound.BaseSoundManager#play", "inherited": true, "___id": "T000002R057167", "___s": true }, { "comment": "/**\r\n * Adds a new audio sprite sound to the sound manager and plays it.\r\n * The sprite will be automatically removed (destroyed) once playback ends.\r\n * This lets you play a new sound on the fly without the need to keep a reference to it.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#playAudioSprite\r\n * @listens Phaser.Sound.Events#COMPLETE\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - Asset key for the sound.\r\n * @param {string} spriteName - The name of the sound sprite to play.\r\n * @param {Phaser.Types.Sound.SoundConfig} [config] - An optional config object containing default sound settings.\r\n *\r\n * @return {boolean} Whether the audio sprite sound started playing successfully.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 347, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "playAudioSprite", "longname": "Phaser.Sound.WebAudioSoundManager#playAudioSprite", "kind": "function", "description": "Adds a new audio sprite sound to the sound manager and plays it.\rThe sprite will be automatically removed (destroyed) once playback ends.\rThis lets you play a new sound on the fly without the need to keep a reference to it.", "listens": [ "Phaser.Sound.Events#event:COMPLETE" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the audio sprite sound started playing successfully." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Asset key for the sound.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the sound sprite to play.", "name": "spriteName" }, { "type": { "names": [ "Phaser.Types.Sound.SoundConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Sound.SoundConfig" } }, "optional": true, "description": "An optional config object containing default sound settings.", "name": "config" } ], "inherits": "Phaser.Sound.BaseSoundManager#playAudioSprite", "inherited": true, "___id": "T000002R057168", "___s": true }, { "comment": "/**\r\n * Removes a sound from the sound manager.\r\n * The removed sound is destroyed before removal.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#remove\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Sound.BaseSound} sound - The sound object to remove.\r\n *\r\n * @return {boolean} True if the sound was removed successfully, otherwise false.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 371, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "remove", "longname": "Phaser.Sound.WebAudioSoundManager#remove", "kind": "function", "description": "Removes a sound from the sound manager.\rThe removed sound is destroyed before removal.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the sound was removed successfully, otherwise false." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Sound.BaseSound" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Sound.BaseSound" } }, "description": "The sound object to remove.", "name": "sound" } ], "inherits": "Phaser.Sound.BaseSoundManager#remove", "inherited": true, "___id": "T000002R057169", "___s": true }, { "comment": "/**\r\n * Removes all sounds from the manager, destroying the sounds.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#removeAll\r\n * @since 3.23.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 398, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "removeAll", "longname": "Phaser.Sound.WebAudioSoundManager#removeAll", "kind": "function", "description": "Removes all sounds from the manager, destroying the sounds.", "since": "3.23.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#removeAll", "inherited": true, "___id": "T000002R057170", "___s": true }, { "comment": "/**\r\n * Removes all sounds from the sound manager that have an asset key matching the given value.\r\n * The removed sounds are destroyed before removal.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#removeByKey\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key to match when removing sound objects.\r\n *\r\n * @return {number} The number of matching sound objects that were removed.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 414, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "removeByKey", "longname": "Phaser.Sound.WebAudioSoundManager#removeByKey", "kind": "function", "description": "Removes all sounds from the sound manager that have an asset key matching the given value.\rThe removed sounds are destroyed before removal.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of matching sound objects that were removed." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to match when removing sound objects.", "name": "key" } ], "inherits": "Phaser.Sound.BaseSoundManager#removeByKey", "inherited": true, "___id": "T000002R057171", "___s": true }, { "comment": "/**\r\n * Pauses all the sounds in the game.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#pauseAll\r\n * @fires Phaser.Sound.Events#PAUSE_ALL\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 446, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "pauseAll", "longname": "Phaser.Sound.WebAudioSoundManager#pauseAll", "kind": "function", "description": "Pauses all the sounds in the game.", "fires": [ "Phaser.Sound.Events#event:PAUSE_ALL" ], "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#pauseAll", "inherited": true, "___id": "T000002R057172", "___s": true }, { "comment": "/**\r\n * Resumes all the sounds in the game.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#resumeAll\r\n * @fires Phaser.Sound.Events#RESUME_ALL\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "resumeAll", "longname": "Phaser.Sound.WebAudioSoundManager#resumeAll", "kind": "function", "description": "Resumes all the sounds in the game.", "fires": [ "Phaser.Sound.Events#event:RESUME_ALL" ], "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#resumeAll", "inherited": true, "___id": "T000002R057173", "___s": true }, { "comment": "/**\r\n * Stops all the sounds in the game.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#stopAll\r\n * @fires Phaser.Sound.Events#STOP_ALL\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 497, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "stopAll", "longname": "Phaser.Sound.WebAudioSoundManager#stopAll", "kind": "function", "description": "Stops all the sounds in the game.", "fires": [ "Phaser.Sound.Events#event:STOP_ALL" ], "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#stopAll", "inherited": true, "___id": "T000002R057174", "___s": true }, { "comment": "/**\r\n * Stops any sounds matching the given key.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#stopByKey\r\n * @since 3.23.0\r\n *\r\n * @param {string} key - Sound asset key.\r\n *\r\n * @return {number} - How many sounds were stopped.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 514, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "stopByKey", "longname": "Phaser.Sound.WebAudioSoundManager#stopByKey", "kind": "function", "description": "Stops any sounds matching the given key.", "since": "3.23.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "- How many sounds were stopped." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Sound asset key.", "name": "key" } ], "inherits": "Phaser.Sound.BaseSoundManager#stopByKey", "inherited": true, "___id": "T000002R057175", "___s": true }, { "comment": "/**\r\n * Sets the global playback rate at which all the sounds will be played.\r\n *\r\n * For example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\r\n * and 2.0 doubles the audios playback speed.\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#setRate\r\n * @fires Phaser.Sound.Events#GLOBAL_RATE\r\n * @since 3.3.0\r\n *\r\n * @param {number} value - Global playback rate at which all the sounds will be played.\r\n *\r\n * @return {this} This Sound Manager.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 686, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "setRate", "longname": "Phaser.Sound.WebAudioSoundManager#setRate", "kind": "function", "description": "Sets the global playback rate at which all the sounds will be played.\r\rFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\rand 2.0 doubles the audios playback speed.", "fires": [ "Phaser.Sound.Events#event:GLOBAL_RATE" ], "since": "3.3.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound Manager." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Global playback rate at which all the sounds will be played.", "name": "value" } ], "inherits": "Phaser.Sound.BaseSoundManager#setRate", "inherited": true, "___id": "T000002R057179", "___s": true }, { "comment": "/**\r\n * Global playback rate at which all the sounds will be played.\r\n * Value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\r\n * and 2.0 doubles the audio's playback speed.\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#rate\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 707, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "rate", "longname": "Phaser.Sound.WebAudioSoundManager#rate", "kind": "member", "description": "Global playback rate at which all the sounds will be played.\rValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\rand 2.0 doubles the audio's playback speed.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#rate", "inherited": true, "___id": "T000002R057180", "___s": true }, { "comment": "/**\r\n * Sets the global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\r\n * The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @method Phaser.Sound.BaseSoundManager#setDetune\r\n * @fires Phaser.Sound.Events#GLOBAL_DETUNE\r\n * @since 3.3.0\r\n *\r\n * @param {number} value - The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @return {this} This Sound Manager.\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 738, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "setDetune", "longname": "Phaser.Sound.WebAudioSoundManager#setDetune", "kind": "function", "description": "Sets the global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\rThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "fires": [ "Phaser.Sound.Events#event:GLOBAL_DETUNE" ], "since": "3.3.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Sound Manager." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "name": "value" } ], "inherits": "Phaser.Sound.BaseSoundManager#setDetune", "inherited": true, "___id": "T000002R057181", "___s": true }, { "comment": "/**\r\n * Global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\r\n * The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).\r\n *\r\n * @name Phaser.Sound.BaseSoundManager#detune\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseSoundManager.js", "lineno": 757, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\sound", "code": {} }, "name": "detune", "longname": "Phaser.Sound.WebAudioSoundManager#detune", "kind": "member", "description": "Global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\rThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Sound.BaseSoundManager#detune", "inherited": true, "___id": "T000002R057182", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Sound.WebAudioSoundManager#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R057183", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Sound.WebAudioSoundManager#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R057184", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Sound.WebAudioSoundManager#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R057185", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Sound.WebAudioSoundManager#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R057186", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Sound.WebAudioSoundManager#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R057187", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Sound.WebAudioSoundManager#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R057188", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Sound.WebAudioSoundManager#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R057189", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Sound.WebAudioSoundManager#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R057190", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Sound.WebAudioSoundManager#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R057191", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Sound.WebAudioSoundManager#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R057192", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Sound.WebAudioSoundManager#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Sound.WebAudioSoundManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R057193", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Structs.ProcessQueue#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Structs.ProcessQueue", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R057194", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Structs.ProcessQueue#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Structs.ProcessQueue", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R057195", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Structs.ProcessQueue#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Structs.ProcessQueue", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R057196", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Structs.ProcessQueue#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Structs.ProcessQueue", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R057197", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Structs.ProcessQueue#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Structs.ProcessQueue", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R057198", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Structs.ProcessQueue#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Structs.ProcessQueue", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R057199", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Structs.ProcessQueue#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Structs.ProcessQueue", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R057200", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Structs.ProcessQueue#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Structs.ProcessQueue", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R057201", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Structs.ProcessQueue#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Structs.ProcessQueue", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R057202", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Structs.ProcessQueue#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Structs.ProcessQueue", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R057203", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Structs.ProcessQueue#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Structs.ProcessQueue", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R057204", "___s": true }, { "comment": "/**\r\n * A reference to the Texture Manager this Texture belongs to.\r\n *\r\n * @name Phaser.Textures.Texture#manager\r\n * @type {Phaser.Textures.TextureManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "manager", "longname": "Phaser.Textures.CanvasTexture#manager", "kind": "member", "description": "A reference to the Texture Manager this Texture belongs to.", "type": { "names": [ "Phaser.Textures.TextureManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } }, "since": "3.0.0", "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "inherits": "Phaser.Textures.Texture#manager", "inherited": true, "___id": "T000002R057205", "___s": true }, { "comment": "/**\r\n * The unique string-based key of this Texture.\r\n *\r\n * @name Phaser.Textures.Texture#key\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "key", "longname": "Phaser.Textures.CanvasTexture#key", "kind": "member", "description": "The unique string-based key of this Texture.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "inherits": "Phaser.Textures.Texture#key", "inherited": true, "___id": "T000002R057206", "___s": true }, { "comment": "/**\r\n * An array of TextureSource instances.\r\n * These are unique to this Texture and contain the actual Image (or Canvas) data.\r\n *\r\n * @name Phaser.Textures.Texture#source\r\n * @type {Phaser.Textures.TextureSource[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "source", "longname": "Phaser.Textures.CanvasTexture#source", "kind": "member", "description": "An array of TextureSource instances.\rThese are unique to this Texture and contain the actual Image (or Canvas) data.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Textures.TextureSource", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "inherits": "Phaser.Textures.Texture#source", "inherited": true, "___id": "T000002R057207", "___s": true }, { "comment": "/**\r\n * An array of TextureSource data instances.\r\n * Used to store additional data images, such as normal maps or specular maps.\r\n *\r\n * @name Phaser.Textures.Texture#dataSource\r\n * @type {array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 78, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "dataSource", "longname": "Phaser.Textures.CanvasTexture#dataSource", "kind": "member", "description": "An array of TextureSource data instances.\rUsed to store additional data images, such as normal maps or specular maps.", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.0.0", "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "inherits": "Phaser.Textures.Texture#dataSource", "inherited": true, "___id": "T000002R057208", "___s": true }, { "comment": "/**\r\n * A key-value object pair associating the unique Frame keys with the Frames objects.\r\n *\r\n * @name Phaser.Textures.Texture#frames\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "frames", "longname": "Phaser.Textures.CanvasTexture#frames", "kind": "member", "description": "A key-value object pair associating the unique Frame keys with the Frames objects.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "inherits": "Phaser.Textures.Texture#frames", "inherited": true, "___id": "T000002R057209", "___s": true }, { "comment": "/**\r\n * Any additional data that was set in the source JSON (if any),\r\n * or any extra data you'd like to store relating to this texture\r\n *\r\n * @name Phaser.Textures.Texture#customData\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "customData", "longname": "Phaser.Textures.CanvasTexture#customData", "kind": "member", "description": "Any additional data that was set in the source JSON (if any),\ror any extra data you'd like to store relating to this texture", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "inherits": "Phaser.Textures.Texture#customData", "inherited": true, "___id": "T000002R057210", "___s": true }, { "comment": "/**\r\n * The name of the first frame of the Texture.\r\n *\r\n * @name Phaser.Textures.Texture#firstFrame\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "firstFrame", "longname": "Phaser.Textures.CanvasTexture#firstFrame", "kind": "member", "description": "The name of the first frame of the Texture.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "inherits": "Phaser.Textures.Texture#firstFrame", "inherited": true, "___id": "T000002R057211", "___s": true }, { "comment": "/**\r\n * The total number of Frames in this Texture, including the `__BASE` frame.\r\n *\r\n * A Texture will always contain at least 1 frame because every Texture contains a `__BASE` frame by default,\r\n * in addition to any extra frames that have been added to it, such as when parsing a Sprite Sheet or Texture Atlas.\r\n *\r\n * @name Phaser.Textures.Texture#frameTotal\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "frameTotal", "longname": "Phaser.Textures.CanvasTexture#frameTotal", "kind": "member", "description": "The total number of Frames in this Texture, including the `__BASE` frame.\r\rA Texture will always contain at least 1 frame because every Texture contains a `__BASE` frame by default,\rin addition to any extra frames that have been added to it, such as when parsing a Sprite Sheet or Texture Atlas.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "inherits": "Phaser.Textures.Texture#frameTotal", "inherited": true, "___id": "T000002R057212", "___s": true }, { "comment": "/**\r\n * Adds a new Frame to this Texture.\r\n *\r\n * A Frame is a rectangular region of a TextureSource with a unique index or string-based key.\r\n *\r\n * The name given must be unique within this Texture. If it already exists, this method will return `null`.\r\n *\r\n * @method Phaser.Textures.Texture#add\r\n * @since 3.0.0\r\n *\r\n * @param {(number|string)} name - The name of this Frame. The name is unique within the Texture.\r\n * @param {number} sourceIndex - The index of the TextureSource that this Frame is a part of.\r\n * @param {number} x - The x coordinate of the top-left of this Frame.\r\n * @param {number} y - The y coordinate of the top-left of this Frame.\r\n * @param {number} width - The width of this Frame.\r\n * @param {number} height - The height of this Frame.\r\n *\r\n * @return {?Phaser.Textures.Frame} The Frame that was added to this Texture, or `null` if the given name already exists.\r\n */", "meta": { "filename": "Texture.js", "lineno": 136, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "add", "longname": "Phaser.Textures.CanvasTexture#add", "kind": "function", "description": "Adds a new Frame to this Texture.\r\rA Frame is a rectangular region of a TextureSource with a unique index or string-based key.\r\rThe name given must be unique within this Texture. If it already exists, this method will return `null`.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame", "nullable": true } }, "nullable": true, "description": "The Frame that was added to this Texture, or `null` if the given name already exists." } ], "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "params": [ { "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The name of this Frame. The name is unique within the Texture.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the TextureSource that this Frame is a part of.", "name": "sourceIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the top-left of this Frame.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the top-left of this Frame.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this Frame.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this Frame.", "name": "height" } ], "inherits": "Phaser.Textures.Texture#add", "inherited": true, "___id": "T000002R057213", "___s": true }, { "comment": "/**\r\n * Removes the given Frame from this Texture. The Frame is destroyed immediately.\r\n *\r\n * Any Game Objects using this Frame should stop using it _before_ you remove it,\r\n * as it does not happen automatically.\r\n *\r\n * @method Phaser.Textures.Texture#remove\r\n * @since 3.19.0\r\n *\r\n * @param {string} name - The key of the Frame to remove.\r\n *\r\n * @return {boolean} True if a Frame with the matching key was removed from this Texture.\r\n */", "meta": { "filename": "Texture.js", "lineno": 180, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "remove", "longname": "Phaser.Textures.CanvasTexture#remove", "kind": "function", "description": "Removes the given Frame from this Texture. The Frame is destroyed immediately.\r\rAny Game Objects using this Frame should stop using it _before_ you remove it,\ras it does not happen automatically.", "since": "3.19.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if a Frame with the matching key was removed from this Texture." } ], "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Frame to remove.", "name": "name" } ], "inherits": "Phaser.Textures.Texture#remove", "inherited": true, "___id": "T000002R057214", "___s": true }, { "comment": "/**\r\n * Checks to see if a Frame matching the given key exists within this Texture.\r\n *\r\n * @method Phaser.Textures.Texture#has\r\n * @since 3.0.0\r\n *\r\n * @param {string} name - The key of the Frame to check for.\r\n *\r\n * @return {boolean} True if a Frame with the matching key exists in this Texture.\r\n */", "meta": { "filename": "Texture.js", "lineno": 209, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "has", "longname": "Phaser.Textures.CanvasTexture#has", "kind": "function", "description": "Checks to see if a Frame matching the given key exists within this Texture.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if a Frame with the matching key exists in this Texture." } ], "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Frame to check for.", "name": "name" } ], "inherits": "Phaser.Textures.Texture#has", "inherited": true, "___id": "T000002R057215", "___s": true }, { "comment": "/**\r\n * Gets a Frame from this Texture based on either the key or the index of the Frame.\r\n *\r\n * In a Texture Atlas Frames are typically referenced by a key.\r\n * In a Sprite Sheet Frames are referenced by an index.\r\n * Passing no value for the name returns the base texture.\r\n *\r\n * @method Phaser.Textures.Texture#get\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number)} [name] - The string-based name, or integer based index, of the Frame to get from this Texture.\r\n *\r\n * @return {Phaser.Textures.Frame} The Texture Frame.\r\n */", "meta": { "filename": "Texture.js", "lineno": 224, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "get", "longname": "Phaser.Textures.CanvasTexture#get", "kind": "function", "description": "Gets a Frame from this Texture based on either the key or the index of the Frame.\r\rIn a Texture Atlas Frames are typically referenced by a key.\rIn a Sprite Sheet Frames are referenced by an index.\rPassing no value for the name returns the base texture.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "description": "The Texture Frame." } ], "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "params": [ { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The string-based name, or integer based index, of the Frame to get from this Texture.", "name": "name" } ], "inherits": "Phaser.Textures.Texture#get", "inherited": true, "___id": "T000002R057216", "___s": true }, { "comment": "/**\r\n * Takes the given TextureSource and returns the index of it within this Texture.\r\n * If it's not in this Texture, it returns -1.\r\n * Unless this Texture has multiple TextureSources, such as with a multi-atlas, this\r\n * method will always return zero or -1.\r\n *\r\n * @method Phaser.Textures.Texture#getTextureSourceIndex\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Textures.TextureSource} source - The TextureSource to check.\r\n *\r\n * @return {number} The index of the TextureSource within this Texture, or -1 if not in this Texture.\r\n */", "meta": { "filename": "Texture.js", "lineno": 258, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "getTextureSourceIndex", "longname": "Phaser.Textures.CanvasTexture#getTextureSourceIndex", "kind": "function", "description": "Takes the given TextureSource and returns the index of it within this Texture.\rIf it's not in this Texture, it returns -1.\rUnless this Texture has multiple TextureSources, such as with a multi-atlas, this\rmethod will always return zero or -1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the TextureSource within this Texture, or -1 if not in this Texture." } ], "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Textures.TextureSource" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureSource" } }, "description": "The TextureSource to check.", "name": "source" } ], "inherits": "Phaser.Textures.Texture#getTextureSourceIndex", "inherited": true, "___id": "T000002R057217", "___s": true }, { "comment": "/**\r\n * Returns an array of all the Frames in the given TextureSource.\r\n *\r\n * @method Phaser.Textures.Texture#getFramesFromTextureSource\r\n * @since 3.0.0\r\n *\r\n * @param {number} sourceIndex - The index of the TextureSource to get the Frames from.\r\n * @param {boolean} [includeBase=false] - Include the `__BASE` Frame in the output array?\r\n *\r\n * @return {Phaser.Textures.Frame[]} An array of Texture Frames.\r\n */", "meta": { "filename": "Texture.js", "lineno": 284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "getFramesFromTextureSource", "longname": "Phaser.Textures.CanvasTexture#getFramesFromTextureSource", "kind": "function", "description": "Returns an array of all the Frames in the given TextureSource.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Textures.Frame", "type": "NameExpression" } ] } }, "description": "An array of Texture Frames." } ], "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the TextureSource to get the Frames from.", "name": "sourceIndex" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Include the `__BASE` Frame in the output array?", "name": "includeBase" } ], "inherits": "Phaser.Textures.Texture#getFramesFromTextureSource", "inherited": true, "___id": "T000002R057218", "___s": true }, { "comment": "/**\r\n * Returns an array with all of the names of the Frames in this Texture.\r\n *\r\n * Useful if you want to randomly assign a Frame to a Game Object, as you can\r\n * pick a random element from the returned array.\r\n *\r\n * @method Phaser.Textures.Texture#getFrameNames\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [includeBase=false] - Include the `__BASE` Frame in the output array?\r\n *\r\n * @return {string[]} An array of all Frame names in this Texture.\r\n */", "meta": { "filename": "Texture.js", "lineno": 319, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "getFrameNames", "longname": "Phaser.Textures.CanvasTexture#getFrameNames", "kind": "function", "description": "Returns an array with all of the names of the Frames in this Texture.\r\rUseful if you want to randomly assign a Frame to a Game Object, as you can\rpick a random element from the returned array.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "An array of all Frame names in this Texture." } ], "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Include the `__BASE` Frame in the output array?", "name": "includeBase" } ], "inherits": "Phaser.Textures.Texture#getFrameNames", "inherited": true, "___id": "T000002R057219", "___s": true }, { "comment": "/**\r\n * Given a Frame name, return the source image it uses to render with.\r\n *\r\n * This will return the actual DOM Image or Canvas element.\r\n *\r\n * @method Phaser.Textures.Texture#getSourceImage\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number)} [name] - The string-based name, or integer based index, of the Frame to get from this Texture.\r\n *\r\n * @return {(HTMLImageElement|HTMLCanvasElement|Phaser.GameObjects.RenderTexture)} The DOM Image, Canvas Element or Render Texture.\r\n */", "meta": { "filename": "Texture.js", "lineno": 351, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "getSourceImage", "longname": "Phaser.Textures.CanvasTexture#getSourceImage", "kind": "function", "description": "Given a Frame name, return the source image it uses to render with.\r\rThis will return the actual DOM Image or Canvas element.", "since": "3.0.0", "returns": [ { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement", "Phaser.GameObjects.RenderTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" }, { "type": "NameExpression", "name": "Phaser.GameObjects.RenderTexture" } ] } }, "description": "The DOM Image, Canvas Element or Render Texture." } ], "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "params": [ { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The string-based name, or integer based index, of the Frame to get from this Texture.", "name": "name" } ], "inherits": "Phaser.Textures.Texture#getSourceImage", "inherited": true, "___id": "T000002R057220", "___s": true }, { "comment": "/**\r\n * Given a Frame name, return the data source image it uses to render with.\r\n * You can use this to get the normal map for an image for example.\r\n *\r\n * This will return the actual DOM Image.\r\n *\r\n * @method Phaser.Textures.Texture#getDataSourceImage\r\n * @since 3.7.0\r\n *\r\n * @param {(string|number)} [name] - The string-based name, or integer based index, of the Frame to get from this Texture.\r\n *\r\n * @return {(HTMLImageElement|HTMLCanvasElement)} The DOM Image or Canvas Element.\r\n */", "meta": { "filename": "Texture.js", "lineno": 384, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "getDataSourceImage", "longname": "Phaser.Textures.CanvasTexture#getDataSourceImage", "kind": "function", "description": "Given a Frame name, return the data source image it uses to render with.\rYou can use this to get the normal map for an image for example.\r\rThis will return the actual DOM Image.", "since": "3.7.0", "returns": [ { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" } ] } }, "description": "The DOM Image or Canvas Element." } ], "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "params": [ { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The string-based name, or integer based index, of the Frame to get from this Texture.", "name": "name" } ], "inherits": "Phaser.Textures.Texture#getDataSourceImage", "inherited": true, "___id": "T000002R057221", "___s": true }, { "comment": "/**\r\n * Adds a data source image to this Texture.\r\n *\r\n * An example of a data source image would be a normal map, where all of the Frames for this Texture\r\n * equally apply to the normal map.\r\n *\r\n * @method Phaser.Textures.Texture#setDataSource\r\n * @since 3.0.0\r\n *\r\n * @param {(HTMLImageElement|HTMLCanvasElement|HTMLImageElement[]|HTMLCanvasElement[])} data - The source image.\r\n */", "meta": { "filename": "Texture.js", "lineno": 421, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "setDataSource", "longname": "Phaser.Textures.CanvasTexture#setDataSource", "kind": "function", "description": "Adds a data source image to this Texture.\r\rAn example of a data source image would be a normal map, where all of the Frames for this Texture\requally apply to the normal map.", "since": "3.0.0", "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "params": [ { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLImageElement", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLCanvasElement", "type": "NameExpression" } ] } ] } }, "description": "The source image.", "name": "data" } ], "inherits": "Phaser.Textures.Texture#setDataSource", "inherited": true, "___id": "T000002R057222", "___s": true }, { "comment": "/**\r\n * Sets the Filter Mode for this Texture.\r\n *\r\n * The mode can be either Linear, the default, or Nearest.\r\n *\r\n * For pixel-art you should use Nearest.\r\n *\r\n * The mode applies to the entire Texture, not just a specific Frame of it.\r\n *\r\n * @method Phaser.Textures.Texture#setFilter\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Textures.FilterMode} filterMode - The Filter Mode.\r\n */", "meta": { "filename": "Texture.js", "lineno": 447, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "setFilter", "longname": "Phaser.Textures.CanvasTexture#setFilter", "kind": "function", "description": "Sets the Filter Mode for this Texture.\r\rThe mode can be either Linear, the default, or Nearest.\r\rFor pixel-art you should use Nearest.\r\rThe mode applies to the entire Texture, not just a specific Frame of it.", "since": "3.0.0", "memberof": "Phaser.Textures.CanvasTexture", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Textures.FilterMode" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.FilterMode" } }, "description": "The Filter Mode.", "name": "filterMode" } ], "inherits": "Phaser.Textures.Texture#setFilter", "inherited": true, "___id": "T000002R057223", "___s": true }, { "comment": "/**\r\n * A reference to the Texture Manager this Texture belongs to.\r\n *\r\n * @name Phaser.Textures.Texture#manager\r\n * @type {Phaser.Textures.TextureManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "manager", "longname": "Phaser.Textures.DynamicTexture#manager", "kind": "member", "description": "A reference to the Texture Manager this Texture belongs to.", "type": { "names": [ "Phaser.Textures.TextureManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } }, "since": "3.0.0", "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "inherits": "Phaser.Textures.Texture#manager", "inherited": true, "___id": "T000002R057224", "___s": true }, { "comment": "/**\r\n * The unique string-based key of this Texture.\r\n *\r\n * @name Phaser.Textures.Texture#key\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "key", "longname": "Phaser.Textures.DynamicTexture#key", "kind": "member", "description": "The unique string-based key of this Texture.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "inherits": "Phaser.Textures.Texture#key", "inherited": true, "___id": "T000002R057225", "___s": true }, { "comment": "/**\r\n * An array of TextureSource instances.\r\n * These are unique to this Texture and contain the actual Image (or Canvas) data.\r\n *\r\n * @name Phaser.Textures.Texture#source\r\n * @type {Phaser.Textures.TextureSource[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "source", "longname": "Phaser.Textures.DynamicTexture#source", "kind": "member", "description": "An array of TextureSource instances.\rThese are unique to this Texture and contain the actual Image (or Canvas) data.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Textures.TextureSource", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "inherits": "Phaser.Textures.Texture#source", "inherited": true, "___id": "T000002R057226", "___s": true }, { "comment": "/**\r\n * An array of TextureSource data instances.\r\n * Used to store additional data images, such as normal maps or specular maps.\r\n *\r\n * @name Phaser.Textures.Texture#dataSource\r\n * @type {array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 78, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "dataSource", "longname": "Phaser.Textures.DynamicTexture#dataSource", "kind": "member", "description": "An array of TextureSource data instances.\rUsed to store additional data images, such as normal maps or specular maps.", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.0.0", "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "inherits": "Phaser.Textures.Texture#dataSource", "inherited": true, "___id": "T000002R057227", "___s": true }, { "comment": "/**\r\n * A key-value object pair associating the unique Frame keys with the Frames objects.\r\n *\r\n * @name Phaser.Textures.Texture#frames\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "frames", "longname": "Phaser.Textures.DynamicTexture#frames", "kind": "member", "description": "A key-value object pair associating the unique Frame keys with the Frames objects.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "inherits": "Phaser.Textures.Texture#frames", "inherited": true, "___id": "T000002R057228", "___s": true }, { "comment": "/**\r\n * Any additional data that was set in the source JSON (if any),\r\n * or any extra data you'd like to store relating to this texture\r\n *\r\n * @name Phaser.Textures.Texture#customData\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "customData", "longname": "Phaser.Textures.DynamicTexture#customData", "kind": "member", "description": "Any additional data that was set in the source JSON (if any),\ror any extra data you'd like to store relating to this texture", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "inherits": "Phaser.Textures.Texture#customData", "inherited": true, "___id": "T000002R057229", "___s": true }, { "comment": "/**\r\n * The name of the first frame of the Texture.\r\n *\r\n * @name Phaser.Textures.Texture#firstFrame\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "firstFrame", "longname": "Phaser.Textures.DynamicTexture#firstFrame", "kind": "member", "description": "The name of the first frame of the Texture.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "inherits": "Phaser.Textures.Texture#firstFrame", "inherited": true, "___id": "T000002R057230", "___s": true }, { "comment": "/**\r\n * The total number of Frames in this Texture, including the `__BASE` frame.\r\n *\r\n * A Texture will always contain at least 1 frame because every Texture contains a `__BASE` frame by default,\r\n * in addition to any extra frames that have been added to it, such as when parsing a Sprite Sheet or Texture Atlas.\r\n *\r\n * @name Phaser.Textures.Texture#frameTotal\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "frameTotal", "longname": "Phaser.Textures.DynamicTexture#frameTotal", "kind": "member", "description": "The total number of Frames in this Texture, including the `__BASE` frame.\r\rA Texture will always contain at least 1 frame because every Texture contains a `__BASE` frame by default,\rin addition to any extra frames that have been added to it, such as when parsing a Sprite Sheet or Texture Atlas.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "inherits": "Phaser.Textures.Texture#frameTotal", "inherited": true, "___id": "T000002R057231", "___s": true }, { "comment": "/**\r\n * Adds a new Frame to this Texture.\r\n *\r\n * A Frame is a rectangular region of a TextureSource with a unique index or string-based key.\r\n *\r\n * The name given must be unique within this Texture. If it already exists, this method will return `null`.\r\n *\r\n * @method Phaser.Textures.Texture#add\r\n * @since 3.0.0\r\n *\r\n * @param {(number|string)} name - The name of this Frame. The name is unique within the Texture.\r\n * @param {number} sourceIndex - The index of the TextureSource that this Frame is a part of.\r\n * @param {number} x - The x coordinate of the top-left of this Frame.\r\n * @param {number} y - The y coordinate of the top-left of this Frame.\r\n * @param {number} width - The width of this Frame.\r\n * @param {number} height - The height of this Frame.\r\n *\r\n * @return {?Phaser.Textures.Frame} The Frame that was added to this Texture, or `null` if the given name already exists.\r\n */", "meta": { "filename": "Texture.js", "lineno": 136, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "add", "longname": "Phaser.Textures.DynamicTexture#add", "kind": "function", "description": "Adds a new Frame to this Texture.\r\rA Frame is a rectangular region of a TextureSource with a unique index or string-based key.\r\rThe name given must be unique within this Texture. If it already exists, this method will return `null`.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame", "nullable": true } }, "nullable": true, "description": "The Frame that was added to this Texture, or `null` if the given name already exists." } ], "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "params": [ { "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The name of this Frame. The name is unique within the Texture.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the TextureSource that this Frame is a part of.", "name": "sourceIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the top-left of this Frame.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the top-left of this Frame.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this Frame.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this Frame.", "name": "height" } ], "inherits": "Phaser.Textures.Texture#add", "inherited": true, "___id": "T000002R057232", "___s": true }, { "comment": "/**\r\n * Removes the given Frame from this Texture. The Frame is destroyed immediately.\r\n *\r\n * Any Game Objects using this Frame should stop using it _before_ you remove it,\r\n * as it does not happen automatically.\r\n *\r\n * @method Phaser.Textures.Texture#remove\r\n * @since 3.19.0\r\n *\r\n * @param {string} name - The key of the Frame to remove.\r\n *\r\n * @return {boolean} True if a Frame with the matching key was removed from this Texture.\r\n */", "meta": { "filename": "Texture.js", "lineno": 180, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "remove", "longname": "Phaser.Textures.DynamicTexture#remove", "kind": "function", "description": "Removes the given Frame from this Texture. The Frame is destroyed immediately.\r\rAny Game Objects using this Frame should stop using it _before_ you remove it,\ras it does not happen automatically.", "since": "3.19.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if a Frame with the matching key was removed from this Texture." } ], "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Frame to remove.", "name": "name" } ], "inherits": "Phaser.Textures.Texture#remove", "inherited": true, "___id": "T000002R057233", "___s": true }, { "comment": "/**\r\n * Checks to see if a Frame matching the given key exists within this Texture.\r\n *\r\n * @method Phaser.Textures.Texture#has\r\n * @since 3.0.0\r\n *\r\n * @param {string} name - The key of the Frame to check for.\r\n *\r\n * @return {boolean} True if a Frame with the matching key exists in this Texture.\r\n */", "meta": { "filename": "Texture.js", "lineno": 209, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "has", "longname": "Phaser.Textures.DynamicTexture#has", "kind": "function", "description": "Checks to see if a Frame matching the given key exists within this Texture.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if a Frame with the matching key exists in this Texture." } ], "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Frame to check for.", "name": "name" } ], "inherits": "Phaser.Textures.Texture#has", "inherited": true, "___id": "T000002R057234", "___s": true }, { "comment": "/**\r\n * Gets a Frame from this Texture based on either the key or the index of the Frame.\r\n *\r\n * In a Texture Atlas Frames are typically referenced by a key.\r\n * In a Sprite Sheet Frames are referenced by an index.\r\n * Passing no value for the name returns the base texture.\r\n *\r\n * @method Phaser.Textures.Texture#get\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number)} [name] - The string-based name, or integer based index, of the Frame to get from this Texture.\r\n *\r\n * @return {Phaser.Textures.Frame} The Texture Frame.\r\n */", "meta": { "filename": "Texture.js", "lineno": 224, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "get", "longname": "Phaser.Textures.DynamicTexture#get", "kind": "function", "description": "Gets a Frame from this Texture based on either the key or the index of the Frame.\r\rIn a Texture Atlas Frames are typically referenced by a key.\rIn a Sprite Sheet Frames are referenced by an index.\rPassing no value for the name returns the base texture.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "description": "The Texture Frame." } ], "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "params": [ { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The string-based name, or integer based index, of the Frame to get from this Texture.", "name": "name" } ], "inherits": "Phaser.Textures.Texture#get", "inherited": true, "___id": "T000002R057235", "___s": true }, { "comment": "/**\r\n * Takes the given TextureSource and returns the index of it within this Texture.\r\n * If it's not in this Texture, it returns -1.\r\n * Unless this Texture has multiple TextureSources, such as with a multi-atlas, this\r\n * method will always return zero or -1.\r\n *\r\n * @method Phaser.Textures.Texture#getTextureSourceIndex\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Textures.TextureSource} source - The TextureSource to check.\r\n *\r\n * @return {number} The index of the TextureSource within this Texture, or -1 if not in this Texture.\r\n */", "meta": { "filename": "Texture.js", "lineno": 258, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "getTextureSourceIndex", "longname": "Phaser.Textures.DynamicTexture#getTextureSourceIndex", "kind": "function", "description": "Takes the given TextureSource and returns the index of it within this Texture.\rIf it's not in this Texture, it returns -1.\rUnless this Texture has multiple TextureSources, such as with a multi-atlas, this\rmethod will always return zero or -1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the TextureSource within this Texture, or -1 if not in this Texture." } ], "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Textures.TextureSource" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureSource" } }, "description": "The TextureSource to check.", "name": "source" } ], "inherits": "Phaser.Textures.Texture#getTextureSourceIndex", "inherited": true, "___id": "T000002R057236", "___s": true }, { "comment": "/**\r\n * Returns an array of all the Frames in the given TextureSource.\r\n *\r\n * @method Phaser.Textures.Texture#getFramesFromTextureSource\r\n * @since 3.0.0\r\n *\r\n * @param {number} sourceIndex - The index of the TextureSource to get the Frames from.\r\n * @param {boolean} [includeBase=false] - Include the `__BASE` Frame in the output array?\r\n *\r\n * @return {Phaser.Textures.Frame[]} An array of Texture Frames.\r\n */", "meta": { "filename": "Texture.js", "lineno": 284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "getFramesFromTextureSource", "longname": "Phaser.Textures.DynamicTexture#getFramesFromTextureSource", "kind": "function", "description": "Returns an array of all the Frames in the given TextureSource.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Textures.Frame", "type": "NameExpression" } ] } }, "description": "An array of Texture Frames." } ], "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the TextureSource to get the Frames from.", "name": "sourceIndex" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Include the `__BASE` Frame in the output array?", "name": "includeBase" } ], "inherits": "Phaser.Textures.Texture#getFramesFromTextureSource", "inherited": true, "___id": "T000002R057237", "___s": true }, { "comment": "/**\r\n * Returns an array with all of the names of the Frames in this Texture.\r\n *\r\n * Useful if you want to randomly assign a Frame to a Game Object, as you can\r\n * pick a random element from the returned array.\r\n *\r\n * @method Phaser.Textures.Texture#getFrameNames\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [includeBase=false] - Include the `__BASE` Frame in the output array?\r\n *\r\n * @return {string[]} An array of all Frame names in this Texture.\r\n */", "meta": { "filename": "Texture.js", "lineno": 319, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "getFrameNames", "longname": "Phaser.Textures.DynamicTexture#getFrameNames", "kind": "function", "description": "Returns an array with all of the names of the Frames in this Texture.\r\rUseful if you want to randomly assign a Frame to a Game Object, as you can\rpick a random element from the returned array.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "An array of all Frame names in this Texture." } ], "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Include the `__BASE` Frame in the output array?", "name": "includeBase" } ], "inherits": "Phaser.Textures.Texture#getFrameNames", "inherited": true, "___id": "T000002R057238", "___s": true }, { "comment": "/**\r\n * Given a Frame name, return the source image it uses to render with.\r\n *\r\n * This will return the actual DOM Image or Canvas element.\r\n *\r\n * @method Phaser.Textures.Texture#getSourceImage\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number)} [name] - The string-based name, or integer based index, of the Frame to get from this Texture.\r\n *\r\n * @return {(HTMLImageElement|HTMLCanvasElement|Phaser.GameObjects.RenderTexture)} The DOM Image, Canvas Element or Render Texture.\r\n */", "meta": { "filename": "Texture.js", "lineno": 351, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "getSourceImage", "longname": "Phaser.Textures.DynamicTexture#getSourceImage", "kind": "function", "description": "Given a Frame name, return the source image it uses to render with.\r\rThis will return the actual DOM Image or Canvas element.", "since": "3.0.0", "returns": [ { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement", "Phaser.GameObjects.RenderTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" }, { "type": "NameExpression", "name": "Phaser.GameObjects.RenderTexture" } ] } }, "description": "The DOM Image, Canvas Element or Render Texture." } ], "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "params": [ { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The string-based name, or integer based index, of the Frame to get from this Texture.", "name": "name" } ], "inherits": "Phaser.Textures.Texture#getSourceImage", "inherited": true, "___id": "T000002R057239", "___s": true }, { "comment": "/**\r\n * Given a Frame name, return the data source image it uses to render with.\r\n * You can use this to get the normal map for an image for example.\r\n *\r\n * This will return the actual DOM Image.\r\n *\r\n * @method Phaser.Textures.Texture#getDataSourceImage\r\n * @since 3.7.0\r\n *\r\n * @param {(string|number)} [name] - The string-based name, or integer based index, of the Frame to get from this Texture.\r\n *\r\n * @return {(HTMLImageElement|HTMLCanvasElement)} The DOM Image or Canvas Element.\r\n */", "meta": { "filename": "Texture.js", "lineno": 384, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "getDataSourceImage", "longname": "Phaser.Textures.DynamicTexture#getDataSourceImage", "kind": "function", "description": "Given a Frame name, return the data source image it uses to render with.\rYou can use this to get the normal map for an image for example.\r\rThis will return the actual DOM Image.", "since": "3.7.0", "returns": [ { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" } ] } }, "description": "The DOM Image or Canvas Element." } ], "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "params": [ { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The string-based name, or integer based index, of the Frame to get from this Texture.", "name": "name" } ], "inherits": "Phaser.Textures.Texture#getDataSourceImage", "inherited": true, "___id": "T000002R057240", "___s": true }, { "comment": "/**\r\n * Adds a data source image to this Texture.\r\n *\r\n * An example of a data source image would be a normal map, where all of the Frames for this Texture\r\n * equally apply to the normal map.\r\n *\r\n * @method Phaser.Textures.Texture#setDataSource\r\n * @since 3.0.0\r\n *\r\n * @param {(HTMLImageElement|HTMLCanvasElement|HTMLImageElement[]|HTMLCanvasElement[])} data - The source image.\r\n */", "meta": { "filename": "Texture.js", "lineno": 421, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "setDataSource", "longname": "Phaser.Textures.DynamicTexture#setDataSource", "kind": "function", "description": "Adds a data source image to this Texture.\r\rAn example of a data source image would be a normal map, where all of the Frames for this Texture\requally apply to the normal map.", "since": "3.0.0", "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "params": [ { "type": { "names": [ "HTMLImageElement", "HTMLCanvasElement", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLImageElement" }, { "type": "NameExpression", "name": "HTMLCanvasElement" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLImageElement", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "HTMLCanvasElement", "type": "NameExpression" } ] } ] } }, "description": "The source image.", "name": "data" } ], "inherits": "Phaser.Textures.Texture#setDataSource", "inherited": true, "___id": "T000002R057241", "___s": true }, { "comment": "/**\r\n * Sets the Filter Mode for this Texture.\r\n *\r\n * The mode can be either Linear, the default, or Nearest.\r\n *\r\n * For pixel-art you should use Nearest.\r\n *\r\n * The mode applies to the entire Texture, not just a specific Frame of it.\r\n *\r\n * @method Phaser.Textures.Texture#setFilter\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Textures.FilterMode} filterMode - The Filter Mode.\r\n */", "meta": { "filename": "Texture.js", "lineno": 447, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\textures", "code": {} }, "name": "setFilter", "longname": "Phaser.Textures.DynamicTexture#setFilter", "kind": "function", "description": "Sets the Filter Mode for this Texture.\r\rThe mode can be either Linear, the default, or Nearest.\r\rFor pixel-art you should use Nearest.\r\rThe mode applies to the entire Texture, not just a specific Frame of it.", "since": "3.0.0", "memberof": "Phaser.Textures.DynamicTexture", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Textures.FilterMode" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.FilterMode" } }, "description": "The Filter Mode.", "name": "filterMode" } ], "inherits": "Phaser.Textures.Texture#setFilter", "inherited": true, "___id": "T000002R057242", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Textures.TextureManager#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Textures.TextureManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R057243", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Textures.TextureManager#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Textures.TextureManager", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R057244", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Textures.TextureManager#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Textures.TextureManager", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R057245", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Textures.TextureManager#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Textures.TextureManager", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R057246", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Textures.TextureManager#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Textures.TextureManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R057247", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Textures.TextureManager#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Textures.TextureManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R057248", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Textures.TextureManager#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Textures.TextureManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R057249", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Textures.TextureManager#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Textures.TextureManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R057250", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Textures.TextureManager#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Textures.TextureManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R057251", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Textures.TextureManager#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Textures.TextureManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R057252", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Textures.TextureManager#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Textures.TextureManager", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R057253", "___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.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": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.Tilemaps.Tile#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.Tile", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "inherited": true, "___id": "T000002R057255", "___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": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.Tilemaps.Tile#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.Tile", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "inherited": true, "___id": "T000002R057256", "___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 *\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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.Tilemaps.Tile#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "scope": "instance", "inherits": "Phaser.GameObjects.Components.AlphaSingle#alpha", "inherited": true, "___id": "T000002R057257", "___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.Components.Flip#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipX", "longname": "Phaser.Tilemaps.Tile#flipX", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipX", "inherited": true, "___id": "T000002R057258", "___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.Components.Flip#flipY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipY", "longname": "Phaser.Tilemaps.Tile#flipY", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipY", "inherited": true, "___id": "T000002R057259", "___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 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 * @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": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipX", "longname": "Phaser.Tilemaps.Tile#toggleFlipX", "kind": "function", "description": "Toggles the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.Tile", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipX", "inherited": true, "___id": "T000002R057260", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipY", "longname": "Phaser.Tilemaps.Tile#toggleFlipY", "kind": "function", "description": "Toggles the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.Tile", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipY", "inherited": true, "___id": "T000002R057261", "___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 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 * @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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipX", "longname": "Phaser.Tilemaps.Tile#setFlipX", "kind": "function", "description": "Sets the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.Tile", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipX", "inherited": true, "___id": "T000002R057262", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\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": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipY", "longname": "Phaser.Tilemaps.Tile#setFlipY", "kind": "function", "description": "Sets the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.Tile", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipY", "inherited": true, "___id": "T000002R057263", "___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 inversed 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 horizontal 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": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlip", "longname": "Phaser.Tilemaps.Tile#setFlip", "kind": "function", "description": "Sets the horizontal and vertical flipped state of this Game Object.\r\rA Game Object that is flipped will render inversed 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.Tile", "scope": "instance", "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 horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlip", "inherited": true, "___id": "T000002R057264", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetFlip", "longname": "Phaser.Tilemaps.Tile#resetFlip", "kind": "function", "description": "Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.Tile", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#resetFlip", "inherited": true, "___id": "T000002R057265", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.Tilemaps.Tile#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.Tile", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R057267", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.Tilemaps.Tile#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.Tile", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R057268", "___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": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "scene", "longname": "Phaser.Tilemaps.TilemapLayer#scene", "kind": "member", "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.", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#scene", "inherited": true, "___id": "T000002R057269", "___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": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "displayList", "longname": "Phaser.Tilemaps.TilemapLayer#displayList", "kind": "member", "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.", "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.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#displayList", "inherited": true, "___id": "T000002R057270", "___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": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "type", "longname": "Phaser.Tilemaps.TilemapLayer#type", "kind": "member", "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.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#type", "inherited": true, "___id": "T000002R057271", "___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": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "state", "longname": "Phaser.Tilemaps.TilemapLayer#state", "kind": "member", "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.", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#state", "inherited": true, "___id": "T000002R057272", "___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": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "parentContainer", "longname": "Phaser.Tilemaps.TilemapLayer#parentContainer", "kind": "member", "description": "The parent Container of this Game Object, if it has one.", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#parentContainer", "inherited": true, "___id": "T000002R057273", "___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": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "name", "longname": "Phaser.Tilemaps.TilemapLayer#name", "kind": "member", "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#name", "inherited": true, "___id": "T000002R057274", "___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": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "active", "longname": "Phaser.Tilemaps.TilemapLayer#active", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#active", "inherited": true, "___id": "T000002R057275", "___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": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "tabIndex", "longname": "Phaser.Tilemaps.TilemapLayer#tabIndex", "kind": "member", "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#tabIndex", "inherited": true, "___id": "T000002R057276", "___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": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "data", "longname": "Phaser.Tilemaps.TilemapLayer#data", "kind": "member", "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`.", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#data", "inherited": true, "___id": "T000002R057277", "___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": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "renderFlags", "longname": "Phaser.Tilemaps.TilemapLayer#renderFlags", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#renderFlags", "inherited": true, "___id": "T000002R057278", "___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": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "cameraFilter", "longname": "Phaser.Tilemaps.TilemapLayer#cameraFilter", "kind": "member", "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" ], "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#cameraFilter", "inherited": true, "___id": "T000002R057279", "___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": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "input", "longname": "Phaser.Tilemaps.TilemapLayer#input", "kind": "member", "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()`.", "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.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#input", "inherited": true, "___id": "T000002R057280", "___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": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "body", "longname": "Phaser.Tilemaps.TilemapLayer#body", "kind": "member", "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics 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.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#body", "inherited": true, "___id": "T000002R057281", "___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": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "ignoreDestroy", "longname": "Phaser.Tilemaps.TilemapLayer#ignoreDestroy", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#ignoreDestroy", "inherited": true, "___id": "T000002R057282", "___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": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setActive", "longname": "Phaser.Tilemaps.TilemapLayer#setActive", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setActive", "inherited": true, "___id": "T000002R057283", "___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": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setName", "longname": "Phaser.Tilemaps.TilemapLayer#setName", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.GameObject#setName", "inherited": true, "___id": "T000002R057284", "___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": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setState", "longname": "Phaser.Tilemaps.TilemapLayer#setState", "kind": "function", "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.", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setState", "inherited": true, "___id": "T000002R057285", "___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": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setDataEnabled", "longname": "Phaser.Tilemaps.TilemapLayer#setDataEnabled", "kind": "function", "description": "Adds a Data Manager component to this Game Object.", "since": "3.0.0", "see": [ "Phaser.Data.DataManager" ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#setDataEnabled", "inherited": true, "___id": "T000002R057286", "___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 {*} [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 GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setData", "longname": "Phaser.Tilemaps.TilemapLayer#setData", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setData", "inherited": true, "___id": "T000002R057287", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "incData", "longname": "Phaser.Tilemaps.TilemapLayer#incData", "kind": "function", "description": "Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#incData", "inherited": true, "___id": "T000002R057288", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toggleData", "longname": "Phaser.Tilemaps.TilemapLayer#toggleData", "kind": "function", "description": "Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.\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.", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "inherits": "Phaser.GameObjects.GameObject#toggleData", "inherited": true, "___id": "T000002R057289", "___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": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getData", "longname": "Phaser.Tilemaps.TilemapLayer#getData", "kind": "function", "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.", "since": "3.0.0", "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.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#getData", "inherited": true, "___id": "T000002R057290", "___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": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "setInteractive", "longname": "Phaser.Tilemaps.TilemapLayer#setInteractive", "kind": "function", "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);" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#setInteractive", "inherited": true, "___id": "T000002R057291", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "disableInteractive", "longname": "Phaser.Tilemaps.TilemapLayer#disableInteractive", "kind": "function", "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.", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#disableInteractive", "inherited": true, "___id": "T000002R057292", "___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 * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeInteractive", "longname": "Phaser.Tilemaps.TilemapLayer#removeInteractive", "kind": "function", "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.)", "since": "3.7.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeInteractive", "inherited": true, "___id": "T000002R057293", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overriden 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": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addedToScene", "longname": "Phaser.Tilemaps.TilemapLayer#addedToScene", "kind": "function", "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overriden 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.", "since": "3.50.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addedToScene", "inherited": true, "___id": "T000002R057294", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overriden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to removed 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": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removedFromScene", "longname": "Phaser.Tilemaps.TilemapLayer#removedFromScene", "kind": "function", "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overriden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to removed themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "since": "3.50.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removedFromScene", "inherited": true, "___id": "T000002R057295", "___s": true }, { "comment": "/**\r\n * To be overridden by custom GameObjects. Allows base objects to be used in a Pool.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - args\r\n */", "meta": { "filename": "GameObject.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "update", "longname": "Phaser.Tilemaps.TilemapLayer#update", "kind": "function", "description": "To be overridden by custom GameObjects. Allows base objects to be used in a Pool.", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "args", "name": "args" } ], "inherits": "Phaser.GameObjects.GameObject#update", "inherited": true, "___id": "T000002R057296", "___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": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "toJSON", "longname": "Phaser.Tilemaps.TilemapLayer#toJSON", "kind": "function", "description": "Returns a JSON representation of the Game Object.", "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.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#toJSON", "inherited": true, "___id": "T000002R057297", "___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": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "willRender", "longname": "Phaser.Tilemaps.TilemapLayer#willRender", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#willRender", "inherited": true, "___id": "T000002R057298", "___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": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "getIndexList", "longname": "Phaser.Tilemaps.TilemapLayer#getIndexList", "kind": "function", "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.", "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.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#getIndexList", "inherited": true, "___id": "T000002R057299", "___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 temporarly\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": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToDisplayList", "longname": "Phaser.Tilemaps.TilemapLayer#addToDisplayList", "kind": "function", "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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.GameObject#addToDisplayList", "inherited": true, "___id": "T000002R057300", "___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: `delta` and `time`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(delta, time)` 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": 722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "addToUpdateList", "longname": "Phaser.Tilemaps.TilemapLayer#addToUpdateList", "kind": "function", "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: `delta` and `time`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(delta, time)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#addToUpdateList", "inherited": true, "___id": "T000002R057301", "___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 move 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 temporarly\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": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromDisplayList", "longname": "Phaser.Tilemaps.TilemapLayer#removeFromDisplayList", "kind": "function", "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 move 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 temporarly\rdisable it from rendering, consider using the `setVisible` method, instead.", "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.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromDisplayList", "inherited": true, "___id": "T000002R057302", "___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": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "name": "removeFromUpdateList", "longname": "Phaser.Tilemaps.TilemapLayer#removeFromUpdateList", "kind": "function", "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.", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.GameObject#removeFromUpdateList", "inherited": true, "___id": "T000002R057303", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Tilemaps.TilemapLayer#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R057304", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Tilemaps.TilemapLayer#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R057305", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Tilemaps.TilemapLayer#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R057306", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Tilemaps.TilemapLayer#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R057307", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Tilemaps.TilemapLayer#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R057308", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Tilemaps.TilemapLayer#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R057309", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Tilemaps.TilemapLayer#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R057310", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Tilemaps.TilemapLayer#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R057311", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Tilemaps.TilemapLayer#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R057312", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Tilemaps.TilemapLayer#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R057313", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Tilemaps.TilemapLayer#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R057314", "___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": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearAlpha", "longname": "Phaser.Tilemaps.TilemapLayer#clearAlpha", "kind": "function", "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#clearAlpha", "inherited": true, "___id": "T000002R057320", "___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": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setAlpha", "longname": "Phaser.Tilemaps.TilemapLayer#setAlpha", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Alpha#setAlpha", "inherited": true, "___id": "T000002R057321", "___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 *\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": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alpha", "longname": "Phaser.Tilemaps.TilemapLayer#alpha", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alpha", "inherited": true, "___id": "T000002R057322", "___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": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopLeft", "longname": "Phaser.Tilemaps.TilemapLayer#alphaTopLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "inherited": true, "___id": "T000002R057323", "___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": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaTopRight", "longname": "Phaser.Tilemaps.TilemapLayer#alphaTopRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "inherited": true, "___id": "T000002R057324", "___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": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomLeft", "longname": "Phaser.Tilemaps.TilemapLayer#alphaBottomLeft", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "inherited": true, "___id": "T000002R057325", "___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": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "alphaBottomRight", "longname": "Phaser.Tilemaps.TilemapLayer#alphaBottomRight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "inherited": true, "___id": "T000002R057326", "___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 of 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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "blendMode", "longname": "Phaser.Tilemaps.TilemapLayer#blendMode", "kind": "member", "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 of which blend modes\rare used.", "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.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.BlendMode#blendMode", "inherited": true, "___id": "T000002R057328", "___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 in 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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setBlendMode", "longname": "Phaser.Tilemaps.TilemapLayer#setBlendMode", "kind": "function", "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 in which blend modes\rare used.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "inherited": true, "___id": "T000002R057329", "___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": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "width", "longname": "Phaser.Tilemaps.TilemapLayer#width", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#width", "inherited": true, "___id": "T000002R057330", "___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": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "height", "longname": "Phaser.Tilemaps.TilemapLayer#height", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#height", "inherited": true, "___id": "T000002R057331", "___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": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayWidth", "longname": "Phaser.Tilemaps.TilemapLayer#displayWidth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#displayWidth", "inherited": true, "___id": "T000002R057332", "___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": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "displayHeight", "longname": "Phaser.Tilemaps.TilemapLayer#displayHeight", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ComputedSize#displayHeight", "inherited": true, "___id": "T000002R057333", "___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": 93, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setSize", "longname": "Phaser.Tilemaps.TilemapLayer#setSize", "kind": "function", "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.", "since": "3.4.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ComputedSize#setSize", "inherited": true, "___id": "T000002R057334", "___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.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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplaySize", "longname": "Phaser.Tilemaps.TilemapLayer#setDisplaySize", "kind": "function", "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "since": "3.4.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ComputedSize#setDisplaySize", "inherited": true, "___id": "T000002R057335", "___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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "depth", "longname": "Phaser.Tilemaps.TilemapLayer#depth", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Depth#depth", "inherited": true, "___id": "T000002R057337", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene.\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 * @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": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDepth", "longname": "Phaser.Tilemaps.TilemapLayer#setDepth", "kind": "function", "description": "The depth of this Game Object within the Scene.\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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Depth#setDepth", "inherited": true, "___id": "T000002R057338", "___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.Components.Flip#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipX", "longname": "Phaser.Tilemaps.TilemapLayer#flipX", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipX", "inherited": true, "___id": "T000002R057339", "___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.Components.Flip#flipY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "flipY", "longname": "Phaser.Tilemaps.TilemapLayer#flipY", "kind": "member", "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.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#flipY", "inherited": true, "___id": "T000002R057340", "___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 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 * @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": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipX", "longname": "Phaser.Tilemaps.TilemapLayer#toggleFlipX", "kind": "function", "description": "Toggles the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipX", "inherited": true, "___id": "T000002R057341", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\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": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "toggleFlipY", "longname": "Phaser.Tilemaps.TilemapLayer#toggleFlipY", "kind": "function", "description": "Toggles the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#toggleFlipY", "inherited": true, "___id": "T000002R057342", "___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 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 * @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": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipX", "longname": "Phaser.Tilemaps.TilemapLayer#setFlipX", "kind": "function", "description": "Sets the horizontal flipped state of this 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipX", "inherited": true, "___id": "T000002R057343", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\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": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlipY", "longname": "Phaser.Tilemaps.TilemapLayer#setFlipY", "kind": "function", "description": "Sets the vertical flipped state of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlipY", "inherited": true, "___id": "T000002R057344", "___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 inversed 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 horizontal 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": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setFlip", "longname": "Phaser.Tilemaps.TilemapLayer#setFlip", "kind": "function", "description": "Sets the horizontal and vertical flipped state of this Game Object.\r\rA Game Object that is flipped will render inversed 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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 horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "inherits": "Phaser.GameObjects.Components.Flip#setFlip", "inherited": true, "___id": "T000002R057345", "___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": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetFlip", "longname": "Phaser.Tilemaps.TilemapLayer#resetFlip", "kind": "function", "description": "Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Flip#resetFlip", "inherited": true, "___id": "T000002R057346", "___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": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getCenter", "longname": "Phaser.Tilemaps.TilemapLayer#getCenter", "kind": "function", "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`.", "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]" } ], "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.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getCenter", "inherited": true, "___id": "T000002R057348", "___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": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopLeft", "longname": "Phaser.Tilemaps.TilemapLayer#getTopLeft", "kind": "function", "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`.", "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]" } ], "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.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "inherited": true, "___id": "T000002R057349", "___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": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopCenter", "longname": "Phaser.Tilemaps.TilemapLayer#getTopCenter", "kind": "function", "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`.", "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]" } ], "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.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "inherited": true, "___id": "T000002R057350", "___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": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getTopRight", "longname": "Phaser.Tilemaps.TilemapLayer#getTopRight", "kind": "function", "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`.", "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]" } ], "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.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getTopRight", "inherited": true, "___id": "T000002R057351", "___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": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLeftCenter", "longname": "Phaser.Tilemaps.TilemapLayer#getLeftCenter", "kind": "function", "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`.", "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]" } ], "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.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "inherited": true, "___id": "T000002R057352", "___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": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getRightCenter", "longname": "Phaser.Tilemaps.TilemapLayer#getRightCenter", "kind": "function", "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`.", "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]" } ], "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.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "inherited": true, "___id": "T000002R057353", "___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": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomLeft", "longname": "Phaser.Tilemaps.TilemapLayer#getBottomLeft", "kind": "function", "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`.", "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]" } ], "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.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "inherited": true, "___id": "T000002R057354", "___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": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomCenter", "longname": "Phaser.Tilemaps.TilemapLayer#getBottomCenter", "kind": "function", "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`.", "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]" } ], "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.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "inherited": true, "___id": "T000002R057355", "___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": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBottomRight", "longname": "Phaser.Tilemaps.TilemapLayer#getBottomRight", "kind": "function", "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`.", "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]" } ], "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.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "inherited": true, "___id": "T000002R057356", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Game Object, regardless of origin.\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": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getBounds", "longname": "Phaser.Tilemaps.TilemapLayer#getBounds", "kind": "function", "description": "Gets the bounds of this Game Object, regardless of origin.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "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.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.GetBounds#getBounds", "inherited": true, "___id": "T000002R057357", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "mask", "longname": "Phaser.Tilemaps.TilemapLayer#mask", "kind": "member", "description": "The Mask this Game Object is using during render.", "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Mask#mask", "inherited": true, "___id": "T000002R057358", "___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 can be either a GeometryMask or a BitmapMask.\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.BitmapMask|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": 28, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setMask", "longname": "Phaser.Tilemaps.TilemapLayer#setMask", "kind": "function", "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\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.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask", "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" }, { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } ] } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "inherits": "Phaser.GameObjects.Components.Mask#setMask", "inherited": true, "___id": "T000002R057359", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\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": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearMask", "longname": "Phaser.Tilemaps.TilemapLayer#clearMask", "kind": "function", "description": "Clears the mask that this Game Object was using.", "since": "3.6.2", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "inherits": "Phaser.GameObjects.Components.Mask#clearMask", "inherited": true, "___id": "T000002R057360", "___s": true }, { "comment": "/**\r\n * Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\r\n * including this one, or a Dynamic Texture.\r\n *\r\n * Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\n *\r\n * To create the mask you need to pass in a reference to a renderable Game Object.\r\n * A renderable Game Object is one that uses a texture to render with, such as an\r\n * Image, Sprite, Render Texture or BitmapText.\r\n *\r\n * If you do not provide a renderable object, and this Game Object has a texture,\r\n * it will use itself as the object. This means you can call this method to create\r\n * a Bitmap Mask from any renderable texture-based Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createBitmapMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G\r\n * @generic {Phaser.Textures.DynamicTexture} T\r\n * @genericUse {(G|T|null)} [maskObject]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.Textures.DynamicTexture)} [maskObject] - The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.\r\n * @param {number} [x] - If creating a Game Object, the horizontal position in the world.\r\n * @param {number} [y] - If creating a Game Object, the vertical position in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.Display.Masks.BitmapMask} This Bitmap Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createBitmapMask", "longname": "Phaser.Tilemaps.TilemapLayer#createBitmapMask", "kind": "function", "description": "Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\rincluding this one, or a Dynamic Texture.\r\rNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\r\rTo create the mask you need to pass in a reference to a renderable Game Object.\rA renderable Game Object is one that uses a texture to render with, such as an\rImage, Sprite, Render Texture or BitmapText.\r\rIf you do not provide a renderable object, and this Game Object has a texture,\rit will use itself as the object. This means you can call this method to create\ra Bitmap Mask from any renderable texture-based Game Object.", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G", "value": "{Phaser.GameObjects.GameObject} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Textures.DynamicTexture} T", "value": "{Phaser.Textures.DynamicTexture} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|T|null)} [maskObject]", "value": "{(G|T|null)} [maskObject]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.BitmapMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.BitmapMask" } }, "description": "This Bitmap Mask that was created." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } ] } }, "optional": true, "description": "The Game Object or Dynamic Texture that will be used as the mask. If `null` it will generate an Image Game Object using the rest of the arguments.", "name": "maskObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the horizontal position in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If creating a Game Object, the vertical position 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": "If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "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": "If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "inherits": "Phaser.GameObjects.Components.Mask#createBitmapMask", "inherited": true, "___id": "T000002R057361", "___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 * @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": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "createGeometryMask", "longname": "Phaser.Tilemaps.TilemapLayer#createGeometryMask", "kind": "function", "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.", "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]" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } }, "description": "This Geometry Mask that was created." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Mask#createGeometryMask", "inherited": true, "___id": "T000002R057362", "___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": {} }, "name": "setOrigin", "longname": "Phaser.Tilemaps.TilemapLayer#setOrigin", "kind": "function", "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setOrigin", "inherited": true, "___id": "T000002R057364", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\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": {} }, "name": "setOriginFromFrame", "longname": "Phaser.Tilemaps.TilemapLayer#setOriginFromFrame", "kind": "function", "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "inherited": true, "___id": "T000002R057365", "___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": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setDisplayOrigin", "longname": "Phaser.Tilemaps.TilemapLayer#setDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "inherited": true, "___id": "T000002R057366", "___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": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "updateDisplayOrigin", "longname": "Phaser.Tilemaps.TilemapLayer#updateDisplayOrigin", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "inherited": true, "___id": "T000002R057367", "___s": true }, { "comment": "/**\r\n * The initial WebGL pipeline of this Game Object.\r\n *\r\n * If you call `resetPipeline` on this Game Object, the pipeline is reset to this default.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#defaultPipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 19, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "defaultPipeline", "longname": "Phaser.Tilemaps.TilemapLayer#defaultPipeline", "kind": "member", "description": "The initial WebGL pipeline of this Game Object.\r\rIf you call `resetPipeline` on this Game Object, the pipeline is reset to this default.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#defaultPipeline", "inherited": true, "___id": "T000002R057368", "___s": true }, { "comment": "/**\r\n * The current WebGL pipeline of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipeline\r\n * @type {Phaser.Renderer.WebGL.WebGLPipeline}\r\n * @default null\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipeline", "longname": "Phaser.Tilemaps.TilemapLayer#pipeline", "kind": "member", "description": "The current WebGL pipeline of this Game Object.", "type": { "names": [ "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } }, "defaultvalue": "null", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipeline", "inherited": true, "___id": "T000002R057369", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.Pipeline#pipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 43, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "pipelineData", "longname": "Phaser.Tilemaps.TilemapLayer#pipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#pipelineData", "inherited": true, "___id": "T000002R057370", "___s": true }, { "comment": "/**\r\n * Sets the initial WebGL Pipeline of this Game Object.\r\n *\r\n * This should only be called during the instantiation of the Game Object. After that, use `setPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#initPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n *\r\n * @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPipeline", "longname": "Phaser.Tilemaps.TilemapLayer#initPipeline", "kind": "function", "description": "Sets the initial WebGL Pipeline of this Game Object.\r\rThis should only be called during the instantiation of the Game Object. After that, use `setPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was set successfully, otherwise `false`." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "optional": true, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#initPipeline", "inherited": true, "___id": "T000002R057371", "___s": true }, { "comment": "/**\r\n * Sets the main WebGL Pipeline of this Game Object.\r\n *\r\n * Also sets the `pipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} pipeline - Either the string-based name of the pipeline, or a pipeline instance to set.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipeline", "longname": "Phaser.Tilemaps.TilemapLayer#setPipeline", "kind": "function", "description": "Sets the main WebGL Pipeline of this Game Object.\r\rAlso sets the `pipelineData` property, if the parameter is given.", "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.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.WebGLPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLPipeline" } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance to set.", "name": "pipeline" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `pipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `pipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipeline", "inherited": true, "___id": "T000002R057372", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `pipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#setPipelineData\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPipelineData", "longname": "Phaser.Tilemaps.TilemapLayer#setPipelineData", "kind": "function", "description": "Adds an entry to the `pipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#setPipelineData", "inherited": true, "___id": "T000002R057373", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Pipeline of this Game Object back to the default it was created with.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#resetPipeline\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `pipelineData` object to being an empty object?\r\n *\r\n * @return {boolean} `true` if the pipeline was reset successfully, otherwise `false`.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPipeline", "longname": "Phaser.Tilemaps.TilemapLayer#resetPipeline", "kind": "function", "description": "Resets the WebGL Pipeline of this Game Object back to the default it was created with.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the pipeline was reset successfully, otherwise `false`." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `pipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.Pipeline#resetPipeline", "inherited": true, "___id": "T000002R057374", "___s": true }, { "comment": "/**\r\n * Gets the name of the WebGL Pipeline this Game Object is currently using.\r\n *\r\n * @method Phaser.GameObjects.Components.Pipeline#getPipelineName\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {string} The string-based name of the pipeline being used by this Game Object.\r\n */", "meta": { "filename": "Pipeline.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPipelineName", "longname": "Phaser.Tilemaps.TilemapLayer#getPipelineName", "kind": "function", "description": "Gets the name of the WebGL Pipeline this Game Object is currently using.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the pipeline being used by this Game Object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Pipeline#getPipelineName", "inherited": true, "___id": "T000002R057375", "___s": true }, { "comment": "/**\r\n * Does this Game Object have any Post Pipelines set?\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#hasPostPipeline\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "hasPostPipeline", "longname": "Phaser.Tilemaps.TilemapLayer#hasPostPipeline", "kind": "member", "description": "Does this Game Object have any Post Pipelines set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#hasPostPipeline", "inherited": true, "___id": "T000002R057376", "___s": true }, { "comment": "/**\r\n * The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\n *\r\n * The pipelines are processed in the order in which they appear in this array.\r\n *\r\n * If you modify this array directly, be sure to set the\r\n * `hasPostPipeline` property accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelines\r\n * @type {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[]}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelines", "longname": "Phaser.Tilemaps.TilemapLayer#postPipelines", "kind": "member", "description": "The WebGL Post FX Pipelines this Game Object uses for post-render effects.\r\rThe pipelines are processed in the order in which they appear in this array.\r\rIf you modify this array directly, be sure to set the\r`hasPostPipeline` property accordingly.", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelines", "inherited": true, "___id": "T000002R057377", "___s": true }, { "comment": "/**\r\n * An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postPipelineData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postPipelineData", "longname": "Phaser.Tilemaps.TilemapLayer#postPipelineData", "kind": "member", "description": "An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postPipelineData", "inherited": true, "___id": "T000002R057378", "___s": true }, { "comment": "/**\r\n * The Pre FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.preFX.addBloom();\r\n * ```\r\n *\r\n * Only the following Game Objects support Pre FX:\r\n *\r\n * * Image\r\n * * Sprite\r\n * * TileSprite\r\n * * Text\r\n * * RenderTexture\r\n * * Video\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#preFX\r\n * @type {?Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "preFX", "longname": "Phaser.Tilemaps.TilemapLayer#preFX", "kind": "member", "description": "The Pre FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.preFX.addBloom();\r```\r\rOnly the following Game Objects support Pre FX:\r\r* Image\r* Sprite\r* TileSprite\r* Text\r* RenderTexture\r* Video\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX", "nullable": true } }, "nullable": true, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#preFX", "inherited": true, "___id": "T000002R057379", "___s": true }, { "comment": "/**\r\n * The Post FX component of this Game Object.\r\n *\r\n * This component allows you to apply a variety of built-in effects to this Game Object, such\r\n * as glow, blur, bloom, displacements, vignettes and more. You access them via this property,\r\n * for example:\r\n *\r\n * ```js\r\n * const player = this.add.sprite();\r\n * player.postFX.addBloom();\r\n * ```\r\n *\r\n * All FX are WebGL only and do not have Canvas counterparts.\r\n *\r\n * Please see the FX Class for more details and available methods.\r\n *\r\n * This property is always `null` until the `initPostPipeline` method is called.\r\n *\r\n * @name Phaser.GameObjects.Components.PostPipeline#postFX\r\n * @type {Phaser.GameObjects.Components.FX}\r\n * @webglOnly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "postFX", "longname": "Phaser.Tilemaps.TilemapLayer#postFX", "kind": "member", "description": "The Post FX component of this Game Object.\r\rThis component allows you to apply a variety of built-in effects to this Game Object, such\ras glow, blur, bloom, displacements, vignettes and more. You access them via this property,\rfor example:\r\r```js\rconst player = this.add.sprite();\rplayer.postFX.addBloom();\r```\r\rAll FX are WebGL only and do not have Canvas counterparts.\r\rPlease see the FX Class for more details and available methods.\r\rThis property is always `null` until the `initPostPipeline` method is called.", "type": { "names": [ "Phaser.GameObjects.Components.FX" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FX" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#postFX", "inherited": true, "___id": "T000002R057380", "___s": true }, { "comment": "/**\r\n * This should only be called during the instantiation of the Game Object.\r\n *\r\n * It is called by default by all core Game Objects and doesn't need\r\n * calling again.\r\n *\r\n * After that, use `setPostPipeline`.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [preFX=false] - Does this Game Object support Pre FX?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "initPostPipeline", "longname": "Phaser.Tilemaps.TilemapLayer#initPostPipeline", "kind": "function", "description": "This should only be called during the instantiation of the Game Object.\r\rIt is called by default by all core Game Objects and doesn't need\rcalling again.\r\rAfter that, use `setPostPipeline`.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Does this Game Object support Pre FX?", "name": "preFX" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#initPostPipeline", "inherited": true, "___id": "T000002R057381", "___s": true }, { "comment": "/**\r\n * Sets one, or more, Post Pipelines on this Game Object.\r\n *\r\n * Post Pipelines are invoked after this Game Object has rendered to its target and\r\n * are commonly used for post-fx.\r\n *\r\n * The post pipelines are appended to the `postPipelines` array belonging to this\r\n * Game Object. When the renderer processes this Game Object, it iterates through the post\r\n * pipelines in the order in which they appear in the array. If you are stacking together\r\n * multiple effects, be aware that the order is important.\r\n *\r\n * If you call this method multiple times, the new pipelines will be appended to any existing\r\n * post pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\n *\r\n * You can optionally also set the `postPipelineData` property, if the parameter is given.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|function|function[]|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} pipelines - Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.\r\n * @param {object} [pipelineData] - Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.\r\n * @param {boolean} [copyData=true] - Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipeline", "longname": "Phaser.Tilemaps.TilemapLayer#setPostPipeline", "kind": "function", "description": "Sets one, or more, Post Pipelines on this Game Object.\r\rPost Pipelines are invoked after this Game Object has rendered to its target and\rare commonly used for post-fx.\r\rThe post pipelines are appended to the `postPipelines` array belonging to this\rGame Object. When the renderer processes this Game Object, it iterates through the post\rpipelines in the order in which they appear in the array. If you are stacking together\rmultiple effects, be aware that the order is important.\r\rIf you call this method multiple times, the new pipelines will be appended to any existing\rpost pipelines already set. Use the `resetPostPipeline` method to clear them first, if required.\r\rYou can optionally also set the `postPipelineData` property, if the parameter is given.", "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.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "string", "Array.", "function", "Array.", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "FunctionType", "params": [] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.", "name": "pipelines" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Optional pipeline data object that is set in to the `postPipelineData` property of this Game Object.", "name": "pipelineData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the pipeline data object be _deep copied_ into the `postPipelineData` property of this Game Object? If `false` it will be set by reference instead.", "name": "copyData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipeline", "inherited": true, "___id": "T000002R057382", "___s": true }, { "comment": "/**\r\n * Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\n *\r\n * If the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\n *\r\n * If `value` is undefined, and `key` exists, `key` is removed from the data object.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#setPostPipelineData\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the pipeline data to set, update, or delete.\r\n * @param {any} [value] - The value to be set with the key. If `undefined` then `key` will be deleted from the object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setPostPipelineData", "longname": "Phaser.Tilemaps.TilemapLayer#setPostPipelineData", "kind": "function", "description": "Adds an entry to the `postPipelineData` object belonging to this Game Object.\r\rIf the 'key' already exists, its value is updated. If it doesn't exist, it is created.\r\rIf `value` is undefined, and `key` exists, `key` is removed from the data object.", "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.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the pipeline data to set, update, or delete.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The value to be set with the key. If `undefined` then `key` will be deleted from the object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#setPostPipelineData", "inherited": true, "___id": "T000002R057383", "___s": true }, { "comment": "/**\r\n * Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#getPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getPostPipeline", "longname": "Phaser.Tilemaps.TilemapLayer#getPostPipeline", "kind": "function", "description": "Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline", "type": "NameExpression" } ] } ] } }, "description": "An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "string", "function", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#getPostPipeline", "inherited": true, "___id": "T000002R057384", "___s": true }, { "comment": "/**\r\n * Resets the WebGL Post Pipelines of this Game Object. It does this by calling\r\n * the `destroy` method on each post pipeline and then clearing the local array.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#resetPostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [resetData=false] - Reset the `postPipelineData` object to being an empty object?\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "resetPostPipeline", "longname": "Phaser.Tilemaps.TilemapLayer#resetPostPipeline", "kind": "function", "description": "Resets the WebGL Post Pipelines of this Game Object. It does this by calling\rthe `destroy` method on each post pipeline and then clearing the local array.", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the `postPipelineData` object to being an empty object?", "name": "resetData" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#resetPostPipeline", "inherited": true, "___id": "T000002R057385", "___s": true }, { "comment": "/**\r\n * Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\n *\r\n * If you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#removePostPipeline\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {string|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline} pipeline - The string-based name of the pipeline, or a pipeline class.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 299, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "removePostPipeline", "longname": "Phaser.Tilemaps.TilemapLayer#removePostPipeline", "kind": "function", "description": "Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.\r\rIf you wish to remove all Post Pipelines use the `resetPostPipeline` method instead.", "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." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Pipelines.PostFXPipeline" } ] } }, "description": "The string-based name of the pipeline, or a pipeline class.", "name": "pipeline" } ], "inherits": "Phaser.GameObjects.Components.PostPipeline#removePostPipeline", "inherited": true, "___id": "T000002R057386", "___s": true }, { "comment": "/**\r\n * Removes all Pre and Post FX Controllers from this Game Object.\r\n *\r\n * If you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\n *\r\n * If you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.\r\n *\r\n * @method Phaser.GameObjects.Components.PostPipeline#clearFX\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PostPipeline.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "clearFX", "longname": "Phaser.Tilemaps.TilemapLayer#clearFX", "kind": "function", "description": "Removes all Pre and Post FX Controllers from this Game Object.\r\rIf you wish to remove a single controller, use the `preFX.remove(fx)` or `postFX.remove(fx)` methods instead.\r\rIf you wish to clear a single controller, use the `preFX.clear()` or `postFX.clear()` methods instead.", "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." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.PostPipeline#clearFX", "inherited": true, "___id": "T000002R057387", "___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 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.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": {} }, "name": "scrollFactorX", "longname": "Phaser.Tilemaps.TilemapLayer#scrollFactorX", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "inherited": true, "___id": "T000002R057388", "___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 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.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": {} }, "name": "scrollFactorY", "longname": "Phaser.Tilemaps.TilemapLayer#scrollFactorY", "kind": "member", "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 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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "inherited": true, "___id": "T000002R057389", "___s": true }, { "comment": "/**\r\n * Sets the 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 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.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": {} }, "name": "setScrollFactor", "longname": "Phaser.Tilemaps.TilemapLayer#setScrollFactor", "kind": "function", "description": "Sets the 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 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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "inherited": true, "___id": "T000002R057390", "___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": {} }, "name": "hasTransformComponent", "longname": "Phaser.Tilemaps.TilemapLayer#hasTransformComponent", "kind": "member", "description": "A property indicating that a Game Object has this component.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "inherited": true, "___id": "T000002R057391", "___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": {} }, "name": "x", "longname": "Phaser.Tilemaps.TilemapLayer#x", "kind": "member", "description": "The x position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#x", "inherited": true, "___id": "T000002R057395", "___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": {} }, "name": "y", "longname": "Phaser.Tilemaps.TilemapLayer#y", "kind": "member", "description": "The y position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#y", "inherited": true, "___id": "T000002R057396", "___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": {} }, "name": "z", "longname": "Phaser.Tilemaps.TilemapLayer#z", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#z", "inherited": true, "___id": "T000002R057397", "___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": {} }, "name": "w", "longname": "Phaser.Tilemaps.TilemapLayer#w", "kind": "member", "description": "The w position of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#w", "inherited": true, "___id": "T000002R057398", "___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": {} }, "name": "scale", "longname": "Phaser.Tilemaps.TilemapLayer#scale", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scale", "inherited": true, "___id": "T000002R057399", "___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": {} }, "name": "scaleX", "longname": "Phaser.Tilemaps.TilemapLayer#scaleX", "kind": "member", "description": "The horizontal scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleX", "inherited": true, "___id": "T000002R057400", "___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": {} }, "name": "scaleY", "longname": "Phaser.Tilemaps.TilemapLayer#scaleY", "kind": "member", "description": "The vertical scale of this Game Object.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#scaleY", "inherited": true, "___id": "T000002R057401", "___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": {} }, "name": "angle", "longname": "Phaser.Tilemaps.TilemapLayer#angle", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#angle", "inherited": true, "___id": "T000002R057402", "___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 1\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": {} }, "name": "rotation", "longname": "Phaser.Tilemaps.TilemapLayer#rotation", "kind": "member", "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.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#rotation", "inherited": true, "___id": "T000002R057403", "___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": {} }, "name": "setPosition", "longname": "Phaser.Tilemaps.TilemapLayer#setPosition", "kind": "function", "description": "Sets the position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setPosition", "inherited": true, "___id": "T000002R057404", "___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": {} }, "name": "copyPosition", "longname": "Phaser.Tilemaps.TilemapLayer#copyPosition", "kind": "function", "description": "Copies an object's coordinates to this Game Object's position.", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#copyPosition", "inherited": true, "___id": "T000002R057405", "___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": {} }, "name": "setRandomPosition", "longname": "Phaser.Tilemaps.TilemapLayer#setRandomPosition", "kind": "function", "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.", "since": "3.8.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRandomPosition", "inherited": true, "___id": "T000002R057406", "___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": {} }, "name": "setRotation", "longname": "Phaser.Tilemaps.TilemapLayer#setRotation", "kind": "function", "description": "Sets the rotation of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "inherits": "Phaser.GameObjects.Components.Transform#setRotation", "inherited": true, "___id": "T000002R057407", "___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": {} }, "name": "setAngle", "longname": "Phaser.Tilemaps.TilemapLayer#setAngle", "kind": "function", "description": "Sets the angle of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "inherits": "Phaser.GameObjects.Components.Transform#setAngle", "inherited": true, "___id": "T000002R057408", "___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": {} }, "name": "setScale", "longname": "Phaser.Tilemaps.TilemapLayer#setScale", "kind": "function", "description": "Sets the scale of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#setScale", "inherited": true, "___id": "T000002R057409", "___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": {} }, "name": "setX", "longname": "Phaser.Tilemaps.TilemapLayer#setX", "kind": "function", "description": "Sets the x position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setX", "inherited": true, "___id": "T000002R057410", "___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": {} }, "name": "setY", "longname": "Phaser.Tilemaps.TilemapLayer#setY", "kind": "function", "description": "Sets the y position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setY", "inherited": true, "___id": "T000002R057411", "___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": {} }, "name": "setZ", "longname": "Phaser.Tilemaps.TilemapLayer#setZ", "kind": "function", "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.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setZ", "inherited": true, "___id": "T000002R057412", "___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": {} }, "name": "setW", "longname": "Phaser.Tilemaps.TilemapLayer#setW", "kind": "function", "description": "Sets the w position of this Game Object.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Transform#setW", "inherited": true, "___id": "T000002R057413", "___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": {} }, "name": "getLocalTransformMatrix", "longname": "Phaser.Tilemaps.TilemapLayer#getLocalTransformMatrix", "kind": "function", "description": "Gets the local transform matrix for this Game Object.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "inherited": true, "___id": "T000002R057414", "___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": {} }, "name": "getWorldTransformMatrix", "longname": "Phaser.Tilemaps.TilemapLayer#getWorldTransformMatrix", "kind": "function", "description": "Gets the world transform matrix for this Game Object, factoring in any parent Containers.", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "inherited": true, "___id": "T000002R057415", "___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": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getLocalPoint", "longname": "Phaser.Tilemaps.TilemapLayer#getLocalPoint", "kind": "function", "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.", "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ], "inherits": "Phaser.GameObjects.Components.Transform#getLocalPoint", "inherited": true, "___id": "T000002R057416", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Objects 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": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "getParentRotation", "longname": "Phaser.Tilemaps.TilemapLayer#getParentRotation", "kind": "function", "description": "Gets the sum total rotation of all of this Game Objects parent Containers.\r\rThe returned value is in radians and will be zero if this Game Object has no parent container.", "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.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Transform#getParentRotation", "inherited": true, "___id": "T000002R057417", "___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": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "visible", "longname": "Phaser.Tilemaps.TilemapLayer#visible", "kind": "member", "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.GameObjects.Components.Visible#visible", "inherited": true, "___id": "T000002R057419", "___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": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "name": "setVisible", "longname": "Phaser.Tilemaps.TilemapLayer#setVisible", "kind": "function", "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "inherits": "Phaser.GameObjects.Components.Visible#setVisible", "inherited": true, "___id": "T000002R057420", "___s": true }, { "comment": "/**\r\n * Sets the Collision Category that this Arcade Physics Body\r\n * will use in order to determine what it can collide with.\r\n *\r\n * It can only have one single category assigned to it.\r\n *\r\n * If you wish to reset the collision category and mask, call\r\n * the `resetCollisionCategory` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#setCollisionCategory\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCollisionCategory", "longname": "Phaser.Tilemaps.TilemapLayer#setCollisionCategory", "kind": "function", "description": "Sets the Collision Category that this Arcade Physics Body\rwill use in order to determine what it can collide with.\r\rIt can only have one single category assigned to it.\r\rIf you wish to reset the collision category and mask, call\rthe `resetCollisionCategory` method.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#setCollisionCategory", "inherited": true, "___id": "T000002R057421", "___s": true }, { "comment": "/**\r\n * Checks to see if the given Collision Category will collide with\r\n * this Arcade Physics object or not.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#willCollideWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - Collision category value to test.\r\n *\r\n * @return {boolean} `true` if the given category will collide with this object, otherwise `false`.\r\n */", "meta": { "filename": "Collision.js", "lineno": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "willCollideWith", "longname": "Phaser.Tilemaps.TilemapLayer#willCollideWith", "kind": "function", "description": "Checks to see if the given Collision Category will collide with\rthis Arcade Physics object or not.", "since": "3.61.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given category will collide with this object, otherwise `false`." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Collision category value to test.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#willCollideWith", "inherited": true, "___id": "T000002R057422", "___s": true }, { "comment": "/**\r\n * Adds the given Collision Category to the list of those that this\r\n * Arcade Physics Body will collide with.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#addCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category to add.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 60, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "addCollidesWith", "longname": "Phaser.Tilemaps.TilemapLayer#addCollidesWith", "kind": "function", "description": "Adds the given Collision Category to the list of those that this\rArcade Physics Body will collide with.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category to add.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#addCollidesWith", "inherited": true, "___id": "T000002R057423", "___s": true }, { "comment": "/**\r\n * Removes the given Collision Category from the list of those that this\r\n * Arcade Physics Body will collide with.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#removeCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {number} category - The collision category to add.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "removeCollidesWith", "longname": "Phaser.Tilemaps.TilemapLayer#removeCollidesWith", "kind": "function", "description": "Removes the given Collision Category from the list of those that this\rArcade Physics Body will collide with.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The collision category to add.", "name": "category" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#removeCollidesWith", "inherited": true, "___id": "T000002R057424", "___s": true }, { "comment": "/**\r\n * Sets all of the Collision Categories that this Arcade Physics Body\r\n * will collide with. You can either pass a single category value, or\r\n * an array of them.\r\n *\r\n * Calling this method will reset all of the collision categories,\r\n * so only those passed to this method are enabled.\r\n *\r\n * If you wish to add a new category to the existing mask, call\r\n * the `addCollisionCategory` method.\r\n *\r\n * If you wish to reset the collision category and mask, call\r\n * the `resetCollisionCategory` method.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#setCollidesWith\r\n * @since 3.61.0\r\n *\r\n * @param {(number|number[])} categories - The collision category to collide with, or an array of them.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "setCollidesWith", "longname": "Phaser.Tilemaps.TilemapLayer#setCollidesWith", "kind": "function", "description": "Sets all of the Collision Categories that this Arcade Physics Body\rwill collide with. You can either pass a single category value, or\ran array of them.\r\rCalling this method will reset all of the collision categories,\rso only those passed to this method are enabled.\r\rIf you wish to add a new category to the existing mask, call\rthe `addCollisionCategory` method.\r\rIf you wish to reset the collision category and mask, call\rthe `resetCollisionCategory` method.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "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" } ] } ] } }, "description": "The collision category to collide with, or an array of them.", "name": "categories" } ], "inherits": "Phaser.Physics.Arcade.Components.Collision#setCollidesWith", "inherited": true, "___id": "T000002R057425", "___s": true }, { "comment": "/**\r\n * Resets the Collision Category and Mask back to the defaults,\r\n * which is to collide with everything.\r\n *\r\n * @method Phaser.Physics.Arcade.Components.Collision#resetCollisionCategory\r\n * @since 3.61.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Collision.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\physics\\arcade\\components", "code": {} }, "name": "resetCollisionCategory", "longname": "Phaser.Tilemaps.TilemapLayer#resetCollisionCategory", "kind": "function", "description": "Resets the Collision Category and Mask back to the defaults,\rwhich is to collide with everything.", "since": "3.61.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.Tilemaps.TilemapLayer", "scope": "instance", "inherits": "Phaser.Physics.Arcade.Components.Collision#resetCollisionCategory", "inherited": true, "___id": "T000002R057426", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Tweens.BaseTween#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Tweens.BaseTween", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R057427", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Tweens.BaseTween#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Tweens.BaseTween", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R057428", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Tweens.BaseTween#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Tweens.BaseTween", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R057429", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Tweens.BaseTween#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Tweens.BaseTween", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R057430", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Tweens.BaseTween#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Tweens.BaseTween", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R057431", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Tweens.BaseTween#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.BaseTween", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R057432", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Tweens.BaseTween#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.BaseTween", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R057433", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Tweens.BaseTween#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.BaseTween", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R057434", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Tweens.BaseTween#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.BaseTween", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R057435", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Tweens.BaseTween#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.BaseTween", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R057436", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Tweens.BaseTween#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.BaseTween", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R057437", "___s": true }, { "comment": "/**\r\n * A reference to the Tween Manager, or Tween Chain, that owns this Tween.\r\n *\r\n * @name Phaser.Tweens.BaseTween#parent\r\n * @type {(Phaser.Tweens.TweenManager|Phaser.Tweens.TweenChain)}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "parent", "longname": "Phaser.Tweens.Tween#parent", "kind": "member", "description": "A reference to the Tween Manager, or Tween Chain, that owns this Tween.", "type": { "names": [ "Phaser.Tweens.TweenManager", "Phaser.Tweens.TweenChain" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Tweens.TweenManager" }, { "type": "NameExpression", "name": "Phaser.Tweens.TweenChain" } ] } }, "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#parent", "inherited": true, "___id": "T000002R057438", "___s": true }, { "comment": "/**\r\n * The main data array. For a Tween, this contains all of the `TweenData` objects, each\r\n * containing a unique property and target that is being tweened.\r\n *\r\n * For a TweenChain, this contains an array of `Tween` instances, which are being played\r\n * through in sequence.\r\n *\r\n * @name Phaser.Tweens.BaseTween#data\r\n * @type {(Phaser.Tweens.TweenData[]|Phaser.Tweens.Tween[])}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "data", "longname": "Phaser.Tweens.Tween#data", "kind": "member", "description": "The main data array. For a Tween, this contains all of the `TweenData` objects, each\rcontaining a unique property and target that is being tweened.\r\rFor a TweenChain, this contains an array of `Tween` instances, which are being played\rthrough in sequence.", "type": { "names": [ "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tweens.TweenData", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tweens.Tween", "type": "NameExpression" } ] } ] } }, "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#data", "inherited": true, "___id": "T000002R057439", "___s": true }, { "comment": "/**\r\n * The cached size of the data array.\r\n *\r\n * @name Phaser.Tweens.BaseTween#totalData\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "totalData", "longname": "Phaser.Tweens.Tween#totalData", "kind": "member", "description": "The cached size of the data array.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#totalData", "inherited": true, "___id": "T000002R057440", "___s": true }, { "comment": "/**\r\n * The time in milliseconds before the 'onStart' event fires.\r\n *\r\n * For a Tween, this is the shortest `delay` value across all of the TweenDatas it owns.\r\n * For a TweenChain, it is whatever delay value was given in the configuration.\r\n *\r\n * @name Phaser.Tweens.BaseTween#startDelay\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 69, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "startDelay", "longname": "Phaser.Tweens.Tween#startDelay", "kind": "member", "description": "The time in milliseconds before the 'onStart' event fires.\r\rFor a Tween, this is the shortest `delay` value across all of the TweenDatas it owns.\rFor a TweenChain, it is whatever delay value was given in the configuration.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#startDelay", "inherited": true, "___id": "T000002R057441", "___s": true }, { "comment": "/**\r\n * Has this Tween started playback yet?\r\n *\r\n * This boolean is toggled when the Tween leaves the 'start delayed' state and begins running.\r\n *\r\n * @name Phaser.Tweens.BaseTween#hasStarted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "hasStarted", "longname": "Phaser.Tweens.Tween#hasStarted", "kind": "member", "description": "Has this Tween started playback yet?\r\rThis boolean is toggled when the Tween leaves the 'start delayed' state and begins running.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#hasStarted", "inherited": true, "___id": "T000002R057442", "___s": true }, { "comment": "/**\r\n * Scales the time applied to this Tween. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on.\r\n *\r\n * The value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.\r\n *\r\n * This value is multiplied by the `TweenManager.timeScale`.\r\n *\r\n * @name Phaser.Tweens.BaseTween#timeScale\r\n * @type {number}\r\n * @default 1\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 94, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "timeScale", "longname": "Phaser.Tweens.Tween#timeScale", "kind": "member", "description": "Scales the time applied to this Tween. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on.\r\rThe value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.\r\rThis value is multiplied by the `TweenManager.timeScale`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#timeScale", "inherited": true, "___id": "T000002R057443", "___s": true }, { "comment": "/**\r\n * The number of times this Tween will loop.\r\n *\r\n * Can be -1 for an infinite loop, zero for none, or a positive integer.\r\n *\r\n * Typically this is set in the configuration object, but can also be set directly\r\n * as long as this Tween is paused and hasn't started playback.\r\n *\r\n * When enabled it will play through ALL Tweens again.\r\n *\r\n * Use TweenData.repeat to loop a single element.\r\n *\r\n * @name Phaser.Tweens.BaseTween#loop\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "loop", "longname": "Phaser.Tweens.Tween#loop", "kind": "member", "description": "The number of times this Tween will loop.\r\rCan be -1 for an infinite loop, zero for none, or a positive integer.\r\rTypically this is set in the configuration object, but can also be set directly\ras long as this Tween is paused and hasn't started playback.\r\rWhen enabled it will play through ALL Tweens again.\r\rUse TweenData.repeat to loop a single element.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#loop", "inherited": true, "___id": "T000002R057444", "___s": true }, { "comment": "/**\r\n * The time in milliseconds before the Tween loops.\r\n *\r\n * Only used if `loop` is > 0.\r\n *\r\n * @name Phaser.Tweens.BaseTween#loopDelay\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 127, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "loopDelay", "longname": "Phaser.Tweens.Tween#loopDelay", "kind": "member", "description": "The time in milliseconds before the Tween loops.\r\rOnly used if `loop` is > 0.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#loopDelay", "inherited": true, "___id": "T000002R057445", "___s": true }, { "comment": "/**\r\n * Internal counter recording how many loops are left to run.\r\n *\r\n * @name Phaser.Tweens.BaseTween#loopCounter\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "loopCounter", "longname": "Phaser.Tweens.Tween#loopCounter", "kind": "member", "description": "Internal counter recording how many loops are left to run.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#loopCounter", "inherited": true, "___id": "T000002R057446", "___s": true }, { "comment": "/**\r\n * The time in milliseconds before the 'onComplete' event fires.\r\n *\r\n * This never fires if `loop = -1` as it never completes because it has been\r\n * set to loop forever.\r\n *\r\n * @name Phaser.Tweens.BaseTween#completeDelay\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "completeDelay", "longname": "Phaser.Tweens.Tween#completeDelay", "kind": "member", "description": "The time in milliseconds before the 'onComplete' event fires.\r\rThis never fires if `loop = -1` as it never completes because it has been\rset to loop forever.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#completeDelay", "inherited": true, "___id": "T000002R057447", "___s": true }, { "comment": "/**\r\n * An internal countdown timer (used by loopDelay and completeDelay)\r\n *\r\n * @name Phaser.Tweens.BaseTween#countdown\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 162, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "countdown", "longname": "Phaser.Tweens.Tween#countdown", "kind": "member", "description": "An internal countdown timer (used by loopDelay and completeDelay)", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#countdown", "inherited": true, "___id": "T000002R057448", "___s": true }, { "comment": "/**\r\n * The current state of the Tween.\r\n *\r\n * @name Phaser.Tweens.BaseTween#state\r\n * @type {Phaser.Tweens.StateType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 172, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "state", "longname": "Phaser.Tweens.Tween#state", "kind": "member", "description": "The current state of the Tween.", "type": { "names": [ "Phaser.Tweens.StateType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.StateType" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#state", "inherited": true, "___id": "T000002R057449", "___s": true }, { "comment": "/**\r\n * Is the Tween currently paused?\r\n *\r\n * A paused Tween needs to be started with the `play` method, or resumed with the `resume` method.\r\n *\r\n * This property can be toggled at runtime if required.\r\n *\r\n * @name Phaser.Tweens.BaseTween#paused\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 181, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "paused", "longname": "Phaser.Tweens.Tween#paused", "kind": "member", "description": "Is the Tween currently paused?\r\rA paused Tween needs to be started with the `play` method, or resumed with the `resume` method.\r\rThis property can be toggled at runtime if required.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#paused", "inherited": true, "___id": "T000002R057450", "___s": true }, { "comment": "/**\r\n * An object containing the different Tween callback functions.\r\n *\r\n * You can either set these in the Tween config, or by calling the `Tween.setCallback` method.\r\n *\r\n * The types available are:\r\n *\r\n * `onActive` - When the Tween is first created it moves to an 'active' state when added to the Tween Manager. 'Active' does not mean 'playing'.\r\n * `onStart` - When the Tween starts playing after a delayed or paused state. This will happen at the same time as `onActive` if the tween has no delay and isn't paused.\r\n * `onLoop` - When a Tween loops, if it has been set to do so. This happens _after_ the `loopDelay` expires, if set.\r\n * `onComplete` - When the Tween finishes playback fully. Never invoked if the Tween is set to repeat infinitely.\r\n * `onStop` - Invoked only if the `Tween.stop` method is called.\r\n * `onPause` - Invoked only if the `Tween.pause` method is called. Not invoked if the Tween Manager is paused.\r\n * `onResume` - Invoked only if the `Tween.resume` method is called. Not invoked if the Tween Manager is resumed.\r\n *\r\n * The following types are also available and are invoked on a `TweenData` level - that is per-object, per-property, being tweened.\r\n *\r\n * `onYoyo` - When a TweenData starts a yoyo. This happens _after_ the `hold` delay expires, if set.\r\n * `onRepeat` - When a TweenData repeats playback. This happens _after_ the `repeatDelay` expires, if set.\r\n * `onUpdate` - When a TweenData updates a property on a source target during playback.\r\n *\r\n * @name Phaser.Tweens.BaseTween#callbacks\r\n * @type {Phaser.Types.Tweens.TweenCallbacks}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "callbacks", "longname": "Phaser.Tweens.Tween#callbacks", "kind": "member", "description": "An object containing the different Tween callback functions.\r\rYou can either set these in the Tween config, or by calling the `Tween.setCallback` method.\r\rThe types available are:\r\r`onActive` - When the Tween is first created it moves to an 'active' state when added to the Tween Manager. 'Active' does not mean 'playing'.\r`onStart` - When the Tween starts playing after a delayed or paused state. This will happen at the same time as `onActive` if the tween has no delay and isn't paused.\r`onLoop` - When a Tween loops, if it has been set to do so. This happens _after_ the `loopDelay` expires, if set.\r`onComplete` - When the Tween finishes playback fully. Never invoked if the Tween is set to repeat infinitely.\r`onStop` - Invoked only if the `Tween.stop` method is called.\r`onPause` - Invoked only if the `Tween.pause` method is called. Not invoked if the Tween Manager is paused.\r`onResume` - Invoked only if the `Tween.resume` method is called. Not invoked if the Tween Manager is resumed.\r\rThe following types are also available and are invoked on a `TweenData` level - that is per-object, per-property, being tweened.\r\r`onYoyo` - When a TweenData starts a yoyo. This happens _after_ the `hold` delay expires, if set.\r`onRepeat` - When a TweenData repeats playback. This happens _after_ the `repeatDelay` expires, if set.\r`onUpdate` - When a TweenData updates a property on a source target during playback.", "type": { "names": [ "Phaser.Types.Tweens.TweenCallbacks" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenCallbacks" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#callbacks", "inherited": true, "___id": "T000002R057451", "___s": true }, { "comment": "/**\r\n * The scope (or context) in which all of the callbacks are invoked.\r\n *\r\n * This defaults to be this Tween, but you can override this property\r\n * to set it to whatever object you require.\r\n *\r\n * @name Phaser.Tweens.BaseTween#callbackScope\r\n * @type {any}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 233, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "callbackScope", "longname": "Phaser.Tweens.Tween#callbackScope", "kind": "member", "description": "The scope (or context) in which all of the callbacks are invoked.\r\rThis defaults to be this Tween, but you can override this property\rto set it to whatever object you require.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#callbackScope", "inherited": true, "___id": "T000002R057452", "___s": true }, { "comment": "/**\r\n * Will this Tween persist after playback? A Tween that persists will _not_ be destroyed by the\r\n * Tween Manager, or when calling `Tween.stop`, and can be re-played as required. You can either\r\n * set this property when creating the tween in the tween config, or set it _prior_ to playback.\r\n *\r\n * However, it's up to you to ensure you destroy persistent tweens when you are finished with them,\r\n * or they will retain references you may no longer require and waste memory.\r\n *\r\n * By default, `Tweens` are set to _not_ persist, so they are automatically cleaned-up by\r\n * the Tween Manager. But `TweenChains` _do_ persist by default, unless overridden in their\r\n * config. This is because the type of situations you use a chain for is far more likely to\r\n * need to be replayed again in the future, rather than disposed of.\r\n *\r\n * @name Phaser.Tweens.BaseTween#persist\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "persist", "longname": "Phaser.Tweens.Tween#persist", "kind": "member", "description": "Will this Tween persist after playback? A Tween that persists will _not_ be destroyed by the\rTween Manager, or when calling `Tween.stop`, and can be re-played as required. You can either\rset this property when creating the tween in the tween config, or set it _prior_ to playback.\r\rHowever, it's up to you to ensure you destroy persistent tweens when you are finished with them,\ror they will retain references you may no longer require and waste memory.\r\rBy default, `Tweens` are set to _not_ persist, so they are automatically cleaned-up by\rthe Tween Manager. But `TweenChains` _do_ persist by default, unless overridden in their\rconfig. This is because the type of situations you use a chain for is far more likely to\rneed to be replayed again in the future, rather than disposed of.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#persist", "inherited": true, "___id": "T000002R057453", "___s": true }, { "comment": "/**\r\n * Sets the value of the time scale applied to this Tween. A value of 1 runs in real-time.\r\n * A value of 0.5 runs 50% slower, and so on.\r\n *\r\n * The value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.\r\n *\r\n * This value is multiplied by the `TweenManager.timeScale`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setTimeScale\r\n * @since 3.60.0\r\n *\r\n * @param {number} value - The time scale value to set.\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 265, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setTimeScale", "longname": "Phaser.Tweens.Tween#setTimeScale", "kind": "function", "description": "Sets the value of the time scale applied to this Tween. A value of 1 runs in real-time.\rA value of 0.5 runs 50% slower, and so on.\r\rThe value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.\r\rThis value is multiplied by the `TweenManager.timeScale`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time scale value to set.", "name": "value" } ], "inherits": "Phaser.Tweens.BaseTween#setTimeScale", "inherited": true, "___id": "T000002R057454", "___s": true }, { "comment": "/**\r\n * Gets the value of the time scale applied to this Tween. A value of 1 runs in real-time.\r\n * A value of 0.5 runs 50% slower, and so on.\r\n *\r\n * @method Phaser.Tweens.BaseTween#getTimeScale\r\n * @since 3.60.0\r\n *\r\n * @return {number} The value of the time scale applied to this Tween.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 287, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "getTimeScale", "longname": "Phaser.Tweens.Tween#getTimeScale", "kind": "function", "description": "Gets the value of the time scale applied to this Tween. A value of 1 runs in real-time.\rA value of 0.5 runs 50% slower, and so on.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value of the time scale applied to this Tween." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#getTimeScale", "inherited": true, "___id": "T000002R057455", "___s": true }, { "comment": "/**\r\n * Checks if this Tween is currently playing.\r\n *\r\n * If this Tween is paused, or not active, this method will return false.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isPlaying\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if the Tween is playing, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isPlaying", "longname": "Phaser.Tweens.Tween#isPlaying", "kind": "function", "description": "Checks if this Tween is currently playing.\r\rIf this Tween is paused, or not active, this method will return false.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Tween is playing, otherwise `false`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isPlaying", "inherited": true, "___id": "T000002R057456", "___s": true }, { "comment": "/**\r\n * Checks if the Tween is currently paused.\r\n *\r\n * This is the same as inspecting the `BaseTween.paused` property directly.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isPaused\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if the Tween is paused, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isPaused", "longname": "Phaser.Tweens.Tween#isPaused", "kind": "function", "description": "Checks if the Tween is currently paused.\r\rThis is the same as inspecting the `BaseTween.paused` property directly.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Tween is paused, otherwise `false`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isPaused", "inherited": true, "___id": "T000002R057457", "___s": true }, { "comment": "/**\r\n * Pauses the Tween immediately. Use `resume` to continue playback.\r\n *\r\n * You can also toggle the `Tween.paused` boolean property, but doing so will not trigger the PAUSE event.\r\n *\r\n * @method Phaser.Tweens.BaseTween#pause\r\n * @fires Phaser.Tweens.Events#TWEEN_PAUSE\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 331, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "pause", "longname": "Phaser.Tweens.Tween#pause", "kind": "function", "description": "Pauses the Tween immediately. Use `resume` to continue playback.\r\rYou can also toggle the `Tween.paused` boolean property, but doing so will not trigger the PAUSE event.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_PAUSE" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#pause", "inherited": true, "___id": "T000002R057458", "___s": true }, { "comment": "/**\r\n * Resumes the playback of a previously paused Tween.\r\n *\r\n * You can also toggle the `Tween.paused` boolean property, but doing so will not trigger the RESUME event.\r\n *\r\n * @method Phaser.Tweens.BaseTween#resume\r\n * @fires Phaser.Tweens.Events#TWEEN_RESUME\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 354, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "resume", "longname": "Phaser.Tweens.Tween#resume", "kind": "function", "description": "Resumes the playback of a previously paused Tween.\r\rYou can also toggle the `Tween.paused` boolean property, but doing so will not trigger the RESUME event.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_RESUME" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#resume", "inherited": true, "___id": "T000002R057459", "___s": true }, { "comment": "/**\r\n * Internal method that makes this Tween active within the TweenManager\r\n * and emits the onActive event and callback.\r\n *\r\n * @method Phaser.Tweens.BaseTween#makeActive\r\n * @fires Phaser.Tweens.Events#TWEEN_ACTIVE\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 377, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "makeActive", "longname": "Phaser.Tweens.Tween#makeActive", "kind": "function", "description": "Internal method that makes this Tween active within the TweenManager\rand emits the onActive event and callback.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_ACTIVE" ], "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#makeActive", "inherited": true, "___id": "T000002R057460", "___s": true }, { "comment": "/**\r\n * Flags the Tween as being complete, whatever stage of progress it is at.\r\n *\r\n * If an `onComplete` callback has been defined it will automatically invoke it, unless a `delay`\r\n * argument is provided, in which case the Tween will delay for that period of time before calling the callback.\r\n *\r\n * If you don't need a delay or don't have an `onComplete` callback then call `Tween.stop` instead.\r\n *\r\n * @method Phaser.Tweens.BaseTween#complete\r\n * @fires Phaser.Tweens.Events#TWEEN_COMPLETE\r\n * @since 3.2.0\r\n *\r\n * @param {number} [delay=0] - The time to wait before invoking the complete callback. If zero it will fire immediately.\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 406, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "complete", "longname": "Phaser.Tweens.Tween#complete", "kind": "function", "description": "Flags the Tween as being complete, whatever stage of progress it is at.\r\rIf an `onComplete` callback has been defined it will automatically invoke it, unless a `delay`\rargument is provided, in which case the Tween will delay for that period of time before calling the callback.\r\rIf you don't need a delay or don't have an `onComplete` callback then call `Tween.stop` instead.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_COMPLETE" ], "since": "3.2.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The time to wait before invoking the complete callback. If zero it will fire immediately.", "name": "delay" } ], "inherits": "Phaser.Tweens.BaseTween#complete", "inherited": true, "___id": "T000002R057461", "___s": true }, { "comment": "/**\r\n * Flags the Tween as being complete only once the current loop has finished.\r\n *\r\n * This is a useful way to stop an infinitely looping tween once a complete cycle is over,\r\n * rather than abruptly.\r\n *\r\n * If you don't have a loop then call `Tween.stop` instead.\r\n *\r\n * @method Phaser.Tweens.BaseTween#completeAfterLoop\r\n * @fires Phaser.Tweens.Events#TWEEN_COMPLETE\r\n * @since 3.60.0\r\n *\r\n * @param {number} [loops=0] - The number of loops that should finish before this tween completes. Zero means complete just the current loop.\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 440, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "completeAfterLoop", "longname": "Phaser.Tweens.Tween#completeAfterLoop", "kind": "function", "description": "Flags the Tween as being complete only once the current loop has finished.\r\rThis is a useful way to stop an infinitely looping tween once a complete cycle is over,\rrather than abruptly.\r\rIf you don't have a loop then call `Tween.stop` instead.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_COMPLETE" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of loops that should finish before this tween completes. Zero means complete just the current loop.", "name": "loops" } ], "inherits": "Phaser.Tweens.BaseTween#completeAfterLoop", "inherited": true, "___id": "T000002R057462", "___s": true }, { "comment": "/**\r\n * Immediately removes this Tween from the TweenManager and all of its internal arrays,\r\n * no matter what stage it is at. Then sets the tween state to `REMOVED`.\r\n *\r\n * You should dispose of your reference to this tween after calling this method, to\r\n * free it from memory. If you no longer require it, call `Tween.destroy()` on it.\r\n *\r\n * @method Phaser.Tweens.BaseTween#remove\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "remove", "longname": "Phaser.Tweens.Tween#remove", "kind": "function", "description": "Immediately removes this Tween from the TweenManager and all of its internal arrays,\rno matter what stage it is at. Then sets the tween state to `REMOVED`.\r\rYou should dispose of your reference to this tween after calling this method, to\rfree it from memory. If you no longer require it, call `Tween.destroy()` on it.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#remove", "inherited": true, "___id": "T000002R057463", "___s": true }, { "comment": "/**\r\n * Stops the Tween immediately, whatever stage of progress it is at.\r\n *\r\n * If not a part of a Tween Chain it is also flagged for removal by the Tween Manager.\r\n *\r\n * If an `onStop` callback has been defined it will automatically invoke it.\r\n *\r\n * The Tween will be removed during the next game frame, but should be considered 'destroyed' from this point on.\r\n *\r\n * Typically, you cannot play a Tween that has been stopped. If you just wish to pause the tween, not destroy it,\r\n * then call the `pause` method instead and use `resume` to continue playback. If you wish to restart the Tween,\r\n * use the `restart` or `seek` methods.\r\n *\r\n * @method Phaser.Tweens.BaseTween#stop\r\n * @fires Phaser.Tweens.Events#TWEEN_STOP\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 490, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "stop", "longname": "Phaser.Tweens.Tween#stop", "kind": "function", "description": "Stops the Tween immediately, whatever stage of progress it is at.\r\rIf not a part of a Tween Chain it is also flagged for removal by the Tween Manager.\r\rIf an `onStop` callback has been defined it will automatically invoke it.\r\rThe Tween will be removed during the next game frame, but should be considered 'destroyed' from this point on.\r\rTypically, you cannot play a Tween that has been stopped. If you just wish to pause the tween, not destroy it,\rthen call the `pause` method instead and use `resume` to continue playback. If you wish to restart the Tween,\ruse the `restart` or `seek` methods.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_STOP" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#stop", "inherited": true, "___id": "T000002R057464", "___s": true }, { "comment": "/**\r\n * Internal method that handles the processing of the loop delay countdown timer and\r\n * the dispatch of related events. Called automatically by `Tween.update`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#updateLoopCountdown\r\n * @since 3.60.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": "BaseTween.js", "lineno": 521, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "updateLoopCountdown", "longname": "Phaser.Tweens.Tween#updateLoopCountdown", "kind": "function", "description": "Internal method that handles the processing of the loop delay countdown timer and\rthe dispatch of related events. Called automatically by `Tween.update`.", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "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" } ], "inherits": "Phaser.Tweens.BaseTween#updateLoopCountdown", "inherited": true, "___id": "T000002R057465", "___s": true }, { "comment": "/**\r\n * Internal method that handles the processing of the start delay countdown timer and\r\n * the dispatch of related events. Called automatically by `Tween.update`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#updateStartCountdown\r\n * @since 3.60.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": "BaseTween.js", "lineno": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "updateStartCountdown", "longname": "Phaser.Tweens.Tween#updateStartCountdown", "kind": "function", "description": "Internal method that handles the processing of the start delay countdown timer and\rthe dispatch of related events. Called automatically by `Tween.update`.", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "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" } ], "inherits": "Phaser.Tweens.BaseTween#updateStartCountdown", "inherited": true, "___id": "T000002R057466", "___s": true }, { "comment": "/**\r\n * Internal method that handles the processing of the complete delay countdown timer and\r\n * the dispatch of related events. Called automatically by `Tween.update`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#updateCompleteDelay\r\n * @since 3.60.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": "BaseTween.js", "lineno": 570, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "updateCompleteDelay", "longname": "Phaser.Tweens.Tween#updateCompleteDelay", "kind": "function", "description": "Internal method that handles the processing of the complete delay countdown timer and\rthe dispatch of related events. Called automatically by `Tween.update`.", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "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" } ], "inherits": "Phaser.Tweens.BaseTween#updateCompleteDelay", "inherited": true, "___id": "T000002R057467", "___s": true }, { "comment": "/**\r\n * Sets an event based callback to be invoked during playback.\r\n *\r\n * Calling this method will replace a previously set callback for the given type, if any exists.\r\n *\r\n * The types available are:\r\n *\r\n * `onActive` - When the Tween is first created it moves to an 'active' state when added to the Tween Manager. 'Active' does not mean 'playing'.\r\n * `onStart` - When the Tween starts playing after a delayed or paused state. This will happen at the same time as `onActive` if the tween has no delay and isn't paused.\r\n * `onLoop` - When a Tween loops, if it has been set to do so. This happens _after_ the `loopDelay` expires, if set.\r\n * `onComplete` - When the Tween finishes playback fully. Never invoked if the Tween is set to repeat infinitely.\r\n * `onStop` - Invoked only if the `Tween.stop` method is called.\r\n * `onPause` - Invoked only if the `Tween.pause` method is called. Not invoked if the Tween Manager is paused.\r\n * `onResume` - Invoked only if the `Tween.resume` method is called. Not invoked if the Tween Manager is resumed.\r\n *\r\n * The following types are also available and are invoked on a `TweenData` level - that is per-object, per-property, being tweened.\r\n *\r\n * `onYoyo` - When a TweenData starts a yoyo. This happens _after_ the `hold` delay expires, if set.\r\n * `onRepeat` - When a TweenData repeats playback. This happens _after_ the `repeatDelay` expires, if set.\r\n * `onUpdate` - When a TweenData updates a property on a source target during playback.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setCallback\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Tweens.TweenCallbackTypes} type - The type of callback to set. One of: `onActive`, `onComplete`, `onLoop`, `onPause`, `onRepeat`, `onResume`, `onStart`, `onStop`, `onUpdate` or `onYoyo`.\r\n * @param {function} callback - Your callback that will be invoked.\r\n * @param {array} [params] - The parameters to pass to the callback. Pass an empty array if you don't want to define any, but do wish to set the scope.\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setCallback", "longname": "Phaser.Tweens.Tween#setCallback", "kind": "function", "description": "Sets an event based callback to be invoked during playback.\r\rCalling this method will replace a previously set callback for the given type, if any exists.\r\rThe types available are:\r\r`onActive` - When the Tween is first created it moves to an 'active' state when added to the Tween Manager. 'Active' does not mean 'playing'.\r`onStart` - When the Tween starts playing after a delayed or paused state. This will happen at the same time as `onActive` if the tween has no delay and isn't paused.\r`onLoop` - When a Tween loops, if it has been set to do so. This happens _after_ the `loopDelay` expires, if set.\r`onComplete` - When the Tween finishes playback fully. Never invoked if the Tween is set to repeat infinitely.\r`onStop` - Invoked only if the `Tween.stop` method is called.\r`onPause` - Invoked only if the `Tween.pause` method is called. Not invoked if the Tween Manager is paused.\r`onResume` - Invoked only if the `Tween.resume` method is called. Not invoked if the Tween Manager is resumed.\r\rThe following types are also available and are invoked on a `TweenData` level - that is per-object, per-property, being tweened.\r\r`onYoyo` - When a TweenData starts a yoyo. This happens _after_ the `hold` delay expires, if set.\r`onRepeat` - When a TweenData repeats playback. This happens _after_ the `repeatDelay` expires, if set.\r`onUpdate` - When a TweenData updates a property on a source target during playback.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Types.Tweens.TweenCallbackTypes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenCallbackTypes" } }, "description": "The type of callback to set. One of: `onActive`, `onComplete`, `onLoop`, `onPause`, `onRepeat`, `onResume`, `onStart`, `onStop`, `onUpdate` or `onYoyo`.", "name": "type" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "Your callback that will be invoked.", "name": "callback" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "The parameters to pass to the callback. Pass an empty array if you don't want to define any, but do wish to set the scope.", "name": "params" } ], "inherits": "Phaser.Tweens.BaseTween#setCallback", "inherited": true, "___id": "T000002R057468", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to PENDING.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setPendingState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 631, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setPendingState", "longname": "Phaser.Tweens.Tween#setPendingState", "kind": "function", "description": "Sets this Tween state to PENDING.", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setPendingState", "inherited": true, "___id": "T000002R057469", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to ACTIVE.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setActiveState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 642, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setActiveState", "longname": "Phaser.Tweens.Tween#setActiveState", "kind": "function", "description": "Sets this Tween state to ACTIVE.", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setActiveState", "inherited": true, "___id": "T000002R057470", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to LOOP_DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setLoopDelayState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 653, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setLoopDelayState", "longname": "Phaser.Tweens.Tween#setLoopDelayState", "kind": "function", "description": "Sets this Tween state to LOOP_DELAY.", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setLoopDelayState", "inherited": true, "___id": "T000002R057471", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to COMPLETE_DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setCompleteDelayState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 664, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setCompleteDelayState", "longname": "Phaser.Tweens.Tween#setCompleteDelayState", "kind": "function", "description": "Sets this Tween state to COMPLETE_DELAY.", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setCompleteDelayState", "inherited": true, "___id": "T000002R057472", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to START_DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setStartDelayState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 675, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setStartDelayState", "longname": "Phaser.Tweens.Tween#setStartDelayState", "kind": "function", "description": "Sets this Tween state to START_DELAY.", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setStartDelayState", "inherited": true, "___id": "T000002R057473", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to PENDING_REMOVE.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setPendingRemoveState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 690, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setPendingRemoveState", "longname": "Phaser.Tweens.Tween#setPendingRemoveState", "kind": "function", "description": "Sets this Tween state to PENDING_REMOVE.", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setPendingRemoveState", "inherited": true, "___id": "T000002R057474", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to REMOVED.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setRemovedState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 701, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setRemovedState", "longname": "Phaser.Tweens.Tween#setRemovedState", "kind": "function", "description": "Sets this Tween state to REMOVED.", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setRemovedState", "inherited": true, "___id": "T000002R057475", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to FINISHED.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setFinishedState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 712, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setFinishedState", "longname": "Phaser.Tweens.Tween#setFinishedState", "kind": "function", "description": "Sets this Tween state to FINISHED.", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setFinishedState", "inherited": true, "___id": "T000002R057476", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to DESTROYED.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setDestroyedState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 723, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setDestroyedState", "longname": "Phaser.Tweens.Tween#setDestroyedState", "kind": "function", "description": "Sets this Tween state to DESTROYED.", "since": "3.60.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setDestroyedState", "inherited": true, "___id": "T000002R057477", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of PENDING, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isPending\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of PENDING, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 734, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isPending", "longname": "Phaser.Tweens.Tween#isPending", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of PENDING, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of PENDING, otherwise `false`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isPending", "inherited": true, "___id": "T000002R057478", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of ACTIVE, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isActive\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of ACTIVE, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isActive", "longname": "Phaser.Tweens.Tween#isActive", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of ACTIVE, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of ACTIVE, otherwise `false`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isActive", "inherited": true, "___id": "T000002R057479", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of LOOP_DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isLoopDelayed\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of LOOP_DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 760, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isLoopDelayed", "longname": "Phaser.Tweens.Tween#isLoopDelayed", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of LOOP_DELAY, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of LOOP_DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isLoopDelayed", "inherited": true, "___id": "T000002R057480", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of COMPLETE_DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isCompleteDelayed\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of COMPLETE_DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isCompleteDelayed", "longname": "Phaser.Tweens.Tween#isCompleteDelayed", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of COMPLETE_DELAY, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of COMPLETE_DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isCompleteDelayed", "inherited": true, "___id": "T000002R057481", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of START_DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isStartDelayed\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of START_DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 786, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isStartDelayed", "longname": "Phaser.Tweens.Tween#isStartDelayed", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of START_DELAY, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of START_DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isStartDelayed", "inherited": true, "___id": "T000002R057482", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of PENDING_REMOVE, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isPendingRemove\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of PENDING_REMOVE, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 799, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isPendingRemove", "longname": "Phaser.Tweens.Tween#isPendingRemove", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of PENDING_REMOVE, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of PENDING_REMOVE, otherwise `false`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isPendingRemove", "inherited": true, "___id": "T000002R057483", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of REMOVED, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isRemoved\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of REMOVED, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 812, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isRemoved", "longname": "Phaser.Tweens.Tween#isRemoved", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of REMOVED, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of REMOVED, otherwise `false`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isRemoved", "inherited": true, "___id": "T000002R057484", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of FINISHED, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isFinished\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of FINISHED, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 825, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isFinished", "longname": "Phaser.Tweens.Tween#isFinished", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of FINISHED, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of FINISHED, otherwise `false`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isFinished", "inherited": true, "___id": "T000002R057485", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of DESTROYED, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isDestroyed\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of DESTROYED, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 838, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isDestroyed", "longname": "Phaser.Tweens.Tween#isDestroyed", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of DESTROYED, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of DESTROYED, otherwise `false`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isDestroyed", "inherited": true, "___id": "T000002R057486", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Tweens.Tween#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R057487", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Tweens.Tween#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R057488", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Tweens.Tween#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R057489", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Tweens.Tween#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R057490", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Tweens.Tween#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R057491", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Tweens.Tween#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R057492", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Tweens.Tween#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R057493", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Tweens.Tween#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R057494", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Tweens.Tween#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R057495", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Tweens.Tween#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R057496", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Tweens.Tween#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.Tween", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R057497", "___s": true }, { "comment": "/**\r\n * A reference to the Tween Manager, or Tween Chain, that owns this Tween.\r\n *\r\n * @name Phaser.Tweens.BaseTween#parent\r\n * @type {(Phaser.Tweens.TweenManager|Phaser.Tweens.TweenChain)}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "parent", "longname": "Phaser.Tweens.TweenChain#parent", "kind": "member", "description": "A reference to the Tween Manager, or Tween Chain, that owns this Tween.", "type": { "names": [ "Phaser.Tweens.TweenManager", "Phaser.Tweens.TweenChain" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Tweens.TweenManager" }, { "type": "NameExpression", "name": "Phaser.Tweens.TweenChain" } ] } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#parent", "inherited": true, "___id": "T000002R057498", "___s": true }, { "comment": "/**\r\n * The main data array. For a Tween, this contains all of the `TweenData` objects, each\r\n * containing a unique property and target that is being tweened.\r\n *\r\n * For a TweenChain, this contains an array of `Tween` instances, which are being played\r\n * through in sequence.\r\n *\r\n * @name Phaser.Tweens.BaseTween#data\r\n * @type {(Phaser.Tweens.TweenData[]|Phaser.Tweens.Tween[])}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "data", "longname": "Phaser.Tweens.TweenChain#data", "kind": "member", "description": "The main data array. For a Tween, this contains all of the `TweenData` objects, each\rcontaining a unique property and target that is being tweened.\r\rFor a TweenChain, this contains an array of `Tween` instances, which are being played\rthrough in sequence.", "type": { "names": [ "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tweens.TweenData", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Tweens.Tween", "type": "NameExpression" } ] } ] } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#data", "inherited": true, "___id": "T000002R057499", "___s": true }, { "comment": "/**\r\n * The cached size of the data array.\r\n *\r\n * @name Phaser.Tweens.BaseTween#totalData\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "totalData", "longname": "Phaser.Tweens.TweenChain#totalData", "kind": "member", "description": "The cached size of the data array.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#totalData", "inherited": true, "___id": "T000002R057500", "___s": true }, { "comment": "/**\r\n * The time in milliseconds before the 'onStart' event fires.\r\n *\r\n * For a Tween, this is the shortest `delay` value across all of the TweenDatas it owns.\r\n * For a TweenChain, it is whatever delay value was given in the configuration.\r\n *\r\n * @name Phaser.Tweens.BaseTween#startDelay\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 69, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "startDelay", "longname": "Phaser.Tweens.TweenChain#startDelay", "kind": "member", "description": "The time in milliseconds before the 'onStart' event fires.\r\rFor a Tween, this is the shortest `delay` value across all of the TweenDatas it owns.\rFor a TweenChain, it is whatever delay value was given in the configuration.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#startDelay", "inherited": true, "___id": "T000002R057501", "___s": true }, { "comment": "/**\r\n * Has this Tween started playback yet?\r\n *\r\n * This boolean is toggled when the Tween leaves the 'start delayed' state and begins running.\r\n *\r\n * @name Phaser.Tweens.BaseTween#hasStarted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "hasStarted", "longname": "Phaser.Tweens.TweenChain#hasStarted", "kind": "member", "description": "Has this Tween started playback yet?\r\rThis boolean is toggled when the Tween leaves the 'start delayed' state and begins running.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#hasStarted", "inherited": true, "___id": "T000002R057502", "___s": true }, { "comment": "/**\r\n * Scales the time applied to this Tween. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on.\r\n *\r\n * The value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.\r\n *\r\n * This value is multiplied by the `TweenManager.timeScale`.\r\n *\r\n * @name Phaser.Tweens.BaseTween#timeScale\r\n * @type {number}\r\n * @default 1\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 94, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "timeScale", "longname": "Phaser.Tweens.TweenChain#timeScale", "kind": "member", "description": "Scales the time applied to this Tween. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on.\r\rThe value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.\r\rThis value is multiplied by the `TweenManager.timeScale`.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#timeScale", "inherited": true, "___id": "T000002R057503", "___s": true }, { "comment": "/**\r\n * The number of times this Tween will loop.\r\n *\r\n * Can be -1 for an infinite loop, zero for none, or a positive integer.\r\n *\r\n * Typically this is set in the configuration object, but can also be set directly\r\n * as long as this Tween is paused and hasn't started playback.\r\n *\r\n * When enabled it will play through ALL Tweens again.\r\n *\r\n * Use TweenData.repeat to loop a single element.\r\n *\r\n * @name Phaser.Tweens.BaseTween#loop\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "loop", "longname": "Phaser.Tweens.TweenChain#loop", "kind": "member", "description": "The number of times this Tween will loop.\r\rCan be -1 for an infinite loop, zero for none, or a positive integer.\r\rTypically this is set in the configuration object, but can also be set directly\ras long as this Tween is paused and hasn't started playback.\r\rWhen enabled it will play through ALL Tweens again.\r\rUse TweenData.repeat to loop a single element.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#loop", "inherited": true, "___id": "T000002R057504", "___s": true }, { "comment": "/**\r\n * The time in milliseconds before the Tween loops.\r\n *\r\n * Only used if `loop` is > 0.\r\n *\r\n * @name Phaser.Tweens.BaseTween#loopDelay\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 127, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "loopDelay", "longname": "Phaser.Tweens.TweenChain#loopDelay", "kind": "member", "description": "The time in milliseconds before the Tween loops.\r\rOnly used if `loop` is > 0.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#loopDelay", "inherited": true, "___id": "T000002R057505", "___s": true }, { "comment": "/**\r\n * Internal counter recording how many loops are left to run.\r\n *\r\n * @name Phaser.Tweens.BaseTween#loopCounter\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 139, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "loopCounter", "longname": "Phaser.Tweens.TweenChain#loopCounter", "kind": "member", "description": "Internal counter recording how many loops are left to run.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#loopCounter", "inherited": true, "___id": "T000002R057506", "___s": true }, { "comment": "/**\r\n * The time in milliseconds before the 'onComplete' event fires.\r\n *\r\n * This never fires if `loop = -1` as it never completes because it has been\r\n * set to loop forever.\r\n *\r\n * @name Phaser.Tweens.BaseTween#completeDelay\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "completeDelay", "longname": "Phaser.Tweens.TweenChain#completeDelay", "kind": "member", "description": "The time in milliseconds before the 'onComplete' event fires.\r\rThis never fires if `loop = -1` as it never completes because it has been\rset to loop forever.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#completeDelay", "inherited": true, "___id": "T000002R057507", "___s": true }, { "comment": "/**\r\n * An internal countdown timer (used by loopDelay and completeDelay)\r\n *\r\n * @name Phaser.Tweens.BaseTween#countdown\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 162, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "countdown", "longname": "Phaser.Tweens.TweenChain#countdown", "kind": "member", "description": "An internal countdown timer (used by loopDelay and completeDelay)", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#countdown", "inherited": true, "___id": "T000002R057508", "___s": true }, { "comment": "/**\r\n * The current state of the Tween.\r\n *\r\n * @name Phaser.Tweens.BaseTween#state\r\n * @type {Phaser.Tweens.StateType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 172, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "state", "longname": "Phaser.Tweens.TweenChain#state", "kind": "member", "description": "The current state of the Tween.", "type": { "names": [ "Phaser.Tweens.StateType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.StateType" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#state", "inherited": true, "___id": "T000002R057509", "___s": true }, { "comment": "/**\r\n * Is the Tween currently paused?\r\n *\r\n * A paused Tween needs to be started with the `play` method, or resumed with the `resume` method.\r\n *\r\n * This property can be toggled at runtime if required.\r\n *\r\n * @name Phaser.Tweens.BaseTween#paused\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 181, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "paused", "longname": "Phaser.Tweens.TweenChain#paused", "kind": "member", "description": "Is the Tween currently paused?\r\rA paused Tween needs to be started with the `play` method, or resumed with the `resume` method.\r\rThis property can be toggled at runtime if required.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#paused", "inherited": true, "___id": "T000002R057510", "___s": true }, { "comment": "/**\r\n * An object containing the different Tween callback functions.\r\n *\r\n * You can either set these in the Tween config, or by calling the `Tween.setCallback` method.\r\n *\r\n * The types available are:\r\n *\r\n * `onActive` - When the Tween is first created it moves to an 'active' state when added to the Tween Manager. 'Active' does not mean 'playing'.\r\n * `onStart` - When the Tween starts playing after a delayed or paused state. This will happen at the same time as `onActive` if the tween has no delay and isn't paused.\r\n * `onLoop` - When a Tween loops, if it has been set to do so. This happens _after_ the `loopDelay` expires, if set.\r\n * `onComplete` - When the Tween finishes playback fully. Never invoked if the Tween is set to repeat infinitely.\r\n * `onStop` - Invoked only if the `Tween.stop` method is called.\r\n * `onPause` - Invoked only if the `Tween.pause` method is called. Not invoked if the Tween Manager is paused.\r\n * `onResume` - Invoked only if the `Tween.resume` method is called. Not invoked if the Tween Manager is resumed.\r\n *\r\n * The following types are also available and are invoked on a `TweenData` level - that is per-object, per-property, being tweened.\r\n *\r\n * `onYoyo` - When a TweenData starts a yoyo. This happens _after_ the `hold` delay expires, if set.\r\n * `onRepeat` - When a TweenData repeats playback. This happens _after_ the `repeatDelay` expires, if set.\r\n * `onUpdate` - When a TweenData updates a property on a source target during playback.\r\n *\r\n * @name Phaser.Tweens.BaseTween#callbacks\r\n * @type {Phaser.Types.Tweens.TweenCallbacks}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "callbacks", "longname": "Phaser.Tweens.TweenChain#callbacks", "kind": "member", "description": "An object containing the different Tween callback functions.\r\rYou can either set these in the Tween config, or by calling the `Tween.setCallback` method.\r\rThe types available are:\r\r`onActive` - When the Tween is first created it moves to an 'active' state when added to the Tween Manager. 'Active' does not mean 'playing'.\r`onStart` - When the Tween starts playing after a delayed or paused state. This will happen at the same time as `onActive` if the tween has no delay and isn't paused.\r`onLoop` - When a Tween loops, if it has been set to do so. This happens _after_ the `loopDelay` expires, if set.\r`onComplete` - When the Tween finishes playback fully. Never invoked if the Tween is set to repeat infinitely.\r`onStop` - Invoked only if the `Tween.stop` method is called.\r`onPause` - Invoked only if the `Tween.pause` method is called. Not invoked if the Tween Manager is paused.\r`onResume` - Invoked only if the `Tween.resume` method is called. Not invoked if the Tween Manager is resumed.\r\rThe following types are also available and are invoked on a `TweenData` level - that is per-object, per-property, being tweened.\r\r`onYoyo` - When a TweenData starts a yoyo. This happens _after_ the `hold` delay expires, if set.\r`onRepeat` - When a TweenData repeats playback. This happens _after_ the `repeatDelay` expires, if set.\r`onUpdate` - When a TweenData updates a property on a source target during playback.", "type": { "names": [ "Phaser.Types.Tweens.TweenCallbacks" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenCallbacks" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#callbacks", "inherited": true, "___id": "T000002R057511", "___s": true }, { "comment": "/**\r\n * The scope (or context) in which all of the callbacks are invoked.\r\n *\r\n * This defaults to be this Tween, but you can override this property\r\n * to set it to whatever object you require.\r\n *\r\n * @name Phaser.Tweens.BaseTween#callbackScope\r\n * @type {any}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 233, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "callbackScope", "longname": "Phaser.Tweens.TweenChain#callbackScope", "kind": "member", "description": "The scope (or context) in which all of the callbacks are invoked.\r\rThis defaults to be this Tween, but you can override this property\rto set it to whatever object you require.", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#callbackScope", "inherited": true, "___id": "T000002R057512", "___s": true }, { "comment": "/**\r\n * Will this Tween persist after playback? A Tween that persists will _not_ be destroyed by the\r\n * Tween Manager, or when calling `Tween.stop`, and can be re-played as required. You can either\r\n * set this property when creating the tween in the tween config, or set it _prior_ to playback.\r\n *\r\n * However, it's up to you to ensure you destroy persistent tweens when you are finished with them,\r\n * or they will retain references you may no longer require and waste memory.\r\n *\r\n * By default, `Tweens` are set to _not_ persist, so they are automatically cleaned-up by\r\n * the Tween Manager. But `TweenChains` _do_ persist by default, unless overridden in their\r\n * config. This is because the type of situations you use a chain for is far more likely to\r\n * need to be replayed again in the future, rather than disposed of.\r\n *\r\n * @name Phaser.Tweens.BaseTween#persist\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "persist", "longname": "Phaser.Tweens.TweenChain#persist", "kind": "member", "description": "Will this Tween persist after playback? A Tween that persists will _not_ be destroyed by the\rTween Manager, or when calling `Tween.stop`, and can be re-played as required. You can either\rset this property when creating the tween in the tween config, or set it _prior_ to playback.\r\rHowever, it's up to you to ensure you destroy persistent tweens when you are finished with them,\ror they will retain references you may no longer require and waste memory.\r\rBy default, `Tweens` are set to _not_ persist, so they are automatically cleaned-up by\rthe Tween Manager. But `TweenChains` _do_ persist by default, unless overridden in their\rconfig. This is because the type of situations you use a chain for is far more likely to\rneed to be replayed again in the future, rather than disposed of.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#persist", "inherited": true, "___id": "T000002R057513", "___s": true }, { "comment": "/**\r\n * Sets the value of the time scale applied to this Tween. A value of 1 runs in real-time.\r\n * A value of 0.5 runs 50% slower, and so on.\r\n *\r\n * The value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.\r\n *\r\n * This value is multiplied by the `TweenManager.timeScale`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setTimeScale\r\n * @since 3.60.0\r\n *\r\n * @param {number} value - The time scale value to set.\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 265, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setTimeScale", "longname": "Phaser.Tweens.TweenChain#setTimeScale", "kind": "function", "description": "Sets the value of the time scale applied to this Tween. A value of 1 runs in real-time.\rA value of 0.5 runs 50% slower, and so on.\r\rThe value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.\r\rThis value is multiplied by the `TweenManager.timeScale`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time scale value to set.", "name": "value" } ], "inherits": "Phaser.Tweens.BaseTween#setTimeScale", "inherited": true, "___id": "T000002R057514", "___s": true }, { "comment": "/**\r\n * Gets the value of the time scale applied to this Tween. A value of 1 runs in real-time.\r\n * A value of 0.5 runs 50% slower, and so on.\r\n *\r\n * @method Phaser.Tweens.BaseTween#getTimeScale\r\n * @since 3.60.0\r\n *\r\n * @return {number} The value of the time scale applied to this Tween.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 287, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "getTimeScale", "longname": "Phaser.Tweens.TweenChain#getTimeScale", "kind": "function", "description": "Gets the value of the time scale applied to this Tween. A value of 1 runs in real-time.\rA value of 0.5 runs 50% slower, and so on.", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value of the time scale applied to this Tween." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#getTimeScale", "inherited": true, "___id": "T000002R057515", "___s": true }, { "comment": "/**\r\n * Checks if this Tween is currently playing.\r\n *\r\n * If this Tween is paused, or not active, this method will return false.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isPlaying\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if the Tween is playing, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isPlaying", "longname": "Phaser.Tweens.TweenChain#isPlaying", "kind": "function", "description": "Checks if this Tween is currently playing.\r\rIf this Tween is paused, or not active, this method will return false.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Tween is playing, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isPlaying", "inherited": true, "___id": "T000002R057516", "___s": true }, { "comment": "/**\r\n * Checks if the Tween is currently paused.\r\n *\r\n * This is the same as inspecting the `BaseTween.paused` property directly.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isPaused\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if the Tween is paused, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isPaused", "longname": "Phaser.Tweens.TweenChain#isPaused", "kind": "function", "description": "Checks if the Tween is currently paused.\r\rThis is the same as inspecting the `BaseTween.paused` property directly.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Tween is paused, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isPaused", "inherited": true, "___id": "T000002R057517", "___s": true }, { "comment": "/**\r\n * Pauses the Tween immediately. Use `resume` to continue playback.\r\n *\r\n * You can also toggle the `Tween.paused` boolean property, but doing so will not trigger the PAUSE event.\r\n *\r\n * @method Phaser.Tweens.BaseTween#pause\r\n * @fires Phaser.Tweens.Events#TWEEN_PAUSE\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 331, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "pause", "longname": "Phaser.Tweens.TweenChain#pause", "kind": "function", "description": "Pauses the Tween immediately. Use `resume` to continue playback.\r\rYou can also toggle the `Tween.paused` boolean property, but doing so will not trigger the PAUSE event.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_PAUSE" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#pause", "inherited": true, "___id": "T000002R057518", "___s": true }, { "comment": "/**\r\n * Resumes the playback of a previously paused Tween.\r\n *\r\n * You can also toggle the `Tween.paused` boolean property, but doing so will not trigger the RESUME event.\r\n *\r\n * @method Phaser.Tweens.BaseTween#resume\r\n * @fires Phaser.Tweens.Events#TWEEN_RESUME\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 354, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "resume", "longname": "Phaser.Tweens.TweenChain#resume", "kind": "function", "description": "Resumes the playback of a previously paused Tween.\r\rYou can also toggle the `Tween.paused` boolean property, but doing so will not trigger the RESUME event.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_RESUME" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#resume", "inherited": true, "___id": "T000002R057519", "___s": true }, { "comment": "/**\r\n * Re-initiases the given Tween and sets it to the Active state.\r\n *\r\n * @method Phaser.Tweens.TweenChain#makeActive\r\n * @since 3.60.0\r\n * @override\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - The Tween to check.\r\n *\r\n * @return {this} This TweenChain instance.\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 253, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "makeActive", "longname": "Phaser.Tweens.TweenChain#makeActive", "kind": "function", "description": "Re-initiases the given Tween and sets it to the Active state.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TweenChain instance." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "fires": [ "Phaser.Tweens.Events#event:TWEEN_ACTIVE" ], "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The Tween to check.", "name": "tween" } ], "inherits": "Phaser.Tweens.TweenChain#makeActive", "inherited": true, "overrides": "Phaser.Tweens.BaseTween#makeActive", "___id": "T000002R057520", "___s": true }, { "comment": "/**\r\n * Internal method that handles this tween completing and emitting the onComplete event\r\n * and callback.\r\n *\r\n * @method Phaser.Tweens.BaseTween#onCompleteHandler\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "onCompleteHandler", "longname": "Phaser.Tweens.TweenChain#onCompleteHandler", "kind": "function", "description": "Internal method that handles this tween completing and emitting the onComplete event\rand callback.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#onCompleteHandler", "inherited": true, "___id": "T000002R057521", "___s": true }, { "comment": "/**\r\n * Flags the Tween as being complete, whatever stage of progress it is at.\r\n *\r\n * If an `onComplete` callback has been defined it will automatically invoke it, unless a `delay`\r\n * argument is provided, in which case the Tween will delay for that period of time before calling the callback.\r\n *\r\n * If you don't need a delay or don't have an `onComplete` callback then call `Tween.stop` instead.\r\n *\r\n * @method Phaser.Tweens.BaseTween#complete\r\n * @fires Phaser.Tweens.Events#TWEEN_COMPLETE\r\n * @since 3.2.0\r\n *\r\n * @param {number} [delay=0] - The time to wait before invoking the complete callback. If zero it will fire immediately.\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 406, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "complete", "longname": "Phaser.Tweens.TweenChain#complete", "kind": "function", "description": "Flags the Tween as being complete, whatever stage of progress it is at.\r\rIf an `onComplete` callback has been defined it will automatically invoke it, unless a `delay`\rargument is provided, in which case the Tween will delay for that period of time before calling the callback.\r\rIf you don't need a delay or don't have an `onComplete` callback then call `Tween.stop` instead.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_COMPLETE" ], "since": "3.2.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The time to wait before invoking the complete callback. If zero it will fire immediately.", "name": "delay" } ], "inherits": "Phaser.Tweens.BaseTween#complete", "inherited": true, "___id": "T000002R057522", "___s": true }, { "comment": "/**\r\n * Flags the Tween as being complete only once the current loop has finished.\r\n *\r\n * This is a useful way to stop an infinitely looping tween once a complete cycle is over,\r\n * rather than abruptly.\r\n *\r\n * If you don't have a loop then call `Tween.stop` instead.\r\n *\r\n * @method Phaser.Tweens.BaseTween#completeAfterLoop\r\n * @fires Phaser.Tweens.Events#TWEEN_COMPLETE\r\n * @since 3.60.0\r\n *\r\n * @param {number} [loops=0] - The number of loops that should finish before this tween completes. Zero means complete just the current loop.\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 440, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "completeAfterLoop", "longname": "Phaser.Tweens.TweenChain#completeAfterLoop", "kind": "function", "description": "Flags the Tween as being complete only once the current loop has finished.\r\rThis is a useful way to stop an infinitely looping tween once a complete cycle is over,\rrather than abruptly.\r\rIf you don't have a loop then call `Tween.stop` instead.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_COMPLETE" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The number of loops that should finish before this tween completes. Zero means complete just the current loop.", "name": "loops" } ], "inherits": "Phaser.Tweens.BaseTween#completeAfterLoop", "inherited": true, "___id": "T000002R057523", "___s": true }, { "comment": "/**\r\n * Removes the given Tween from this Tween Chain.\r\n *\r\n * The removed tween is _not_ destroyed. It is just removed from this Tween Chain.\r\n *\r\n * If the given Tween is currently playing then the chain will automatically move\r\n * to the next tween in the chain. If there are no more tweens, this chain will complete.\r\n *\r\n * @method Phaser.Tweens.TweenChain#remove\r\n * @since 3.60.0\r\n * @override\r\n *\r\n * @param {Phaser.Tweens.Tween} tween - The Tween to be removed.\r\n *\r\n * @return {this} This Tween Chain instance.\r\n */", "meta": { "filename": "TweenChain.js", "lineno": 141, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "remove", "longname": "Phaser.Tweens.TweenChain#remove", "kind": "function", "description": "Removes the given Tween from this Tween Chain.\r\rThe removed tween is _not_ destroyed. It is just removed from this Tween Chain.\r\rIf the given Tween is currently playing then the chain will automatically move\rto the next tween in the chain. If there are no more tweens, this chain will complete.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween Chain instance." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The Tween to be removed.", "name": "tween" } ], "inherits": "Phaser.Tweens.TweenChain#remove", "inherited": true, "overrides": "Phaser.Tweens.BaseTween#remove", "___id": "T000002R057524", "___s": true }, { "comment": "/**\r\n * Stops the Tween immediately, whatever stage of progress it is at.\r\n *\r\n * If not a part of a Tween Chain it is also flagged for removal by the Tween Manager.\r\n *\r\n * If an `onStop` callback has been defined it will automatically invoke it.\r\n *\r\n * The Tween will be removed during the next game frame, but should be considered 'destroyed' from this point on.\r\n *\r\n * Typically, you cannot play a Tween that has been stopped. If you just wish to pause the tween, not destroy it,\r\n * then call the `pause` method instead and use `resume` to continue playback. If you wish to restart the Tween,\r\n * use the `restart` or `seek` methods.\r\n *\r\n * @method Phaser.Tweens.BaseTween#stop\r\n * @fires Phaser.Tweens.Events#TWEEN_STOP\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 490, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "stop", "longname": "Phaser.Tweens.TweenChain#stop", "kind": "function", "description": "Stops the Tween immediately, whatever stage of progress it is at.\r\rIf not a part of a Tween Chain it is also flagged for removal by the Tween Manager.\r\rIf an `onStop` callback has been defined it will automatically invoke it.\r\rThe Tween will be removed during the next game frame, but should be considered 'destroyed' from this point on.\r\rTypically, you cannot play a Tween that has been stopped. If you just wish to pause the tween, not destroy it,\rthen call the `pause` method instead and use `resume` to continue playback. If you wish to restart the Tween,\ruse the `restart` or `seek` methods.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_STOP" ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#stop", "inherited": true, "___id": "T000002R057525", "___s": true }, { "comment": "/**\r\n * Internal method that handles the processing of the loop delay countdown timer and\r\n * the dispatch of related events. Called automatically by `Tween.update`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#updateLoopCountdown\r\n * @since 3.60.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": "BaseTween.js", "lineno": 521, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "updateLoopCountdown", "longname": "Phaser.Tweens.TweenChain#updateLoopCountdown", "kind": "function", "description": "Internal method that handles the processing of the loop delay countdown timer and\rthe dispatch of related events. Called automatically by `Tween.update`.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "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" } ], "inherits": "Phaser.Tweens.BaseTween#updateLoopCountdown", "inherited": true, "___id": "T000002R057526", "___s": true }, { "comment": "/**\r\n * Internal method that handles the processing of the start delay countdown timer and\r\n * the dispatch of related events. Called automatically by `Tween.update`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#updateStartCountdown\r\n * @since 3.60.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": "BaseTween.js", "lineno": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "updateStartCountdown", "longname": "Phaser.Tweens.TweenChain#updateStartCountdown", "kind": "function", "description": "Internal method that handles the processing of the start delay countdown timer and\rthe dispatch of related events. Called automatically by `Tween.update`.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "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" } ], "inherits": "Phaser.Tweens.BaseTween#updateStartCountdown", "inherited": true, "___id": "T000002R057527", "___s": true }, { "comment": "/**\r\n * Internal method that handles the processing of the complete delay countdown timer and\r\n * the dispatch of related events. Called automatically by `Tween.update`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#updateCompleteDelay\r\n * @since 3.60.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": "BaseTween.js", "lineno": 570, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "updateCompleteDelay", "longname": "Phaser.Tweens.TweenChain#updateCompleteDelay", "kind": "function", "description": "Internal method that handles the processing of the complete delay countdown timer and\rthe dispatch of related events. Called automatically by `Tween.update`.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "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" } ], "inherits": "Phaser.Tweens.BaseTween#updateCompleteDelay", "inherited": true, "___id": "T000002R057528", "___s": true }, { "comment": "/**\r\n * Sets an event based callback to be invoked during playback.\r\n *\r\n * Calling this method will replace a previously set callback for the given type, if any exists.\r\n *\r\n * The types available are:\r\n *\r\n * `onActive` - When the Tween is first created it moves to an 'active' state when added to the Tween Manager. 'Active' does not mean 'playing'.\r\n * `onStart` - When the Tween starts playing after a delayed or paused state. This will happen at the same time as `onActive` if the tween has no delay and isn't paused.\r\n * `onLoop` - When a Tween loops, if it has been set to do so. This happens _after_ the `loopDelay` expires, if set.\r\n * `onComplete` - When the Tween finishes playback fully. Never invoked if the Tween is set to repeat infinitely.\r\n * `onStop` - Invoked only if the `Tween.stop` method is called.\r\n * `onPause` - Invoked only if the `Tween.pause` method is called. Not invoked if the Tween Manager is paused.\r\n * `onResume` - Invoked only if the `Tween.resume` method is called. Not invoked if the Tween Manager is resumed.\r\n *\r\n * The following types are also available and are invoked on a `TweenData` level - that is per-object, per-property, being tweened.\r\n *\r\n * `onYoyo` - When a TweenData starts a yoyo. This happens _after_ the `hold` delay expires, if set.\r\n * `onRepeat` - When a TweenData repeats playback. This happens _after_ the `repeatDelay` expires, if set.\r\n * `onUpdate` - When a TweenData updates a property on a source target during playback.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setCallback\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.Tweens.TweenCallbackTypes} type - The type of callback to set. One of: `onActive`, `onComplete`, `onLoop`, `onPause`, `onRepeat`, `onResume`, `onStart`, `onStop`, `onUpdate` or `onYoyo`.\r\n * @param {function} callback - Your callback that will be invoked.\r\n * @param {array} [params] - The parameters to pass to the callback. Pass an empty array if you don't want to define any, but do wish to set the scope.\r\n *\r\n * @return {this} This Tween instance.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 589, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setCallback", "longname": "Phaser.Tweens.TweenChain#setCallback", "kind": "function", "description": "Sets an event based callback to be invoked during playback.\r\rCalling this method will replace a previously set callback for the given type, if any exists.\r\rThe types available are:\r\r`onActive` - When the Tween is first created it moves to an 'active' state when added to the Tween Manager. 'Active' does not mean 'playing'.\r`onStart` - When the Tween starts playing after a delayed or paused state. This will happen at the same time as `onActive` if the tween has no delay and isn't paused.\r`onLoop` - When a Tween loops, if it has been set to do so. This happens _after_ the `loopDelay` expires, if set.\r`onComplete` - When the Tween finishes playback fully. Never invoked if the Tween is set to repeat infinitely.\r`onStop` - Invoked only if the `Tween.stop` method is called.\r`onPause` - Invoked only if the `Tween.pause` method is called. Not invoked if the Tween Manager is paused.\r`onResume` - Invoked only if the `Tween.resume` method is called. Not invoked if the Tween Manager is resumed.\r\rThe following types are also available and are invoked on a `TweenData` level - that is per-object, per-property, being tweened.\r\r`onYoyo` - When a TweenData starts a yoyo. This happens _after_ the `hold` delay expires, if set.\r`onRepeat` - When a TweenData repeats playback. This happens _after_ the `repeatDelay` expires, if set.\r`onUpdate` - When a TweenData updates a property on a source target during playback.", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tween instance." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "params": [ { "type": { "names": [ "Phaser.Types.Tweens.TweenCallbackTypes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Tweens.TweenCallbackTypes" } }, "description": "The type of callback to set. One of: `onActive`, `onComplete`, `onLoop`, `onPause`, `onRepeat`, `onResume`, `onStart`, `onStop`, `onUpdate` or `onYoyo`.", "name": "type" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "Your callback that will be invoked.", "name": "callback" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "The parameters to pass to the callback. Pass an empty array if you don't want to define any, but do wish to set the scope.", "name": "params" } ], "inherits": "Phaser.Tweens.BaseTween#setCallback", "inherited": true, "___id": "T000002R057529", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to PENDING.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setPendingState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 631, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setPendingState", "longname": "Phaser.Tweens.TweenChain#setPendingState", "kind": "function", "description": "Sets this Tween state to PENDING.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setPendingState", "inherited": true, "___id": "T000002R057530", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to ACTIVE.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setActiveState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 642, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setActiveState", "longname": "Phaser.Tweens.TweenChain#setActiveState", "kind": "function", "description": "Sets this Tween state to ACTIVE.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setActiveState", "inherited": true, "___id": "T000002R057531", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to LOOP_DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setLoopDelayState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 653, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setLoopDelayState", "longname": "Phaser.Tweens.TweenChain#setLoopDelayState", "kind": "function", "description": "Sets this Tween state to LOOP_DELAY.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setLoopDelayState", "inherited": true, "___id": "T000002R057532", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to COMPLETE_DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setCompleteDelayState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 664, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setCompleteDelayState", "longname": "Phaser.Tweens.TweenChain#setCompleteDelayState", "kind": "function", "description": "Sets this Tween state to COMPLETE_DELAY.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setCompleteDelayState", "inherited": true, "___id": "T000002R057533", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to START_DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setStartDelayState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 675, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setStartDelayState", "longname": "Phaser.Tweens.TweenChain#setStartDelayState", "kind": "function", "description": "Sets this Tween state to START_DELAY.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setStartDelayState", "inherited": true, "___id": "T000002R057534", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to PENDING_REMOVE.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setPendingRemoveState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 690, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setPendingRemoveState", "longname": "Phaser.Tweens.TweenChain#setPendingRemoveState", "kind": "function", "description": "Sets this Tween state to PENDING_REMOVE.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setPendingRemoveState", "inherited": true, "___id": "T000002R057535", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to REMOVED.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setRemovedState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 701, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setRemovedState", "longname": "Phaser.Tweens.TweenChain#setRemovedState", "kind": "function", "description": "Sets this Tween state to REMOVED.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setRemovedState", "inherited": true, "___id": "T000002R057536", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to FINISHED.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setFinishedState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 712, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setFinishedState", "longname": "Phaser.Tweens.TweenChain#setFinishedState", "kind": "function", "description": "Sets this Tween state to FINISHED.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setFinishedState", "inherited": true, "___id": "T000002R057537", "___s": true }, { "comment": "/**\r\n * Sets this Tween state to DESTROYED.\r\n *\r\n * @method Phaser.Tweens.BaseTween#setDestroyedState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 723, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setDestroyedState", "longname": "Phaser.Tweens.TweenChain#setDestroyedState", "kind": "function", "description": "Sets this Tween state to DESTROYED.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#setDestroyedState", "inherited": true, "___id": "T000002R057538", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of PENDING, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isPending\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of PENDING, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 734, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isPending", "longname": "Phaser.Tweens.TweenChain#isPending", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of PENDING, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of PENDING, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isPending", "inherited": true, "___id": "T000002R057539", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of ACTIVE, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isActive\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of ACTIVE, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isActive", "longname": "Phaser.Tweens.TweenChain#isActive", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of ACTIVE, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of ACTIVE, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isActive", "inherited": true, "___id": "T000002R057540", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of LOOP_DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isLoopDelayed\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of LOOP_DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 760, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isLoopDelayed", "longname": "Phaser.Tweens.TweenChain#isLoopDelayed", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of LOOP_DELAY, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of LOOP_DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isLoopDelayed", "inherited": true, "___id": "T000002R057541", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of COMPLETE_DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isCompleteDelayed\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of COMPLETE_DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isCompleteDelayed", "longname": "Phaser.Tweens.TweenChain#isCompleteDelayed", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of COMPLETE_DELAY, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of COMPLETE_DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isCompleteDelayed", "inherited": true, "___id": "T000002R057542", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of START_DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isStartDelayed\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of START_DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 786, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isStartDelayed", "longname": "Phaser.Tweens.TweenChain#isStartDelayed", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of START_DELAY, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of START_DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isStartDelayed", "inherited": true, "___id": "T000002R057543", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of PENDING_REMOVE, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isPendingRemove\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of PENDING_REMOVE, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 799, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isPendingRemove", "longname": "Phaser.Tweens.TweenChain#isPendingRemove", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of PENDING_REMOVE, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of PENDING_REMOVE, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isPendingRemove", "inherited": true, "___id": "T000002R057544", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of REMOVED, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isRemoved\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of REMOVED, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 812, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isRemoved", "longname": "Phaser.Tweens.TweenChain#isRemoved", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of REMOVED, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of REMOVED, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isRemoved", "inherited": true, "___id": "T000002R057545", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of FINISHED, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isFinished\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of FINISHED, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 825, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isFinished", "longname": "Phaser.Tweens.TweenChain#isFinished", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of FINISHED, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of FINISHED, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isFinished", "inherited": true, "___id": "T000002R057546", "___s": true }, { "comment": "/**\r\n * Returns `true` if this Tween has a _current_ state of DESTROYED, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTween#isDestroyed\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this Tween has a _current_ state of DESTROYED, otherwise `false`.\r\n */", "meta": { "filename": "BaseTween.js", "lineno": 838, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isDestroyed", "longname": "Phaser.Tweens.TweenChain#isDestroyed", "kind": "function", "description": "Returns `true` if this Tween has a _current_ state of DESTROYED, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this Tween has a _current_ state of DESTROYED, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Tweens.BaseTween#isDestroyed", "inherited": true, "___id": "T000002R057547", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.Tweens.TweenChain#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R057548", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.Tweens.TweenChain#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R057549", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.Tweens.TweenChain#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R057550", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.Tweens.TweenChain#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "___id": "T000002R057551", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.Tweens.TweenChain#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "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" } ], "___id": "T000002R057552", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.Tweens.TweenChain#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "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" } ], "___id": "T000002R057553", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.Tweens.TweenChain#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "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" } ], "___id": "T000002R057554", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.Tweens.TweenChain#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "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" } ], "___id": "T000002R057555", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.Tweens.TweenChain#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "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" } ], "___id": "T000002R057556", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.Tweens.TweenChain#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "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" } ], "___id": "T000002R057557", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.Tweens.TweenChain#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Tweens.TweenChain", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "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" } ], "___id": "T000002R057558", "___s": true }, { "comment": "/**\r\n * A reference to the Tween that this TweenData instance belongs to.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#tween\r\n * @type {Phaser.Tweens.Tween}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "tween", "longname": "Phaser.Tweens.TweenData#tween", "kind": "member", "description": "A reference to the Tween that this TweenData instance belongs to.", "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#tween", "inherited": true, "___id": "T000002R057559", "___s": true }, { "comment": "/**\r\n * The index of the target within the Tween `targets` array.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#targetIndex\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "targetIndex", "longname": "Phaser.Tweens.TweenData#targetIndex", "kind": "member", "description": "The index of the target within the Tween `targets` array.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#targetIndex", "inherited": true, "___id": "T000002R057560", "___s": true }, { "comment": "/**\r\n * The duration of the tween in milliseconds, excluding any time required\r\n * for yoyo or repeats.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#duration\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "duration", "longname": "Phaser.Tweens.TweenData#duration", "kind": "member", "description": "The duration of the tween in milliseconds, excluding any time required\rfor yoyo or repeats.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#duration", "inherited": true, "___id": "T000002R057561", "___s": true }, { "comment": "/**\r\n * The total calculated duration, in milliseconds, of this TweenData.\r\n * Factoring in the duration, repeats, delays and yoyos.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#totalDuration\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "totalDuration", "longname": "Phaser.Tweens.TweenData#totalDuration", "kind": "member", "description": "The total calculated duration, in milliseconds, of this TweenData.\rFactoring in the duration, repeats, delays and yoyos.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#totalDuration", "inherited": true, "___id": "T000002R057562", "___s": true }, { "comment": "/**\r\n * The time, in milliseconds, before this tween will start playing.\r\n *\r\n * This value is generated by the `getDelay` function.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#delay\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 87, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "delay", "longname": "Phaser.Tweens.TweenData#delay", "kind": "member", "description": "The time, in milliseconds, before this tween will start playing.\r\rThis value is generated by the `getDelay` function.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#delay", "inherited": true, "___id": "T000002R057563", "___s": true }, { "comment": "/**\r\n * This function returns the value to be used for `TweenData.delay`.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#getDelay\r\n * @type {function}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "getDelay", "longname": "Phaser.Tweens.TweenData#getDelay", "kind": "member", "description": "This function returns the value to be used for `TweenData.delay`.", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#getDelay", "inherited": true, "___id": "T000002R057564", "___s": true }, { "comment": "/**\r\n * Will the Tween ease back to its starting values, after reaching the end\r\n * and any `hold` value that may be set?\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#yoyo\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "yoyo", "longname": "Phaser.Tweens.TweenData#yoyo", "kind": "member", "description": "Will the Tween ease back to its starting values, after reaching the end\rand any `hold` value that may be set?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#yoyo", "inherited": true, "___id": "T000002R057565", "___s": true }, { "comment": "/**\r\n * The time, in milliseconds, before this tween will start a yoyo to repeat.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#hold\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 117, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "hold", "longname": "Phaser.Tweens.TweenData#hold", "kind": "member", "description": "The time, in milliseconds, before this tween will start a yoyo to repeat.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#hold", "inherited": true, "___id": "T000002R057566", "___s": true }, { "comment": "/**\r\n * The number of times this tween will repeat.\r\n *\r\n * The tween will always run once regardless of this value,\r\n * so a repeat value of '1' will play the tween twice: I.e. the original\r\n * play-through and then it repeats that once (1).\r\n *\r\n * If this value is set to -1 this tween will repeat forever.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#repeat\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 126, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "repeat", "longname": "Phaser.Tweens.TweenData#repeat", "kind": "member", "description": "The number of times this tween will repeat.\r\rThe tween will always run once regardless of this value,\rso a repeat value of '1' will play the tween twice: I.e. the original\rplay-through and then it repeats that once (1).\r\rIf this value is set to -1 this tween will repeat forever.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#repeat", "inherited": true, "___id": "T000002R057567", "___s": true }, { "comment": "/**\r\n * The time, in milliseconds, before the repeat will start.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#repeatDelay\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "repeatDelay", "longname": "Phaser.Tweens.TweenData#repeatDelay", "kind": "member", "description": "The time, in milliseconds, before the repeat will start.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#repeatDelay", "inherited": true, "___id": "T000002R057568", "___s": true }, { "comment": "/**\r\n * How many repeats are left to run?\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#repeatCounter\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "repeatCounter", "longname": "Phaser.Tweens.TweenData#repeatCounter", "kind": "member", "description": "How many repeats are left to run?", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#repeatCounter", "inherited": true, "___id": "T000002R057569", "___s": true }, { "comment": "/**\r\n * If `true` this Tween will call `toggleFlipX` on the Tween target\r\n * whenever it yoyo's or repeats. It will only be called if the target\r\n * has a function matching this name, like most Phaser GameObjects do.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#flipX\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "flipX", "longname": "Phaser.Tweens.TweenData#flipX", "kind": "member", "description": "If `true` this Tween will call `toggleFlipX` on the Tween target\rwhenever it yoyo's or repeats. It will only be called if the target\rhas a function matching this name, like most Phaser GameObjects do.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#flipX", "inherited": true, "___id": "T000002R057570", "___s": true }, { "comment": "/**\r\n * If `true` this Tween will call `toggleFlipY` on the Tween target\r\n * whenever it yoyo's or repeats. It will only be called if the target\r\n * has a function matching this name, like most Phaser GameObjects do.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#flipY\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 170, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "flipY", "longname": "Phaser.Tweens.TweenData#flipY", "kind": "member", "description": "If `true` this Tween will call `toggleFlipY` on the Tween target\rwhenever it yoyo's or repeats. It will only be called if the target\rhas a function matching this name, like most Phaser GameObjects do.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#flipY", "inherited": true, "___id": "T000002R057571", "___s": true }, { "comment": "/**\r\n * A value between 0 and 1 holding the progress of this TweenData.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#progress\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 181, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "progress", "longname": "Phaser.Tweens.TweenData#progress", "kind": "member", "description": "A value between 0 and 1 holding the progress of this TweenData.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#progress", "inherited": true, "___id": "T000002R057572", "___s": true }, { "comment": "/**\r\n * The amount of time, in milliseconds, that has elapsed since this\r\n * TweenData was made active.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#elapsed\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 190, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "elapsed", "longname": "Phaser.Tweens.TweenData#elapsed", "kind": "member", "description": "The amount of time, in milliseconds, that has elapsed since this\rTweenData was made active.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#elapsed", "inherited": true, "___id": "T000002R057573", "___s": true }, { "comment": "/**\r\n * The state of this TweenData.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#state\r\n * @type {Phaser.Tweens.StateType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 200, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "state", "longname": "Phaser.Tweens.TweenData#state", "kind": "member", "description": "The state of this TweenData.", "type": { "names": [ "Phaser.Tweens.StateType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.StateType" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#state", "inherited": true, "___id": "T000002R057574", "___s": true }, { "comment": "/**\r\n * Is this Tween Data currently waiting for a countdown to elapse, or not?\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#isCountdown\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 209, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isCountdown", "longname": "Phaser.Tweens.TweenData#isCountdown", "kind": "member", "description": "Is this Tween Data currently waiting for a countdown to elapse, or not?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isCountdown", "inherited": true, "___id": "T000002R057575", "___s": true }, { "comment": "/**\r\n * Returns a reference to the target object belonging to this TweenData.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#getTarget\r\n * @since 3.60.0\r\n *\r\n * @return {object} The target object. Can be any JavaScript object, but is typically a Game Object.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 219, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "getTarget", "longname": "Phaser.Tweens.TweenData#getTarget", "kind": "function", "description": "Returns a reference to the target object belonging to this TweenData.", "since": "3.60.0", "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The target object. Can be any JavaScript object, but is typically a Game Object." } ], "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#getTarget", "inherited": true, "___id": "T000002R057576", "___s": true }, { "comment": "/**\r\n * Sets this TweenData's target object property to be the given value.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setTargetValue\r\n * @since 3.60.0\r\n *\r\n * @param {number} [value] - The value to set on the target. If not given, sets it to the last `current` value.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 232, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setTargetValue", "longname": "Phaser.Tweens.TweenData#setTargetValue", "kind": "function", "description": "Sets this TweenData's target object property to be the given value.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The value to set on the target. If not given, sets it to the last `current` value.", "name": "value" } ], "inherits": "Phaser.Tweens.BaseTweenData#setTargetValue", "inherited": true, "___id": "T000002R057577", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to CREATED.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setCreatedState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setCreatedState", "longname": "Phaser.Tweens.TweenData#setCreatedState", "kind": "function", "description": "Sets this TweenData state to CREATED.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#setCreatedState", "inherited": true, "___id": "T000002R057578", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setDelayState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 259, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setDelayState", "longname": "Phaser.Tweens.TweenData#setDelayState", "kind": "function", "description": "Sets this TweenData state to DELAY.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#setDelayState", "inherited": true, "___id": "T000002R057579", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to PENDING_RENDER.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setPendingRenderState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 271, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setPendingRenderState", "longname": "Phaser.Tweens.TweenData#setPendingRenderState", "kind": "function", "description": "Sets this TweenData state to PENDING_RENDER.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#setPendingRenderState", "inherited": true, "___id": "T000002R057580", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to PLAYING_FORWARD.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setPlayingForwardState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 283, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setPlayingForwardState", "longname": "Phaser.Tweens.TweenData#setPlayingForwardState", "kind": "function", "description": "Sets this TweenData state to PLAYING_FORWARD.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#setPlayingForwardState", "inherited": true, "___id": "T000002R057581", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to PLAYING_BACKWARD.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setPlayingBackwardState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setPlayingBackwardState", "longname": "Phaser.Tweens.TweenData#setPlayingBackwardState", "kind": "function", "description": "Sets this TweenData state to PLAYING_BACKWARD.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#setPlayingBackwardState", "inherited": true, "___id": "T000002R057582", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to HOLD_DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setHoldState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setHoldState", "longname": "Phaser.Tweens.TweenData#setHoldState", "kind": "function", "description": "Sets this TweenData state to HOLD_DELAY.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#setHoldState", "inherited": true, "___id": "T000002R057583", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to REPEAT_DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setRepeatState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 319, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setRepeatState", "longname": "Phaser.Tweens.TweenData#setRepeatState", "kind": "function", "description": "Sets this TweenData state to REPEAT_DELAY.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#setRepeatState", "inherited": true, "___id": "T000002R057584", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to COMPLETE.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setCompleteState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 331, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setCompleteState", "longname": "Phaser.Tweens.TweenData#setCompleteState", "kind": "function", "description": "Sets this TweenData state to COMPLETE.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#setCompleteState", "inherited": true, "___id": "T000002R057585", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of CREATED, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isCreated\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of CREATED, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 343, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isCreated", "longname": "Phaser.Tweens.TweenData#isCreated", "kind": "function", "description": "Returns `true` if this TweenData has a _current_ state of CREATED, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of CREATED, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isCreated", "inherited": true, "___id": "T000002R057586", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isDelayed\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isDelayed", "longname": "Phaser.Tweens.TweenData#isDelayed", "kind": "function", "description": "Returns `true` if this TweenData has a _current_ state of DELAY, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isDelayed", "inherited": true, "___id": "T000002R057587", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of PENDING_RENDER, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isPendingRender\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of PENDING_RENDER, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 369, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isPendingRender", "longname": "Phaser.Tweens.TweenData#isPendingRender", "kind": "function", "description": "Returns `true` if this TweenData has a _current_ state of PENDING_RENDER, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of PENDING_RENDER, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isPendingRender", "inherited": true, "___id": "T000002R057588", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of PLAYING_FORWARD, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isPlayingForward\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of PLAYING_FORWARD, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 382, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isPlayingForward", "longname": "Phaser.Tweens.TweenData#isPlayingForward", "kind": "function", "description": "Returns `true` if this TweenData has a _current_ state of PLAYING_FORWARD, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of PLAYING_FORWARD, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isPlayingForward", "inherited": true, "___id": "T000002R057589", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of PLAYING_BACKWARD, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isPlayingBackward\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of PLAYING_BACKWARD, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 395, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isPlayingBackward", "longname": "Phaser.Tweens.TweenData#isPlayingBackward", "kind": "function", "description": "Returns `true` if this TweenData has a _current_ state of PLAYING_BACKWARD, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of PLAYING_BACKWARD, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isPlayingBackward", "inherited": true, "___id": "T000002R057590", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of HOLD_DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isHolding\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of HOLD_DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isHolding", "longname": "Phaser.Tweens.TweenData#isHolding", "kind": "function", "description": "Returns `true` if this TweenData has a _current_ state of HOLD_DELAY, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of HOLD_DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isHolding", "inherited": true, "___id": "T000002R057591", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of REPEAT_DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isRepeating\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of REPEAT_DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 421, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isRepeating", "longname": "Phaser.Tweens.TweenData#isRepeating", "kind": "function", "description": "Returns `true` if this TweenData has a _current_ state of REPEAT_DELAY, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of REPEAT_DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isRepeating", "inherited": true, "___id": "T000002R057592", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of COMPLETE, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isComplete\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of COMPLETE, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 434, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isComplete", "longname": "Phaser.Tweens.TweenData#isComplete", "kind": "function", "description": "Returns `true` if this TweenData has a _current_ state of COMPLETE, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of COMPLETE, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isComplete", "inherited": true, "___id": "T000002R057593", "___s": true }, { "comment": "/**\r\n * Internal method used as part of the playback process that checks if this\r\n * TweenData should yoyo, repeat, or has completed.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setStateFromEnd\r\n * @fires Phaser.Tweens.Events#TWEEN_REPEAT\r\n * @fires Phaser.Tweens.Events#TWEEN_YOYO\r\n * @since 3.60.0\r\n *\r\n * @param {number} diff - Any extra time that needs to be accounted for in the elapsed and progress values.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 447, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setStateFromEnd", "longname": "Phaser.Tweens.TweenData#setStateFromEnd", "kind": "function", "description": "Internal method used as part of the playback process that checks if this\rTweenData should yoyo, repeat, or has completed.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_REPEAT", "Phaser.Tweens.Events#event:TWEEN_YOYO" ], "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Any extra time that needs to be accounted for in the elapsed and progress values.", "name": "diff" } ], "inherits": "Phaser.Tweens.BaseTweenData#setStateFromEnd", "inherited": true, "___id": "T000002R057594", "___s": true }, { "comment": "/**\r\n * Internal method used as part of the playback process that checks if this\r\n * TweenData should repeat or has completed.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setStateFromStart\r\n * @fires Phaser.Tweens.Events#TWEEN_REPEAT\r\n * @since 3.60.0\r\n *\r\n * @param {number} diff - Any extra time that needs to be accounted for in the elapsed and progress values.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 474, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setStateFromStart", "longname": "Phaser.Tweens.TweenData#setStateFromStart", "kind": "function", "description": "Internal method used as part of the playback process that checks if this\rTweenData should repeat or has completed.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_REPEAT" ], "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Any extra time that needs to be accounted for in the elapsed and progress values.", "name": "diff" } ], "inherits": "Phaser.Tweens.BaseTweenData#setStateFromStart", "inherited": true, "___id": "T000002R057595", "___s": true }, { "comment": "/**\r\n * Internal method that handles repeating or yoyo'ing this TweenData.\r\n *\r\n * Called automatically by `setStateFromStart` and `setStateFromEnd`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#onRepeat\r\n * @fires Phaser.Tweens.Events#TWEEN_REPEAT\r\n * @fires Phaser.Tweens.Events#TWEEN_YOYO\r\n * @since 3.60.0\r\n *\r\n * @param {number} diff - Any extra time that needs to be accounted for in the elapsed and progress values.\r\n * @param {boolean} setStart - Set the TweenData start values?\r\n * @param {boolean} isYoyo - Is this call a Yoyo check?\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 569, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "onRepeat", "longname": "Phaser.Tweens.TweenData#onRepeat", "kind": "function", "description": "Internal method that handles repeating or yoyo'ing this TweenData.\r\rCalled automatically by `setStateFromStart` and `setStateFromEnd`.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_REPEAT", "Phaser.Tweens.Events#event:TWEEN_YOYO" ], "since": "3.60.0", "memberof": "Phaser.Tweens.TweenData", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Any extra time that needs to be accounted for in the elapsed and progress values.", "name": "diff" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set the TweenData start values?", "name": "setStart" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this call a Yoyo check?", "name": "isYoyo" } ], "inherits": "Phaser.Tweens.BaseTweenData#onRepeat", "inherited": true, "___id": "T000002R057596", "___s": true }, { "comment": "/**\r\n * A reference to the Tween that this TweenData instance belongs to.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#tween\r\n * @type {Phaser.Tweens.Tween}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "tween", "longname": "Phaser.Tweens.TweenFrameData#tween", "kind": "member", "description": "A reference to the Tween that this TweenData instance belongs to.", "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#tween", "inherited": true, "___id": "T000002R057597", "___s": true }, { "comment": "/**\r\n * The index of the target within the Tween `targets` array.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#targetIndex\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "targetIndex", "longname": "Phaser.Tweens.TweenFrameData#targetIndex", "kind": "member", "description": "The index of the target within the Tween `targets` array.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#targetIndex", "inherited": true, "___id": "T000002R057598", "___s": true }, { "comment": "/**\r\n * The duration of the tween in milliseconds, excluding any time required\r\n * for yoyo or repeats.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#duration\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "duration", "longname": "Phaser.Tweens.TweenFrameData#duration", "kind": "member", "description": "The duration of the tween in milliseconds, excluding any time required\rfor yoyo or repeats.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#duration", "inherited": true, "___id": "T000002R057599", "___s": true }, { "comment": "/**\r\n * The total calculated duration, in milliseconds, of this TweenData.\r\n * Factoring in the duration, repeats, delays and yoyos.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#totalDuration\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "totalDuration", "longname": "Phaser.Tweens.TweenFrameData#totalDuration", "kind": "member", "description": "The total calculated duration, in milliseconds, of this TweenData.\rFactoring in the duration, repeats, delays and yoyos.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#totalDuration", "inherited": true, "___id": "T000002R057600", "___s": true }, { "comment": "/**\r\n * The time, in milliseconds, before this tween will start playing.\r\n *\r\n * This value is generated by the `getDelay` function.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#delay\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 87, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "delay", "longname": "Phaser.Tweens.TweenFrameData#delay", "kind": "member", "description": "The time, in milliseconds, before this tween will start playing.\r\rThis value is generated by the `getDelay` function.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#delay", "inherited": true, "___id": "T000002R057601", "___s": true }, { "comment": "/**\r\n * This function returns the value to be used for `TweenData.delay`.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#getDelay\r\n * @type {function}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "getDelay", "longname": "Phaser.Tweens.TweenFrameData#getDelay", "kind": "member", "description": "This function returns the value to be used for `TweenData.delay`.", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#getDelay", "inherited": true, "___id": "T000002R057602", "___s": true }, { "comment": "/**\r\n * The time, in milliseconds, before this tween will start a yoyo to repeat.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#hold\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 117, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "hold", "longname": "Phaser.Tweens.TweenFrameData#hold", "kind": "member", "description": "The time, in milliseconds, before this tween will start a yoyo to repeat.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#hold", "inherited": true, "___id": "T000002R057603", "___s": true }, { "comment": "/**\r\n * The number of times this tween will repeat.\r\n *\r\n * The tween will always run once regardless of this value,\r\n * so a repeat value of '1' will play the tween twice: I.e. the original\r\n * play-through and then it repeats that once (1).\r\n *\r\n * If this value is set to -1 this tween will repeat forever.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#repeat\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 126, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "repeat", "longname": "Phaser.Tweens.TweenFrameData#repeat", "kind": "member", "description": "The number of times this tween will repeat.\r\rThe tween will always run once regardless of this value,\rso a repeat value of '1' will play the tween twice: I.e. the original\rplay-through and then it repeats that once (1).\r\rIf this value is set to -1 this tween will repeat forever.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#repeat", "inherited": true, "___id": "T000002R057604", "___s": true }, { "comment": "/**\r\n * The time, in milliseconds, before the repeat will start.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#repeatDelay\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "repeatDelay", "longname": "Phaser.Tweens.TweenFrameData#repeatDelay", "kind": "member", "description": "The time, in milliseconds, before the repeat will start.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#repeatDelay", "inherited": true, "___id": "T000002R057605", "___s": true }, { "comment": "/**\r\n * How many repeats are left to run?\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#repeatCounter\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "repeatCounter", "longname": "Phaser.Tweens.TweenFrameData#repeatCounter", "kind": "member", "description": "How many repeats are left to run?", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#repeatCounter", "inherited": true, "___id": "T000002R057606", "___s": true }, { "comment": "/**\r\n * If `true` this Tween will call `toggleFlipX` on the Tween target\r\n * whenever it yoyo's or repeats. It will only be called if the target\r\n * has a function matching this name, like most Phaser GameObjects do.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#flipX\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "flipX", "longname": "Phaser.Tweens.TweenFrameData#flipX", "kind": "member", "description": "If `true` this Tween will call `toggleFlipX` on the Tween target\rwhenever it yoyo's or repeats. It will only be called if the target\rhas a function matching this name, like most Phaser GameObjects do.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#flipX", "inherited": true, "___id": "T000002R057607", "___s": true }, { "comment": "/**\r\n * If `true` this Tween will call `toggleFlipY` on the Tween target\r\n * whenever it yoyo's or repeats. It will only be called if the target\r\n * has a function matching this name, like most Phaser GameObjects do.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#flipY\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 170, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "flipY", "longname": "Phaser.Tweens.TweenFrameData#flipY", "kind": "member", "description": "If `true` this Tween will call `toggleFlipY` on the Tween target\rwhenever it yoyo's or repeats. It will only be called if the target\rhas a function matching this name, like most Phaser GameObjects do.", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#flipY", "inherited": true, "___id": "T000002R057608", "___s": true }, { "comment": "/**\r\n * A value between 0 and 1 holding the progress of this TweenData.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#progress\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 181, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "progress", "longname": "Phaser.Tweens.TweenFrameData#progress", "kind": "member", "description": "A value between 0 and 1 holding the progress of this TweenData.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#progress", "inherited": true, "___id": "T000002R057609", "___s": true }, { "comment": "/**\r\n * The amount of time, in milliseconds, that has elapsed since this\r\n * TweenData was made active.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#elapsed\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 190, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "elapsed", "longname": "Phaser.Tweens.TweenFrameData#elapsed", "kind": "member", "description": "The amount of time, in milliseconds, that has elapsed since this\rTweenData was made active.", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#elapsed", "inherited": true, "___id": "T000002R057610", "___s": true }, { "comment": "/**\r\n * The state of this TweenData.\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#state\r\n * @type {Phaser.Tweens.StateType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 200, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "state", "longname": "Phaser.Tweens.TweenFrameData#state", "kind": "member", "description": "The state of this TweenData.", "type": { "names": [ "Phaser.Tweens.StateType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.StateType" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#state", "inherited": true, "___id": "T000002R057611", "___s": true }, { "comment": "/**\r\n * Is this Tween Data currently waiting for a countdown to elapse, or not?\r\n *\r\n * @name Phaser.Tweens.BaseTweenData#isCountdown\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 209, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isCountdown", "longname": "Phaser.Tweens.TweenFrameData#isCountdown", "kind": "member", "description": "Is this Tween Data currently waiting for a countdown to elapse, or not?", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isCountdown", "inherited": true, "___id": "T000002R057612", "___s": true }, { "comment": "/**\r\n * Returns a reference to the target object belonging to this TweenData.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#getTarget\r\n * @since 3.60.0\r\n *\r\n * @return {object} The target object. Can be any JavaScript object, but is typically a Game Object.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 219, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "getTarget", "longname": "Phaser.Tweens.TweenFrameData#getTarget", "kind": "function", "description": "Returns a reference to the target object belonging to this TweenData.", "since": "3.60.0", "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The target object. Can be any JavaScript object, but is typically a Game Object." } ], "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#getTarget", "inherited": true, "___id": "T000002R057613", "___s": true }, { "comment": "/**\r\n * Sets this TweenData's target object property to be the given value.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setTargetValue\r\n * @since 3.60.0\r\n *\r\n * @param {number} [value] - The value to set on the target. If not given, sets it to the last `current` value.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 232, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setTargetValue", "longname": "Phaser.Tweens.TweenFrameData#setTargetValue", "kind": "function", "description": "Sets this TweenData's target object property to be the given value.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The value to set on the target. If not given, sets it to the last `current` value.", "name": "value" } ], "inherits": "Phaser.Tweens.BaseTweenData#setTargetValue", "inherited": true, "___id": "T000002R057614", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to CREATED.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setCreatedState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setCreatedState", "longname": "Phaser.Tweens.TweenFrameData#setCreatedState", "kind": "function", "description": "Sets this TweenData state to CREATED.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#setCreatedState", "inherited": true, "___id": "T000002R057615", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setDelayState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 259, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setDelayState", "longname": "Phaser.Tweens.TweenFrameData#setDelayState", "kind": "function", "description": "Sets this TweenData state to DELAY.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#setDelayState", "inherited": true, "___id": "T000002R057616", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to PENDING_RENDER.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setPendingRenderState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 271, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setPendingRenderState", "longname": "Phaser.Tweens.TweenFrameData#setPendingRenderState", "kind": "function", "description": "Sets this TweenData state to PENDING_RENDER.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#setPendingRenderState", "inherited": true, "___id": "T000002R057617", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to PLAYING_FORWARD.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setPlayingForwardState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 283, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setPlayingForwardState", "longname": "Phaser.Tweens.TweenFrameData#setPlayingForwardState", "kind": "function", "description": "Sets this TweenData state to PLAYING_FORWARD.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#setPlayingForwardState", "inherited": true, "___id": "T000002R057618", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to PLAYING_BACKWARD.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setPlayingBackwardState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 295, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setPlayingBackwardState", "longname": "Phaser.Tweens.TweenFrameData#setPlayingBackwardState", "kind": "function", "description": "Sets this TweenData state to PLAYING_BACKWARD.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#setPlayingBackwardState", "inherited": true, "___id": "T000002R057619", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to HOLD_DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setHoldState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setHoldState", "longname": "Phaser.Tweens.TweenFrameData#setHoldState", "kind": "function", "description": "Sets this TweenData state to HOLD_DELAY.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#setHoldState", "inherited": true, "___id": "T000002R057620", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to REPEAT_DELAY.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setRepeatState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 319, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setRepeatState", "longname": "Phaser.Tweens.TweenFrameData#setRepeatState", "kind": "function", "description": "Sets this TweenData state to REPEAT_DELAY.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#setRepeatState", "inherited": true, "___id": "T000002R057621", "___s": true }, { "comment": "/**\r\n * Sets this TweenData state to COMPLETE.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setCompleteState\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 331, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setCompleteState", "longname": "Phaser.Tweens.TweenFrameData#setCompleteState", "kind": "function", "description": "Sets this TweenData state to COMPLETE.", "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#setCompleteState", "inherited": true, "___id": "T000002R057622", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of CREATED, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isCreated\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of CREATED, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 343, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isCreated", "longname": "Phaser.Tweens.TweenFrameData#isCreated", "kind": "function", "description": "Returns `true` if this TweenData has a _current_ state of CREATED, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of CREATED, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isCreated", "inherited": true, "___id": "T000002R057623", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isDelayed\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isDelayed", "longname": "Phaser.Tweens.TweenFrameData#isDelayed", "kind": "function", "description": "Returns `true` if this TweenData has a _current_ state of DELAY, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isDelayed", "inherited": true, "___id": "T000002R057624", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of PENDING_RENDER, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isPendingRender\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of PENDING_RENDER, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 369, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isPendingRender", "longname": "Phaser.Tweens.TweenFrameData#isPendingRender", "kind": "function", "description": "Returns `true` if this TweenData has a _current_ state of PENDING_RENDER, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of PENDING_RENDER, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isPendingRender", "inherited": true, "___id": "T000002R057625", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of PLAYING_FORWARD, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isPlayingForward\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of PLAYING_FORWARD, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 382, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isPlayingForward", "longname": "Phaser.Tweens.TweenFrameData#isPlayingForward", "kind": "function", "description": "Returns `true` if this TweenData has a _current_ state of PLAYING_FORWARD, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of PLAYING_FORWARD, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isPlayingForward", "inherited": true, "___id": "T000002R057626", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of PLAYING_BACKWARD, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isPlayingBackward\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of PLAYING_BACKWARD, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 395, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isPlayingBackward", "longname": "Phaser.Tweens.TweenFrameData#isPlayingBackward", "kind": "function", "description": "Returns `true` if this TweenData has a _current_ state of PLAYING_BACKWARD, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of PLAYING_BACKWARD, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isPlayingBackward", "inherited": true, "___id": "T000002R057627", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of HOLD_DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isHolding\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of HOLD_DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isHolding", "longname": "Phaser.Tweens.TweenFrameData#isHolding", "kind": "function", "description": "Returns `true` if this TweenData has a _current_ state of HOLD_DELAY, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of HOLD_DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isHolding", "inherited": true, "___id": "T000002R057628", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of REPEAT_DELAY, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isRepeating\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of REPEAT_DELAY, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 421, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isRepeating", "longname": "Phaser.Tweens.TweenFrameData#isRepeating", "kind": "function", "description": "Returns `true` if this TweenData has a _current_ state of REPEAT_DELAY, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of REPEAT_DELAY, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isRepeating", "inherited": true, "___id": "T000002R057629", "___s": true }, { "comment": "/**\r\n * Returns `true` if this TweenData has a _current_ state of COMPLETE, otherwise `false`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#isComplete\r\n * @since 3.60.0\r\n *\r\n * @return {boolean} `true` if this TweenData has a _current_ state of COMPLETE, otherwise `false`.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 434, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "isComplete", "longname": "Phaser.Tweens.TweenFrameData#isComplete", "kind": "function", "description": "Returns `true` if this TweenData has a _current_ state of COMPLETE, otherwise `false`.", "since": "3.60.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this TweenData has a _current_ state of COMPLETE, otherwise `false`." } ], "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "inherits": "Phaser.Tweens.BaseTweenData#isComplete", "inherited": true, "___id": "T000002R057630", "___s": true }, { "comment": "/**\r\n * Internal method used as part of the playback process that checks if this\r\n * TweenData should yoyo, repeat, or has completed.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setStateFromEnd\r\n * @fires Phaser.Tweens.Events#TWEEN_REPEAT\r\n * @fires Phaser.Tweens.Events#TWEEN_YOYO\r\n * @since 3.60.0\r\n *\r\n * @param {number} diff - Any extra time that needs to be accounted for in the elapsed and progress values.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 447, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setStateFromEnd", "longname": "Phaser.Tweens.TweenFrameData#setStateFromEnd", "kind": "function", "description": "Internal method used as part of the playback process that checks if this\rTweenData should yoyo, repeat, or has completed.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_REPEAT", "Phaser.Tweens.Events#event:TWEEN_YOYO" ], "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Any extra time that needs to be accounted for in the elapsed and progress values.", "name": "diff" } ], "inherits": "Phaser.Tweens.BaseTweenData#setStateFromEnd", "inherited": true, "___id": "T000002R057631", "___s": true }, { "comment": "/**\r\n * Internal method used as part of the playback process that checks if this\r\n * TweenData should repeat or has completed.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#setStateFromStart\r\n * @fires Phaser.Tweens.Events#TWEEN_REPEAT\r\n * @since 3.60.0\r\n *\r\n * @param {number} diff - Any extra time that needs to be accounted for in the elapsed and progress values.\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 474, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "setStateFromStart", "longname": "Phaser.Tweens.TweenFrameData#setStateFromStart", "kind": "function", "description": "Internal method used as part of the playback process that checks if this\rTweenData should repeat or has completed.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_REPEAT" ], "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Any extra time that needs to be accounted for in the elapsed and progress values.", "name": "diff" } ], "inherits": "Phaser.Tweens.BaseTweenData#setStateFromStart", "inherited": true, "___id": "T000002R057632", "___s": true }, { "comment": "/**\r\n * Internal method that handles repeating or yoyo'ing this TweenData.\r\n *\r\n * Called automatically by `setStateFromStart` and `setStateFromEnd`.\r\n *\r\n * @method Phaser.Tweens.BaseTweenData#onRepeat\r\n * @fires Phaser.Tweens.Events#TWEEN_REPEAT\r\n * @fires Phaser.Tweens.Events#TWEEN_YOYO\r\n * @since 3.60.0\r\n *\r\n * @param {number} diff - Any extra time that needs to be accounted for in the elapsed and progress values.\r\n * @param {boolean} setStart - Set the TweenData start values?\r\n * @param {boolean} isYoyo - Is this call a Yoyo check?\r\n */", "meta": { "filename": "BaseTweenData.js", "lineno": 569, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tweens\\tween", "code": {} }, "name": "onRepeat", "longname": "Phaser.Tweens.TweenFrameData#onRepeat", "kind": "function", "description": "Internal method that handles repeating or yoyo'ing this TweenData.\r\rCalled automatically by `setStateFromStart` and `setStateFromEnd`.", "fires": [ "Phaser.Tweens.Events#event:TWEEN_REPEAT", "Phaser.Tweens.Events#event:TWEEN_YOYO" ], "since": "3.60.0", "memberof": "Phaser.Tweens.TweenFrameData", "scope": "instance", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Any extra time that needs to be accounted for in the elapsed and progress values.", "name": "diff" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set the TweenData start values?", "name": "setStart" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this call a Yoyo check?", "name": "isYoyo" } ], "inherits": "Phaser.Tweens.BaseTweenData#onRepeat", "inherited": true, "___id": "T000002R057633", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "shutdown", "longname": "Phaser.FacebookInstantGamesLeaderboard#shutdown", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.FacebookInstantGamesLeaderboard", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#shutdown", "inherited": true, "___id": "T000002R057634", "___s": true }, { "comment": "/**\r\n * Removes all listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "destroy", "longname": "Phaser.FacebookInstantGamesLeaderboard#destroy", "kind": "function", "description": "Removes all listeners.", "since": "3.0.0", "memberof": "Phaser.FacebookInstantGamesLeaderboard", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#destroy", "inherited": true, "___id": "T000002R057635", "___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": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "eventNames", "longname": "Phaser.FacebookInstantGamesLeaderboard#eventNames", "kind": "function", "description": "Return an array listing the events for which the emitter has registered listeners.", "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.FacebookInstantGamesLeaderboard", "scope": "instance", "inherits": "Phaser.Events.EventEmitter#eventNames", "inherited": true, "___id": "T000002R057636", "___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": 64, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listeners", "longname": "Phaser.FacebookInstantGamesLeaderboard#listeners", "kind": "function", "description": "Return the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.FacebookInstantGamesLeaderboard", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listeners", "inherited": true, "___id": "T000002R057637", "___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": 75, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "listenerCount", "longname": "Phaser.FacebookInstantGamesLeaderboard#listenerCount", "kind": "function", "description": "Return the number of listeners listening to a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.FacebookInstantGamesLeaderboard", "scope": "instance", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "inherits": "Phaser.Events.EventEmitter#listenerCount", "inherited": true, "___id": "T000002R057638", "___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": 86, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "emit", "longname": "Phaser.FacebookInstantGamesLeaderboard#emit", "kind": "function", "description": "Calls each of the listeners registered for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.FacebookInstantGamesLeaderboard", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#emit", "inherited": true, "___id": "T000002R057639", "___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": 98, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "on", "longname": "Phaser.FacebookInstantGamesLeaderboard#on", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.FacebookInstantGamesLeaderboard", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#on", "inherited": true, "___id": "T000002R057640", "___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": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "addListener", "longname": "Phaser.FacebookInstantGamesLeaderboard#addListener", "kind": "function", "description": "Add a listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.FacebookInstantGamesLeaderboard", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#addListener", "inherited": true, "___id": "T000002R057641", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\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": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "once", "longname": "Phaser.FacebookInstantGamesLeaderboard#once", "kind": "function", "description": "Add a one-time listener for a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.FacebookInstantGamesLeaderboard", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#once", "inherited": true, "___id": "T000002R057642", "___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": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeListener", "longname": "Phaser.FacebookInstantGamesLeaderboard#removeListener", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.FacebookInstantGamesLeaderboard", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeListener", "inherited": true, "___id": "T000002R057643", "___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": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "off", "longname": "Phaser.FacebookInstantGamesLeaderboard#off", "kind": "function", "description": "Remove the listeners of a given event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.FacebookInstantGamesLeaderboard", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#off", "inherited": true, "___id": "T000002R057644", "___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": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "name": "removeAllListeners", "longname": "Phaser.FacebookInstantGamesLeaderboard#removeAllListeners", "kind": "function", "description": "Remove all listeners, or those of the specified event.", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.FacebookInstantGamesLeaderboard", "scope": "instance", "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" } ], "inherits": "Phaser.Events.EventEmitter#removeAllListeners", "inherited": true, "___id": "T000002R057645", "___s": true }, { "comment": "/**\r\n * The game canvas is not centered within the parent by Phaser.\r\n * You can still center it yourself via CSS.\r\n *\r\n * @name Phaser.Scale.Center.NO_CENTER\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "CENTER_CONST.js", "lineno": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The game canvas is not centered within the parent by Phaser.\rYou can still center it yourself via CSS.", "name": "NO_CENTER", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.NO_CENTER", "scope": "static", "___id": "T000002R057646", "___s": true }, { "comment": "/**\r\n * The game canvas is centered both horizontally and vertically within the parent.\r\n * To do this, the parent has to have a bounds that can be calculated and not be empty.\r\n *\r\n * Centering is achieved by setting the margin left and top properties of the\r\n * game canvas, and does not factor in any other CSS styles you may have applied.\r\n *\r\n * @name Phaser.Scale.Center.CENTER_BOTH\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "CENTER_CONST.js", "lineno": 38, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The game canvas is centered both horizontally and vertically within the parent.\rTo do this, the parent has to have a bounds that can be calculated and not be empty.\r\rCentering is achieved by setting the margin left and top properties of the\rgame canvas, and does not factor in any other CSS styles you may have applied.", "name": "CENTER_BOTH", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.CENTER_BOTH", "scope": "static", "___id": "T000002R057647", "___s": true }, { "comment": "/**\r\n * The game canvas is centered horizontally within the parent.\r\n * To do this, the parent has to have a bounds that can be calculated and not be empty.\r\n *\r\n * Centering is achieved by setting the margin left and top properties of the\r\n * game canvas, and does not factor in any other CSS styles you may have applied.\r\n *\r\n * @name Phaser.Scale.Center.CENTER_HORIZONTALLY\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "CENTER_CONST.js", "lineno": 52, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The game canvas is centered horizontally within the parent.\rTo do this, the parent has to have a bounds that can be calculated and not be empty.\r\rCentering is achieved by setting the margin left and top properties of the\rgame canvas, and does not factor in any other CSS styles you may have applied.", "name": "CENTER_HORIZONTALLY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.CENTER_HORIZONTALLY", "scope": "static", "___id": "T000002R057648", "___s": true }, { "comment": "/**\r\n * The game canvas is centered both vertically within the parent.\r\n * To do this, the parent has to have a bounds that can be calculated and not be empty.\r\n *\r\n * Centering is achieved by setting the margin left and top properties of the\r\n * game canvas, and does not factor in any other CSS styles you may have applied.\r\n *\r\n * @name Phaser.Scale.Center.CENTER_VERTICALLY\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "CENTER_CONST.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The game canvas is centered both vertically within the parent.\rTo do this, the parent has to have a bounds that can be calculated and not be empty.\r\rCentering is achieved by setting the margin left and top properties of the\rgame canvas, and does not factor in any other CSS styles you may have applied.", "name": "CENTER_VERTICALLY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.CENTER_VERTICALLY", "scope": "static", "___id": "T000002R057649", "___s": true }, { "comment": "/**\r\n * A landscape orientation.\r\n *\r\n * @name Phaser.Scale.Orientation.LANDSCAPE\r\n * @type {string}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ORIENTATION_CONST.js", "lineno": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "A landscape orientation.", "name": "LANDSCAPE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.LANDSCAPE", "scope": "static", "___id": "T000002R057650", "___s": true }, { "comment": "/**\r\n * A portrait orientation.\r\n *\r\n * @name Phaser.Scale.Orientation.PORTRAIT\r\n * @type {string}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ORIENTATION_CONST.js", "lineno": 37, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "A portrait orientation.", "name": "PORTRAIT", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.PORTRAIT", "scope": "static", "___id": "T000002R057651", "___s": true }, { "comment": "/**\r\n * No scaling happens at all. The canvas is set to the size given in the game config and Phaser doesn't change it\r\n * again from that point on. If you change the canvas size, either via CSS, or directly via code, then you need\r\n * to call the Scale Managers `resize` method to give the new dimensions, or input events will stop working.\r\n *\r\n * @name Phaser.Scale.ScaleModes.NONE\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "SCALE_MODE_CONST.js", "lineno": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "No scaling happens at all. The canvas is set to the size given in the game config and Phaser doesn't change it\ragain from that point on. If you change the canvas size, either via CSS, or directly via code, then you need\rto call the Scale Managers `resize` method to give the new dimensions, or input events will stop working.", "name": "NONE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.NONE", "scope": "static", "___id": "T000002R057652", "___s": true }, { "comment": "/**\r\n * The height is automatically adjusted based on the width.\r\n *\r\n * @name Phaser.Scale.ScaleModes.WIDTH_CONTROLS_HEIGHT\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "SCALE_MODE_CONST.js", "lineno": 39, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The height is automatically adjusted based on the width.", "name": "WIDTH_CONTROLS_HEIGHT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.WIDTH_CONTROLS_HEIGHT", "scope": "static", "___id": "T000002R057653", "___s": true }, { "comment": "/**\r\n * The width is automatically adjusted based on the height.\r\n *\r\n * @name Phaser.Scale.ScaleModes.HEIGHT_CONTROLS_WIDTH\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "SCALE_MODE_CONST.js", "lineno": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The width is automatically adjusted based on the height.", "name": "HEIGHT_CONTROLS_WIDTH", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.HEIGHT_CONTROLS_WIDTH", "scope": "static", "___id": "T000002R057654", "___s": true }, { "comment": "/**\r\n * The width and height are automatically adjusted to fit inside the given target area,\r\n * while keeping the aspect ratio. Depending on the aspect ratio there may be some space\r\n * inside the area which is not covered.\r\n *\r\n * @name Phaser.Scale.ScaleModes.FIT\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "SCALE_MODE_CONST.js", "lineno": 59, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The width and height are automatically adjusted to fit inside the given target area,\rwhile keeping the aspect ratio. Depending on the aspect ratio there may be some space\rinside the area which is not covered.", "name": "FIT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.FIT", "scope": "static", "___id": "T000002R057655", "___s": true }, { "comment": "/**\r\n * The width and height are automatically adjusted to make the size cover the entire target\r\n * area while keeping the aspect ratio. This may extend further out than the target size.\r\n *\r\n * @name Phaser.Scale.ScaleModes.ENVELOP\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "SCALE_MODE_CONST.js", "lineno": 71, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The width and height are automatically adjusted to make the size cover the entire target\rarea while keeping the aspect ratio. This may extend further out than the target size.", "name": "ENVELOP", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.ENVELOP", "scope": "static", "___id": "T000002R057656", "___s": true }, { "comment": "/**\r\n * The Canvas is resized to fit all available _parent_ space, regardless of aspect ratio.\r\n *\r\n * @name Phaser.Scale.ScaleModes.RESIZE\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "SCALE_MODE_CONST.js", "lineno": 82, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The Canvas is resized to fit all available _parent_ space, regardless of aspect ratio.", "name": "RESIZE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.RESIZE", "scope": "static", "___id": "T000002R057657", "___s": true }, { "comment": "/**\r\n * The game canvas will not be zoomed by Phaser.\r\n *\r\n * @name Phaser.Scale.Zoom.NO_ZOOM\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ZOOM_CONST.js", "lineno": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The game canvas will not be zoomed by Phaser.", "name": "NO_ZOOM", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.NO_ZOOM", "scope": "static", "___id": "T000002R057658", "___s": true }, { "comment": "/**\r\n * The game canvas will be 2x zoomed by Phaser.\r\n *\r\n * @name Phaser.Scale.Zoom.ZOOM_2X\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ZOOM_CONST.js", "lineno": 37, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The game canvas will be 2x zoomed by Phaser.", "name": "ZOOM_2X", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.ZOOM_2X", "scope": "static", "___id": "T000002R057659", "___s": true }, { "comment": "/**\r\n * The game canvas will be 4x zoomed by Phaser.\r\n *\r\n * @name Phaser.Scale.Zoom.ZOOM_4X\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ZOOM_CONST.js", "lineno": 47, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "The game canvas will be 4x zoomed by Phaser.", "name": "ZOOM_4X", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.ZOOM_4X", "scope": "static", "___id": "T000002R057660", "___s": true }, { "comment": "/**\r\n * Calculate the zoom value based on the maximum multiplied game size that will\r\n * fit into the parent, or browser window if no parent is set.\r\n *\r\n * @name Phaser.Scale.Zoom.MAX_ZOOM\r\n * @type {number}\r\n * @const\r\n * @since 3.16.0\r\n */", "meta": { "filename": "ZOOM_CONST.js", "lineno": 57, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\scale\\const", "code": {} }, "description": "Calculate the zoom value based on the maximum multiplied game size that will\rfit into the parent, or browser window if no parent is set.", "name": "MAX_ZOOM", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.16.0", "memberof": "Phaser.Scale", "longname": "Phaser.Scale.MAX_ZOOM", "scope": "static", "___id": "T000002R057661", "___s": true }, { "comment": "/**\r\n * Orthogonal Tilemap orientation constant.\r\n *\r\n * @name Phaser.Tilemaps.Orientation.ORTHOGONAL\r\n * @type {number}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "ORIENTATION_CONST.js", "lineno": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\const", "code": {} }, "description": "Orthogonal Tilemap orientation constant.", "name": "ORTHOGONAL", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Tilemaps", "longname": "Phaser.Tilemaps.ORTHOGONAL", "scope": "static", "___id": "T000002R057662", "___s": true }, { "comment": "/**\r\n * Isometric Tilemap orientation constant.\r\n *\r\n * @name Phaser.Tilemaps.Orientation.ISOMETRIC\r\n * @type {number}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "ORIENTATION_CONST.js", "lineno": 37, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\const", "code": {} }, "description": "Isometric Tilemap orientation constant.", "name": "ISOMETRIC", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Tilemaps", "longname": "Phaser.Tilemaps.ISOMETRIC", "scope": "static", "___id": "T000002R057663", "___s": true }, { "comment": "/**\r\n * Staggered Tilemap orientation constant.\r\n *\r\n * @name Phaser.Tilemaps.Orientation.STAGGERED\r\n * @type {number}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "ORIENTATION_CONST.js", "lineno": 47, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\const", "code": {} }, "description": "Staggered Tilemap orientation constant.", "name": "STAGGERED", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Tilemaps", "longname": "Phaser.Tilemaps.STAGGERED", "scope": "static", "___id": "T000002R057664", "___s": true }, { "comment": "/**\r\n * Hexagonal Tilemap orientation constant.\r\n *\r\n * @name Phaser.Tilemaps.Orientation.HEXAGONAL\r\n * @type {number}\r\n * @const\r\n * @since 3.50.0\r\n */", "meta": { "filename": "ORIENTATION_CONST.js", "lineno": 57, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\tilemaps\\const", "code": {} }, "description": "Hexagonal Tilemap orientation constant.", "name": "HEXAGONAL", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "kind": "constant", "since": "3.50.0", "memberof": "Phaser.Tilemaps", "longname": "Phaser.Tilemaps.HEXAGONAL", "scope": "static", "___id": "T000002R057665", "___s": true } ]